mvx-common 0.2.1__tar.gz

mvx_common-0.2.1/.gitignore

@@ -0,0 +1,40 @@
+# Python bytecode
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Build artifacts
+build/
+dist/
+*.egg-info/
+.eggs/
+
+# Test / coverage artifacts
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+coverage.xml
+htmlcov/
+
+# Documentation build
+docs/_build/
+common/docs/_build/
+
+# IDE
+.idea/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Logs
+*.log
+
+# Local IDE/tool configs
+mypy_ide.ini

mvx_common-0.2.1/LICENSE

@@ -0,0 +1,42 @@
+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

mvx_common-0.2.1/NOTICE

@@ -0,0 +1,4 @@
+MVX Common
+Copyright 2026 Vladimir Makarov
+
+Licensed under the Apache License, Version 2.0.

mvx_common-0.2.1/PKG-INFO

@@ -0,0 +1,208 @@
+Metadata-Version: 2.4
+Name: mvx-common
+Version: 0.2.1
+Summary: Common utilities for MVX Python packages.
+Project-URL: Documentation, https://mvx-lib.readthedocs.io/en/latest/
+Project-URL: Source, https://github.com/makarovvvdream-dev/mvx-lib
+Project-URL: Issues, https://github.com/makarovvvdream-dev/mvx-lib/issues
+Project-URL: Changelog, https://mvx-lib.readthedocs.io/en/latest/common/version_history/
+Author: Vladimir Makarov
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.11
+Provides-Extra: dev
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-asyncio; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: enum-tools[sphinx]; extra == 'docs'
+Requires-Dist: myst-parser; extra == 'docs'
+Requires-Dist: sphinx-autodoc-typehints; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme; extra == 'docs'
+Requires-Dist: sphinx<9; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# MVX Common
+
+[![common-ci](https://github.com/makarovvvdream-dev/mvx-lib/actions/workflows/common-ci.yml/badge.svg)](https://github.com/makarovvvdream-dev/mvx-lib/actions/workflows/common-ci.yml)
+
+`mvx-common` is a Python package with foundation-level infrastructure for MVX Python projects.
+
+Its main public component is **MVX Logger**.
+
+MVX Logger is a lightweight structured event logging infrastructure for applications and reusable Python libraries that need rich and flexible diagnostic visibility.
+
+Most logging tools focus on formatting, routing, or collecting log records. MVX Logger focuses on the step before that: how code creates structured diagnostic events, controls their diagnostic data, and hands them over for delivery.
+
+## Key features
+
+* log structured events with rich, flexible, and structured diagnostic info instead of hand-written log strings
+* control logging width through event policies without changing calling code, focusing logs on current diagnostic needs
+* keep event diagnostic data well-shaped and clean through centralized payload normalization
+* change logging destination and formatting without changing event-producing code
+* deliver events to standard logging streams, files, async sinks, or custom backends
+* keep the logging path fast and thread-safe while slow backends are handled outside the business flow
+* log standardized business operation lifecycles without writing logging code inside the operation body
+* capture selected call arguments, results, errors, and context fields as structured event diagnostic info
+* keep business logic focused on the operation itself instead of repetitive try/except logging blocks
+* start using it almost as simply as regular logging, then move to deeper structured diagnostics when needed
+
+## What MVX Logger is not
+
+MVX Logger is not a replacement for `logging`, `structlog`, `loguru`, or OpenTelemetry.
+
+It is a structured event creation layer that can sit before those tools or other delivery backends.
+
+The goal is not to own the whole observability stack. The goal is to make diagnostic event creation explicit, structured, configurable, and safe to use across project boundaries.
+
+## Other utilities
+
+`mvx-common` also includes smaller foundation utilities used by MVX packages:
+
+```text
+structured errors
+public API error normalization helpers
+asyncio cancellation helpers
+```
+
+These utilities support predictable public errors, explicit cancellation behavior, and consistent diagnostics.
+
+## Requirements
+
+`mvx-common` requires Python 3.11 or newer.
+
+```text
+Python >= 3.11
+```
+
+## Installation for development
+
+From the package directory:
+
+```bash
+cd common
+python -m pip install -e ".[dev]"
+```
+
+To install documentation dependencies as well:
+
+```bash
+python -m pip install -e ".[dev,docs]"
+```
+
+## Running checks
+
+From the package directory:
+
+```bash
+scripts/check.sh
+```
+
+The check script runs:
+
+```text
+black --check
+ruff check
+mypy
+pytest with branch coverage
+```
+
+The package requires at least 90% branch coverage.
+
+## Documentation
+
+Full documentation:
+
+```text
+https://mvx-lib.readthedocs.io/en/latest/
+```
+
+MVX Logger overview:
+
+```text
+https://mvx-lib.readthedocs.io/en/latest/common/logger/overview.html
+```
+
+Getting started:
+
+```text
+https://mvx-lib.readthedocs.io/en/latest/common/logger/getting_started/
+```
+
+Advanced usage:
+
+```text
+https://mvx-lib.readthedocs.io/en/latest/common/logger/advanced_usage/
+```
+
+`log_invocation` guide:
+
+```text
+https://mvx-lib.readthedocs.io/en/latest/common/logger/log_components/log_invocation/overview.html
+```
+
+Version history:
+
+```text
+https://mvx-lib.readthedocs.io/en/latest/common/version_history/
+```
+
+## Building documentation
+
+From the repository root:
+
+```bash
+scripts/docs.sh
+```
+
+The built HTML documentation is written to:
+
+```text
+docs/_build/html/
+```
+
+## Project status
+
+This is an early public project.
+
+The implementation reflects the needs of the project at this stage. The code is covered with tests, CI checks, and documentation that describes both ordinary usage and extension points.
+
+Feedback, bug reports, documentation corrections, and practical feature requests are welcome.
+
+## Contributing
+
+Repository-level contribution rules are documented in:
+
+```text
+../CONTRIBUTING.md
+```
+
+## License
+
+`mvx-common` is licensed under the Apache License, Version 2.0.
+
+See:
+
+```text
+LICENSE
+NOTICE
+```
+
+## Author
+
+Vladimir Makarov
+
+Contact:
+
+```text
+makarovvv.dream@gmail.com
+```

mvx_common-0.2.1/README.md

@@ -0,0 +1,175 @@
+# MVX Common
+
+[![common-ci](https://github.com/makarovvvdream-dev/mvx-lib/actions/workflows/common-ci.yml/badge.svg)](https://github.com/makarovvvdream-dev/mvx-lib/actions/workflows/common-ci.yml)
+
+`mvx-common` is a Python package with foundation-level infrastructure for MVX Python projects.
+
+Its main public component is **MVX Logger**.
+
+MVX Logger is a lightweight structured event logging infrastructure for applications and reusable Python libraries that need rich and flexible diagnostic visibility.
+
+Most logging tools focus on formatting, routing, or collecting log records. MVX Logger focuses on the step before that: how code creates structured diagnostic events, controls their diagnostic data, and hands them over for delivery.
+
+## Key features
+
+* log structured events with rich, flexible, and structured diagnostic info instead of hand-written log strings
+* control logging width through event policies without changing calling code, focusing logs on current diagnostic needs
+* keep event diagnostic data well-shaped and clean through centralized payload normalization
+* change logging destination and formatting without changing event-producing code
+* deliver events to standard logging streams, files, async sinks, or custom backends
+* keep the logging path fast and thread-safe while slow backends are handled outside the business flow
+* log standardized business operation lifecycles without writing logging code inside the operation body
+* capture selected call arguments, results, errors, and context fields as structured event diagnostic info
+* keep business logic focused on the operation itself instead of repetitive try/except logging blocks
+* start using it almost as simply as regular logging, then move to deeper structured diagnostics when needed
+
+## What MVX Logger is not
+
+MVX Logger is not a replacement for `logging`, `structlog`, `loguru`, or OpenTelemetry.
+
+It is a structured event creation layer that can sit before those tools or other delivery backends.
+
+The goal is not to own the whole observability stack. The goal is to make diagnostic event creation explicit, structured, configurable, and safe to use across project boundaries.
+
+## Other utilities
+
+`mvx-common` also includes smaller foundation utilities used by MVX packages:
+
+```text
+structured errors
+public API error normalization helpers
+asyncio cancellation helpers
+```
+
+These utilities support predictable public errors, explicit cancellation behavior, and consistent diagnostics.
+
+## Requirements
+
+`mvx-common` requires Python 3.11 or newer.
+
+```text
+Python >= 3.11
+```
+
+## Installation for development
+
+From the package directory:
+
+```bash
+cd common
+python -m pip install -e ".[dev]"
+```
+
+To install documentation dependencies as well:
+
+```bash
+python -m pip install -e ".[dev,docs]"
+```
+
+## Running checks
+
+From the package directory:
+
+```bash
+scripts/check.sh
+```
+
+The check script runs:
+
+```text
+black --check
+ruff check
+mypy
+pytest with branch coverage
+```
+
+The package requires at least 90% branch coverage.
+
+## Documentation
+
+Full documentation:
+
+```text
+https://mvx-lib.readthedocs.io/en/latest/
+```
+
+MVX Logger overview:
+
+```text
+https://mvx-lib.readthedocs.io/en/latest/common/logger/overview.html
+```
+
+Getting started:
+
+```text
+https://mvx-lib.readthedocs.io/en/latest/common/logger/getting_started/
+```
+
+Advanced usage:
+
+```text
+https://mvx-lib.readthedocs.io/en/latest/common/logger/advanced_usage/
+```
+
+`log_invocation` guide:
+
+```text
+https://mvx-lib.readthedocs.io/en/latest/common/logger/log_components/log_invocation/overview.html
+```
+
+Version history:
+
+```text
+https://mvx-lib.readthedocs.io/en/latest/common/version_history/
+```
+
+## Building documentation
+
+From the repository root:
+
+```bash
+scripts/docs.sh
+```
+
+The built HTML documentation is written to:
+
+```text
+docs/_build/html/
+```
+
+## Project status
+
+This is an early public project.
+
+The implementation reflects the needs of the project at this stage. The code is covered with tests, CI checks, and documentation that describes both ordinary usage and extension points.
+
+Feedback, bug reports, documentation corrections, and practical feature requests are welcome.
+
+## Contributing
+
+Repository-level contribution rules are documented in:
+
+```text
+../CONTRIBUTING.md
+```
+
+## License
+
+`mvx-common` is licensed under the Apache License, Version 2.0.
+
+See:
+
+```text
+LICENSE
+NOTICE
+```
+
+## Author
+
+Vladimir Makarov
+
+Contact:
+
+```text
+makarovvv.dream@gmail.com
+```

mvx_common-0.2.1/pyproject.toml

@@ -0,0 +1,101 @@
+[project]
+name = "mvx-common"
+version = "0.2.1"
+description = "Common utilities for MVX Python packages."
+readme = "README.md"
+requires-python = ">=3.11"
+license = "Apache-2.0"
+license-files = ["LICENSE", "NOTICE"]
+authors = [
+    { name = "Vladimir Makarov" }
+]
+classifiers = [
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+dependencies = [
+]
+
+[project.urls]
+Documentation = "https://mvx-lib.readthedocs.io/en/latest/"
+Source = "https://github.com/makarovvvdream-dev/mvx-lib"
+Issues = "https://github.com/makarovvvdream-dev/mvx-lib/issues"
+Changelog = "https://mvx-lib.readthedocs.io/en/latest/common/version_history/"
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "pytest-asyncio",
+    "pytest-cov",
+    "ruff",
+    "black",
+    "mypy",
+]
+docs = [
+    "Sphinx<9",
+    "sphinx-rtd-theme",
+    "myst-parser",
+    "sphinx-autodoc-typehints",
+    "enum-tools[sphinx]",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/mvx"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+
+[tool.black]
+line-length = 100
+target-version = ["py311", "py312", "py313"]
+
+[tool.mypy]
+files = ["src"]
+python_version = "3.11"
+strict = false
+warn_unused_ignores = true
+warn_return_any = true
+disallow_untyped_defs = true
+ignore_missing_imports = true
+namespace_packages = true
+explicit_package_bases = true
+mypy_path = ["src"]
+
+[tool.ruff]
+line-length = 100
+src = ["src"]
+target-version = "py311"
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = [
+  "F841",
+  "S101",
+  "SLF001",
+  "PLR2004",
+  "D",
+  "ANN",
+  "ARG001",
+]
+
+[tool.coverage.run]
+branch = true
+source = ["src/mvx/common"]
+
+[tool.coverage.report]
+show_missing = true
+skip_covered = false
+fail_under = 90
+exclude_lines = [
+    "pragma: no cover",
+    "if TYPE_CHECKING:",
+    "if __name__ == .__main__.:",
+    "raise NotImplementedError",
+    "\\.\\.\\.",
+]

mvx_common-0.2.1/scripts/check.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+black --check src tests
+ruff check src tests
+mypy
+pytest --cov=mvx.common --cov-report=term-missing

mvx_common-0.2.1/scripts/format.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+black src tests
+ruff check src tests --fix

mvx_common-0.2.1/src/mvx/common/__init__.py

@@ -0,0 +1 @@
+# common/src/mvx/common/__init__.py

mvx_common-0.2.1/src/mvx/common/errors/__init__.py

@@ -0,0 +1,14 @@
+# common/src/mvx/common/errors/__init__.py
+
+from .structured_error import StructuredError
+from .reasoned_error import ReasonedError
+from .runtime_errors import RuntimeExtendedError, RuntimeUnexpectedError
+from .invalid_function_argument_error import InvalidFunctionArgumentError
+
+__all__ = (
+    "StructuredError",
+    "ReasonedError",
+    "RuntimeExtendedError",
+    "RuntimeUnexpectedError",
+    "InvalidFunctionArgumentError",
+)

mvx_common-0.2.1/src/mvx/common/errors/invalid_function_argument_error.py

@@ -0,0 +1,54 @@
+# common/src/mvx/common/errors/invalid_function_argument_error.py
+
+from __future__ import annotations
+from typing import Any, Mapping, Optional
+
+from .structured_error import StructuredError
+
+__all__ = ("InvalidFunctionArgumentError",)
+
+
+class InvalidFunctionArgumentError(StructuredError):
+    """
+    Error raised when a function argument fails validation.
+
+    Wraps an underlying validation exception and adds structured context about
+    the function, argument, offending value, and validation error type.
+
+    Args:
+        func: Function name where validation failed.
+        arg: Argument name that failed validation.
+        value: Offending argument value, when safe and useful to log.
+        cause: Underlying validation exception.
+        details: Additional log-friendly diagnostic context.
+    """
+
+    def __init__(
+        self,
+        *,
+        func: Optional[str],
+        arg: Optional[str],
+        value: Optional[Any] = None,
+        cause: Exception,
+        details: Optional[Mapping[str, Any]] = None,
+    ) -> None:
+        msg = f"invalid argument -> {str(cause)}"
+
+        func = func or "<unknown>"
+        arg = arg or "<unknown>"
+
+        base_details: dict[str, Any] = {
+            "func": func,
+            "arg": arg,
+            "error_type": type(cause).__name__,
+        }
+        if value is not None:
+            base_details["value"] = value
+        if details:
+            base_details.update(details)
+
+        super().__init__(
+            message=msg,
+            details=base_details,
+            cause=cause,
+        )