RecursiveNamespaceV2 0.0.2__tar.gz → 0.0.3__tar.gz

recursivenamespacev2-0.0.3/.gitignore

@@ -0,0 +1,172 @@
+# 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/
+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/
+cover/
+coverage*/
+
+# 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
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# uv
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This ensures reproducibility in CI and development environments.
+uv.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__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/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+out/

recursivenamespacev2-0.0.3/PKG-INFO

@@ -0,0 +1,157 @@
+Metadata-Version: 2.4
+Name: RecursiveNamespaceV2
+Version: 0.0.3
+Summary: Recursive Namespace. An extension of SimpleNamespace. Enhance get/set and parse from JSON
+Project-URL: homepage, https://github.com/pasxd245/RecursiveNamespaceV2
+Project-URL: repository, https://github.com/pasxd245/RecursiveNamespaceV2
+Author-email: VienPQ <pasxd245@gmail.com>
+License: MIT License
+        
+        Copyright (c) Jan.2025 VienPQ
+        
+        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: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Provides-Extra: dev
+Requires-Dist: pre-commit>=3.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: sphinx-rtd-theme>=2.0; extra == 'docs'
+Requires-Dist: sphinx>=7.0; extra == 'docs'
+Provides-Extra: test
+Requires-Dist: coverage>=7.0; extra == 'test'
+Requires-Dist: pytest>=6.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# RecursiveNamespaceV2
+
+[![CI](https://github.com/pasxd245/RecursiveNamespaceV2/workflows/CI/badge.svg)](https://github.com/pasxd245/RecursiveNamespaceV2/actions/workflows/ci.yml)
+[![Type Check](https://github.com/pasxd245/RecursiveNamespaceV2/workflows/Type%20Check/badge.svg)](https://github.com/pasxd245/RecursiveNamespaceV2/actions/workflows/type-check.yml)
+[![codecov](https://codecov.io/gh/pasxd245/RecursiveNamespaceV2/branch/main/graph/badge.svg)](https://codecov.io/gh/pasxd245/RecursiveNamespaceV2)
+[![Python Version](https://img.shields.io/pypi/pyversions/RecursiveNamespaceV2)](https://pypi.org/project/RecursiveNamespaceV2/)
+[![PyPI version](https://badge.fury.io/py/RecursiveNamespaceV2.svg)](https://badge.fury.io/py/RecursiveNamespaceV2)
+[![License](https://img.shields.io/github/license/pasxd245/RecursiveNamespaceV2)](https://github.com/pasxd245/RecursiveNamespaceV2/blob/main/LICENSE)
+[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+
+## Description
+
+**RecursiveNamespaceV2** extends Python's **SimpleNamespace** to make nested dicts easy to work with using attribute access, dict access, and chain-keys.
+
+Full documentation: [https://recursivenamespacev2.readthedocs.io/](https://recursivenamespacev2.readthedocs.io/)
+
+Key features:
+
+- Recursive conversion of nested dicts/lists
+- Attribute and dict access (`rn.a` and `rn["a"]`)
+- Chain-key access (`rn.val_get("a.b.c")`)
+- Array indexing and append syntax (`items[].0`, `items[].#`)
+- Typed, zero-dependency, pure Python
+
+## Installation
+
+```bash
+pip install RecursiveNamespaceV2
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add RecursiveNamespaceV2
+```
+
+For development from source:
+
+```bash
+git clone https://github.com/pasxd245/RecursiveNamespaceV2.git
+cd RecursiveNamespaceV2
+uv venv
+source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+uv pip install -e ".[test]"
+```
+
+## Quick Start
+
+```python
+from recursivenamespace import RNS  # or RecursiveNamespace
+
+data = {
+    'name': 'John',
+    'age': 30,
+    'address': {
+        'street': '123 Main St',
+        'city': 'Anytown'
+    },
+    'friends': ['Jane', 'Tom']
+}
+
+rn = RNS(data)
+print(rn.address.city)  # Anytown
+print(rn["friends"][1])  # Tom
+
+# Chain-key access
+rn.val_set("address.zip", "12345")
+print(rn.val_get("address.zip"))  # 12345
+
+# Convert back to dict
+data2 = rn.to_dict()
+print(data2["address"]["city"])  # Anytown
+```
+
+## Examples
+
+See the `examples/` directory for 15 runnable examples organized by difficulty (basic, intermediate, advanced, real-world).
+
+## Testing
+
+To run tests, navigate to the project's root directory and execute:
+
+```bash
+uv run pytest -s
+# or with coverage:
+uv run coverage run -m pytest
+# to generate html report:
+uv run coverage html
+```
+
+## Release
+
+Versions are derived automatically from **git tags** (via [hatch-vcs](https://github.com/ofek/hatch-vcs)):
+
+```bash
+git tag -a v1.2.3 -m "v1.2.3"
+git push --tags
+```
+
+CI automatically builds, publishes to PyPI (OIDC trusted publishing), and creates a GitHub Release with auto-generated notes.
+
+## Contributing
+
+Contributions to the **RecursiveNamespace** project are welcome! Please ensure that any pull requests include tests covering new features or fixes. See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+## License
+
+This project is licensed under the MIT License - see the `LICENSE` file for details.
+
+---
+
+## Transparency
+
+AI-assisted development (e.g., Claude Code, Copilot) was used for scaffolding and iteration.

recursivenamespacev2-0.0.3/README.md

@@ -0,0 +1,114 @@
+# RecursiveNamespaceV2
+
+[![CI](https://github.com/pasxd245/RecursiveNamespaceV2/workflows/CI/badge.svg)](https://github.com/pasxd245/RecursiveNamespaceV2/actions/workflows/ci.yml)
+[![Type Check](https://github.com/pasxd245/RecursiveNamespaceV2/workflows/Type%20Check/badge.svg)](https://github.com/pasxd245/RecursiveNamespaceV2/actions/workflows/type-check.yml)
+[![codecov](https://codecov.io/gh/pasxd245/RecursiveNamespaceV2/branch/main/graph/badge.svg)](https://codecov.io/gh/pasxd245/RecursiveNamespaceV2)
+[![Python Version](https://img.shields.io/pypi/pyversions/RecursiveNamespaceV2)](https://pypi.org/project/RecursiveNamespaceV2/)
+[![PyPI version](https://badge.fury.io/py/RecursiveNamespaceV2.svg)](https://badge.fury.io/py/RecursiveNamespaceV2)
+[![License](https://img.shields.io/github/license/pasxd245/RecursiveNamespaceV2)](https://github.com/pasxd245/RecursiveNamespaceV2/blob/main/LICENSE)
+[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+
+## Description
+
+**RecursiveNamespaceV2** extends Python's **SimpleNamespace** to make nested dicts easy to work with using attribute access, dict access, and chain-keys.
+
+Full documentation: [https://recursivenamespacev2.readthedocs.io/](https://recursivenamespacev2.readthedocs.io/)
+
+Key features:
+
+- Recursive conversion of nested dicts/lists
+- Attribute and dict access (`rn.a` and `rn["a"]`)
+- Chain-key access (`rn.val_get("a.b.c")`)
+- Array indexing and append syntax (`items[].0`, `items[].#`)
+- Typed, zero-dependency, pure Python
+
+## Installation
+
+```bash
+pip install RecursiveNamespaceV2
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add RecursiveNamespaceV2
+```
+
+For development from source:
+
+```bash
+git clone https://github.com/pasxd245/RecursiveNamespaceV2.git
+cd RecursiveNamespaceV2
+uv venv
+source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+uv pip install -e ".[test]"
+```
+
+## Quick Start
+
+```python
+from recursivenamespace import RNS  # or RecursiveNamespace
+
+data = {
+    'name': 'John',
+    'age': 30,
+    'address': {
+        'street': '123 Main St',
+        'city': 'Anytown'
+    },
+    'friends': ['Jane', 'Tom']
+}
+
+rn = RNS(data)
+print(rn.address.city)  # Anytown
+print(rn["friends"][1])  # Tom
+
+# Chain-key access
+rn.val_set("address.zip", "12345")
+print(rn.val_get("address.zip"))  # 12345
+
+# Convert back to dict
+data2 = rn.to_dict()
+print(data2["address"]["city"])  # Anytown
+```
+
+## Examples
+
+See the `examples/` directory for 15 runnable examples organized by difficulty (basic, intermediate, advanced, real-world).
+
+## Testing
+
+To run tests, navigate to the project's root directory and execute:
+
+```bash
+uv run pytest -s
+# or with coverage:
+uv run coverage run -m pytest
+# to generate html report:
+uv run coverage html
+```
+
+## Release
+
+Versions are derived automatically from **git tags** (via [hatch-vcs](https://github.com/ofek/hatch-vcs)):
+
+```bash
+git tag -a v1.2.3 -m "v1.2.3"
+git push --tags
+```
+
+CI automatically builds, publishes to PyPI (OIDC trusted publishing), and creates a GitHub Release with auto-generated notes.
+
+## Contributing
+
+Contributions to the **RecursiveNamespace** project are welcome! Please ensure that any pull requests include tests covering new features or fixes. See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+## License
+
+This project is licensed under the MIT License - see the `LICENSE` file for details.
+
+---
+
+## Transparency
+
+AI-assisted development (e.g., Claude Code, Copilot) was used for scaffolding and iteration.

recursivenamespacev2-0.0.3/pyproject.toml

@@ -0,0 +1,96 @@
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[project]
+name = 'RecursiveNamespaceV2'
+dynamic = ['version']
+description = 'Recursive Namespace. An extension of SimpleNamespace. Enhance get/set and parse from JSON'
+readme = 'README.md'
+authors = [{ name = 'VienPQ', email = 'pasxd245@gmail.com' }]
+license = { file = 'LICENSE' }
+requires-python = '>=3.8'
+dependencies = []
+classifiers = [
+    'Programming Language :: Python :: 3',
+    'License :: OSI Approved :: MIT License',
+    'Operating System :: OS Independent',
+]
+
+[project.urls]
+homepage = 'https://github.com/pasxd245/RecursiveNamespaceV2'
+repository = 'https://github.com/pasxd245/RecursiveNamespaceV2'
+
+[project.optional-dependencies]
+dev = ['pre-commit>=3.0']
+test = ['pytest>=6.0', 'coverage>=7.0']
+docs = ['sphinx>=7.0', 'sphinx-rtd-theme>=2.0']
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.version.raw-options]
+version_scheme = "guess-next-dev"
+local_scheme = "no-local-version"
+
+[tool.hatch.build.targets.sdist]
+include = ["src/recursivenamespace"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/recursivenamespace"]
+
+[tool.ruff]
+line-length = 80
+target-version = "py310"
+fix = true
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+addopts = "--strict-markers --strict-config --capture=no --durations=30 --junitxml=out/test-data.xml"
+testpaths = ["tests"]
+junit_family = "xunit2"
+
+[tool.coverage.run]
+branch = true
+
+[tool.coverage.report]
+ignore_errors = false
+show_missing = true
+exclude_lines = [
+    # Have to re-enable the standard pragma
+    "pragma: no cover",
+    # Don't complain about missing debug-only code:s
+    "def __repr__",
+    "if self.debug",
+    # Don't complain if tests don't hit defensive assertion code:
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "AbstractMethodError",
+    # Don't complain if non-runnable code isn't run:
+    "if 0:",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+]
+
+[tool.coverage.html]
+directory = "coverage_html_report"
+
+[tool.codespell]
+ignore-words-list = "rns"
+ignore-regex = 'https://([\w/\.])+'
+
+[tool.mypy]
+python_version = "3.9"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+disallow_untyped_decorators = false
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_no_return = true
+follow_imports = "normal"
+strict_equality = true
+strict = true

recursivenamespacev2-0.0.3/src/recursivenamespace/__init__.py

@@ -0,0 +1,23 @@
+from __future__ import annotations
+
+from .main import recursivenamespace
+from .main import recursivenamespace as RecursiveNamespace
+from .main import recursivenamespace as RNS
+from . import main as rns
+from .errors import GetChainKeyError, SerializationError, SetChainKeyError
+
+from importlib.metadata import version as _get_version
+
+__version__: str = _get_version("RecursiveNamespaceV2")
+del _get_version
+
+__all__ = [
+    "recursivenamespace",
+    "RecursiveNamespace",
+    "RNS",
+    "rns",
+    "GetChainKeyError",
+    "SerializationError",
+    "SetChainKeyError",
+    "__version__",
+]

recursivenamespacev2-0.0.3/src/recursivenamespace/errors.py

@@ -0,0 +1,27 @@
+"""Custom exception classes for RecursiveNamespaceV2."""
+
+from __future__ import annotations
+
+from typing import Any
+
+
+class SetChainKeyError(KeyError):
+    def __init__(self, obj: Any, key: str, sub_key: str) -> None:
+        super().__init__(
+            f"The object '{key}' typeof({type(obj)}) does not support"
+            f" set[] operator on chain-key '{sub_key}'."
+        )
+
+
+class GetChainKeyError(KeyError):
+    def __init__(self, obj: Any, key: str, sub_key: str) -> None:
+        super().__init__(
+            f"The object '{key}' typeof({type(obj)}) does not support"
+            f" get[] operator on chain-key '{sub_key}'."
+        )
+
+
+class SerializationError(Exception):
+    """Raised when serialization or deserialization fails."""
+
+    pass