Skip to content

Sample ID

sample_id

Sample ID Value Object

Represents a unique identifier for a biological sample.

Classes

SampleId dataclass 

SampleId(value: str)

Value Object for sample identifier.

Parameters:

Name Type Description Default
value str

Sample identifier name (cannot be empty)

 required

Raises:

Type Description
ValueError

If value is empty or contains only spaces
Notes

This object is immutable ensuring identifier consistency throughout the application lifecycle.

Functions
__post_init__ 
__post_init__()

Validates the identifier after initialization.

Raises:

Type Description
ValueError

If value is empty or None.
Source code in src/domain/value_objects/sample_id.py 
33
34
35
36
37
38
39
40
41
42
43
def __post_init__(self):
    """
    Validates the identifier after initialization.

    Raises
    ------
    ValueError
        If value is empty or None.
    """
    if not self.value or not self.value.strip():
        raise ValueError("Sample ID cannot be empty")
__str__ 
__str__() -> str

Returns string representation of Sample ID.

Returns:

Type Description
str

The identifier value.
Source code in src/domain/value_objects/sample_id.py 
45
46
47
48
49
50
51
52
53
54
def __str__(self) -> str:
    """
    Returns string representation of Sample ID.

    Returns
    -------
    str
        The identifier value.
    """
    return self.value
__repr__ 
__repr__() -> str

Returns debug representation of Sample ID.

Returns:

Type Description
str

Representation in format "SampleId('value')".
Source code in src/domain/value_objects/sample_id.py 
56
57
58
59
60
61
62
63
64
65
def __repr__(self) -> str:
    """
    Returns debug representation of Sample ID.

    Returns
    -------
    str
        Representation in format "SampleId('value')".
    """
    return f"SampleId('{self.value}')"
__hash__ 
__hash__() -> int

Allows using SampleId as dictionary key.

Returns:

Type Description
int

Hash of the value.
Source code in src/domain/value_objects/sample_id.py 
67
68
69
70
71
72
73
74
75
76
def __hash__(self) -> int:
    """
    Allows using SampleId as dictionary key.

    Returns
    -------
    int
        Hash of the value.
    """
    return hash(self.value)