Skip to content

Exceptions

blackline.exceptions

CollectionNotFoundError

Bases: Exception

Exception raised when an collection does not exist.

Attributes:

Name Type Description
name str

The name of the missing collection.

Parameters:

Name Type Description Default
name str

The name of the missing collection.

 required

Raises:

Type Description
CollectionNotFoundError

If an collection is not found.
Example

try: fetch_collection_data(name) except CollectionNotFoundError as e: print(f"Collection '{e.name}' does not exist.")

Source code in BAR /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/blackline/exceptions.py 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
class CollectionNotFoundError(Exception):
    """
    Exception raised when an collection does not exist.

    Attributes:
        name (str): The name of the missing collection.

    Args:
        name (str): The name of the missing collection.

    Raises:
        CollectionNotFoundError: If an collection is not found.

    Example:
        try:
            fetch_collection_data(name)
        except CollectionNotFoundError as e:
            print(f"Collection '{e.name}' does not exist.")
    """

    def __init__(self, collection: str) -> None:
        self.collection = collection
        super().__init__(f"Collection '{collection}' does not exist.")

collection = collection instance-attribute

__init__(collection)

Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/blackline/exceptions.py 
21
22
23
def __init__(self, collection: str) -> None:
    self.collection = collection
    super().__init__(f"Collection '{collection}' does not exist.")

FieldNotFoundError

Bases: Exception

Exception raised when an SQLite collection does not include a given column.

Attributes:

Name Type Description
collection_name str

The name of the collection.
field_name str

The name of the missing column.

Parameters:

Name Type Description Default
collection_name str

The name of the collection.

 required
field_name str

The name of the missing column.

 required

Raises:

Type Description
FieldNotFoundError

If an SQLite collection does not include the given column.
Example

try: fetch_column_data(name, field_name) except FieldNotFoundError as e: print(f"Field '{e.field_name}' not found in collection '{e.name}'.")

Source code in BAR /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/blackline/exceptions.py 
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
class FieldNotFoundError(Exception):
    """
    Exception raised when an SQLite collection does not include a given column.

    Attributes:
        collection_name (str): The name of the collection.
        field_name (str): The name of the missing column.

    Args:
        collection_name (str): The name of the collection.
        field_name (str): The name of the missing column.

    Raises:
        FieldNotFoundError: If an SQLite collection does not include the given column.

    Example:
        try:
            fetch_column_data(name, field_name)
        except FieldNotFoundError as e:
            print(f"Field '{e.field_name}' not found in collection '{e.name}'.")
    """

    def __init__(self, collection: str, field: str) -> None:
        self.collection = collection
        self.field = field
        super().__init__(f"Field '{field}' not found in collection '{collection}'.")

collection = collection instance-attribute

field = field instance-attribute

__init__(collection, field)

Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/blackline/exceptions.py 
48
49
50
51
def __init__(self, collection: str, field: str) -> None:
    self.collection = collection
    self.field = field
    super().__init__(f"Field '{field}' not found in collection '{collection}'.")

InvalidDatsetError

Bases: Exception

Exception raised when a Dataset is invalid.

Attributes:

Name Type Description
name

The name of the invalid dataset.

Parameters:

Name Type Description Default
name str

The name of the invalid dataset.

 required

Raises:

Type Description
InvalidDatasetError

If a catalogue is invalid.
Example

try: validate_catalogue(name) except InvalidDatasetError as e: print(f"Dataset '{e.name}' is invalid.")

Source code in BAR /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/blackline/exceptions.py 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
class InvalidDatsetError(Exception):
    """
    Exception raised when a Dataset is invalid.

    Attributes:
        name: The name of the invalid dataset.

    Args:
        name: The name of the invalid dataset.

    Raises:
        InvalidDatasetError: If a catalogue is invalid.

    Example:
        try:
            validate_catalogue(name)
        except InvalidDatasetError as e:
            print(f"Dataset '{e.name}' is invalid.")
    """

    def __init__(self, name: str) -> None:
        self.name = name
        super().__init__(f"Dataset '{name}' is invalid.")

name = name instance-attribute

__init__(name)

Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/blackline/exceptions.py 
108
109
110
def __init__(self, name: str) -> None:
    self.name = name
    super().__init__(f"Dataset '{name}' is invalid.")

InvalidFieldConstraintError

Bases: Exception

Exception raised when a SQLite column constraint is invalid for a given de-identification method.

Attributes:

Name Type Description
constraint_name str

The name of the invalid column constraint.
deidentification_method str

The de-identification method being applied.

Parameters:

Name Type Description Default
constraint_name str

The name of the invalid column constraint.

 required
deidentification_method str

The de-identification method being applied.

 required

Raises:

Type Description
InvalidFieldConstraintError

If a column constraint is not compatible with the de-identification method.
Example

try: apply_deidentification_method( field_name, constraint_name, deidentification_method ) except InvalidFieldConstraintError as e: print(f"Invalid column constraint '{e.constraint_name}' for de-identification method '{e.deidentification_method}'.") # noqa: E501

Source code in BAR /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/blackline/exceptions.py 
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
class InvalidFieldConstraintError(Exception):
    """
    Exception raised when a SQLite column constraint is invalid for a given de-identification method.

    Attributes:
        constraint_name (str): The name of the invalid column constraint.
        deidentification_method (str): The de-identification method being applied.

    Args:
        constraint_name (str): The name of the invalid column constraint.
        deidentification_method (str): The de-identification method being applied.

    Raises:
        InvalidFieldConstraintError: If a column constraint is not compatible with the de-identification method.

    Example:
        try:
            apply_deidentification_method(
                field_name,
                constraint_name,
                deidentification_method
                )
        except InvalidFieldConstraintError as e:
            print(f"Invalid column constraint '{e.constraint_name}' for de-identification method '{e.deidentification_method}'.") # noqa: E501
    """

    def __init__(self, constraint_name: str, deidentification_method: str) -> None:
        self.constraint_name = constraint_name
        self.deidentification_method = deidentification_method
        super().__init__(
            f"Invalid column constraint '{constraint_name}' for de-identification method '{deidentification_method}'."  # noqa: E501
        )

constraint_name = constraint_name instance-attribute

deidentification_method = deidentification_method instance-attribute

__init__(constraint_name, deidentification_method)

Source code in /opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/blackline/exceptions.py 
80
81
82
83
84
85
def __init__(self, constraint_name: str, deidentification_method: str) -> None:
    self.constraint_name = constraint_name
    self.deidentification_method = deidentification_method
    super().__init__(
        f"Invalid column constraint '{constraint_name}' for de-identification method '{deidentification_method}'."  # noqa: E501
    )