From adab778de528262a56ef7ff9d56678e20ef6b903 Mon Sep 17 00:00:00 2001 From: Maksim Stepanov <17935127+delatrie@users.noreply.github.com> Date: Wed, 2 Apr 2025 16:57:06 +0700 Subject: [PATCH 1/8] refactor(commons): use double quotes in setup.py --- allure-python-commons/setup.py | 35 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 18 deletions(-) diff --git a/allure-python-commons/setup.py b/allure-python-commons/setup.py index ee645587..30ad8796 100644 --- a/allure-python-commons/setup.py +++ b/allure-python-commons/setup.py @@ -4,19 +4,19 @@ PACKAGE = "allure-python-commons" classifiers = [ - 'Development Status :: 5 - Production/Stable', - 'Intended Audience :: Developers', - 'License :: OSI Approved :: Apache Software License', - 'Topic :: Software Development :: Quality Assurance', - 'Topic :: Software Development :: Testing', - 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3 :: Only', - 'Programming Language :: Python :: 3.8', - 'Programming Language :: Python :: 3.9', - 'Programming Language :: Python :: 3.10', - 'Programming Language :: Python :: 3.11', - 'Programming Language :: Python :: 3.12', - 'Programming Language :: Python :: 3.13', + "Development Status :: 5 - Production/Stable", + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Topic :: Software Development :: Quality Assurance", + "Topic :: Software Development :: Testing", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", ] install_requires = [ @@ -33,7 +33,7 @@ def main(): setup( name=PACKAGE, use_scm_version={"root": "..", "relative_to": __file__}, - setup_requires=['setuptools_scm'], + setup_requires=["setuptools_scm"], description=( "Contains the API for end users as well as helper functions and " "classes to build Allure adapters for Python test frameworks", @@ -50,12 +50,11 @@ def main(): long_description=get_readme("README.md"), long_description_content_type="text/markdown", packages=["allure_commons"], - package_dir={"allure_commons": 'src'}, + package_dir={"allure_commons": "src"}, install_requires=install_requires, - py_modules=['allure', 'allure_commons'], - python_requires='>=3.6' + python_requires=">=3.6" ) -if __name__ == '__main__': +if __name__ == "__main__": main() From a5ee79e28bb85a02213ffaabe0c354c4b4910b1a Mon Sep 17 00:00:00 2001 From: Maksim Stepanov <17935127+delatrie@users.noreply.github.com> Date: Wed, 2 Apr 2025 16:57:48 +0700 Subject: [PATCH 2/8] fix(commons): invalid package description type --- allure-python-commons/setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/allure-python-commons/setup.py b/allure-python-commons/setup.py index 30ad8796..7c8df986 100644 --- a/allure-python-commons/setup.py +++ b/allure-python-commons/setup.py @@ -36,7 +36,7 @@ def main(): setup_requires=["setuptools_scm"], description=( "Contains the API for end users as well as helper functions and " - "classes to build Allure adapters for Python test frameworks", + "classes to build Allure adapters for Python test frameworks" ), url="https://allurereport.org/", project_urls={ From 8a96d95b357ae5c140a004d736b33dfefb6a6708 Mon Sep 17 00:00:00 2001 From: Maksim Stepanov <17935127+delatrie@users.noreply.github.com> Date: Wed, 2 Apr 2025 17:22:02 +0700 Subject: [PATCH 3/8] refactor(commons): make allure a package --- allure-python-commons/{allure.py => allure/__init__.py} | 0 allure-python-commons/{src => allure_commons}/__init__.py | 0 allure-python-commons/{src => allure_commons}/_allure.py | 0 allure-python-commons/{src => allure_commons}/_core.py | 0 allure-python-commons/{src => allure_commons}/_hooks.py | 0 allure-python-commons/{src => allure_commons}/lifecycle.py | 0 allure-python-commons/{src => allure_commons}/logger.py | 0 allure-python-commons/{src => allure_commons}/mapping.py | 0 allure-python-commons/{src => allure_commons}/model2.py | 0 allure-python-commons/{src => allure_commons}/reporter.py | 0 allure-python-commons/{src => allure_commons}/types.py | 0 allure-python-commons/{src => allure_commons}/utils.py | 0 allure-python-commons/setup.py | 3 +-- 13 files changed, 1 insertion(+), 2 deletions(-) rename allure-python-commons/{allure.py => allure/__init__.py} (100%) rename allure-python-commons/{src => allure_commons}/__init__.py (100%) rename allure-python-commons/{src => allure_commons}/_allure.py (100%) rename allure-python-commons/{src => allure_commons}/_core.py (100%) rename allure-python-commons/{src => allure_commons}/_hooks.py (100%) rename allure-python-commons/{src => allure_commons}/lifecycle.py (100%) rename allure-python-commons/{src => allure_commons}/logger.py (100%) rename allure-python-commons/{src => allure_commons}/mapping.py (100%) rename allure-python-commons/{src => allure_commons}/model2.py (100%) rename allure-python-commons/{src => allure_commons}/reporter.py (100%) rename allure-python-commons/{src => allure_commons}/types.py (100%) rename allure-python-commons/{src => allure_commons}/utils.py (100%) diff --git a/allure-python-commons/allure.py b/allure-python-commons/allure/__init__.py similarity index 100% rename from allure-python-commons/allure.py rename to allure-python-commons/allure/__init__.py diff --git a/allure-python-commons/src/__init__.py b/allure-python-commons/allure_commons/__init__.py similarity index 100% rename from allure-python-commons/src/__init__.py rename to allure-python-commons/allure_commons/__init__.py diff --git a/allure-python-commons/src/_allure.py b/allure-python-commons/allure_commons/_allure.py similarity index 100% rename from allure-python-commons/src/_allure.py rename to allure-python-commons/allure_commons/_allure.py diff --git a/allure-python-commons/src/_core.py b/allure-python-commons/allure_commons/_core.py similarity index 100% rename from allure-python-commons/src/_core.py rename to allure-python-commons/allure_commons/_core.py diff --git a/allure-python-commons/src/_hooks.py b/allure-python-commons/allure_commons/_hooks.py similarity index 100% rename from allure-python-commons/src/_hooks.py rename to allure-python-commons/allure_commons/_hooks.py diff --git a/allure-python-commons/src/lifecycle.py b/allure-python-commons/allure_commons/lifecycle.py similarity index 100% rename from allure-python-commons/src/lifecycle.py rename to allure-python-commons/allure_commons/lifecycle.py diff --git a/allure-python-commons/src/logger.py b/allure-python-commons/allure_commons/logger.py similarity index 100% rename from allure-python-commons/src/logger.py rename to allure-python-commons/allure_commons/logger.py diff --git a/allure-python-commons/src/mapping.py b/allure-python-commons/allure_commons/mapping.py similarity index 100% rename from allure-python-commons/src/mapping.py rename to allure-python-commons/allure_commons/mapping.py diff --git a/allure-python-commons/src/model2.py b/allure-python-commons/allure_commons/model2.py similarity index 100% rename from allure-python-commons/src/model2.py rename to allure-python-commons/allure_commons/model2.py diff --git a/allure-python-commons/src/reporter.py b/allure-python-commons/allure_commons/reporter.py similarity index 100% rename from allure-python-commons/src/reporter.py rename to allure-python-commons/allure_commons/reporter.py diff --git a/allure-python-commons/src/types.py b/allure-python-commons/allure_commons/types.py similarity index 100% rename from allure-python-commons/src/types.py rename to allure-python-commons/allure_commons/types.py diff --git a/allure-python-commons/src/utils.py b/allure-python-commons/allure_commons/utils.py similarity index 100% rename from allure-python-commons/src/utils.py rename to allure-python-commons/allure_commons/utils.py diff --git a/allure-python-commons/setup.py b/allure-python-commons/setup.py index 7c8df986..1297d4a0 100644 --- a/allure-python-commons/setup.py +++ b/allure-python-commons/setup.py @@ -49,8 +49,7 @@ def main(): keywords="allure reporting report-engine", long_description=get_readme("README.md"), long_description_content_type="text/markdown", - packages=["allure_commons"], - package_dir={"allure_commons": "src"}, + packages=["allure_commons", "allure"], install_requires=install_requires, python_requires=">=3.6" ) From 0d243709d147e06e9536c00d3bd68f26cfbf1fae Mon Sep 17 00:00:00 2001 From: Maksim Stepanov <17935127+delatrie@users.noreply.github.com> Date: Wed, 2 Apr 2025 18:35:59 +0700 Subject: [PATCH 4/8] feat(commons): enable type check --- allure-python-commons/allure/py.typed | 0 allure-python-commons/allure_commons/py.typed | 0 allure-python-commons/setup.py | 4 ++++ 3 files changed, 4 insertions(+) create mode 100644 allure-python-commons/allure/py.typed create mode 100644 allure-python-commons/allure_commons/py.typed diff --git a/allure-python-commons/allure/py.typed b/allure-python-commons/allure/py.typed new file mode 100644 index 00000000..e69de29b diff --git a/allure-python-commons/allure_commons/py.typed b/allure-python-commons/allure_commons/py.typed new file mode 100644 index 00000000..e69de29b diff --git a/allure-python-commons/setup.py b/allure-python-commons/setup.py index 1297d4a0..f9422bf0 100644 --- a/allure-python-commons/setup.py +++ b/allure-python-commons/setup.py @@ -50,6 +50,10 @@ def main(): long_description=get_readme("README.md"), long_description_content_type="text/markdown", packages=["allure_commons", "allure"], + package_data={ + "allure": ["py.typed"], + "allure_commons": ["py.typed"], + }, install_requires=install_requires, python_requires=">=3.6" ) From 1bcb3ae9ad213ad08efb29cce1cbfe67abb0bced Mon Sep 17 00:00:00 2001 From: Maksim Stepanov <17935127+delatrie@users.noreply.github.com> Date: Wed, 2 Apr 2025 19:26:39 +0700 Subject: [PATCH 5/8] refactor(commons): move packages under src --- allure-python-commons/setup.py | 1 + allure-python-commons/{ => src}/allure/__init__.py | 0 allure-python-commons/{ => src}/allure/py.typed | 0 allure-python-commons/{ => src}/allure_commons/__init__.py | 0 allure-python-commons/{ => src}/allure_commons/_allure.py | 0 allure-python-commons/{ => src}/allure_commons/_core.py | 0 allure-python-commons/{ => src}/allure_commons/_hooks.py | 0 allure-python-commons/{ => src}/allure_commons/lifecycle.py | 0 allure-python-commons/{ => src}/allure_commons/logger.py | 0 allure-python-commons/{ => src}/allure_commons/mapping.py | 0 allure-python-commons/{ => src}/allure_commons/model2.py | 0 allure-python-commons/{ => src}/allure_commons/py.typed | 0 allure-python-commons/{ => src}/allure_commons/reporter.py | 0 allure-python-commons/{ => src}/allure_commons/types.py | 0 allure-python-commons/{ => src}/allure_commons/utils.py | 0 15 files changed, 1 insertion(+) rename allure-python-commons/{ => src}/allure/__init__.py (100%) rename allure-python-commons/{ => src}/allure/py.typed (100%) rename allure-python-commons/{ => src}/allure_commons/__init__.py (100%) rename allure-python-commons/{ => src}/allure_commons/_allure.py (100%) rename allure-python-commons/{ => src}/allure_commons/_core.py (100%) rename allure-python-commons/{ => src}/allure_commons/_hooks.py (100%) rename allure-python-commons/{ => src}/allure_commons/lifecycle.py (100%) rename allure-python-commons/{ => src}/allure_commons/logger.py (100%) rename allure-python-commons/{ => src}/allure_commons/mapping.py (100%) rename allure-python-commons/{ => src}/allure_commons/model2.py (100%) rename allure-python-commons/{ => src}/allure_commons/py.typed (100%) rename allure-python-commons/{ => src}/allure_commons/reporter.py (100%) rename allure-python-commons/{ => src}/allure_commons/types.py (100%) rename allure-python-commons/{ => src}/allure_commons/utils.py (100%) diff --git a/allure-python-commons/setup.py b/allure-python-commons/setup.py index f9422bf0..75bb2332 100644 --- a/allure-python-commons/setup.py +++ b/allure-python-commons/setup.py @@ -54,6 +54,7 @@ def main(): "allure": ["py.typed"], "allure_commons": ["py.typed"], }, + package_dir={"": "src"}, install_requires=install_requires, python_requires=">=3.6" ) diff --git a/allure-python-commons/allure/__init__.py b/allure-python-commons/src/allure/__init__.py similarity index 100% rename from allure-python-commons/allure/__init__.py rename to allure-python-commons/src/allure/__init__.py diff --git a/allure-python-commons/allure/py.typed b/allure-python-commons/src/allure/py.typed similarity index 100% rename from allure-python-commons/allure/py.typed rename to allure-python-commons/src/allure/py.typed diff --git a/allure-python-commons/allure_commons/__init__.py b/allure-python-commons/src/allure_commons/__init__.py similarity index 100% rename from allure-python-commons/allure_commons/__init__.py rename to allure-python-commons/src/allure_commons/__init__.py diff --git a/allure-python-commons/allure_commons/_allure.py b/allure-python-commons/src/allure_commons/_allure.py similarity index 100% rename from allure-python-commons/allure_commons/_allure.py rename to allure-python-commons/src/allure_commons/_allure.py diff --git a/allure-python-commons/allure_commons/_core.py b/allure-python-commons/src/allure_commons/_core.py similarity index 100% rename from allure-python-commons/allure_commons/_core.py rename to allure-python-commons/src/allure_commons/_core.py diff --git a/allure-python-commons/allure_commons/_hooks.py b/allure-python-commons/src/allure_commons/_hooks.py similarity index 100% rename from allure-python-commons/allure_commons/_hooks.py rename to allure-python-commons/src/allure_commons/_hooks.py diff --git a/allure-python-commons/allure_commons/lifecycle.py b/allure-python-commons/src/allure_commons/lifecycle.py similarity index 100% rename from allure-python-commons/allure_commons/lifecycle.py rename to allure-python-commons/src/allure_commons/lifecycle.py diff --git a/allure-python-commons/allure_commons/logger.py b/allure-python-commons/src/allure_commons/logger.py similarity index 100% rename from allure-python-commons/allure_commons/logger.py rename to allure-python-commons/src/allure_commons/logger.py diff --git a/allure-python-commons/allure_commons/mapping.py b/allure-python-commons/src/allure_commons/mapping.py similarity index 100% rename from allure-python-commons/allure_commons/mapping.py rename to allure-python-commons/src/allure_commons/mapping.py diff --git a/allure-python-commons/allure_commons/model2.py b/allure-python-commons/src/allure_commons/model2.py similarity index 100% rename from allure-python-commons/allure_commons/model2.py rename to allure-python-commons/src/allure_commons/model2.py diff --git a/allure-python-commons/allure_commons/py.typed b/allure-python-commons/src/allure_commons/py.typed similarity index 100% rename from allure-python-commons/allure_commons/py.typed rename to allure-python-commons/src/allure_commons/py.typed diff --git a/allure-python-commons/allure_commons/reporter.py b/allure-python-commons/src/allure_commons/reporter.py similarity index 100% rename from allure-python-commons/allure_commons/reporter.py rename to allure-python-commons/src/allure_commons/reporter.py diff --git a/allure-python-commons/allure_commons/types.py b/allure-python-commons/src/allure_commons/types.py similarity index 100% rename from allure-python-commons/allure_commons/types.py rename to allure-python-commons/src/allure_commons/types.py diff --git a/allure-python-commons/allure_commons/utils.py b/allure-python-commons/src/allure_commons/utils.py similarity index 100% rename from allure-python-commons/allure_commons/utils.py rename to allure-python-commons/src/allure_commons/utils.py From 9cfc24d5c8ee4bf0adb4d2ebe46faed883e52803 Mon Sep 17 00:00:00 2001 From: Maksim Stepanov <17935127+delatrie@users.noreply.github.com> Date: Wed, 2 Apr 2025 19:46:42 +0700 Subject: [PATCH 6/8] fix(commons): add None to dynamic.parameter mode typing --- allure-python-commons/src/allure_commons/_allure.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/allure-python-commons/src/allure_commons/_allure.py b/allure-python-commons/src/allure_commons/_allure.py index 4776f81b..b7bbe2a5 100644 --- a/allure-python-commons/src/allure_commons/_allure.py +++ b/allure-python-commons/src/allure_commons/_allure.py @@ -1,5 +1,5 @@ from functools import wraps -from typing import Any, Callable, TypeVar, overload +from typing import Any, Callable, TypeVar, Union, overload from allure_commons._core import plugin_manager from allure_commons.types import LabelType, LinkType, ParameterMode @@ -133,7 +133,7 @@ def link(url, link_type=LinkType.LINK, name=None): plugin_manager.hook.add_link(url=url, link_type=link_type, name=name) @staticmethod - def parameter(name, value, excluded=None, mode: ParameterMode = None): + def parameter(name, value, excluded=None, mode: Union[ParameterMode, None] = None): plugin_manager.hook.add_parameter(name=name, value=value, excluded=excluded, mode=mode) @staticmethod From 248e8ffe6da76cc943f9a5d189660009dcaabed1 Mon Sep 17 00:00:00 2001 From: Maksim Stepanov <17935127+delatrie@users.noreply.github.com> Date: Wed, 2 Apr 2025 20:46:58 +0700 Subject: [PATCH 7/8] chore(commons): fix known flake violations ignoring --- .flake8 | 3 +-- allure-python-commons/src/allure/__init__.py | 2 +- allure-python-commons/src/allure_commons/model2.py | 6 +++--- 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/.flake8 b/.flake8 index 70cbc719..af25e839 100644 --- a/.flake8 +++ b/.flake8 @@ -6,6 +6,5 @@ exclude = ./tests/allure_behave/acceptance/**/test-data/** ./tests/allure_behave/acceptance/behave_support/background/background_steps.py per-file-ignores = - ./allure-python-commons/src/model2.py:A003 - ./allure-python-commons/src/types.py:A005 + ./allure-python-commons/src/allure_commons/types.py:A005 ./allure-robotframework/src/listener/types.py:A005 diff --git a/allure-python-commons/src/allure/__init__.py b/allure-python-commons/src/allure/__init__.py index 4acb83e3..c30329a6 100644 --- a/allure-python-commons/src/allure/__init__.py +++ b/allure-python-commons/src/allure/__init__.py @@ -3,7 +3,7 @@ from allure_commons._allure import label from allure_commons._allure import severity from allure_commons._allure import tag -from allure_commons._allure import id +from allure_commons._allure import id # noqa: A004 from allure_commons._allure import suite, parent_suite, sub_suite from allure_commons._allure import epic, feature, story from allure_commons._allure import link, issue, testcase diff --git a/allure-python-commons/src/allure_commons/model2.py b/allure-python-commons/src/allure_commons/model2.py index e8fd330a..ccaf4459 100644 --- a/allure-python-commons/src/allure_commons/model2.py +++ b/allure-python-commons/src/allure_commons/model2.py @@ -53,7 +53,7 @@ class TestResult(ExecutableItem): @attrs class TestStepResult(ExecutableItem): - id = attrib(default=None) + id = attrib(default=None) # noqa: A003 @attrs @@ -82,7 +82,7 @@ class Label: @attrs class Link: - type = attrib(default=None) + type = attrib(default=None) # noqa: A003 url = attrib(default=None) name = attrib(default=None) @@ -99,7 +99,7 @@ class StatusDetails: class Attachment: name = attrib(default=None) source = attrib(default=None) - type = attrib(default=None) + type = attrib(default=None) # noqa: A003 class Status: From 12a7df4966666797a1a8987e422b93315868cdb5 Mon Sep 17 00:00:00 2001 From: Maksim Stepanov <17935127+delatrie@users.noreply.github.com> Date: Wed, 2 Apr 2025 20:47:31 +0700 Subject: [PATCH 8/8] test(commons): fix tests command --- allure-python-commons/pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/allure-python-commons/pyproject.toml b/allure-python-commons/pyproject.toml index 2cf00cbc..9fd4df26 100644 --- a/allure-python-commons/pyproject.toml +++ b/allure-python-commons/pyproject.toml @@ -1,3 +1,3 @@ [tool.poe.tasks] linter = "flake8 --extend-ignore=A001,A002,A003 ./src" -tests = "python -m doctest ./src/*.py" +tests = "python -m doctest ./src/allure_commons/*.py"