Skip to content

biip.gs1_application_identifiers

Support for GS1 Application Identifiers (AI).

Application identifiers are used to identify the type of data that follows in a GS1 element string.

All application identifier data is bundled with Biip. No network access is required.

Examples:

>>> from biip.gs1_application_identifiers import GS1ApplicationIdentifier
>>> ai = GS1ApplicationIdentifier.extract("01")
>>> pprint(ai)
GS1ApplicationIdentifier(
    ai='01',
    description='Global Trade Item Number (GTIN)',
    data_title='GTIN',
    separator_required=False,
    format='N2+N14'
)
>>> ai.pattern
'^01(\\d{14})$'

GS1ApplicationIdentifier dataclass

GS1 Application Identifier (AI).

AIs are data field prefixes used in several types of barcodes, including GS1-128. The AI defines what semantical meaning and format of the following data field.

AIs standardize how to include e.g. product weight, expiration dates, and lot numbers in barcodes.

References

https://www.gs1.org/standards/barcodes/application-identifiers

Source code in src/biip/gs1_application_identifiers/__init__.py 
 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
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
@dataclass(frozen=True)
class GS1ApplicationIdentifier:
    """GS1 Application Identifier (AI).

    AIs are data field prefixes used in several types of barcodes, including
    GS1-128. The AI defines what semantical meaning and format of the following
    data field.

    AIs standardize how to include e.g. product weight, expiration dates,
    and lot numbers in barcodes.

    References:
        https://www.gs1.org/standards/barcodes/application-identifiers
    """

    ai: str
    """The Application Identifier (AI) itself."""

    description: str
    """Description of the AIs use."""

    data_title: str
    """Commonly used label/abbreviation for the AI."""

    separator_required: bool
    """Whether a separator character is required after element strings of this type.

    This is the case for all AIs that have a variable length.
    """

    format: str
    """Human readable format of the AIs element string."""

    pattern: str = field(repr=False)
    """Regular expression for parsing the AIs element string."""

    @classmethod
    def extract(cls, value: str) -> GS1ApplicationIdentifier:
        """Extract the GS1 Application Identifier (AI) from the given value.

        Args:
            value: The string to extract an AI from.

        Returns:
            Metadata about the extracted AI.

        Raises:
            ParseError: If the parsing fails.

        Examples:
            >>> from biip.gs1_application_identifiers import GS1ApplicationIdentifier
            >>> ai = GS1ApplicationIdentifier.extract("010703206980498815210526100329")
            >>> pprint(ai)
            GS1ApplicationIdentifier(
                ai='01',
                description='Global Trade Item Number (GTIN)',
                data_title='GTIN',
                separator_required=False,
                format='N2+N14'
            )
        """
        for application_identifier in _GS1_APPLICATION_IDENTIFIERS.values():
            if value.startswith(application_identifier.ai):
                return application_identifier

        msg = f"Failed to get GS1 Application Identifier from {value!r}."
        raise ParseError(msg)

    def __len__(self) -> int:
        """Get the length of the Application Identifier code."""
        return len(self.ai)

    def __str__(self) -> str:
        """Get the string representation of the Application Identifier."""
        return f"({self.ai})"

ai instance-attribute 

ai: str

The Application Identifier (AI) itself.

data_title instance-attribute 

data_title: str

Commonly used label/abbreviation for the AI.

description instance-attribute 

description: str

Description of the AIs use.

format instance-attribute 

format: str

Human readable format of the AIs element string.

pattern class-attribute instance-attribute 

pattern: str = field(repr=False)

Regular expression for parsing the AIs element string.

separator_required instance-attribute 

separator_required: bool

Whether a separator character is required after element strings of this type.

This is the case for all AIs that have a variable length.

extract classmethod 

extract(value: str) -> GS1ApplicationIdentifier

Extract the GS1 Application Identifier (AI) from the given value.

Parameters:

  • value (str) –

    The string to extract an AI from.

Returns:

Raises:

Examples:

>>> from biip.gs1_application_identifiers import GS1ApplicationIdentifier
>>> ai = GS1ApplicationIdentifier.extract("010703206980498815210526100329")
>>> pprint(ai)
GS1ApplicationIdentifier(
    ai='01',
    description='Global Trade Item Number (GTIN)',
    data_title='GTIN',
    separator_required=False,
    format='N2+N14'
)
Source code in src/biip/gs1_application_identifiers/__init__.py 
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
@classmethod
def extract(cls, value: str) -> GS1ApplicationIdentifier:
    """Extract the GS1 Application Identifier (AI) from the given value.

    Args:
        value: The string to extract an AI from.

    Returns:
        Metadata about the extracted AI.

    Raises:
        ParseError: If the parsing fails.

    Examples:
        >>> from biip.gs1_application_identifiers import GS1ApplicationIdentifier
        >>> ai = GS1ApplicationIdentifier.extract("010703206980498815210526100329")
        >>> pprint(ai)
        GS1ApplicationIdentifier(
            ai='01',
            description='Global Trade Item Number (GTIN)',
            data_title='GTIN',
            separator_required=False,
            format='N2+N14'
        )
    """
    for application_identifier in _GS1_APPLICATION_IDENTIFIERS.values():
        if value.startswith(application_identifier.ai):
            return application_identifier

    msg = f"Failed to get GS1 Application Identifier from {value!r}."
    raise ParseError(msg)