Skip to content

Definitions Module

anonipy.definitions

Module containing the definitions.

The definitions module provides a set of predefined types used in the package.

Classes:

Name Description
Entity

The class representing the anonipy entity object.
Replacement

The class representing the anonipy replacement object.

Entity dataclass

The class representing the anonipy Entity object.

Attributes:

Name Type Description
text str

The text of the entity.
label str

The label of the entity.
start_index int

The start index of the entity in the text.
end_index int

The end index of the entity in the text.
score float

The prediction score of the entity. The score is returned by the extractor models.
type ENTITY_TYPES

The type of the entity.
regex Union[str, Pattern]

The regular expression the entity must match.
Source code in anonipy/definitions.py 
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
64
65
66
67
68
69
70
71
@dataclass
class Entity:
    """The class representing the anonipy Entity object.

    Attributes:
        text (str): The text of the entity.
        label (str): The label of the entity.
        start_index (int): The start index of the entity in the text.
        end_index (int): The end index of the entity in the text.
        score (float): The prediction score of the entity. The score is returned by the extractor models.
        type (ENTITY_TYPES): The type of the entity.
        regex (Union[str, re.Pattern]): The regular expression the entity must match.

    """

    text: str
    label: str
    start_index: int
    end_index: int
    score: float = 1.0
    type: ENTITY_TYPES = None
    regex: Union[str, re.Pattern] = None

    def __post_init__(self):
        if self.regex is None:
            if self.type == "custom":
                raise ValueError("Custom entities require a regex.")
            self.regex = regex_mapping[self.type]

    def get_regex_group(self) -> Union[str, None]:
        """Get the regex group.

        Returns:
            The regex group.

        """

        p_match = re.match(r"^.*?\((.*)\).*$", self.regex)
        return p_match.group(1) if p_match else self.regex

    def __str__(self) -> str:
        """String representation of the entity.

        Returns:
            The string representation of the entity.

        """
        return f"Entity(text='{self.text}', label='{self.label}', start_index={self.start_index}, end_index={self.end_index}, type='{self.type}')"

get_regex_group()

Get the regex group.

Returns:

Type Description
Union[str, None]

The regex group.
Source code in anonipy/definitions.py 
53
54
55
56
57
58
59
60
61
62
def get_regex_group(self) -> Union[str, None]:
    """Get the regex group.

    Returns:
        The regex group.

    """

    p_match = re.match(r"^.*?\((.*)\).*$", self.regex)
    return p_match.group(1) if p_match else self.regex

__str__()

String representation of the entity.

Returns:

Type Description
str

The string representation of the entity.
Source code in anonipy/definitions.py 
64
65
66
67
68
69
70
71
def __str__(self) -> str:
    """String representation of the entity.

    Returns:
        The string representation of the entity.

    """
    return f"Entity(text='{self.text}', label='{self.label}', start_index={self.start_index}, end_index={self.end_index}, type='{self.type}')"

Replacement

Bases: TypedDict

The class representing the anonipy Replacement object.

Attributes:

Name Type Description
original_text str

The original text of the entity.
label str

The label of the entity.
start_index int

The start index of the entity in the text.
end_index int

The end index of the entity in the text.
anonymized_text str

The anonymized text replacing the original.
Source code in anonipy/definitions.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
class Replacement(TypedDict):
    """The class representing the anonipy Replacement object.

    Attributes:
        original_text (str): The original text of the entity.
        label (str): The label of the entity.
        start_index (int): The start index of the entity in the text.
        end_index (int): The end index of the entity in the text.
        anonymized_text (str): The anonymized text replacing the original.

    """

    original_text: NotRequired[str]
    label: NotRequired[str]
    start_index: int
    end_index: int
    anonymized_text: str