Skip to content

name

Module for managing entities with names.

This module provides a mixin class, NameMixin, designed to simplify the management of names associated with an entity. The mixin can be used by any class that has the necessary attributes to support name retrieval, specifically an entity_info object containing a name attribute.

NameMixin

Mixin for entities that have a name.

This mixin provides a method for retrieving the name associated with an entity. It assumes that the class using this mixin has an entity_info object containing a name attribute.

Methods:

Name Description
get_name

Retrieve the name associated with the entity.
Source code in merlin/db_scripts/entities/mixins/name.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
class NameMixin:
    """
    Mixin for entities that have a name.

    This mixin provides a method for retrieving the name associated with an entity.
    It assumes that the class using this mixin has an `entity_info` object containing
    a `name` attribute.

    Methods:
        get_name:
            Retrieve the name associated with the entity.
    """

    def get_name(self) -> str:
        """
        Get the name of this entity.

        Assumptions:
            - The class using this must have an `entity_info` object containing a `name` attribute

        Returns:
            The name of this entity.
        """
        return self.entity_info.name

get_name()

Get the name of this entity.

Assumptions
  • The class using this must have an entity_info object containing a name attribute

Returns:

Type Description
str

The name of this entity.
Source code in merlin/db_scripts/entities/mixins/name.py 
32
33
34
35
36
37
38
39
40
41
42
def get_name(self) -> str:
    """
    Get the name of this entity.

    Assumptions:
        - The class using this must have an `entity_info` object containing a `name` attribute

    Returns:
        The name of this entity.
    """
    return self.entity_info.name