extendable 1.2.2__tar.gz → 1.4.0__tar.gz

extendable-1.4.0/.gitignore

@@ -0,0 +1,129 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

extendable-1.4.0/.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+default_language_version:
+  python: python3
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.17.0
+    hooks:
+      - id: ruff-check
+        args: ["--fix"]
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: trailing-whitespace

extendable-1.4.0/HISTORY.rst

@@ -0,0 +1,135 @@
+1.4.0 (2026-10-22)
+==================
+
+Bugfixes
+--------
+
+- Each class is built once during registry initialization. Previously, if a class had to wait for one of its bases, all classes were rebuilt on each pass, potentially leaving the waiting class based on a class that was later replaced in the registry
+- The classes built by the registry now keep the qualified name of the original
+  class instead of a generated one (``MyClass0``, ``MyClass1``, ...). Since these
+  classes are the same class for the end user, error messages and schemas
+  generated by third party libraries (e.g. pydantic) now use the expected name.
+
+  Also add a custom repr for aggregated classes to make them easier to
+  distinguish.
+
+
+Deprecations and Removals
+-------------------------
+
+- Drop support for python < 3.10 (python 3.9 and older versions have reached
+  their end of life). Add support for python 3.14.
+
+
+1.3.0 (2025-04-16)
+==================
+
+Bugfixes
+--------
+
+- When checking if an instance of extendable class is a type of itself, first check if both classes have the same __xreg_name__ attribute. (`#18 <https://github.com/lmignon/extendable/issues/18>`_)
+
+
+1.2.2 (2023-10-03)
+==================
+
+Bugfixes
+--------
+
+- Fix error when a class is extended to add others aggregated classes as parent
+  classes. Before this fix, the builder used the list of all base classes of
+  the final class as base classes for every class into the hierarchy. (`#15 <https://github.com/lmignon/extendable/issues/15>`_)
+
+
+1.2.1 (2023-09-19)
+==================
+
+Bugfixes
+--------
+
+- Fix isinstance and issublcass method on multi levels inheritance hierarchy. (`#14 <https://github.com/lmignon/extendable/pull/14>`_)
+
+
+1.2.0 (2023-07-28)
+==================
+
+Features
+--------
+
+- Add a  `before_init_registry` hook method into the `ExtendableRegistryListener` class.
+  This methods allows you to udpate the list of modules to load into the registry if
+  you need to do so. (`#before_hook <https://github.com/lmignon/extendable/pull/13>`_)
+
+
+1.1.0 (2023-07-15)
+==================
+
+Features
+--------
+
+- Simpler syntax for defining a class extending another class. The `extends` parameter now accepts `True` as its value. `class PersonExt(Person, extends=True)` means that `PersonExt` extends its first base class: `Person`. This is equivalent to `class PersonExt(Person, extends=Person)`. (`#2 <https://github.com/lmignon/extendable/issues/2>`_)
+
+
+1.0.0 (2023-07-14)
+==================
+
+Features
+--------
+
+- Access to the context variable used to store the current extended Classes
+  returns None if no context is available. Previously the access to the context
+  throws an exception if no context was available.
+- Calls to the classmethod "_get_assembled_cls" now raises RegistryNotInitializedError
+  if the registry is not initialized.
+- The metadaclass now provides the method `_wrap_class_method`. This method
+  can be used to wrap class methods in a way that when the method is called
+  the logic is delegated to the aggregated class if it exists.
+
+
+0.0.5 (2023-07-13)
+==================
+
+Bugfixes
+--------
+
+- Preserve kwargs values in class defintion to ensure to properly create a concrete class with the same attributes as the original one.
+
+
+0.0.4 (2023-06-26)
+==================
+
+Bugfixes
+--------
+
+- Fix registry rebuild (`Details <https://github.com/lmignon/extendable/pull/8/commits/120c1b749081f48893ca74d711091621c3c3481e>`_)
+- Add missing type annotation
+
+
+Deprecations and Removals
+-------------------------
+
+- Drop support fo py3.6
+
+
+0.0.3 (2022-11-01)
+==================
+
+Bugfixes
+--------
+
+-  Fix error when '__qualname__' is not provided (`#6 <https://github.com/lmignon/extendable/issues/6>`_)
+
+
+0.0.2 (2022-06-15)
+==================
+
+Bugfixes
+--------
+
+- Fix compatibility issue with py3.11. (`#4 <https://github.com/lmignon/extendable/issues/4>`_)
+
+
+v0.0.1 (2021-30-12)
+===================
+
+First release.

{extendable-1.2.2 → extendable-1.4.0}/PKG-INFO

@@ -1,27 +1,43 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.5
 Name: extendable
-Version: 1.2.2
+Version: 1.4.0
 Summary: A lib to define class extendable at runtime.
+Project-URL: Source, https://github.com/lmignon/extendable
+Project-URL: Changelog, https://github.com/lmignon/extendable/blob/master/HISTORY.rst
 Author-email: Laurent Mignon <laurent.mignon@acsone.eu>
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-Classifier: License :: OSI Approved :: MIT License
+License: The MIT License (MIT)
+        
+        Copyright (c) 2021 Laurent Mignon
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in
+        all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+        THE SOFTWARE.
+License-File: LICENSE
 Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Dist: contextvars;python_version<'3.7'
-Requires-Dist: types-contextvars;python_version<'3.7'
-Requires-Dist: typing_extensions;python_version<'3.7'
-Requires-Dist: mypy ; extra == "mypy"
-Requires-Dist: towncrier ; extra == "release"
-Requires-Dist: bumpversion ; extra == "release"
-Requires-Dist: pytest ; extra == "test"
-Requires-Dist: pytest-mock ; extra == "test"
-Requires-Dist: coverage[toml] ; extra == "test"
-Project-URL: Changelog, https://github.com/lmignon/extendable/blob/master/HISTORY.rst
-Project-URL: Source, https://github.com/lmignon/extendable
+Requires-Python: >=3.10
 Provides-Extra: mypy
-Provides-Extra: release
+Requires-Dist: mypy; extra == 'mypy'
 Provides-Extra: test
+Requires-Dist: coverage[toml]; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-mock; extra == 'test'
+Description-Content-Type: text/markdown
 
 [![CI](https://github.com/lmignon/extendable/actions/workflows/ci.yml/badge.svg)](https://github.com/lmignon/extendable/actions/workflows/ci.yml)
 [![codecov](https://codecov.io/gh/lmignon/extendable/branch/master/graph/badge.svg?token=LXD34T420H)](https://codecov.io/gh/lmignon/extendable)
@@ -188,22 +204,28 @@ method into the metaclass.
 To run tests, use `tox`. You will get a test coverage report in `htmlcov/index.html`.
 An easy way to install tox is `pipx install tox`.
 
-This project uses pre-commit to enforce linting (among which black for code formating,
-isort for sorting imports, and mypy for type checking).
+This project uses pre-commit to enforce linting and formatting (ruff). The type
+checking (mypy) is run by `tox -e typing`.
 
 To make sure linters run locally on each of your commits, install pre-commit
 (`pipx install pre-commit` is recommended), and run `pre-commit install` in your
 local clone of the extendable repository.
 
-To release:
+## Release
 
- * run ``bumpversion patch|minor|major` --list`
- * Check the `new_version` value returned by the previous command
- * run `towncrier build`.
- * Inspect and commit the updated HISTORY.rst.
- * `git tag {new_version} ; git push --tags`.
+The version of the package is computed from the git tags (hatch-vcs) and the
+changelog is built from the news fragments (towncrier).
+
+* Each change worth mentioning into the changelog comes with a news fragment
+  into the `news` directory: `news/<issue number>.<type>`, or
+  `news/+<name>.<type>` for a change without issue, where `<type>` is one of
+  `feature`, `bugfix`, `doc`, `removal` or `misc`.
+* To release a new version, run the `release` workflow from the GitHub "Actions"
+  tab and choose the part of the version to increase (`patch`, `minor` or
+  `major`). Once the run is approved (required reviewers of the
+  `release-approval` environment), the workflow updates `HISTORY.rst`, tags the
+  release, publishes the package to PyPI and creates the GitHub release.
 
 ## Contributing
 
 All kind of contributions are welcome.
-

{extendable-1.2.2 → extendable-1.4.0}/README.md

@@ -163,20 +163,27 @@ method into the metaclass.
 To run tests, use `tox`. You will get a test coverage report in `htmlcov/index.html`.
 An easy way to install tox is `pipx install tox`.
 
-This project uses pre-commit to enforce linting (among which black for code formating,
-isort for sorting imports, and mypy for type checking).
+This project uses pre-commit to enforce linting and formatting (ruff). The type
+checking (mypy) is run by `tox -e typing`.
 
 To make sure linters run locally on each of your commits, install pre-commit
 (`pipx install pre-commit` is recommended), and run `pre-commit install` in your
 local clone of the extendable repository.
 
-To release:
+## Release
 
- * run ``bumpversion patch|minor|major` --list`
- * Check the `new_version` value returned by the previous command
- * run `towncrier build`.
- * Inspect and commit the updated HISTORY.rst.
- * `git tag {new_version} ; git push --tags`.
+The version of the package is computed from the git tags (hatch-vcs) and the
+changelog is built from the news fragments (towncrier).
+
+* Each change worth mentioning into the changelog comes with a news fragment
+  into the `news` directory: `news/<issue number>.<type>`, or
+  `news/+<name>.<type>` for a change without issue, where `<type>` is one of
+  `feature`, `bugfix`, `doc`, `removal` or `misc`.
+* To release a new version, run the `release` workflow from the GitHub "Actions"
+  tab and choose the part of the version to increase (`patch`, `minor` or
+  `major`). Once the run is approved (required reviewers of the
+  `release-approval` environment), the workflow updates `HISTORY.rst`, tags the
+  release, publishes the package to PyPI and creates the GitHub release.
 
 ## Contributing
 

extendable-1.4.0/news/.gitignore

@@ -0,0 +1 @@
+!.gitignore

{extendable-1.2.2 → extendable-1.4.0}/pyproject.toml

@@ -1,9 +1,10 @@
 [build-system]
-requires = ["flit_core >=3.2,<4"]
-build-backend = "flit_core.buildapi"
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
 
 [project]
 name = "extendable"
+description = "A lib to define class extendable at runtime."
 authors = [{name = "Laurent Mignon", email = "laurent.mignon@acsone.eu"}]
 readme = "README.md"
 license = {file = "LICENSE"}
@@ -12,13 +13,9 @@ classifiers = [
     "Intended Audience :: Developers",
     "Operating System :: OS Independent",
 ]
-dynamic = ["version", "description"]
-dependencies = [
-    "contextvars;python_version<'3.7'",
-    "types-contextvars;python_version<'3.7'",
-    "typing_extensions;python_version<'3.7'",
-]
-requires-python = ">=3.6"
+dynamic = ["version"]
+dependencies = []
+requires-python = ">=3.10"
 
 [project.optional-dependencies]
 test = [
@@ -29,21 +26,41 @@ test = [
 mypy = [
     "mypy",
 ]
-release = [
-    "towncrier",
-    "bumpversion",
-]
 
 [project.urls]
 Source = "https://github.com/lmignon/extendable"
 Changelog = "https://github.com/lmignon/extendable/blob/master/HISTORY.rst"
 
-[tool.flit.sdist]
+[tool.hatch.version]
+# the version is computed from the git tags
+source = "vcs"
+
+[tool.hatch.build.targets.sdist]
 exclude = [".github"]
 
-[tool.isort]
-profile = "black"
-multi_line_output = 3
+[tool.hatch.build.targets.wheel]
+packages = ["src/extendable"]
+
+[tool.ruff]
+# keep the examples of the documentation as written (e.g. the "#>" outputs)
+extend-exclude = ["*.md"]
+
+[tool.ruff.lint]
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # isort
+    "B",   # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "UP",  # pyupgrade
+]
+ignore = [
+    "E501",  # line too long, handled by the formatter
+]
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["F401"]
 
 [tool.coverage.run]
 branch = true
@@ -59,8 +76,7 @@ exclude_lines = [
 ]
 
 [tool.towncrier]
-package = "extendable"
-package_dir = "src"
+name = "Extendable"
 filename = "HISTORY.rst"
 directory = "news"
 issue_format = "`#{issue} <https://github.com/lmignon/extendable/issues/{issue}>`_"

{extendable-1.2.2 → extendable-1.4.0}/src/extendable/__init__.py

@@ -1,8 +1,11 @@
 """A lib to define class extendable at runtime."""
 
+from importlib.metadata import version
+
 # shortcut to main used class
 from .main import ExtendableMeta
-from .version import __version__
+
+__version__ = version("extendable")
 
 # declare "public" members
 # __all__ doesn't restrict access to others members, but they are at least

{extendable-1.2.2 → extendable-1.4.0}/src/extendable/main.py

@@ -1,15 +1,14 @@
 import collections
 import functools
 import inspect
-import sys
-from typing import TYPE_CHECKING, Any, Dict, List, Optional, Set, Type, no_type_check
-
-if sys.version_info >= (3, 7):
-    from typing import OrderedDict
-else:
-    from typing_extensions import OrderedDict
-
 from abc import ABCMeta
+from collections import OrderedDict
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Optional,
+    no_type_check,
+)
 
 from .context import extendable_registry
 from .exceptions import RegistryNotInitializedError
@@ -23,23 +22,23 @@ if TYPE_CHECKING:
 
 class ExtendableClassDef:
     name: str
-    base_names: List[str]
-    original_base_names: List[str]
-    namespace: Dict[str, Any]
+    base_names: list[str]
+    original_base_names: list[str]
+    namespace: dict[str, Any]
     original_name: str
-    others_bases: List[Any]
-    hierarchy: List["ExtendableClassDef"]
+    others_bases: list[Any]
+    hierarchy: list["ExtendableClassDef"]
     metaclass: "ExtendableMeta"
-    original_cls: Type["ExtendableMeta"]
-    kwargs: Dict[str, Any]
+    original_cls: type["ExtendableMeta"]
+    kwargs: dict[str, Any]
 
     def __init__(
         self,
         original_name: str,
-        bases: List[Any],
-        namespace: Dict[str, Any],
+        bases: list[Any],
+        namespace: dict[str, Any],
         metaclass: "ExtendableMeta",
-        kwargs: Dict[str, Any],
+        kwargs: dict[str, Any],
     ) -> None:
         self.namespace = namespace
         self.name = namespace["__xreg_name__"]
@@ -87,28 +86,27 @@ class ExtendableClassDef:
         return clone
 
 
-_extendable_class_defs_by_module: OrderedDict[
-    str, List[ExtendableClassDef]
-] = collections.OrderedDict()
+_extendable_class_defs_by_module: OrderedDict[str, list[ExtendableClassDef]] = (
+    collections.OrderedDict()
+)
 
 
 def __register_class_def__(module: str, cls_def: ExtendableClassDef) -> None:
-    global _extendable_class_defs_by_module
     if module not in _extendable_class_defs_by_module:
         _extendable_class_defs_by_module[module] = []
     _extendable_class_defs_by_module[module].append(cls_def)
 
 
 class ExtendableMeta(ABCMeta):
-    __xreg_base_names__: List[str]
+    __xreg_base_names__: list[str]
     __xreg_name__: str
-    __xreg_all_base_names__: Set[str]
+    __xreg_all_base_names__: set[str]
     _is_aggregated_class: bool
     _original_cls: "ExtendableMeta"
 
     @no_type_check
     def __new__(metacls, name, bases, namespace, extends=None, **kwargs):
-        """create the expected class and collect the class definition that will be used
+        """Create the expected class and collect the class definition that will be used
         at the end of registry load process to build the final class."""
         class_def = None
         if isinstance(extends, bool) and extends:
@@ -191,10 +189,10 @@ class ExtendableMeta(ABCMeta):
         return super().__new__(metacls, name, bases, namespace, **kwargs)
 
     @classmethod
-    def _wrap_class_methods(metacls, namespace: Dict[str, Any]) -> Dict[str, Any]:
+    def _wrap_class_methods(metacls, namespace: dict[str, Any]) -> dict[str, Any]:
         """Wrap classmethods defined into the namespace to delegate the call to the
         final class."""
-        new_namespace: Dict[str, Any] = {}
+        new_namespace: dict[str, Any] = {}
         for key, value in namespace.items():
             if isinstance(value, classmethod):
                 new_namespace[key] = metacls._wrap_class_method(value, key)
@@ -203,7 +201,7 @@ class ExtendableMeta(ABCMeta):
         return new_namespace
 
     @classmethod
-    def _is_extendable(metacls, cls: Type[Any]) -> bool:
+    def _is_extendable(metacls, cls: type[Any]) -> bool:
         return issubclass(type(cls), ExtendableMeta)
 
     @classmethod
@@ -248,9 +246,37 @@ class ExtendableMeta(ABCMeta):
             return super().__call__(*args, **kwargs)
         return cls._get_assembled_cls()(*args, **kwargs)
 
+    def __repr__(cls) -> str:
+        """Add to the representation of the classes built by the registry their level
+        into the class hierarchy and the class definition they come from.
+
+        e.g. ``<class 'addon_b.Location' #2 (addon_b.LocationCode)>``
+        """
+        level = cls.__dict__.get("__xreg_level__")
+        if level is None:
+            return super().__repr__()
+        name = f"{cls.__module__}.{cls.__qualname__}"
+        original_cls = cls.__dict__["__xreg_original_cls__"]
+        original_name = f"{original_cls.__module__}.{original_cls.__qualname__}"
+        if original_name == name:
+            return f"<class '{name}' #{level}>"
+        return f"<class '{name}' #{level} ({original_name})>"
+
     ###############################################################
     # concrete methods provided to the final class by the metaclass
     ###############################################################
+    def __instancecheck__(self, instance: Any) -> bool:  # noqa: B902
+        """Implement issubclass(sub, cls)."""
+        if not hasattr(instance, "__xreg_name__"):
+            return False
+
+        if instance.__xreg_name__ == self.__xreg_name__:
+            # this is the same class
+            return True
+        # self is a class and instance is an instance of a class
+        if self.__xreg_name__ in instance.__xreg_all_base_names__:
+            return True
+        return super().__instancecheck__(instance)
 
     def __subclasscheck__(cls, subclass: Any) -> bool:  # noqa: B902
         """Implement issubclass(sub, cls)."""