fields-metadata 1.0.0__py3-none-any.whl

fields_metadata/__init__.py

@@ -0,0 +1,33 @@
+"""fields-metadata: A Python library for extracting field metadata from dataclasses and Pydantic models."""
+
+from fields_metadata.annotations import (
+    HumanReadableId,
+    InternationalURNAnnotation,
+    Multiline,
+    SemanticClassification,
+)
+from fields_metadata.exceptions import (
+    FieldMetadataError,
+    InvalidTypeUnionError,
+    NoneTypeFieldError,
+)
+from fields_metadata.extractor import MetadataExtractor
+from fields_metadata.metadata import FieldMetadata
+from fields_metadata.path import FieldsMetadataMap, FieldsPath
+
+__version__ = "1.0.0"
+
+__all__ = [
+    "MetadataExtractor",
+    "FieldMetadata",
+    "FieldsPath",
+    "FieldsMetadataMap",
+    "Multiline",
+    "HumanReadableId",
+    "SemanticClassification",
+    "InternationalURNAnnotation",
+    "FieldMetadataError",
+    "InvalidTypeUnionError",
+    "NoneTypeFieldError",
+    "__version__",
+]

fields_metadata/annotations.py

@@ -0,0 +1,43 @@
+"""Custom annotation types for field metadata."""
+
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class Multiline:
+    """Annotation to mark a string field as multiline text."""
+
+
+@dataclass(frozen=True)
+class HumanReadableId:
+    """Annotation to mark a field as a human-readable identifier."""
+
+
+@dataclass(frozen=True)
+class SemanticClassification:
+    """
+    Annotation for semantic classification of a field.
+
+    :param classification: The semantic classification value
+    """
+
+    classification: str
+
+
+@dataclass(frozen=True)
+class InternationalURNAnnotation:
+    """Annotation to mark a field as an international URN."""
+
+
+@dataclass(frozen=True)
+class NonCategorical:
+    """Annotation to mark a field as non-categorical."""
+
+
+__all__ = [
+    "Multiline",
+    "HumanReadableId",
+    "SemanticClassification",
+    "InternationalURNAnnotation",
+    "NonCategorical",
+]

fields_metadata/exceptions.py

@@ -0,0 +1,20 @@
+"""Custom exceptions for fields-metadata library."""
+
+
+class FieldMetadataError(Exception):
+    """Base exception for fields-metadata library."""
+
+
+class InvalidTypeUnionError(FieldMetadataError):
+    """Raised when a field has a union between non-None types."""
+
+
+class NoneTypeFieldError(FieldMetadataError):
+    """Raised when a field has only None as its type."""
+
+
+__all__ = [
+    "FieldMetadataError",
+    "InvalidTypeUnionError",
+    "NoneTypeFieldError",
+]