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:

Member Value
PATH_TYPE "path_type"
SOLVER "solver"
GENERATOR "generator"
STRUCTURE "structure"
CONTENT "content"
ANALYSIS_TYPE "analysis_type"
SOLUTION_TYPE "solution_type"

PathType

Member Value
FILE "file"
DIR "dir"

FileStructure

Member Value
ASCII "ascii"
BINARY "binary"
HDF5 "hdf5"
JSON "json"
CSV "csv"

FileContent

Member Value
MESH "mesh"
SOLVER_INPUTS "solver_inputs"
SOLVER_OUTPUTS "solver_outputs"
FILTERED_DATA "filtered_data"
SURFACE_3D_MODEL "surface_3d_model"
SURFACE_3D_VIEWS "surface_3d_views"

AnalysisType

Member Value
STRUCTURAL "structural"
THERMAL "thermal"
FLUID "fluid"
CRASH "crash"

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

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for vctmohan from gravatar.com vctmohan

Credits

Author: Visual Collaboration Technologies Inc.

Requires

Python <3.15, >=3.12

Provides Extra

test lint

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vcti_path_format_attributes-1.1.0.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vcti_path_format_attributes-1.1.0-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file vcti_path_format_attributes-1.1.0.tar.gz.

File metadata

File hashes

Hashes for vcti_path_format_attributes-1.1.0.tar.gz
Algorithm Hash digest
SHA256 df454c7c413683eec33c52ed0966c4ec1f42bdfdfae162da7815321fe97179ad
MD5 5121af2c529c049bb6d5a88e64ef5f42
BLAKE2b-256 f95c89e454604e6b33f705095ab2980b34aed92b433a3b59f1699a3b9a8e48eb

See more details on using hashes here.

Provenance

The following attestation bundles were made for vcti_path_format_attributes-1.1.0.tar.gz:

Publisher: publish.yml on vcollab/vcti-python-path-format-attributes

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vcti_path_format_attributes-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for vcti_path_format_attributes-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6d9cf172ff521649fa27bca3cec09b4154bf93f97806d5c20089014eece1f8c5
MD5 e9861f1232a76bb6a6cabafd647d01c7
BLAKE2b-256 42961e0e92b86d7bdc7b6f8e379af8e419e91328c5e8e26827e3d234ee5183d4

See more details on using hashes here.

Provenance

The following attestation bundles were made for vcti_path_format_attributes-1.1.0-py3-none-any.whl:

Publisher: publish.yml on vcollab/vcti-python-path-format-attributes

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

1.1.0 This release

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page