Skip to content

dsdl.geometry.registry

LabelRegistry

Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/registry.py 
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
class LabelRegistry:
    def __init__(self):
        """A collection to register given `dsdl.geometry.Label` objects.
        """
        self._labels = {}

    def registry(self, label):
        """Register a given `Label` objects into the current `Registry` object.
        Args:
            label(dsdl.geometry.Label): The `Label` object to be registered.
        """
        registry_name = label.registry_name
        if registry_name in self._labels:
            # raise ClassHasDefinedError(f"The label {label.registry_name} has been registered.")
            ClassHasDefinedWarning(
                f"The label {label.registry_name} has been registered, it will be replaced bt this updated one.")
        self._labels[registry_name] = label

    def get(self, registry_name):
        """Get the `Label` object when given the registry name.

        Args:
            name: The registry name to be queried.

        Returns:
            (dsdl.geometry.Label): The `Label` object coresponding the given registry name.
        """
        if registry_name not in self._labels:
            raise ClassNotFoundError
        return self._labels[registry_name]

    def __contains__(self, item):
        """Whether the current `Registry` object contains a given object.

        Args:
            item(str or dsdl.geometry.Label): The object or the registry name to be quried.

        Returns:
            Whether the current `Registry` object contains a given object.
        """
        if isinstance(item, str):
            return item in self._labels
        elif hasattr(item, "registry_name"):
            return item.registry_name in self._labels
        else:
            return False

    def clear(self):
        """Clear all the registered objects in the current `Registry` object.
        """
        self._labels = {}

__contains__(item)

Whether the current Registry object contains a given object.

Parameters:

Name Type Description Default
item(str or dsdl.geometry.Label

The object or the registry name to be quried.

 required

Returns:

Type Description

Whether the current Registry object contains a given object.
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/registry.py 
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
def __contains__(self, item):
    """Whether the current `Registry` object contains a given object.

    Args:
        item(str or dsdl.geometry.Label): The object or the registry name to be quried.

    Returns:
        Whether the current `Registry` object contains a given object.
    """
    if isinstance(item, str):
        return item in self._labels
    elif hasattr(item, "registry_name"):
        return item.registry_name in self._labels
    else:
        return False

__init__()

A collection to register given dsdl.geometry.Label objects.

Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/registry.py 
74
75
76
77
def __init__(self):
    """A collection to register given `dsdl.geometry.Label` objects.
    """
    self._labels = {}

clear()

Clear all the registered objects in the current Registry object.

Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/registry.py 
120
121
122
123
def clear(self):
    """Clear all the registered objects in the current `Registry` object.
    """
    self._labels = {}

get(registry_name)

Get the Label object when given the registry name.

Parameters:

Name Type Description Default
name

The registry name to be queried.

 required

Returns:

Type Description
dsdl.geometry.Label

The Label object coresponding the given registry name.
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/registry.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
def get(self, registry_name):
    """Get the `Label` object when given the registry name.

    Args:
        name: The registry name to be queried.

    Returns:
        (dsdl.geometry.Label): The `Label` object coresponding the given registry name.
    """
    if registry_name not in self._labels:
        raise ClassNotFoundError
    return self._labels[registry_name]

registry(label)

Register a given Label objects into the current Registry object.

Parameters:

Name Type Description Default
label(dsdl.geometry.Label)

The Label object to be registered.

 required
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/registry.py 
79
80
81
82
83
84
85
86
87
88
89
def registry(self, label):
    """Register a given `Label` objects into the current `Registry` object.
    Args:
        label(dsdl.geometry.Label): The `Label` object to be registered.
    """
    registry_name = label.registry_name
    if registry_name in self._labels:
        # raise ClassHasDefinedError(f"The label {label.registry_name} has been registered.")
        ClassHasDefinedWarning(
            f"The label {label.registry_name} has been registered, it will be replaced bt this updated one.")
    self._labels[registry_name] = label

Registry

Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/registry.py 
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
class Registry:
    def __init__(self, name):
        """A collection to register given `dsdl.types.Struct` classes or `dsdl.geometry.ClassDomain` classes.

        Args:
            name: The name of the current `Registry` object.
        """
        self._name = name
        self._map = dict()
        self._names_contained = []

    @property
    def name(self):
        """
        Returns:
            The name of the current `Registry` object.
        """
        return self._name

    def register(self, name, cls):
        """Register a given `Struct` or `ClassDomain` class into the current `Registry` object.
        Args:
            name(str): The registry name of the given `Struct` class.
            cls(dsdl.types.Struct or dsdl.geometry.ClassDomain): The `Struct` class to be registered.
        """
        # NOTICE: Since this method is called when models are imported,
        # it cannot perform imports because of the risk of import loops.
        if name in self._map:
            # raise ClassHasDefinedError
            ClassHasDefinedWarning(f"Class '{name}' has been registered, it will be replaced by this updated one.")
        else:
            self._names_contained.append(name)
        self._map[name] = cls

    def get(self, name):
        """Get the `Struct` class when given the registry name.

        Args:
            name: The registry name to be queried.

        Returns:
            (dsdl.types.Struct or dsdl.geometry.ClassDomain): The `Struct` class coresponding the given registry name.
        """
        if name not in self._map:
            raise ClassNotFoundError(f"Class '{name}' is not defined.")
        return self._map[name]

    def clear(self):
        """Clear all the registered classes in the current `Registry` object.
        """
        self._map = {}

    def names_contained(self):
        """Return all the registered classes' names in the current `Registry` object.
        """
        return self._names_contained

    def __contains__(self, name):
        return name in self._names_contained

name property

Returns:

Type Description

The name of the current Registry object.

__init__(name)

A collection to register given dsdl.types.Struct classes or dsdl.geometry.ClassDomain classes.

Parameters:

Name Type Description Default
name

The name of the current Registry object.

 required
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/registry.py 
 6
 7
 8
 9
10
11
12
13
14
def __init__(self, name):
    """A collection to register given `dsdl.types.Struct` classes or `dsdl.geometry.ClassDomain` classes.

    Args:
        name: The name of the current `Registry` object.
    """
    self._name = name
    self._map = dict()
    self._names_contained = []

clear()

Clear all the registered classes in the current Registry object.

Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/registry.py 
52
53
54
55
def clear(self):
    """Clear all the registered classes in the current `Registry` object.
    """
    self._map = {}

get(name)

Get the Struct class when given the registry name.

Parameters:

Name Type Description Default
name

The registry name to be queried.

 required

Returns:

Type Description
dsdl.types.Struct or dsdl.geometry.ClassDomain

The Struct class coresponding the given registry name.
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/registry.py 
39
40
41
42
43
44
45
46
47
48
49
50
def get(self, name):
    """Get the `Struct` class when given the registry name.

    Args:
        name: The registry name to be queried.

    Returns:
        (dsdl.types.Struct or dsdl.geometry.ClassDomain): The `Struct` class coresponding the given registry name.
    """
    if name not in self._map:
        raise ClassNotFoundError(f"Class '{name}' is not defined.")
    return self._map[name]

names_contained()

Return all the registered classes' names in the current Registry object.

Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/registry.py 
57
58
59
60
def names_contained(self):
    """Return all the registered classes' names in the current `Registry` object.
    """
    return self._names_contained

register(name, cls)

Register a given Struct or ClassDomain class into the current Registry object.

Parameters:

Name Type Description Default
name(str)

The registry name of the given Struct class.

 required
cls(dsdl.types.Struct or dsdl.geometry.ClassDomain

The Struct class to be registered.

 required
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/registry.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
def register(self, name, cls):
    """Register a given `Struct` or `ClassDomain` class into the current `Registry` object.
    Args:
        name(str): The registry name of the given `Struct` class.
        cls(dsdl.types.Struct or dsdl.geometry.ClassDomain): The `Struct` class to be registered.
    """
    # NOTICE: Since this method is called when models are imported,
    # it cannot perform imports because of the risk of import loops.
    if name in self._map:
        # raise ClassHasDefinedError
        ClassHasDefinedWarning(f"Class '{name}' has been registered, it will be replaced by this updated one.")
    else:
        self._names_contained.append(name)
    self._map[name] = cls