initial commit

Author: enesdogan00

.gitignore

@@ -0,0 +1,162 @@
+# 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
+
+# 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/#use-with-ide
+.pdm.toml
+
+# 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/
+
+.vscode/

README.md

@@ -0,0 +1,22 @@
+# Dot to Object
+
+This module is for converting dot notation strings like 'class.object.object' to actual Python objects. To use this module just initialize the class with your variables, usally locals(), then use the get method to obtain the object.
+Note that the get function will not raise an error if property is not found, it will just return ```None```. 
+
+
+## Installation
+```pip install dot_to_object```
+
+## Usage
+```python
+from dot_to_object import DottoObject
+
+dotto = DottoObject(locals())
+
+my_prop = dotto.get('my_class.my_prop')
+```
+
+
+## TODO
+- [ ] Make a setter function.
+- [ ] Write unit tests

dot_to_object/__init__.py

@@ -0,0 +1,3 @@
+from .dot_to_object import DottoObject
+
+__all__ = ('DottoObject',)

dot_to_object/dot_to_object.py

@@ -0,0 +1,30 @@
+#!/usr/bin/env python
+"""
+This module is for converting dot notation strings like 'class.object.object'
+to actual Python objects. To use this module just initialize the class with
+your variables, usally locals(), then use the get method to obtain the object.
+"""
+
+
+class DottoObject:
+    def __init__(self, variables):
+        self.vars = variables
+
+    def get(self, notation):
+        if not isinstance(notation, str):
+            raise TypeError('Notation must be a string.')
+
+        obj_gen = (obj for obj in notation.split('.'))
+        top_object = next(obj_gen)
+        try:
+            top_object = self.vars.get(top_object, None)
+        except AttributeError:  # if top object doesn't exist
+            top_object = None
+
+        for prop in obj_gen:
+            try:
+                top_object = getattr(top_object, prop)
+            except AttributeError:  # if property doesn't exist
+                top_object = None
+        
+        return top_object

setup.py

@@ -0,0 +1,20 @@
+"""Install packages as defined in this file into the Python environment."""
+from setuptools import setup, find_packages
+
+setup(
+    name="dot_to_object",
+    author="Enes Doğan",
+    author_email="enesdogan26@gmail.com",
+    url="https://github.com/enesdogan00/dot_to_object",
+    description="A module to return python objects from dot notation strings.",
+    version="0.0.1",
+    packages=find_packages(where=".", exclude=["tests"]),
+    install_requires=[
+        "setuptools>=45.0",
+    ],
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+)