Path Format Attributes

Domain vocabulary enums for file format classification — path types, structures, content, and analysis categories.

Part of the path-format ecosystem: attributes (this package) · vcti-python-path-format (framework) · vcti-python-path-format-descriptors (format plugins)

This package is the shared taxonomy — it defines the classification dimensions that format descriptors and identification rules use. It lives in its own repository so that vocabulary changes are deliberate and reviewed across all formats. See docs/ecosystem.md for how the three repos work together, and docs/extending.md for how to add new members and enums.

Installation

pip install vcti-path-format-attributes>=1.1.0

In pyproject.toml dependencies

dependencies = [
    "vcti-path-format-attributes>=1.1.0",
]

Quick Start

from vcti.pathformat.attribute import (
    AnalysisType,
    Attribute,
    FileContent,
    FileStructure,
    PathType,
)

# Use as metadata keys and values for format descriptors
attrs = {
    Attribute.PATH_TYPE: PathType.FILE,
    Attribute.STRUCTURE: FileStructure.HDF5,
    Attribute.CONTENT: FileContent.SOLVER_OUTPUTS,
    Attribute.ANALYSIS_TYPE: AnalysisType.STRUCTURAL,
}

# Enum values are lowercase strings — usable with vcti-lookup rules
#   Rule(Attribute.STRUCTURE.value, "==", FileStructure.HDF5.value)

# Lookup by value (useful for deserialization)
structure = FileStructure("hdf5")
assert structure is FileStructure.HDF5

Enums

Attribute

Attribute names for format descriptor metadata:

PathType

FileStructure

FileContent

AnalysisType

Extending

To add a new member or a new enum, see docs/extending.md. All members use auto_enum_value() — values are always lowercase strings derived from the member name.

Dependencies

• vcti-enum (>=1.0.3) — value-generated string enums