vmx 2.6.0__py3-none-any.whl

vmx/__about__.py

@@ -0,0 +1,10 @@
+"""Package metadata for vmx."""
+
+# release-please updates the value preceding the marker comment on the
+# `__version__` line each time it cuts a release PR. `__min_spec_version__`
+# is intentionally not auto-bumped — when a spec major bumps, the user
+# adjusts it together with `spec/VERSION` and the compatibility matrix in
+# the release-prep PR review (or in a follow-up commit on the release PR
+# before merging).
+__version__ = "2.6.0"  # x-release-please-version
+__min_spec_version__ = "2.6.0"

vmx/__init__.py

@@ -0,0 +1,289 @@
+"""VMx — hierarchical, lifecycle-aware MVVM viewmodel framework (Python flavor).
+
+Public API is organised by responsibility under sub-packages: ``vmx.lifecycle``,
+``vmx.messages``, ``vmx.services``, ``vmx.commands``, ``vmx.components``,
+``vmx.composites``, ``vmx.groups``, ``vmx.aggregates``, ``vmx.forwarding``,
+``vmx.builders``, ``vmx.tree``, ``vmx.collections``, ``vmx.capabilities``,
+``vmx.properties``, ``vmx.localization``, ``vmx.hierarchical``, ``vmx.dialogs``,
+``vmx.forms``. The ``vmx.notifications`` sub-package is opt-in and must be
+imported explicitly. The full set of public types is re-exported here so
+``from vmx import ...`` reaches every primitive.
+"""
+
+from vmx.__about__ import __min_spec_version__, __version__
+from vmx.aggregates import (
+    AggregateVM1,
+    AggregateVM1Builder,
+    AggregateVM2,
+    AggregateVM2Builder,
+    AggregateVM3,
+    AggregateVM3Builder,
+    AggregateVM4,
+    AggregateVM4Builder,
+    AggregateVM5,
+    AggregateVM5Builder,
+    AggregateVM6,
+    AggregateVM6Builder,
+    AggregateVMBuilder1,
+    AggregateVMBuilder2,
+    AggregateVMBuilder3,
+    AggregateVMBuilder4,
+    AggregateVMBuilder5,
+    AggregateVMBuilder6,
+)
+from vmx.builders import BuilderValidationError
+from vmx.capabilities import (
+    ExpandableState,
+    Filterable,
+    IApprovable,
+    ICancelable,
+    IClosable,
+    ICollapsible,
+    IConstructable,
+    ICurrentDeletable,
+    ICurrentUpdatable,
+    IDeletable,
+    IDeselectable,
+    IDestructable,
+    IExpandable,
+    IExpansionTogglable,
+    IManagable,
+    INewCreatable,
+    IReconstructable,
+    ISavable,
+    ISearchable,
+    ISelectable,
+    ISelectionTogglable,
+    IUpdatable,
+    Pageable,
+    SearchableState,
+)
+from vmx.collections import (
+    BatchUpdateHandle,
+    CollectionChangedEvent,
+    ObservableDictionary,
+    ObservableList,
+    PagedComposition,
+    ServicedObservableCollection,
+)
+from vmx.commands import (
+    Command,
+    CompositeCommand,
+    ConfirmationDecoratorCommand,
+    DecoratorCommand,
+    ModeledCrudCommands,
+    ParameterizedCommand,
+    RelayCommand,
+    RelayCommandBuilder,
+    RelayCommandOf,
+    RelayCommandOfBuilder,
+    RelayCommandOfT,
+    RelayCommandOfTBuilder,
+    confirm,
+    confirm_with_dialog_service,
+    precede_with,
+    succeed_with,
+    wrap_with,
+)
+from vmx.components import (
+    ComponentVM,
+    ComponentVMBuilder,
+    ComponentVMOf,
+    ComponentVMOfBuilder,
+    ReadonlyComponentVMOf,
+    ReadonlyComponentVMOfBuilder,
+    ViewModelType,
+)
+from vmx.composites import (
+    CompositeVM,
+    CompositeVMBuilder,
+    CompositeVMOf,
+    CompositeVMOfBuilder,
+)
+from vmx.dialogs import (
+    NULL_DIALOG_SERVICE,
+    DialogService,
+    FileFilter,
+    NotificationSeverity,
+    NullDialogService,
+)
+from vmx.forms import FormVM, FormVMBuilder
+from vmx.forwarding import ForwardingComponentVM, ForwardingCompositeVM
+from vmx.groups import GroupVM, GroupVMBuilder
+from vmx.hierarchical import HierarchicalVM, HierarchicalVMBuilder
+from vmx.lifecycle import ConstructionStatus, StatusTransitionError
+from vmx.localization import NULL_LOCALIZER, ILocalizer, NullLocalizer
+from vmx.messages import (
+    CollectionChangedMessage,
+    ConstructionStatusChangedMessage,
+    FormRevertedMessage,
+    Message,
+    PropertyChangedMessage,
+    TreeStructureChange,
+    TreeStructureChangedMessage,
+    TypedMessage,
+    property_value_changed_messages_for,
+)
+from vmx.properties import (
+    DerivedProperty,
+    from_five,
+    from_four,
+    from_many,
+    from_one,
+    from_sources,
+    from_three,
+    from_two,
+)
+from vmx.services import (
+    NULL_DISPATCHER,
+    NULL_MESSAGE_HUB,
+    Dispatcher,
+    MessageHub,
+    MessageHubProto,
+    NullDispatcher,
+    NullMessageHub,
+    RxDispatcher,
+    null_message_hub_of,
+)
+from vmx.tree import find, walk, walk_expanded
+
+__all__ = [
+    "NULL_DIALOG_SERVICE",
+    "NULL_DISPATCHER",
+    "NULL_LOCALIZER",
+    "NULL_MESSAGE_HUB",
+    "AggregateVM1",
+    "AggregateVM1Builder",
+    "AggregateVM2",
+    "AggregateVM2Builder",
+    "AggregateVM3",
+    "AggregateVM3Builder",
+    "AggregateVM4",
+    "AggregateVM4Builder",
+    "AggregateVM5",
+    "AggregateVM5Builder",
+    "AggregateVM6",
+    "AggregateVM6Builder",
+    "AggregateVMBuilder1",
+    "AggregateVMBuilder2",
+    "AggregateVMBuilder3",
+    "AggregateVMBuilder4",
+    "AggregateVMBuilder5",
+    "AggregateVMBuilder6",
+    "BatchUpdateHandle",
+    "BuilderValidationError",
+    "CollectionChangedEvent",
+    "CollectionChangedMessage",
+    "Command",
+    "ComponentVM",
+    "ComponentVMBuilder",
+    "ComponentVMOf",
+    "ComponentVMOfBuilder",
+    "CompositeCommand",
+    "CompositeVM",
+    "CompositeVMBuilder",
+    "CompositeVMOf",
+    "CompositeVMOfBuilder",
+    "ConfirmationDecoratorCommand",
+    "ConstructionStatus",
+    "ConstructionStatusChangedMessage",
+    "DecoratorCommand",
+    "DerivedProperty",
+    "DialogService",
+    "Dispatcher",
+    "ExpandableState",
+    "FileFilter",
+    "Filterable",
+    "FormRevertedMessage",
+    "FormVM",
+    "FormVMBuilder",
+    "ForwardingComponentVM",
+    "ForwardingCompositeVM",
+    "GroupVM",
+    "GroupVMBuilder",
+    "HierarchicalVM",
+    "HierarchicalVMBuilder",
+    "IApprovable",
+    "ICancelable",
+    "IClosable",
+    "ICollapsible",
+    "IConstructable",
+    "ICurrentDeletable",
+    "ICurrentUpdatable",
+    "IDeletable",
+    "IDeselectable",
+    "IDestructable",
+    "IExpandable",
+    "IExpansionTogglable",
+    "ILocalizer",
+    "IManagable",
+    "INewCreatable",
+    "IReconstructable",
+    "ISavable",
+    "ISearchable",
+    "ISelectable",
+    "ISelectionTogglable",
+    "IUpdatable",
+    "Message",
+    "MessageHub",
+    "MessageHubProto",
+    "ModeledCrudCommands",
+    "NotificationSeverity",
+    "NullDialogService",
+    "NullDispatcher",
+    "NullLocalizer",
+    "NullMessageHub",
+    "ObservableDictionary",
+    "ObservableList",
+    "Pageable",
+    "PagedComposition",
+    "ParameterizedCommand",
+    "PropertyChangedMessage",
+    "ReadonlyComponentVMOf",
+    "ReadonlyComponentVMOfBuilder",
+    "RelayCommand",
+    "RelayCommandBuilder",
+    "RelayCommandOf",
+    "RelayCommandOfBuilder",
+    "RelayCommandOfT",
+    "RelayCommandOfTBuilder",
+    "RxDispatcher",
+    "SearchableState",
+    "ServicedObservableCollection",
+    "StatusTransitionError",
+    "TreeStructureChange",
+    "TreeStructureChangedMessage",
+    "TypedMessage",
+    "ViewModelType",
+    "__min_spec_version__",
+    "__version__",
+    "confirm",
+    "confirm_with_dialog_service",
+    "find",
+    "from_five",
+    "from_four",
+    "from_many",
+    "from_one",
+    "from_sources",
+    "from_three",
+    "from_two",
+    "null_message_hub_of",
+    "precede_with",
+    "property_value_changed_messages_for",
+    "succeed_with",
+    "walk",
+    "walk_expanded",
+    "wrap_with",
+]
+
+# Lifecycle capabilities are baseline: every core VM trivially satisfies them.
+# See spec/14-capabilities.md rule 2 and CAP-020.
+IConstructable.register(ComponentVM)
+IConstructable.register(ComponentVMOf)
+IConstructable.register(ReadonlyComponentVMOf)
+IDestructable.register(ComponentVM)
+IDestructable.register(ComponentVMOf)
+IDestructable.register(ReadonlyComponentVMOf)
+IReconstructable.register(ComponentVM)
+IReconstructable.register(ComponentVMOf)
+IReconstructable.register(ReadonlyComponentVMOf)

vmx/aggregates/__init__.py

@@ -0,0 +1,60 @@
+"""vmx.aggregates — fixed-arity heterogeneous component VM tuples.
+
+Exports AggregateVM1 through AggregateVM6 and their corresponding builders.
+
+Builder naming
+--------------
+The canonical builder names from v1.2.0 are ``AggregateVM1Builder`` through
+``AggregateVM6Builder`` (matching the TypeScript flavor). The historical
+``AggregateVMBuilder1`` through ``AggregateVMBuilder6`` names remain as identity
+aliases for backward compatibility; the originally planned v2.0.0 removal slipped
+and is deferred to vmx v3.0.0 per ADR-0009.
+
+See spec/08-aggregate-vm.md and ADR-0007 (arity 6 added per ADR-0034).
+"""
+
+from __future__ import annotations
+
+from vmx.aggregates.aggregate_vm import (
+    AggregateVM1,
+    AggregateVM2,
+    AggregateVM3,
+    AggregateVM4,
+    AggregateVM5,
+    AggregateVM6,
+)
+from vmx.aggregates.builders import (
+    AggregateVM1Builder,
+    AggregateVM2Builder,
+    AggregateVM3Builder,
+    AggregateVM4Builder,
+    AggregateVM5Builder,
+    AggregateVM6Builder,
+    AggregateVMBuilder1,
+    AggregateVMBuilder2,
+    AggregateVMBuilder3,
+    AggregateVMBuilder4,
+    AggregateVMBuilder5,
+    AggregateVMBuilder6,
+)
+
+__all__ = [
+    "AggregateVM1",
+    "AggregateVM1Builder",
+    "AggregateVM2",
+    "AggregateVM2Builder",
+    "AggregateVM3",
+    "AggregateVM3Builder",
+    "AggregateVM4",
+    "AggregateVM4Builder",
+    "AggregateVM5",
+    "AggregateVM5Builder",
+    "AggregateVM6",
+    "AggregateVM6Builder",
+    "AggregateVMBuilder1",
+    "AggregateVMBuilder2",
+    "AggregateVMBuilder3",
+    "AggregateVMBuilder4",
+    "AggregateVMBuilder5",
+    "AggregateVMBuilder6",
+]