morphir-python 0.0.1__py3-none-any.whl

morphir/ir/v4/__init__.py

@@ -0,0 +1,160 @@
+"""Morphir IR v4 model (draft upstream).
+
+IR v4 is not frozen in finos/morphir. The JSON codec in `morphir.ir.v4.codec` is a
+draft pinned to finos/morphir commit efa36060.
+"""
+
+from . import annotation, incompleteness, module, package
+from .access_controlled import AccessControlled
+from .annotation import (
+    Annotation,
+    AnnotationArgument,
+    CompactAnnotation,
+    NamedArgument,
+    PositionalArgument,
+    StructuredAnnotation,
+)
+from .decorations import (
+    DecorationFormat,
+    DecorationValuesFile,
+    LayerManifest,
+    SchemaRef,
+)
+from .distribution import (
+    ApplicationDistribution,
+    Distribution,
+    EntryPoint,
+    EntryPointKind,
+    LibraryDistribution,
+    PackageInfo,
+    SpecsDistribution,
+)
+from .document import (
+    DocArray,
+    DocBool,
+    DocFloat,
+    DocInt,
+    DocNull,
+    DocObject,
+    DocString,
+    Document,
+)
+from .documented import Documented
+from .fqname import FQName
+from .incompleteness import (
+    DeletedDuringRefactor,
+    DraftIncompleteness,
+    HoleIncompleteness,
+    HoleReason,
+    Incompleteness,
+    TypeMismatch,
+    UnresolvedReference,
+)
+from .literal import (
+    BoolLiteral,
+    CharLiteral,
+    DecimalLiteral,
+    FloatLiteral,
+    IntegerLiteral,
+    Literal,
+    StringLiteral,
+)
+from .meta import FileMeta, SourceRange
+from .name import Name
+from .path import Path
+from .qname import QName
+from .ref import DefRef, FileWithDefs, PointerRef, Ref
+from .type import Field, Type, TypeAttributes
+from .type_constraints import TypeConstraints
+from .type_def import Definition as TypeDefinition
+from .type_spec import Specification as TypeSpecification
+from .value import Definition as ValueDefinition
+from .value import (
+    ExternalBinding,
+    ExternalBody,
+    IncompleteBody,
+    NativeBody,
+    NativeHint,
+    NativeInfo,
+    Pattern,
+    Value,
+    ValueAttributes,
+    ValueDefinitionBody,
+)
+from .value import Specification as ValueSpecification
+
+__all__ = [
+    "AccessControlled",
+    "Annotation",
+    "AnnotationArgument",
+    "ApplicationDistribution",
+    "BoolLiteral",
+    "CharLiteral",
+    "CompactAnnotation",
+    "DecimalLiteral",
+    "DecorationFormat",
+    "DecorationValuesFile",
+    "DefRef",
+    "DeletedDuringRefactor",
+    "Distribution",
+    "DocArray",
+    "DocBool",
+    "DocFloat",
+    "DocInt",
+    "DocNull",
+    "DocObject",
+    "DocString",
+    "Document",
+    "Documented",
+    "DraftIncompleteness",
+    "EntryPoint",
+    "EntryPointKind",
+    "ExternalBinding",
+    "ExternalBody",
+    "FQName",
+    "Field",
+    "FileMeta",
+    "FileWithDefs",
+    "FloatLiteral",
+    "HoleIncompleteness",
+    "HoleReason",
+    "IncompleteBody",
+    "Incompleteness",
+    "IntegerLiteral",
+    "LayerManifest",
+    "LibraryDistribution",
+    "Literal",
+    "Name",
+    "NamedArgument",
+    "NativeBody",
+    "NativeHint",
+    "NativeInfo",
+    "PackageInfo",
+    "Path",
+    "Pattern",
+    "PointerRef",
+    "PositionalArgument",
+    "QName",
+    "Ref",
+    "SchemaRef",
+    "SourceRange",
+    "SpecsDistribution",
+    "StringLiteral",
+    "StructuredAnnotation",
+    "Type",
+    "TypeAttributes",
+    "TypeConstraints",
+    "TypeDefinition",
+    "TypeMismatch",
+    "TypeSpecification",
+    "UnresolvedReference",
+    "Value",
+    "ValueAttributes",
+    "ValueDefinition",
+    "ValueDefinitionBody",
+    "ValueSpecification",
+    "annotation",
+    "incompleteness",
+    "module",
+    "package",
+]

morphir/ir/v4/access_controlled.py

@@ -0,0 +1,17 @@
+from dataclasses import dataclass
+from typing import Generic, TypeVar, Union
+
+T = TypeVar("T")
+
+
+@dataclass(frozen=True)
+class Public(Generic[T]):
+    value: T
+
+
+@dataclass(frozen=True)
+class Private(Generic[T]):
+    value: T
+
+
+AccessControlled = Union[Public[T], Private[T]]

morphir/ir/v4/annotation.py

@@ -0,0 +1,75 @@
+"""Annotations on v4 specifications.
+
+Follows the finos/morphir v4 schema (``Annotation``, ``AnnotationArgument``) at
+the pinned commit and the morphir-rust v4 model. An annotation keeps the form it
+was written in, because the kit writes an argument-less structured annotation as
+an object and a compact one as a string. Annotations belong to specifications,
+the public face; definitions carry none.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import Union
+
+from .fqname import FQName
+from .name import Name
+from .value import Value
+
+
+@dataclass(frozen=True)
+class PositionalArgument:
+    """An annotation argument written on its own.
+
+    Attributes:
+        value: The argument expression.
+    """
+
+    value: Value
+
+
+@dataclass(frozen=True)
+class NamedArgument:
+    """An annotation argument written under the name it answers to.
+
+    Attributes:
+        name: The parameter name.
+        value: The argument expression.
+    """
+
+    name: Name
+    value: Value
+
+
+AnnotationArgument = Union[PositionalArgument, NamedArgument]
+"""A positional or named annotation argument."""
+
+
+@dataclass(frozen=True)
+class CompactAnnotation:
+    """The compact spelling: ``"pkg:mod#name"`` or ``"pkg:mod#name:text"``.
+
+    Attributes:
+        name: The annotation type.
+        text: The free text after the first colon after ``#``, if any.
+    """
+
+    name: FQName
+    text: str | None = None
+
+
+@dataclass(frozen=True)
+class StructuredAnnotation:
+    """The structured spelling: ``{"name": ..., "arguments": [...]}``.
+
+    Attributes:
+        name: The annotation type.
+        arguments: Positional and named arguments, in order.
+    """
+
+    name: FQName
+    arguments: list[AnnotationArgument] = field(default_factory=list)
+
+
+Annotation = Union[CompactAnnotation, StructuredAnnotation]
+"""An annotation on a module, type or value specification."""