sldkit 0.2.0__cp310-abi3-win_amd64.whl

sldkit/__init__.py

@@ -0,0 +1,269 @@
+from .api import (
+    decode_drawing_structure_bytes,
+    decode_drawing_structure_file,
+    decode_geometry_bytes,
+    decode_geometry_file,
+    extract_bytes,
+    extract_file,
+    extract_resource_bytes,
+    extract_resource_file,
+    inspect_bytes,
+    inspect_file,
+    parse_bytes,
+    parse_file,
+    probe_bytes,
+    probe_file,
+    scan_project,
+)
+from .errors import DrawingStructureError, GeometryError, ParseError, SldkitError
+from .model import (
+    AssemblyComponent,
+    BinaryResource,
+    BinaryResourceKind,
+    ByteRange,
+    ChecksumStatus,
+    CompressionMethod,
+    Configuration,
+    ContainerInventory,
+    CoverageReport,
+    CustomProperty,
+    Diagnostic,
+    DiagnosticKind,
+    DiagnosticSeverity,
+    DocumentKind,
+    DocumentReference,
+    DrawingBytePartitionStatus,
+    DrawingCarrier,
+    DrawingCarrierRole,
+    DrawingRecord,
+    DrawingRecordClass,
+    DrawingRecordSource,
+    DrawingSheet,
+    DrawingStructureCoverage,
+    DrawingStructureDocument,
+    DrawingStructureResult,
+    DrawingStructureSheet,
+    DrawingStructureStatus,
+    DrawingStructureView,
+    DrawingView,
+    Envelope,
+    ExtractionMode,
+    ExtractionResult,
+    ExtractionStatus,
+    GeometryBody,
+    GeometryByteClassification,
+    GeometryByteCoverage,
+    GeometryByteDomain,
+    GeometryByteOffsetBasis,
+    GeometryBytePartitionStatus,
+    GeometryByteRange,
+    GeometryByteStorage,
+    GeometryCarrier,
+    GeometryCarrierDomain,
+    GeometryCoedge,
+    GeometryConfigurationState,
+    GeometryConstruction,
+    GeometryConstructionDomain,
+    GeometryDecodedSpan,
+    GeometryDocument,
+    GeometryEdge,
+    GeometryEntityProvenance,
+    GeometryExactness,
+    GeometryFace,
+    GeometryFidelityReport,
+    GeometryFinding,
+    GeometryLoop,
+    GeometryLoss,
+    GeometryModel,
+    GeometryPcurveState,
+    GeometryPcurveUse,
+    GeometryPoint,
+    GeometryRawRecord,
+    GeometryRegion,
+    GeometryResult,
+    GeometryShell,
+    GeometrySourceObject,
+    GeometryStatus,
+    GeometryStreamCandidate,
+    GeometryStreamRole,
+    GeometryStreamSelection,
+    GeometryTessellation,
+    GeometryTessellationChannel,
+    GeometryTessellationTextureAssignment,
+    GeometryTessellationTriangleGroup,
+    GeometryTopologyMetrics,
+    GeometryVertex,
+    GeometryVertexUse,
+    InventoryEntry,
+    InventoryEntryKind,
+    InventoryEntryState,
+    InventoryResult,
+    InventoryStatus,
+    LimitProfile,
+    MassProperties,
+    ParseResult,
+    ParseStatus,
+    ProbeConfidence,
+    ProbeEvidence,
+    ProbeResult,
+    ProbeStatus,
+    ProjectCompatibilityReport,
+    ProjectConfigurationIdentity,
+    ProjectEdge,
+    ProjectNode,
+    ProjectScanResult,
+    ProjectScanStatus,
+    PropertyKind,
+    PropertyScope,
+    PropertyValueState,
+    RecordOffsetBasis,
+    ReferenceKind,
+    ReferenceResolutionBasis,
+    ReferenceResolutionStatus,
+    ReferenceTraversalStatus,
+    SemanticCoverage,
+    SourceDocument,
+    SourcedValue,
+    SourceInfo,
+    SourceInputKind,
+    StreamExtraction,
+    UnknownRecord,
+    ValueOrigin,
+)
+
+__version__ = "0.2.0"
+
+__all__ = [
+    "AssemblyComponent",
+    "BinaryResource",
+    "BinaryResourceKind",
+    "ByteRange",
+    "ChecksumStatus",
+    "CompressionMethod",
+    "Configuration",
+    "ContainerInventory",
+    "CoverageReport",
+    "CustomProperty",
+    "Diagnostic",
+    "DiagnosticKind",
+    "DiagnosticSeverity",
+    "DocumentKind",
+    "DocumentReference",
+    "DrawingBytePartitionStatus",
+    "DrawingCarrier",
+    "DrawingCarrierRole",
+    "DrawingRecord",
+    "DrawingRecordClass",
+    "DrawingRecordSource",
+    "DrawingSheet",
+    "DrawingStructureCoverage",
+    "DrawingStructureDocument",
+    "DrawingStructureError",
+    "DrawingStructureResult",
+    "DrawingStructureSheet",
+    "DrawingStructureStatus",
+    "DrawingStructureView",
+    "DrawingView",
+    "Envelope",
+    "ExtractionMode",
+    "ExtractionResult",
+    "ExtractionStatus",
+    "GeometryBody",
+    "GeometryByteCoverage",
+    "GeometryByteClassification",
+    "GeometryByteRange",
+    "GeometryDecodedSpan",
+    "GeometryByteDomain",
+    "GeometryByteOffsetBasis",
+    "GeometryBytePartitionStatus",
+    "GeometryByteStorage",
+    "GeometryCarrier",
+    "GeometryCarrierDomain",
+    "GeometryCoedge",
+    "GeometryConfigurationState",
+    "GeometryConstruction",
+    "GeometryConstructionDomain",
+    "GeometryDocument",
+    "GeometryEdge",
+    "GeometryEntityProvenance",
+    "GeometryError",
+    "GeometryExactness",
+    "GeometryFace",
+    "GeometryFidelityReport",
+    "GeometryFinding",
+    "GeometryLoop",
+    "GeometryLoss",
+    "GeometryModel",
+    "GeometryPcurveState",
+    "GeometryPcurveUse",
+    "GeometryPoint",
+    "GeometryRawRecord",
+    "GeometryRegion",
+    "GeometryResult",
+    "GeometryShell",
+    "GeometrySourceObject",
+    "GeometryStatus",
+    "GeometryStreamCandidate",
+    "GeometryStreamRole",
+    "GeometryStreamSelection",
+    "GeometryTessellation",
+    "GeometryTessellationChannel",
+    "GeometryTessellationTextureAssignment",
+    "GeometryTessellationTriangleGroup",
+    "GeometryTopologyMetrics",
+    "GeometryVertex",
+    "GeometryVertexUse",
+    "InventoryEntry",
+    "InventoryEntryKind",
+    "InventoryEntryState",
+    "InventoryResult",
+    "InventoryStatus",
+    "LimitProfile",
+    "MassProperties",
+    "ParseError",
+    "ParseResult",
+    "ParseStatus",
+    "ProbeConfidence",
+    "ProbeEvidence",
+    "ProbeResult",
+    "ProbeStatus",
+    "ProjectCompatibilityReport",
+    "ProjectConfigurationIdentity",
+    "ProjectEdge",
+    "ProjectNode",
+    "ProjectScanResult",
+    "ProjectScanStatus",
+    "PropertyKind",
+    "PropertyScope",
+    "PropertyValueState",
+    "RecordOffsetBasis",
+    "ReferenceKind",
+    "ReferenceResolutionBasis",
+    "ReferenceResolutionStatus",
+    "ReferenceTraversalStatus",
+    "SemanticCoverage",
+    "SldkitError",
+    "SourceDocument",
+    "SourceInfo",
+    "SourceInputKind",
+    "StreamExtraction",
+    "SourcedValue",
+    "UnknownRecord",
+    "ValueOrigin",
+    "__version__",
+    "decode_drawing_structure_bytes",
+    "decode_drawing_structure_file",
+    "decode_geometry_bytes",
+    "decode_geometry_file",
+    "extract_bytes",
+    "extract_file",
+    "extract_resource_bytes",
+    "extract_resource_file",
+    "inspect_bytes",
+    "inspect_file",
+    "parse_bytes",
+    "parse_file",
+    "probe_bytes",
+    "probe_file",
+    "scan_project",
+]

sldkit/__main__.py

@@ -0,0 +1,3 @@
+from .cli import main
+
+raise SystemExit(main())

sldkit/_core.pyi

@@ -0,0 +1,35 @@
+def probe_bytes_json(data: bytes, profile: str) -> str: ...
+def probe_file_json(path: str, profile: str) -> str: ...
+def inspect_bytes_json(data: bytes, filename: str | None, profile: str) -> str: ...
+def inspect_file_json(path: str, profile: str) -> str: ...
+def parse_bytes_json(data: bytes, filename: str | None, profile: str) -> str: ...
+def parse_file_json(path: str, profile: str) -> str: ...
+def decode_geometry_bytes_json(
+    data: bytes, filename: str | None, profile: str
+) -> str: ...
+def decode_geometry_file_json(path: str, profile: str) -> str: ...
+def decode_drawing_structure_bytes_json(
+    data: bytes, filename: str | None, profile: str
+) -> str: ...
+def decode_drawing_structure_file_json(path: str, profile: str) -> str: ...
+def scan_project_json(
+    path: str,
+    project_root: str | None,
+    configuration: str | None,
+    search_directories: list[str],
+    windows_prefix_mappings: list[tuple[str, str]],
+    follow_suppressed: bool,
+    profile: str,
+) -> str: ...
+def extract_bytes_result(
+    data: bytes, entry_id: str, mode: str, profile: str
+) -> tuple[str, bytes | None]: ...
+def extract_file_result(
+    path: str, entry_id: str, mode: str, profile: str
+) -> tuple[str, bytes | None]: ...
+def extract_resource_bytes_result(
+    data: bytes, resource_json: str, profile: str
+) -> tuple[str, bytes | None]: ...
+def extract_resource_file_result(
+    path: str, resource_json: str, profile: str
+) -> tuple[str, bytes | None]: ...

sldkit/api.py

@@ -0,0 +1,309 @@
+from __future__ import annotations
+
+import json
+import os
+from collections.abc import Iterable, Mapping
+from os import PathLike
+from typing import Any
+
+from . import _core
+from .errors import DrawingStructureError, GeometryError, ParseError
+from .model import (
+    BinaryResource,
+    DrawingStructureResult,
+    DrawingStructureStatus,
+    ExtractionMode,
+    ExtractionResult,
+    GeometryResult,
+    GeometryStatus,
+    InventoryResult,
+    LimitProfile,
+    ParseResult,
+    ParseStatus,
+    ProbeResult,
+    ProjectScanResult,
+    StreamExtraction,
+)
+
+BytesLike = bytes | bytearray | memoryview
+PathType = str | PathLike[str]
+WindowsPrefixMappings = Mapping[str, PathType] | Iterable[tuple[str, PathType]]
+
+
+def probe_bytes(
+    data: BytesLike,
+    *,
+    profile: str | LimitProfile = LimitProfile.DESKTOP,
+) -> ProbeResult:
+    """Classify a bounded byte input by content without semantic parsing."""
+    payload = _load_json(_core.probe_bytes_json(bytes(data), _profile_name(profile)))
+    return ProbeResult.from_dict(payload)
+
+
+def probe_file(
+    path: PathType,
+    *,
+    profile: str | LimitProfile = LimitProfile.DESKTOP,
+) -> ProbeResult:
+    """Read a file under a resource limit and classify its envelope."""
+    payload = _load_json(
+        _core.probe_file_json(os.fsdecode(os.fspath(path)), _profile_name(profile))
+    )
+    return ProbeResult.from_dict(payload)
+
+
+def inspect_bytes(
+    data: BytesLike,
+    *,
+    filename: str | None = None,
+    profile: str | LimitProfile = LimitProfile.DESKTOP,
+) -> InventoryResult:
+    """Return a bounded, deterministic inventory without document semantics."""
+    payload = _load_json(
+        _core.inspect_bytes_json(bytes(data), filename, _profile_name(profile))
+    )
+    return InventoryResult.from_dict(payload)
+
+
+def inspect_file(
+    path: PathType,
+    *,
+    profile: str | LimitProfile = LimitProfile.DESKTOP,
+) -> InventoryResult:
+    """Read a file under a resource limit and inventory its outer container."""
+    payload = _load_json(
+        _core.inspect_file_json(os.fsdecode(os.fspath(path)), _profile_name(profile))
+    )
+    return InventoryResult.from_dict(payload)
+
+
+def extract_bytes(
+    data: BytesLike,
+    entry_id: str,
+    *,
+    mode: str | ExtractionMode = ExtractionMode.DECODED,
+    profile: str | LimitProfile = LimitProfile.DESKTOP,
+) -> StreamExtraction:
+    """Extract one validated entry representation without filesystem expansion."""
+    metadata, payload = _core.extract_bytes_result(
+        bytes(data), entry_id, _mode_name(mode), _profile_name(profile)
+    )
+    return StreamExtraction(
+        result=ExtractionResult.from_dict(_load_json(metadata)), data=payload
+    )
+
+
+def extract_file(
+    path: PathType,
+    entry_id: str,
+    *,
+    mode: str | ExtractionMode = ExtractionMode.DECODED,
+    profile: str | LimitProfile = LimitProfile.DESKTOP,
+) -> StreamExtraction:
+    """Extract one validated entry from a bounded source path."""
+    metadata, payload = _core.extract_file_result(
+        os.fsdecode(os.fspath(path)),
+        entry_id,
+        _mode_name(mode),
+        _profile_name(profile),
+    )
+    return StreamExtraction(
+        result=ExtractionResult.from_dict(_load_json(metadata)), data=payload
+    )
+
+
+def extract_resource_bytes(
+    data: BytesLike,
+    resource: BinaryResource,
+    *,
+    profile: str | LimitProfile = LimitProfile.DESKTOP,
+) -> StreamExtraction:
+    """Extract and revalidate the exact bytes described by a binary resource."""
+    metadata, payload = _core.extract_resource_bytes_result(
+        bytes(data),
+        json.dumps(resource.to_dict(), separators=(",", ":"), sort_keys=True),
+        _profile_name(profile),
+    )
+    return StreamExtraction(
+        result=ExtractionResult.from_dict(_load_json(metadata)), data=payload
+    )
+
+
+def extract_resource_file(
+    path: PathType,
+    resource: BinaryResource,
+    *,
+    profile: str | LimitProfile = LimitProfile.DESKTOP,
+) -> StreamExtraction:
+    """Read a bounded file and extract one exact binary resource from it."""
+    metadata, payload = _core.extract_resource_file_result(
+        os.fsdecode(os.fspath(path)),
+        json.dumps(resource.to_dict(), separators=(",", ":"), sort_keys=True),
+        _profile_name(profile),
+    )
+    return StreamExtraction(
+        result=ExtractionResult.from_dict(_load_json(metadata)), data=payload
+    )
+
+
+def parse_bytes(
+    data: BytesLike,
+    *,
+    filename: str | None = None,
+    profile: str | LimitProfile = LimitProfile.DESKTOP,
+    strict: bool = False,
+) -> ParseResult:
+    """Parse supported facts while retaining partial or malformed results."""
+    payload = _load_json(
+        _core.parse_bytes_json(bytes(data), filename, _profile_name(profile))
+    )
+    return _apply_strict(ParseResult.from_dict(payload), strict)
+
+
+def parse_file(
+    path: PathType,
+    *,
+    profile: str | LimitProfile = LimitProfile.DESKTOP,
+    strict: bool = False,
+) -> ParseResult:
+    """Parse a path and retain its exact source identity and diagnostics."""
+    payload = _load_json(
+        _core.parse_file_json(os.fsdecode(os.fspath(path)), _profile_name(profile))
+    )
+    return _apply_strict(ParseResult.from_dict(payload), strict)
+
+
+def decode_geometry_bytes(
+    data: BytesLike,
+    *,
+    filename: str | None = None,
+    profile: str | LimitProfile = LimitProfile.DESKTOP,
+    strict: bool = False,
+) -> GeometryResult:
+    """Decode modern part geometry into the source-oriented geometry model."""
+    payload = _load_json(
+        _core.decode_geometry_bytes_json(bytes(data), filename, _profile_name(profile))
+    )
+    return _apply_geometry_strict(GeometryResult.from_dict(payload), strict)
+
+
+def decode_geometry_file(
+    path: PathType,
+    *,
+    profile: str | LimitProfile = LimitProfile.DESKTOP,
+    strict: bool = False,
+) -> GeometryResult:
+    """Decode modern part geometry while retaining provenance and loss details."""
+    payload = _load_json(
+        _core.decode_geometry_file_json(
+            os.fsdecode(os.fspath(path)), _profile_name(profile)
+        )
+    )
+    return _apply_geometry_strict(GeometryResult.from_dict(payload), strict)
+
+
+def decode_drawing_structure_bytes(
+    data: BytesLike,
+    *,
+    filename: str | None = None,
+    profile: str | LimitProfile = LimitProfile.DESKTOP,
+    strict: bool = False,
+) -> DrawingStructureResult:
+    """Inventory source-native records from a modern Drawing."""
+    payload = _load_json(
+        _core.decode_drawing_structure_bytes_json(
+            bytes(data), filename, _profile_name(profile)
+        )
+    )
+    return _apply_drawing_structure_strict(
+        DrawingStructureResult.from_dict(payload), strict
+    )
+
+
+def decode_drawing_structure_file(
+    path: PathType,
+    *,
+    profile: str | LimitProfile = LimitProfile.DESKTOP,
+    strict: bool = False,
+) -> DrawingStructureResult:
+    """Inventory Drawing records while retaining exact source ranges and carriers."""
+    payload = _load_json(
+        _core.decode_drawing_structure_file_json(
+            os.fsdecode(os.fspath(path)), _profile_name(profile)
+        )
+    )
+    return _apply_drawing_structure_strict(
+        DrawingStructureResult.from_dict(payload), strict
+    )
+
+
+def scan_project(
+    path: PathType,
+    *,
+    project_root: PathType | None = None,
+    configuration: str | None = None,
+    search_directories: Iterable[PathType] = (),
+    windows_prefix_mappings: WindowsPrefixMappings | None = None,
+    follow_suppressed: bool = False,
+    profile: str | LimitProfile = LimitProfile.DESKTOP,
+) -> ProjectScanResult:
+    """Resolve a bounded local document graph without changing stored paths."""
+    mappings = (
+        ()
+        if windows_prefix_mappings is None
+        else (
+            windows_prefix_mappings.items()
+            if isinstance(windows_prefix_mappings, Mapping)
+            else windows_prefix_mappings
+        )
+    )
+    payload = _load_json(
+        _core.scan_project_json(
+            os.fsdecode(os.fspath(path)),
+            (None if project_root is None else os.fsdecode(os.fspath(project_root))),
+            configuration,
+            [os.fsdecode(os.fspath(item)) for item in search_directories],
+            [
+                (str(prefix), os.fsdecode(os.fspath(target)))
+                for prefix, target in mappings
+            ],
+            follow_suppressed,
+            _profile_name(profile),
+        )
+    )
+    return ProjectScanResult.from_dict(payload)
+
+
+def _load_json(value: str) -> Mapping[str, Any]:
+    decoded = json.loads(value)
+    if not isinstance(decoded, dict):
+        raise RuntimeError("native parser returned a non-object JSON result")
+    return decoded
+
+
+def _profile_name(profile: str | LimitProfile) -> str:
+    return profile.value if isinstance(profile, LimitProfile) else profile
+
+
+def _mode_name(mode: str | ExtractionMode) -> str:
+    return mode.value if isinstance(mode, ExtractionMode) else mode
+
+
+def _apply_strict(result: ParseResult, strict: bool) -> ParseResult:
+    if strict and result.status is not ParseStatus.PARSED:
+        raise ParseError(result)
+    return result
+
+
+def _apply_geometry_strict(result: GeometryResult, strict: bool) -> GeometryResult:
+    if strict and result.status is not GeometryStatus.DECODED:
+        raise GeometryError(result)
+    return result
+
+
+def _apply_drawing_structure_strict(
+    result: DrawingStructureResult, strict: bool
+) -> DrawingStructureResult:
+    if strict and result.status is not DrawingStructureStatus.INVENTORIED:
+        raise DrawingStructureError(result)
+    return result