pytestarch 3.1.0__tar.gz → 4.0.0__tar.gz

{pytestarch-3.1.0 → pytestarch-4.0.0}/PKG-INFO

@@ -1,34 +1,30 @@
-Metadata-Version: 2.1
-Name: pytestarch
-Version: 3.1.0
+Metadata-Version: 2.3
+Name: PyTestArch
+Version: 4.0.0
 Summary: Test framework for software architecture based on imports between modules
-Home-page: https://github.com/zyskarch/pytestarch
 License: Apache-2.0
 Keywords: architecture,test
 Author: zyskarch
 Author-email: zyskarch@gmail.com
 Maintainer: zyskarch
 Maintainer-email: zyskarch@gmail.com
-Requires-Python: >=3.9,<4.0
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.9
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.9
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development :: Testing
 Classifier: Topic :: Software Development :: Testing :: Unit
 Provides-Extra: visualization
-Requires-Dist: matplotlib (>=3.9,<4.0) ; extra == "visualization"
-Requires-Dist: networkx (>=3.2,<4.0)
-Project-URL: Bug Tracker, https://github.com/zyskarch/pytestarch/issues
-Project-URL: Documentation, https://zyskarch.github.io/pytestarch/
+Requires-Dist: matplotlib (>=3.9) ; extra == "visualization"
+Requires-Dist: networkx (>=3.2)
+Project-URL: Documentation, https://zyskarch.github.io/pytestarch/latest
 Project-URL: Repository, https://github.com/zyskarch/pytestarch
+Project-URL: issues, https://github.com/zyskarch/pytestarch/issues
 Description-Content-Type: text/markdown
 
 # Welcome to PyTestArch

pytestarch-4.0.0/pyproject.toml

@@ -0,0 +1,79 @@
+[project]
+name = "PyTestArch"
+version = "4.0.0"
+requires-python = ">=3.9"
+description = "Test framework for software architecture based on imports between modules"
+authors = [{ name = "zyskarch", email = "zyskarch@gmail.com" }]
+maintainers = [{ name = "zyskarch", email = "zyskarch@gmail.com" }]
+readme = "README.md"
+license = "Apache-2.0"
+
+keywords = ["architecture", "test"]
+classifiers = [
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.9",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Testing",
+    "Topic :: Software Development :: Testing :: Unit",
+]
+
+dependencies = ["networkx>=3.2"]
+
+[project.optional-dependencies]
+visualization = ["matplotlib>=3.9"]
+
+[project.urls]
+issues = "https://github.com/zyskarch/pytestarch/issues"
+documentation = "https://zyskarch.github.io/pytestarch/latest"
+repository = "https://github.com/zyskarch/pytestarch"
+
+[tool.poetry.group.dev.dependencies]
+mkdocs = "1.6.0"
+mkdocstrings-python = "1.10.3"
+mkdocs-material = "9.5.25"
+mkdocs-autorefs = "1.0.1"
+mkdocs-material-extensions = "1.3.1"
+mkdocstrings = "0.25.1"
+griffe = "0.45.2"
+nox = "2024.4.15"
+pre-commit = "3.7.1"
+pytest = "^8.2.1"
+coverage = "^7.5.2"
+mike = "2.1.1"
+ruff = "^0.7.0"
+
+[build-system]
+requires = ["poetry-core>=2.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.ruff]
+line-length = 88
+
+[tool.ruff.lint]
+select = [
+    "F",      # Pyflakes
+    "E",
+    "W",      # Pylint Error, Warning
+    "UP",     # pyupgrade
+    "FURB",   # refurb
+    "S",      # flake8-bandit
+    "I",      # isort
+    "RUF100", # Unneeded noqa
+]
+ignore = [
+    "E501", # line too long -> handled by formatter
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*.py" = [
+    "S101", # assert statement
+    "E743", # ambiguous function name
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["integration", "resources", "query_language"]

pytestarch-4.0.0/src/pytestarch/__init__.py

@@ -0,0 +1,22 @@
+from pytestarch.diagram_extension.diagram_rule import DiagramRule
+from pytestarch.eval_structure.evaluable_architecture import EvaluableArchitecture
+from pytestarch.query_language.layered_architecture_rule import (
+    LayeredArchitecture,
+    LayerRule,
+)
+from pytestarch.query_language.rule import Rule
+
+from .pytestarch import (
+    get_evaluable_architecture,
+    get_evaluable_architecture_for_module_objects,
+)
+
+__all__ = [
+    "DiagramRule",
+    "EvaluableArchitecture",
+    "get_evaluable_architecture",
+    "get_evaluable_architecture_for_module_objects",
+    "LayeredArchitecture",
+    "LayerRule",
+    "Rule",
+]

{pytestarch-3.1.0 → pytestarch-4.0.0}/src/pytestarch/diagram_extension/dependency_to_rule_converter.py

@@ -1,8 +1,8 @@
 from __future__ import annotations
 
-from pytestarch import Rule
 from pytestarch.diagram_extension.parsed_dependencies import ParsedDependencies
 from pytestarch.query_language.base_language import RuleApplier
+from pytestarch.query_language.rule import Rule
 
 
 class DependencyToRuleConverter:

{pytestarch-3.1.0 → pytestarch-4.0.0}/src/pytestarch/diagram_extension/diagram_rule.py

@@ -2,12 +2,12 @@ from __future__ import annotations
 
 from pathlib import Path
 
-from pytestarch import EvaluableArchitecture
 from pytestarch.diagram_extension.dependency_to_rule_converter import (
     DependencyToRuleConverter,
 )
 from pytestarch.diagram_extension.diagram_parser import PumlParser
 from pytestarch.diagram_extension.parsed_dependencies import ParsedDependencies
+from pytestarch.eval_structure.evaluable_graph import EvaluableArchitecture
 from pytestarch.query_language.base_language import (
     BaseModuleSpecifier,
     FileRule,

{pytestarch-3.1.0 → pytestarch-4.0.0}/src/pytestarch/eval_structure/breadth_first_searches.py

@@ -41,7 +41,7 @@ def get_dependency_between_modules(
     return dependencies  # type: ignore
 
 
-def any_dependency_to_module_other_than(  # noqa: C901
+def any_dependency_to_module_other_than(
     graph: AbstractGraph, dependent: ModuleFilter, dependent_upons: set[ModuleFilter]
 ) -> list[Dependency]:
     # nodes to exclude are nodes that once reached will not have their submodules analysed next
@@ -75,7 +75,10 @@ def any_dependency_to_module_other_than(  # noqa: C901
             # the true submodules are excluded
             # reason: if something imports B, then it imports something that is not B.X (and B.X is a dependent_upon module)
             # (but we do not care if it imports B.X.M, as this is part of B.X)
-            nodes_to_exclude.remove(dependent_upon.identifier)
+            try:
+                nodes_to_exclude.remove(dependent_upon.identifier)
+            except KeyError:
+                pass
 
     nodes_to_check = list(nodes_that_do_not_fulfill_criterion)
     checked_nodes = set()
@@ -106,7 +109,7 @@ def any_dependency_to_module_other_than(  # noqa: C901
     return nodes_fulfilling_criteria  # type: ignore
 
 
-def any_other_dependency_to_module_than(  # noqa: C901
+def any_other_dependency_to_module_than(
     graph: AbstractGraph, dependents: set[ModuleFilter], dependent_upon: ModuleFilter
 ) -> list[Dependency]:
     # submodules of the dependent upon module do not count as an import that is not the dependent upon module
@@ -145,7 +148,10 @@ def any_other_dependency_to_module_than(  # noqa: C901
             # if the dependent module is defined via a parent module, this parent module counts as an allowed import
             # reason: we are looking for dependencies other than module A.X. Parent module A is not (only) A.X, so it counts
             # (submodule A.X.M does not count, as it is not anything else but A.X)
-            nodes_to_exclude.remove(dependent.identifier)
+            try:
+                nodes_to_exclude.remove(dependent.identifier)
+            except KeyError:
+                pass
 
     checked_nodes = set()
 

{pytestarch-3.1.0 → pytestarch-4.0.0}/src/pytestarch/eval_structure/module_name_converter.py

@@ -5,9 +5,9 @@ from collections import defaultdict
 from collections.abc import Sequence
 from typing import cast
 
-from pytestarch import EvaluableArchitecture
 from pytestarch.eval_structure.breadth_first_searches import get_all_submodules_of
 from pytestarch.eval_structure.evaluable_architecture import (
+    EvaluableArchitecture,
     Module,
     ModuleFilter,
     ModuleNameFilter,
@@ -64,7 +64,8 @@ class ModuleNameConverter:
                         never_matched.remove(module_to_match)
 
                     submodules_of_match = get_all_submodules_of(
-                        arch._graph, converted_module_filter  # type: ignore
+                        arch._graph,  # type: ignore
+                        converted_module_filter,
                     )
                     submodules_of_match.remove(
                         actually_present_module

{pytestarch-3.1.0 → pytestarch-4.0.0}/src/pytestarch/eval_structure_generation/file_import/converter.py

@@ -78,10 +78,26 @@ class ImportConverter:
         if isinstance(module, ast.Import):
             new_imports = []
             for alias in module.names:
-                new_imports.append(AbsoluteImport(module_name, self._adjust_with_root_prefix(alias.name, absolute_import_prefix, all_internal_modules)))  # type: ignore
+                new_imports.append(
+                    AbsoluteImport(
+                        module_name,
+                        self._adjust_with_root_prefix(
+                            alias.name, absolute_import_prefix, all_internal_modules
+                        ),
+                    )
+                )  # type: ignore
         elif isinstance(module, ast.ImportFrom):
             if module.level == 0:
-                new_imports = [AbsoluteImport(module_name, self._adjust_with_root_prefix(module.module, absolute_import_prefix, all_internal_modules))]  # type: ignore
+                new_imports = [
+                    AbsoluteImport(
+                        module_name,
+                        self._adjust_with_root_prefix(
+                            module.module,  # type: ignore
+                            absolute_import_prefix,
+                            all_internal_modules,
+                        ),
+                    )
+                ]
             else:
                 new_imports = []
                 for alias in module.names:

{pytestarch-3.1.0 → pytestarch-4.0.0}/src/pytestarch/query_language/base_language.py

@@ -4,7 +4,7 @@ from abc import ABC, abstractmethod
 from pathlib import Path
 from typing import Generic, TypeVar, Union
 
-from pytestarch import EvaluableArchitecture
+from pytestarch.eval_structure.evaluable_architecture import EvaluableArchitecture
 from pytestarch.utils.decorators import deprecated
 
 
@@ -203,7 +203,6 @@ class LayerName(ABC):
 
 
 class BaseLayeredArchitecture(ABC):
-
     @abstractmethod
     def with_layer(self) -> LayerName:
         """This is simply a convenience method to achieve proper typing. It can be omitted."""

{pytestarch-3.1.0 → pytestarch-4.0.0}/src/pytestarch/query_language/layered_architecture_rule.py

@@ -3,8 +3,8 @@ from __future__ import annotations
 from collections.abc import Sequence
 from functools import partial
 
-from pytestarch import EvaluableArchitecture, Rule
 from pytestarch.eval_structure.evaluable_architecture import (
+    EvaluableArchitecture,
     LayerMapping,
     ModuleFilter,
     ModuleNameFilter,
@@ -24,6 +24,7 @@ from pytestarch.query_language.base_language import (
     RuleApplier,
 )
 from pytestarch.query_language.exceptions import ImproperlyConfigured
+from pytestarch.query_language.rule import Rule
 from pytestarch.rule_assessment.rule_check.rule_matcher import (
     LayerRuleMatcher,
     RuleMatcher,
@@ -170,7 +171,12 @@ class LayerRule(
                 "Specify a LayeredArchitecture before defining layer behavior."
             )
 
-        self._rule = Rule(rule_matcher_class=partial(self._rule_matcher_class, layer_mapping=self._architecture.layer_mapping)).modules_that()  # type: ignore
+        self._rule = Rule(
+            rule_matcher_class=partial(
+                self._rule_matcher_class,
+                layer_mapping=self._architecture.layer_mapping,  # type: ignore
+            )
+        ).modules_that()
 
         return self
 

{pytestarch-3.1.0 → pytestarch-4.0.0}/src/pytestarch/query_language/multiple_rule_applier.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from pytestarch import EvaluableArchitecture
+from pytestarch.eval_structure.evaluable_architecture import EvaluableArchitecture
 from pytestarch.query_language.base_language import RuleApplier
 
 

{pytestarch-3.1.0 → pytestarch-4.0.0}/src/pytestarch/query_language/rule.py

@@ -4,8 +4,8 @@ from collections.abc import Sequence
 from dataclasses import dataclass, replace
 from typing import Callable
 
-from pytestarch import EvaluableArchitecture
 from pytestarch.eval_structure.evaluable_architecture import (
+    EvaluableArchitecture,
     ModuleFilter,
     ModuleNameFilter,
     ModuleNameRegexFilter,
@@ -77,20 +77,20 @@ class Rule(
         return self
 
     def are_sub_modules_of(  # type: ignore
-        self, modules: str | list[str]
+        self, modules: str | Sequence[str]
     ) -> BehaviorSpecification:
         self._set_modules(
             modules, lambda name: ParentModuleNameFilter(parent_module=name)
         )
         return self
 
-    def are_named(self, names: str | list[str]) -> BehaviorSpecification:  # type: ignore
+    def are_named(self, names: str | Sequence[str]) -> BehaviorSpecification:  # type: ignore
         self._set_modules(names, lambda name: ModuleNameFilter(name=name))
         return self
 
     @deprecated
     def have_name_containing(
-        self, partial_names: str | list[str]
+        self, partial_names: str | Sequence[str]
     ) -> BehaviorSpecification:
         self._set_modules(
             partial_names,
@@ -109,7 +109,7 @@ class Rule(
 
     def _set_modules(
         self,
-        module_names: str | list[str],
+        module_names: str | Sequence[str],
         create_module_fn: Callable[[str], ModuleFilter],
     ) -> None:
         if self._modules_to_check_to_be_specified_next is None:
@@ -124,7 +124,9 @@ class Rule(
         else:
             self._configuration.modules_to_check_against = modules
 
-    def _add_modules(self, modules: list[tuple[str, bool]]) -> BehaviorSpecification:
+    def _add_modules(
+        self, modules: Sequence[tuple[str, bool]]
+    ) -> BehaviorSpecification:
         module_names = []
         module_creation_fn = []
 
@@ -143,8 +145,8 @@ class Rule(
 
     def _append_modules(
         self,
-        module_names: list[str],
-        create_module_fns: list[Callable[[str], ModuleFilter]],
+        module_names: Sequence[str],
+        create_module_fns: Sequence[Callable[[str], ModuleFilter]],
     ) -> None:
         modules = [fn(n) for n, fn in zip(module_names, create_module_fns)]
         if self._modules_to_check_to_be_specified_next:

{pytestarch-3.1.0 → pytestarch-4.0.0}/src/pytestarch/rule_assessment/rule_check/rule_matcher.py

@@ -100,16 +100,10 @@ class RuleMatcher(ABC):
             self._behavior_requirement.not_explicitly_requested_dependency_required
             or self._behavior_requirement.not_explicitly_requested_dependency_not_allowed
         ):
-            if (
-                not self._updated_module_requirement.rule_specified_with_importer_as_rule_object
-            ):
-                not_explicitly_requested_dependency_check_method = (
-                    evaluable.any_dependencies_from_dependents_to_modules_other_than_dependent_upons
-                )
+            if not self._updated_module_requirement.rule_specified_with_importer_as_rule_object:
+                not_explicitly_requested_dependency_check_method = evaluable.any_dependencies_from_dependents_to_modules_other_than_dependent_upons
             else:
-                not_explicitly_requested_dependency_check_method = (
-                    evaluable.any_other_dependencies_on_dependent_upons_than_from_dependents
-                )
+                not_explicitly_requested_dependency_check_method = evaluable.any_other_dependencies_on_dependent_upons_than_from_dependents
 
             return not_explicitly_requested_dependency_check_method(
                 self._updated_module_requirement.importers,

pytestarch-3.1.0/pyproject.toml

@@ -1,63 +0,0 @@
-[tool.poetry]
-name = "PyTestArch"
-version = "3.1.0"
-description = "Test framework for software architecture based on imports between modules"
-authors = ["zyskarch <zyskarch@gmail.com>"]
-maintainers = ["zyskarch <zyskarch@gmail.com>"]
-readme = "README.md"
-license = "Apache-2.0"
-documentation = "https://zyskarch.github.io/pytestarch/"
-repository = "https://github.com/zyskarch/pytestarch"
-
-keywords = ["architecture", "test"]
-classifiers = [
-    "Programming Language :: Python :: 3.12",
-    "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.10",
-    "Programming Language :: Python :: 3.9",
-    "License :: OSI Approved :: Apache Software License",
-    "Operating System :: OS Independent",
-    "Intended Audience :: Developers",
-    "Topic :: Software Development :: Testing",
-    "Topic :: Software Development :: Testing :: Unit",
-]
-
-[tool.poetry.urls]
-"Bug Tracker" = "https://github.com/zyskarch/pytestarch/issues"
-
-[tool.poetry.dependencies]
-python = "^3.9"
-networkx = "^3.2"
-matplotlib = { version = "^3.9", optional = true }
-
-[tool.poetry.extras]
-visualization = ["matplotlib"]
-
-[tool.poetry.dev-dependencies]
-mkdocs = "1.6.0"
-mkdocstrings-python = "1.10.3"
-mkdocs-material = "9.5.25"
-mkdocs-autorefs = "1.0.1"
-mkdocs-material-extensions = "1.3.1"
-mkdocstrings = "0.25.1"
-griffe = "0.45.2"
-nox = "2024.4.15"
-pre-commit = "3.7.1"
-pytest = "^8.2.1"
-coverage = "^7.5.2"
-mike = "2.1.1"
-
-[build-system]
-requires = ["poetry-core>=1.0.0"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.pytest.ini_options]
-sourcepath = "src"
-
-[tool.isort]
-profile = "black"
-add_imports = ["from __future__ import annotations"]
-
-[tool.bandit]
-[tool.bandit.assert_used]
-skips = ["*/test_*.py"]

pytestarch-3.1.0/setup.py

@@ -1,48 +0,0 @@
-# -*- coding: utf-8 -*-
-from setuptools import setup
-
-package_dir = \
-{'': 'src'}
-
-packages = \
-['pytestarch',
- 'pytestarch.diagram_extension',
- 'pytestarch.eval_structure',
- 'pytestarch.eval_structure_generation',
- 'pytestarch.eval_structure_generation.file_import',
- 'pytestarch.eval_structure_generation.graph_generation',
- 'pytestarch.query_language',
- 'pytestarch.rule_assessment',
- 'pytestarch.rule_assessment.error_message',
- 'pytestarch.rule_assessment.rule_check',
- 'pytestarch.utils']
-
-package_data = \
-{'': ['*']}
-
-install_requires = \
-['networkx>=3.2,<4.0']
-
-extras_require = \
-{'visualization': ['matplotlib>=3.9,<4.0']}
-
-setup_kwargs = {
-    'name': 'pytestarch',
-    'version': '3.1.0',
-    'description': 'Test framework for software architecture based on imports between modules',
-    'long_description': '# Welcome to PyTestArch\n\nPyTestArch is an open source library that allows users to define architectural rules and test their code against them. It is \ngenerally inspired by [ArchUnit](https://www.archunit.org/).\n\n## Installation Guide\nPyTestArch is available via [PyPI](https://pypi.org/project/pytestarch/) and can be installed e.g. via pip: `pip install pytestarch`. To also install the\noptional dependency matplotlib, which is required to draw the created dependency graphs, install `pytestarch[visualization]`\n\n## Usage Guide\nThree steps are required to test an architectural rule:\n\n1) Create an evaluable representation of the source code you want to test\n\n```\nfrom pytestarch import get_evaluable_architecture\n\nevaluable = get_evaluable_architecture("/home/dummy/project", "/home/dummy/project/src")\n```\nThis will scan all python files under /home/dummy/project/src for imports and build an internal representation that can\nlater be queried. The first parameter /home/dummy/project helps PyTestArch to differentiate between internal and external \ndependencies. This evaluable can be used for multiple architectural rule checks; if you are using [pytest](https://docs.pytest.org/en/7.1.x/),\nyou could use a fixture for this evaluable object.\n\n2) Define an architectural rule\n```\nfrom pytestarch import Rule\n\nrule = (\n    Rule() \n    .modules_that() \n    .are_named("project.src.moduleB") \n    .should_not() \n    .be_imported_by_modules_that() \n    .are_sub_modules_of("project.src.moduleA") \n)\n```\n\nThis rule represents the architectural requirements that a module named "project.src.moduleB" should not be imported by any module\nthat is a submodule of "project.src.moduleA", excluding "project.src.moduleA" itself.\n\n3) Evaluate your code against this rule\n\n```\nrule.assert_applies(evaluable)\n```\nThat\'s it!\n',
-    'author': 'zyskarch',
-    'author_email': 'zyskarch@gmail.com',
-    'maintainer': 'zyskarch',
-    'maintainer_email': 'zyskarch@gmail.com',
-    'url': 'https://github.com/zyskarch/pytestarch',
-    'package_dir': package_dir,
-    'packages': packages,
-    'package_data': package_data,
-    'install_requires': install_requires,
-    'extras_require': extras_require,
-    'python_requires': '>=3.9,<4.0',
-}
-
-
-setup(**setup_kwargs)

pytestarch-3.1.0/src/pytestarch/__init__.py

@@ -1,13 +0,0 @@
-from pytestarch.eval_structure.evaluable_architecture import (  # noqa: F401
-    EvaluableArchitecture,
-)
-from pytestarch.query_language.rule import Rule  # noqa: F401
-from .pytestarch import get_evaluable_architecture  # noqa: F401 E401
-from .pytestarch import (  # noqa: F401 E401; noqa: F401 E401
-    get_evaluable_architecture_for_module_objects,
-)
-from pytestarch.query_language.layered_architecture_rule import (  # noqa: F401
-    LayeredArchitecture,
-    LayerRule,
-)
-from pytestarch.diagram_extension.diagram_rule import DiagramRule  # noqa: F401