RecursiveNamespaceV2 0.0.1__tar.gz

recursivenamespacev2-0.0.1/.env.sample

@@ -0,0 +1 @@
+PYTHONPATH=./src

recursivenamespacev2-0.0.1/.gitattributes

@@ -0,0 +1,2 @@
+_version.py export-subst
+src/recursivenamespace/_version.py export-subst

recursivenamespacev2-0.0.1/.github/workflows/publish.yml

@@ -0,0 +1,70 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build release distributions
+        run: |
+          # NOTE: put your own distribution build steps here.
+          python -m pip install flit
+          python -m flit build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      # url: https://pypi.org/p/YOURPROJECT
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

recursivenamespacev2-0.0.1/.gitignore

@@ -0,0 +1,176 @@
+# 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/
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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.1/.vscode/launch.json

@@ -0,0 +1,15 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python Debugger: Current File",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal"
+        }
+    ]
+}

recursivenamespacev2-0.0.1/LICENSE

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

recursivenamespacev2-0.0.1/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.3
+Name: RecursiveNamespaceV2
+Version: 0.0.1
+Summary: Recursive Namespace. An extension of SimpleNamespace. Enhance get/set and parse from JSON
+Author-email: VienPQ <pasxd245@gmail.com>
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Dist: pytest>=6.0 ; extra == "test"
+Requires-Dist: coverage>=7.0 ; extra == "test"
+Project-URL: repository, https://github.com/pasxd245/RecursiveNamespaceV2
+Provides-Extra: test
+
+# RecursiveNamespace
+
+## Description
+**RecursiveNamespace** is an extension of Python's **SimpleNamespace** that provides enhanced functionality for working with nested namespaces and dictionaries. This package allows easy access and manipulation of deeply nested data structures in an intuitive and Pythonic way.
+
+## Installation
+To install **RecursiveNamespaceV2** from PyPI use the following command.
+```bash
+pip install RecursiveNamespaceV2
+```
+
+If you want to use the github clone, use the following.
+```bash
+git clone https://github.com/pasxd245/RecursiveNamespaceV2.git
+cd RecursiveNamespaceV2
+python -m venv .venv  # to setup a virtual env.
+pip install -r .\requirements.txt
+```
+
+# Usage
+
+The **RecursiveNamespace** class can be used in the same way as Python's **SimpleNamespace** class, but in a recursive fashion. The **RecursiveNamespace** class can be instantiated with a dictionary or keyword arguments. The **RecursiveNamespace** class also provides a `to_dict()` method that returns a dictionary representation of the namespace.
+
+## Basic Usage
+One of the best use cases of this module is converting `dict` into a recursive namespace, and back to `dict`.
+Another usage is to convert a dictionary to a recursive namespace.
+
+```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(type(rn)) # <class 'recursivenamespace.main.recursivenamespace'>
+print(rn)       # RNS(name=John, age=30, address=RNS(street=123 Main St, city=Anytown))
+print(rn.name)  # John
+print(rn.address.city) # Anytown
+print(rn.friends[1])   # Tom, yes it does recognize iterables
+
+# convert back to dictionary
+data2 = rn.to_dict()
+print(type(data2)) # <class 'dict'>
+print(data2 == data) # True
+print(data2['address']['city']) # Anytown
+print(data2['friends'][1])      # Tom
+```
+
+You can use the key or namespace interchangeably
+```python
+print(rn.friends[1] is rn['friends'][1]) # True
+```
+
+
+You can also use it with YAML. 
+```python
+import yaml
+from recursivenamespace import RNS
+datatext = """
+name: John
+age: 30
+address:
+    street: 123 Main St
+    city: Anytown
+friends:
+    - Jane
+    - Tom
+"""
+data = yaml.safe_load(datatext)
+rn = RNS(data) 
+print(rn) # RNS(name=John, age=30, address=RNS(street=123 Main St, city=Anytown))
+
+# convert back to YAML
+data_yaml = yaml.dump(rn.to_dict())
+```
+
+Let's see other use cases. You can make a nested rns.
+```python
+from recursivenamespace import RNS
+results = RNS(
+    params=rns(
+        alpha=1.0,
+        beta=2.0,
+    ),
+    metrics=rns(
+        accuracy=98.79,
+        f1=97.62
+    )
+)
+```
+
+Access elements as dictionary keys or namespace attributes.
+```python
+print(results.params.alpha is results.params['alpha'])             # True
+print(results['metrics'].accuracy is  results.metrics['accuracy']) # True
+```
+
+Convert only the metrics to dictionary.
+```python
+metrics_dict = results.metrics.to_dict()
+print(metrics_dict) # {'accuracy': 98.79, 'f1': 97.62}
+```
+Or convert all to a nested dictionary.
+```python
+from pprint import pprint
+output_dict = results.to_dict()
+pprint(output_dict)
+# {'metrics': {'accuracy': 98.79, 'f1': 97.62},
+# 'params':  {'alpha': 1.0, 'beta': 2.0}}
+```
+Flatten the dictionary using a separator for keys.
+```python
+flat_dict = results.to_dict(flatten_sep='_')
+pprint(flat_dict)
+# {'metrics_accuracy': 98.79,
+#  'metrics_f1': 97.62,
+#  'params_alpha': 1.0,
+#  'params_beta': 2.0}
+```
+Add more fields on the fly.
+```python
+results.experiment_name = 'experiment_name'
+results.params.dataset_version = 'dataset_version'
+results.params.gamma = 0.35
+```
+
+The character '-' in a key will be converted to '_'
+```python
+results.params['some-key'] = 'some-value'
+print(results.params.some_key)                                  # some-value
+print(results.params['some-key'] is results.params.some_key)    # True
+print(results.params['some-key'] is results.params['some_key']) # True
+```
+
+# Testing
+To run tests, navigate to the project's root directory and execute:
+```bash
+pytest -s
+# or with coverage:
+coverage run -m pytest
+```
+
+The `test_recursive_namespace.py` file contains tests for the **RecursiveNamespace** class.
+
+# Contributing
+Contributions to the **RecursiveNamespace** project are welcome! Please ensure that any pull requests include tests covering new features or fixes.
+
+# License
+This project is licensed under the MIT License - see the `LICENSE` file for details.
+
+You should copy the actual content from examlpes scripts (founde under `./examples/` directory) and paste it into the respective sections of the README. This provides users with immediate examples of how to use your package. The Testing section explains how to run the unit tests, encouraging users to check that everything is working correctly.

recursivenamespacev2-0.0.1/README.md

@@ -0,0 +1,158 @@
+# RecursiveNamespace
+
+## Description
+**RecursiveNamespace** is an extension of Python's **SimpleNamespace** that provides enhanced functionality for working with nested namespaces and dictionaries. This package allows easy access and manipulation of deeply nested data structures in an intuitive and Pythonic way.
+
+## Installation
+To install **RecursiveNamespaceV2** from PyPI use the following command.
+```bash
+pip install RecursiveNamespaceV2
+```
+
+If you want to use the github clone, use the following.
+```bash
+git clone https://github.com/pasxd245/RecursiveNamespaceV2.git
+cd RecursiveNamespaceV2
+python -m venv .venv  # to setup a virtual env.
+pip install -r .\requirements.txt
+```
+
+# Usage
+
+The **RecursiveNamespace** class can be used in the same way as Python's **SimpleNamespace** class, but in a recursive fashion. The **RecursiveNamespace** class can be instantiated with a dictionary or keyword arguments. The **RecursiveNamespace** class also provides a `to_dict()` method that returns a dictionary representation of the namespace.
+
+## Basic Usage
+One of the best use cases of this module is converting `dict` into a recursive namespace, and back to `dict`.
+Another usage is to convert a dictionary to a recursive namespace.
+
+```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(type(rn)) # <class 'recursivenamespace.main.recursivenamespace'>
+print(rn)       # RNS(name=John, age=30, address=RNS(street=123 Main St, city=Anytown))
+print(rn.name)  # John
+print(rn.address.city) # Anytown
+print(rn.friends[1])   # Tom, yes it does recognize iterables
+
+# convert back to dictionary
+data2 = rn.to_dict()
+print(type(data2)) # <class 'dict'>
+print(data2 == data) # True
+print(data2['address']['city']) # Anytown
+print(data2['friends'][1])      # Tom
+```
+
+You can use the key or namespace interchangeably
+```python
+print(rn.friends[1] is rn['friends'][1]) # True
+```
+
+
+You can also use it with YAML. 
+```python
+import yaml
+from recursivenamespace import RNS
+datatext = """
+name: John
+age: 30
+address:
+    street: 123 Main St
+    city: Anytown
+friends:
+    - Jane
+    - Tom
+"""
+data = yaml.safe_load(datatext)
+rn = RNS(data) 
+print(rn) # RNS(name=John, age=30, address=RNS(street=123 Main St, city=Anytown))
+
+# convert back to YAML
+data_yaml = yaml.dump(rn.to_dict())
+```
+
+Let's see other use cases. You can make a nested rns.
+```python
+from recursivenamespace import RNS
+results = RNS(
+    params=rns(
+        alpha=1.0,
+        beta=2.0,
+    ),
+    metrics=rns(
+        accuracy=98.79,
+        f1=97.62
+    )
+)
+```
+
+Access elements as dictionary keys or namespace attributes.
+```python
+print(results.params.alpha is results.params['alpha'])             # True
+print(results['metrics'].accuracy is  results.metrics['accuracy']) # True
+```
+
+Convert only the metrics to dictionary.
+```python
+metrics_dict = results.metrics.to_dict()
+print(metrics_dict) # {'accuracy': 98.79, 'f1': 97.62}
+```
+Or convert all to a nested dictionary.
+```python
+from pprint import pprint
+output_dict = results.to_dict()
+pprint(output_dict)
+# {'metrics': {'accuracy': 98.79, 'f1': 97.62},
+# 'params':  {'alpha': 1.0, 'beta': 2.0}}
+```
+Flatten the dictionary using a separator for keys.
+```python
+flat_dict = results.to_dict(flatten_sep='_')
+pprint(flat_dict)
+# {'metrics_accuracy': 98.79,
+#  'metrics_f1': 97.62,
+#  'params_alpha': 1.0,
+#  'params_beta': 2.0}
+```
+Add more fields on the fly.
+```python
+results.experiment_name = 'experiment_name'
+results.params.dataset_version = 'dataset_version'
+results.params.gamma = 0.35
+```
+
+The character '-' in a key will be converted to '_'
+```python
+results.params['some-key'] = 'some-value'
+print(results.params.some_key)                                  # some-value
+print(results.params['some-key'] is results.params.some_key)    # True
+print(results.params['some-key'] is results.params['some_key']) # True
+```
+
+# Testing
+To run tests, navigate to the project's root directory and execute:
+```bash
+pytest -s
+# or with coverage:
+coverage run -m pytest
+```
+
+The `test_recursive_namespace.py` file contains tests for the **RecursiveNamespace** class.
+
+# Contributing
+Contributions to the **RecursiveNamespace** project are welcome! Please ensure that any pull requests include tests covering new features or fixes.
+
+# License
+This project is licensed under the MIT License - see the `LICENSE` file for details.
+
+You should copy the actual content from examlpes scripts (founde under `./examples/` directory) and paste it into the respective sections of the README. This provides users with immediate examples of how to use your package. The Testing section explains how to run the unit tests, encouraging users to check that everything is working correctly.

recursivenamespacev2-0.0.1/examples/basic_usage.py

@@ -0,0 +1,51 @@
+from pprint import pprint
+
+# from recursivenamespace import recursivenamespace
+# or
+from recursivenamespace import RNS
+
+# I prefer to use as the following
+results = RNS(
+    params=RNS(
+        alpha=1.0,
+        beta=2.0,
+    ),
+    metrics=RNS(accuracy=98.79, f1=97.62),
+)
+# I can access elements as dictionary keys or namespace attributes
+print(results.params.alpha)  # 1.0
+print(results.params["alpha"])  # 1.0
+print(results["metrics"].accuracy)  # 98.79
+
+
+# I can convert just the metrics to dictionary
+metrics_dict = results.metrics.to_dict()
+print(metrics_dict)  # {'accuracy': 98.79, 'f1': 97.62}
+
+# Or I can convert all of it to a nested dictionary
+output_dict = results.to_dict()
+pprint(output_dict)
+# {'metrics': {'accuracy': 98.79, 'f1': 97.62},
+#  'params':  {'alpha': 1.0, 'beta': 2.0}}
+
+# I can also flatten the keys using a separator
+flat_dict = results.to_dict(flatten_sep="_")
+pprint(flat_dict)
+# {'metrics_accuracy': 98.79,
+#  'metrics_f1': 97.62,
+#  'params_alpha': 1.0,
+#  'params_beta': 2.0}
+
+# I can add more fields on the fly
+results.experiment_name = "experiment_name"
+results.params.dataset_version = "dataset_version"
+results.params.gamma = 0.35
+
+# If I add a key that contains '-' it will be converted to '_'
+results.params["classifier-name"] = "some-random-classifier"
+print(results.params.classifier_name)  # some-random-classifier
+print(
+    results.params["classifier-name"]
+    == results.params["classifier-name"]
+    == results.params.classifier_name
+)  # True