swarmauri_typing 0.9.2.dev10__py3-none-any.whl

swarmauri_typing/Intersection.py

@@ -0,0 +1,47 @@
+from typing import Type, TypeVar, Union, Any, Annotated, Tuple
+
+T = TypeVar("T")
+
+
+class IntersectionMetadata:
+    def __init__(self, classes: Tuple[Type[T]]):
+        self.classes = classes
+
+    def __repr__(self):
+        # Return a more 'developer-focused' string, e.g.:
+        return f"IntersectionMetadata(classes={self.classes!r})"
+
+
+# The Intersection metaclass as provided.
+class Intersection(type):
+    """
+    A generic metaclass to create an intersection of discriminated subclasses.
+    Usage:
+        Intersection[TypeA, TypeB, ...]
+    will return an Annotated Union of all registered classes that are common to
+    all given resource types.
+    """
+
+    def __class_getitem__(cls, classes: Union[Type, Tuple[Type, ...]]) -> type:
+        # Allow a single type or a tuple of types.
+        if not isinstance(classes, tuple):
+            classes = (classes,)
+
+        # Compute the intersection of all MRO sets.
+        common = set(classes[0].__mro__)
+        for c in classes[1:]:
+            common.intersection_update(c.__mro__)
+
+        # Order the common classes as they appear in the first class's MRO.
+        ordered_common = [c for c in classes[0].__mro__ if c in common]
+
+        if not ordered_common:
+            # Fallback to Any (should not happen as 'object' is always common)
+            return Annotated[Any, IntersectionMetadata(classes=(classes))]
+        else:
+            # Construct a Union type from the ordered common bases.
+            union_type = Union[tuple(ordered_common)]
+            return Annotated[
+                union_type,
+                IntersectionMetadata(classes=(classes)),
+            ]

swarmauri_typing/UnionFactory.py

@@ -0,0 +1,109 @@
+from typing import (
+    Type,
+    TypeVar,
+    Callable,
+    List,
+    Union,
+    Any,
+    Annotated,
+    get_args,
+    Optional,
+)
+
+T = TypeVar("T")
+
+
+class UnionFactoryMetadata:
+    """
+    Stores any metadata related to the union created by 'UnionFactory'.
+    You can store anything you like in here (e.g., the original input
+    or other context data).
+    """
+
+    def __init__(self, data: Any, name: Optional[str] = None):
+        self.data = data
+        self.name = name or self.__class__.__name__
+
+    def __repr__(self):
+        # Return a more 'developer-focused' string, e.g.:
+        return f"UnionFactoryMetadata(name={self.name!r}, data={self.data!r})"
+
+
+class UnionFactory:
+    """
+    A configurable factory for creating Annotated Union types.
+
+    This can be used for many scenarios—e.g., uniting a set of classes
+    discovered dynamically, or enumerating a set of allowed types
+    based on a function you supply.
+    """
+
+    def __init__(
+        self,
+        bound: Callable[[Type[T]], List[type]],
+        name: "str" = None,
+        annotation_extenders: List[Any] = None,
+    ):
+        """
+        :param bound:
+            A function that takes an input (like a parent class or any other
+            context) and returns a list of types to be included in the union.
+        :param annotation_extenders:
+            A list of metadata items to be appended (in order) to the final
+            Annotated[...] union (beyond the default UnionFactoryMetadata).
+        """
+        self.name = name or self.__class__.__name__
+        self._union_types_getter = bound
+        self._annotation_extenders = annotation_extenders or []
+
+    def _add_metadata(self, annotated_type: Any, new_metadata: Any) -> Any:
+        """
+        Appends 'new_metadata' to an existing Annotated type,
+        or wraps a bare type in Annotated if it's not already Annotated.
+        """
+        if not (
+            hasattr(annotated_type, "__origin__")
+            and annotated_type.__origin__ is Annotated
+        ):
+            return Annotated[annotated_type, new_metadata]
+
+        args = get_args(annotated_type)
+        base_type = args[0]
+        old_metadata = args[1:]
+        return Annotated.__class_getitem__((base_type, *old_metadata, new_metadata))
+
+    def __getitem__(self, input_data: Union[Type[T], str]) -> type:
+        """
+        Usage example:
+          union_factory = UnionFactory(my_types_getter, [meta1, meta2])
+          MyUnion = union_factory[MyParentClassOrOtherInput]
+
+        Returns:
+          An Annotated[...] union (or Annotated[Any, ...]) with:
+            • A UnionFactoryMetadata object referencing 'input_data'
+            • Any additional metadata from 'annotation_extenders'
+        """
+
+        if isinstance(input_data, str):
+            model_name = input_data
+        else:
+            model_name = input_data.__name__
+
+        union_members = self._union_types_getter(model_name)
+
+        # If no types are returned, fall back to Annotated[Any, UnionFactoryMetadata]
+        if not union_members:
+            final_annotated = Annotated[
+                Any, UnionFactoryMetadata(data=model_name, name=self.name)
+            ]
+        else:
+            union_type = Union[tuple(union_members)]
+            final_annotated = Annotated[
+                union_type, UnionFactoryMetadata(data=model_name, name=self.name)
+            ]
+
+            # Add any additional metadata
+            for extension in self._annotation_extenders:
+                final_annotated = self._add_metadata(final_annotated, extension)
+
+        return final_annotated

swarmauri_typing/__init__.py

@@ -0,0 +1,22 @@
+from .UnionFactory import UnionFactory, UnionFactoryMetadata
+from .Intersection import Intersection, IntersectionMetadata
+
+__all__ = [
+    "UnionFactory",
+    "UnionFactoryMetadata",
+    "Intersection",
+    "IntersectionMetadata",
+]
+
+try:
+    # For Python 3.8 and newer
+    from importlib.metadata import version, PackageNotFoundError
+except ImportError:
+    # For older Python versions, use the backport
+    from importlib_metadata import version, PackageNotFoundError
+
+try:
+    __version__ = version("swarmauri_typing")
+except PackageNotFoundError:
+    # If the package is not installed (for example, during development)
+    __version__ = "0.0.0"

swarmauri_typing-0.9.2.dev10.dist-info/METADATA

@@ -0,0 +1,155 @@
+Metadata-Version: 2.4
+Name: swarmauri_typing
+Version: 0.9.2.dev10
+Summary: This repository includes typing used in the Swarmauri framework.
+License-Expression: Apache-2.0
+License-File: LICENSE
+Author: Jacob Stewart
+Author-email: jacob@swarmauri.com
+Requires-Python: >=3.10,<3.13
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Description-Content-Type: text/markdown
+
+![Swarmauri Logo](https://github.com/swarmauri/swarmauri-sdk/blob/3d4d1cfa949399d7019ae9d8f296afba773dfb7f/assets/swarmauri.brand.theme.svg)
+
+<p align="center">
+    <a href="https://pypi.org/project/swarmauri-typing/">
+        <img src="https://img.shields.io/pypi/dm/swarmauri-typing" alt="PyPI - Downloads"/></a>
+    <a href="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/typing/">
+        <img alt="Hits" src="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/typing.svg"/></a>
+    <a href="https://pypi.org/project/swarmauri-typing/">
+        <img src="https://img.shields.io/pypi/pyversions/swarmauri-typing" alt="PyPI - Python Version"/></a>
+    <a href="https://pypi.org/project/swarmauri-typing/">
+        <img src="https://img.shields.io/pypi/l/swarmauri-typing" alt="PyPI - License"/></a>
+    <a href="https://pypi.org/project/swarmauri-typing/">
+        <img src="https://img.shields.io/pypi/v/swarmauri-typing?label=swarmauri-typing&color=green" alt="PyPI - swarmauri-typing"/></a>
+</p>
+
+---
+
+# Swarmauri Typing
+
+The Swarmauri Typing Library provides advanced type utilities for Python, enabling more expressive and flexible type annotations. It includes tools for creating intersection and union types dynamically.
+
+## Features
+
+- **Intersection Types**: Create intersection types that combine multiple classes.
+
+```python
+from typing import Type, TypeVar, Union, Any, Annotated, Tuple
+
+T = TypeVar("T")
+
+class IntersectionMetadata:
+    def __init__(self, classes: Tuple[Type[T]]):
+        self.classes = classes
+
+    def __repr__(self):
+        return f"IntersectionMetadata(classes={self.classes!r})"
+
+class Intersection(type):
+    def __class_getitem__(cls, classes: Union[Type, Tuple[Type, ...]]) -> type:
+        if not isinstance(classes, tuple):
+            classes = (classes,)
+
+        common = set(classes[0].__mro__)
+        for c in classes[1:]:
+            common.intersection_update(c.__mro__)
+
+        ordered_common = [c for c in classes[0].__mro__ if c in common]
+
+        if not ordered_common:
+            return Annotated[Any, IntersectionMetadata(classes=(classes))]
+        else:
+            union_type = Union[tuple(ordered_common)]
+            return Annotated[union_type, IntersectionMetadata(classes=(classes))]
+```
+
+- **Union Factory**: Dynamically create union types based on a provided function.
+
+```python
+from typing import Type, TypeVar, Callable, List, Union, Any, Annotated, get_args, Optional
+
+T = TypeVar("T")
+
+class UnionFactoryMetadata:
+    def __init__(self, data: Any, name: Optional[str] = None):
+        self.data = data
+        self.name = name or self.__class__.__name__
+
+    def __repr__(self):
+        return f"UnionFactoryMetadata(name={self.name!r}, data={self.data!r})"
+
+class UnionFactory:
+    def __init__(self, bound: Callable[[Type[T]], List[type]], name: str = None, annotation_extenders: List[Any] = None):
+        self.name = name or self.__class__.__name__
+        self._union_types_getter = bound
+        self._annotation_extenders = annotation_extenders or []
+
+    def _add_metadata(self, annotated_type: Any, new_metadata: Any) -> Any:
+        if not (hasattr(annotated_type, '__origin__') and annotated_type.__origin__ is Annotated):
+            return Annotated[annotated_type, new_metadata]
+
+        args = get_args(annotated_type)
+        base_type = args[0]
+        old_metadata = args[1:]
+        return Annotated[base_type, *old_metadata, new_metadata]
+
+    def __getitem__(self, input_data: Union[Type[T], str]) -> type:
+        if isinstance(input_data, str):
+            model_name = input_data
+        else:
+            model_name = input_data.__name__
+
+        union_members = self._union_types_getter(model_name)
+
+        if not union_members:
+            final_annotated = Annotated[Any, UnionFactoryMetadata(data=model_name, name=self.name)]
+        else:
+            union_type = Union[tuple(union_members)]
+            final_annotated = Annotated[union_type, UnionFactoryMetadata(data=model_name, name=self.name)]
+
+            for extension in self._annotation_extenders:
+                final_annotated = self._add_metadata(final_annotated, extension)
+
+        return final_annotated
+```
+
+## Getting Started
+
+To start using the Swarmauri Typing Library, include it as a module in your Python project. Ensure you have Python 3.10 or later installed.
+
+### Steps to install via pypi
+
+```sh
+pip install swarmauri-typing
+```
+
+### Usage Example
+
+```python
+from swarmauri_typing import Intersection, UnionFactory
+
+# Example of using Intersection
+class A: pass
+class B: pass
+
+IntersectionType = Intersection[A, B]
+
+# Example of using UnionFactory
+def my_types_getter(name: str):
+    return [A, B]
+
+union_factory = UnionFactory(my_types_getter)
+MyUnion = union_factory["MyModel"]
+```
+
+
+## Contributing
+
+Contributions are welcome! If you'd like to add a new feature, fix a bug, or improve documentation, kindly go through the [contributions guidelines](https://github.com/swarmauri/swarmauri-sdk/blob/master/contributing.md) first.
+
+

swarmauri_typing-0.9.2.dev10.dist-info/RECORD

@@ -0,0 +1,7 @@
+swarmauri_typing/Intersection.py,sha256=OR3aAqZpH-kYbL8ag_MoiSueg7XKcPYhk4g1snqkkLI,1647
+swarmauri_typing/UnionFactory.py,sha256=CQRmiuzeM4cHk0QcZYoxADG9du3iyuz2Q2ZG5Z2NZR4,3605
+swarmauri_typing/__init__.py,sha256=co_cAZSCG69iIJP3fJZ-mXmyccL-M3IGgC-y-6LeOeE,649
+swarmauri_typing-0.9.2.dev10.dist-info/METADATA,sha256=CDhO5kXDnTgpjtHPhFs1yzdqZnX7tSflS6_hhIF2qz8,5591
+swarmauri_typing-0.9.2.dev10.dist-info/WHEEL,sha256=kJCRJT_g0adfAJzTx2GUMmS80rTJIVHRCfG0DQgLq3o,88
+swarmauri_typing-0.9.2.dev10.dist-info/licenses/LICENSE,sha256=djUXOlCxLVszShEpZXshZ7v33G-2qIC_j9KXpWKZSzQ,11359
+swarmauri_typing-0.9.2.dev10.dist-info/RECORD,,

swarmauri_typing-0.9.2.dev10.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.3.1
+Root-Is-Purelib: true
+Tag: py3-none-any

swarmauri_typing-0.9.2.dev10.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2025] [Jacob Stewart @ Swarmauri]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.