Skip to content

Core

Base class for entities with unique identifiers for common entities in blue.

Source code in blue/core.py 
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
class Entity:
    """Base class for entities with unique identifiers for common entities in blue."""

    def __init__(self, name=None, id=None, sid=None, cid=None, prefix=None, suffix=None):
        """Initialize the Entity.

        Parameters:
            name: Name of the entity.
            id: Unique identifier for the entity.
            sid: Short identifier (combination of name and id).
            cid: Canonical identifier (may include prefix and suffix).
            prefix: Optional prefix for the cid.
            suffix: Optional suffix for the cid.
        """
        if cid:
            self.cid = cid
            # extract name, id, prefix
            self.name, self.id = uuid_utils.extract_name_id(cid)
            self.sid = uuid_utils.extract_sid(cid)

            self.prefix = uuid_utils.extract_prefix(cid)
            # always assume suffix=None
            self.suffix = None
        else:
            if sid:
                self.sid = sid
                # extract name, id
                self.name, self.id = uuid_utils.extract_name_id(sid)
            else:
                self.name = name
                if id:
                    self.id = id
                else:
                    self.id = uuid_utils.create_uuid()

                self.sid = uuid_utils.concat_ids(self.name, self.id)

            self.cid = self.sid

            self.prefix = prefix
            self.suffix = suffix

            if self.prefix:
                self.cid = uuid_utils.concat_ids(self.prefix, self.cid)
            if self.suffix:
                self.cid = uuid_utils.concat_ids(self.cid, self.suffix)

__init__(name=None, id=None, sid=None, cid=None, prefix=None, suffix=None)

Initialize the Entity.

Parameters:

Name Type Description Default
name

Name of the entity.

 None
id

Unique identifier for the entity.

 None
sid

Short identifier (combination of name and id).

 None
cid

Canonical identifier (may include prefix and suffix).

 None
prefix

Optional prefix for the cid.

 None
suffix

Optional suffix for the cid.

 None
Source code in blue/core.py 
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
def __init__(self, name=None, id=None, sid=None, cid=None, prefix=None, suffix=None):
    """Initialize the Entity.

    Parameters:
        name: Name of the entity.
        id: Unique identifier for the entity.
        sid: Short identifier (combination of name and id).
        cid: Canonical identifier (may include prefix and suffix).
        prefix: Optional prefix for the cid.
        suffix: Optional suffix for the cid.
    """
    if cid:
        self.cid = cid
        # extract name, id, prefix
        self.name, self.id = uuid_utils.extract_name_id(cid)
        self.sid = uuid_utils.extract_sid(cid)

        self.prefix = uuid_utils.extract_prefix(cid)
        # always assume suffix=None
        self.suffix = None
    else:
        if sid:
            self.sid = sid
            # extract name, id
            self.name, self.id = uuid_utils.extract_name_id(sid)
        else:
            self.name = name
            if id:
                self.id = id
            else:
                self.id = uuid_utils.create_uuid()

            self.sid = uuid_utils.concat_ids(self.name, self.id)

        self.cid = self.sid

        self.prefix = prefix
        self.suffix = suffix

        if self.prefix:
            self.cid = uuid_utils.concat_ids(self.prefix, self.cid)
        if self.suffix:
            self.cid = uuid_utils.concat_ids(self.cid, self.suffix)
Last update: 2025-10-08