pathfinder_framework.product_footprint package

Submodules

pathfinder_framework.product_footprint.company_id_list module

pathfinder_framework.product_footprint.cpc module

class pathfinder_framework.product_footprint.cpc.CPC(code: str, title: str)

Bases: object

Represents a Central Product Classification (CPC) code.

Attributes:

code (str): The CPC code. title (str): The title of the CPC code. section (str): The section of the CPC code. division (str): The division of the CPC code. group (str): The group of the CPC code. class_ (str): The class of the CPC code. subclass (str): The subclass of the CPC code.

class pathfinder_framework.product_footprint.cpc.CPCCodeLookup

Bases: object

A lookup table for CPC codes.

Attributes:

filename (str): The name of the CSV file containing the CPC codes. cpc_codes (dict[str, CPC]): A dictionary mapping CPC codes to CPC objects.

load_cpc_codes() → None

Loads the CPC codes from the CSV file.

lookup(cpc_code: str) → CPC | None

Looks up a CPC code.

Args:

cpc_code (str): The CPC code to look up. Must be a string of 2-5 digits.

Returns:

CPC | None: The CPC object corresponding to the CPC code, or None if not found.

Raises:

ValueError: If the CPC code is not a numerical string with a maximum length of 5.

pathfinder_framework.product_footprint.id module

class pathfinder_framework.product_footprint.id.ProductFootprintId(value: str | None = None)

Bases: UUID

int

is_safe

pathfinder_framework.product_footprint.product_footprint module

pathfinder_framework.product_footprint.product_id_list module

pathfinder_framework.product_footprint.status module

class pathfinder_framework.product_footprint.status.ProductFootprintStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Status of a product footprint.

Attributes:

ACTIVE: The default status of a product footprint. A product footprint with

status Active can be used by data recipients, e.g., for product footprint calculations.

DEPRECATED: The product footprint is deprecated and should not be used for

e.g., product footprint calculations by data recipients.

ACTIVE = 'Active'

DEPRECATED = 'Deprecated'

pathfinder_framework.product_footprint.validity_period module

pathfinder_framework.product_footprint.version module

class pathfinder_framework.product_footprint.version.Version(version: int)

Bases: object

Represents a version of a product footprint.

Attributes:

version (int): The version number, which must be an integer in the range 0 to 2^31-1.

Raises:

ValueError: If the version number is not an integer or is out of range.

classmethod get_latest_version(*versions: Version) → Version

Returns the latest version from a list of versions.

Args:

*versions (Version): The versions to compare.

Returns:

Version: The latest version.

Raises:

ValueError: If any of the arguments are not instances of Version.

Module contents