sqlalchemyseed 1.0.5__tar.gz → 1.0.7__tar.gz

{sqlalchemyseed-1.0.5/src/sqlalchemyseed.egg-info → sqlalchemyseed-1.0.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sqlalchemyseed
-Version: 1.0.5
+Version: 1.0.7
 Summary: SQLAlchemy Seeder
 Home-page: https://github.com/jedymatt/sqlalchemyseed
 Author: Jedy Matt Tabasco
@@ -10,7 +10,6 @@ Project-URL: Documentation, https://sqlalchemyseed.readthedocs.io/
 Project-URL: Source, https://github.com/jedymatt/sqlalchemyseed
 Project-URL: Tracker, https://github.com/jedymatt/sqlalchemyseed/issues
 Keywords: sqlalchemy,orm,seed,seeder,json,yaml
-Platform: UNKNOWN
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
@@ -20,7 +19,6 @@ Classifier: Programming Language :: Python :: 3.10
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 Provides-Extra: yaml
-Provides-Extra: docs
 License-File: LICENSE
 
 # sqlalchemyseed
@@ -28,7 +26,7 @@ License-File: LICENSE
 [![PyPI](https://img.shields.io/pypi/v/sqlalchemyseed)](https://pypi.org/project/sqlalchemyseed)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sqlalchemyseed)](https://pypi.org/project/sqlalchemyseed)
 [![PyPI - License](https://img.shields.io/pypi/l/sqlalchemyseed)](https://github.com/jedymatt/sqlalchemyseed/blob/main/LICENSE)
-[![Build Status](https://app.travis-ci.com/jedymatt/sqlalchemyseed.svg?branch=main)](https://app.travis-ci.com/jedymatt/sqlalchemyseed)
+[![Python package](https://github.com/jedymatt/sqlalchemyseed/actions/workflows/python-package.yml/badge.svg)](https://github.com/jedymatt/sqlalchemyseed/actions/workflows/python-package.yml)
 [![Maintainability](https://api.codeclimate.com/v1/badges/2ca97c98929b614658ea/maintainability)](https://codeclimate.com/github/jedymatt/sqlalchemyseed/maintainability)
 [![codecov](https://codecov.io/gh/jedymatt/sqlalchemyseed/branch/main/graph/badge.svg?token=W03MFZ2FAG)](https://codecov.io/gh/jedymatt/sqlalchemyseed)
 [![Documentation Status](https://readthedocs.org/projects/sqlalchemyseed/badge/?version=latest)](https://sqlalchemyseed.readthedocs.io/en/latest/?badge=latest)
@@ -51,8 +49,9 @@ pip install sqlalchemyseed
 
 ## Quickstart
 
+main.py
+
 ```python
-# main.py
 from sqlalchemyseed import load_entities_from_json
 from sqlalchemyseed import Seeder
 from db import session
@@ -70,8 +69,69 @@ seeder.seed(entities)
 session.commit()  # or seeder.session.commit()
 ```
 
+data.json
+
+```json
+{
+    "model": "models.Person",
+    "data": [
+        {
+            "name": "John March",
+            "age": 23
+        },
+        {
+            "name": "Juan Dela Cruz",
+            "age": 21
+        }
+    ]
+}
+```
+
 ## Documentation
 
 <https://sqlalchemyseed.readthedocs.io/>
 
+## Found Bug?
+
+Report here in this link:
+<https://github.com/jedymatt/sqlalchemyseed/issues>
+
+## Want to contribute?
+
+First, Clone this [repository](https://github.com/jedymatt/sqlalchemyseed).
+
+### Install dev dependencies
+
+Inside the folder, paste this in the terminal to install necessary dependencies:
+
+```shell
+pip install -r requirements.txt -r docs/requirements.txt
+```
+
+Note: make sure you have the virtual environment and enabled, or if you are using vs code and docker then you can simply re-open this as container.
+
+### Run tests
+
+Before running tests, make sure that the package is installed as editable:
 
+```shell
+python setup.py develop --user
+```
+
+Then run the test:
+
+```shell
+pytest tests
+```
+
+Run test with coverage
+
+```shell
+coverage run -m pytest
+```
+
+Autobuild documentation
+
+```shell
+sphinx-autobuild docs docs/_build/html
+```

{sqlalchemyseed-1.0.5 → sqlalchemyseed-1.0.7}/README.md

@@ -3,7 +3,7 @@
 [![PyPI](https://img.shields.io/pypi/v/sqlalchemyseed)](https://pypi.org/project/sqlalchemyseed)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sqlalchemyseed)](https://pypi.org/project/sqlalchemyseed)
 [![PyPI - License](https://img.shields.io/pypi/l/sqlalchemyseed)](https://github.com/jedymatt/sqlalchemyseed/blob/main/LICENSE)
-[![Build Status](https://app.travis-ci.com/jedymatt/sqlalchemyseed.svg?branch=main)](https://app.travis-ci.com/jedymatt/sqlalchemyseed)
+[![Python package](https://github.com/jedymatt/sqlalchemyseed/actions/workflows/python-package.yml/badge.svg)](https://github.com/jedymatt/sqlalchemyseed/actions/workflows/python-package.yml)
 [![Maintainability](https://api.codeclimate.com/v1/badges/2ca97c98929b614658ea/maintainability)](https://codeclimate.com/github/jedymatt/sqlalchemyseed/maintainability)
 [![codecov](https://codecov.io/gh/jedymatt/sqlalchemyseed/branch/main/graph/badge.svg?token=W03MFZ2FAG)](https://codecov.io/gh/jedymatt/sqlalchemyseed)
 [![Documentation Status](https://readthedocs.org/projects/sqlalchemyseed/badge/?version=latest)](https://sqlalchemyseed.readthedocs.io/en/latest/?badge=latest)
@@ -26,8 +26,9 @@ pip install sqlalchemyseed
 
 ## Quickstart
 
+main.py
+
 ```python
-# main.py
 from sqlalchemyseed import load_entities_from_json
 from sqlalchemyseed import Seeder
 from db import session
@@ -45,6 +46,69 @@ seeder.seed(entities)
 session.commit()  # or seeder.session.commit()
 ```
 
+data.json
+
+```json
+{
+    "model": "models.Person",
+    "data": [
+        {
+            "name": "John March",
+            "age": 23
+        },
+        {
+            "name": "Juan Dela Cruz",
+            "age": 21
+        }
+    ]
+}
+```
+
 ## Documentation
 
 <https://sqlalchemyseed.readthedocs.io/>
+
+## Found Bug?
+
+Report here in this link:
+<https://github.com/jedymatt/sqlalchemyseed/issues>
+
+## Want to contribute?
+
+First, Clone this [repository](https://github.com/jedymatt/sqlalchemyseed).
+
+### Install dev dependencies
+
+Inside the folder, paste this in the terminal to install necessary dependencies:
+
+```shell
+pip install -r requirements.txt -r docs/requirements.txt
+```
+
+Note: make sure you have the virtual environment and enabled, or if you are using vs code and docker then you can simply re-open this as container.
+
+### Run tests
+
+Before running tests, make sure that the package is installed as editable:
+
+```shell
+python setup.py develop --user
+```
+
+Then run the test:
+
+```shell
+pytest tests
+```
+
+Run test with coverage
+
+```shell
+coverage run -m pytest
+```
+
+Autobuild documentation
+
+```shell
+sphinx-autobuild docs docs/_build/html
+```

{sqlalchemyseed-1.0.5 → sqlalchemyseed-1.0.7}/pyproject.toml

@@ -3,4 +3,4 @@ requires = [
     "setuptools>=42",
     "wheel"
 ]
-build-backend = "setuptools.build_meta"
+build-backend = "setuptools.build_meta"

{sqlalchemyseed-1.0.5 → sqlalchemyseed-1.0.7}/setup.cfg

@@ -8,7 +8,8 @@ url = https://github.com/jedymatt/sqlalchemyseed
 author = Jedy Matt Tabasco
 author_email = jedymatt@gmail.com
 license = MIT
-license_file = LICENSE
+license_files = 
+	LICENSE
 classifiers = 
 	License :: OSI Approved :: MIT License
 	Programming Language :: Python :: 3.6
@@ -27,7 +28,7 @@ packages = find:
 package_dir = 
 	=src
 install_requires = 
-	SQLAlchemy>=1.4
+	SQLAlchemy>=1.4,<2.0
 python_requires = >=3.6
 
 [options.packages.find]
@@ -36,9 +37,6 @@ where = src
 [options.extras_require]
 yaml = 
 	PyYAML>=5.4
-docs = 
-	sphinx-rtd-theme>=1.0
-	sphinx>=4.2
 
 [egg_info]
 tag_build = 

{sqlalchemyseed-1.0.5 → sqlalchemyseed-1.0.7}/setup.py

@@ -1,4 +1,4 @@
-from setuptools import setup
-
-
-setup()
+from setuptools import setup
+
+
+setup()

sqlalchemyseed-1.0.7/src/sqlalchemyseed/__init__.py

@@ -0,0 +1,17 @@
+"""
+SQLAlchemy seeder that supports nested relationships with an easy to read text files.
+"""
+
+from .seeder import HybridSeeder
+from .seeder import Seeder
+from .loader import load_entities_from_json
+from .loader import load_entities_from_yaml
+from .loader import load_entities_from_csv
+from . import util
+from . import attribute
+
+
+__version__ = "1.0.7"
+
+if __name__ == '__main__':
+    pass

sqlalchemyseed-1.0.7/src/sqlalchemyseed/attribute.py

@@ -0,0 +1,70 @@
+"""
+attribute module containing helper functions for instrumented attribute.
+"""
+
+from functools import lru_cache
+from inspect import isclass
+
+from sqlalchemy.orm import ColumnProperty, RelationshipProperty
+from sqlalchemy.orm.attributes import InstrumentedAttribute, get_attribute, set_attribute
+
+
+def instrumented_attribute(class_or_instance, key: str):
+    """
+    Returns instrumented attribute from the class or instance.
+    """
+
+    if isclass(class_or_instance):
+        return getattr(class_or_instance, key)
+
+    return getattr(class_or_instance.__class__, key)
+
+
+def attr_is_relationship(instrumented_attr: InstrumentedAttribute):
+    """
+    Check if instrumented attribute property is a RelationshipProperty
+    """
+    return isinstance(instrumented_attr.property, RelationshipProperty)
+
+
+def attr_is_column(instrumented_attr: InstrumentedAttribute):
+    """
+    Check if instrumented attribute property is a ColumnProperty
+    """
+    return isinstance(instrumented_attr.property, ColumnProperty)
+
+
+def set_instance_attribute(instance, key, value):
+    """
+    Set attribute value of instance
+    """
+
+    instr_attr: InstrumentedAttribute = getattr(instance.__class__, key)
+
+    if attr_is_relationship(instr_attr) and instr_attr.property.uselist:
+        get_attribute(instance, key).append(value)
+    else:
+        set_attribute(instance, key, value)
+
+@lru_cache()
+def foreign_key_column(instrumented_attr: InstrumentedAttribute):
+    """
+    Returns the table name of the first foreignkey.
+    """
+    return next(iter(instrumented_attr.foreign_keys)).column
+
+@lru_cache()
+def referenced_class(instrumented_attr: InstrumentedAttribute):
+    """
+    Returns class that the attribute is referenced to.
+    """
+
+    if attr_is_relationship(instrumented_attr):
+        return instrumented_attr.mapper.class_
+
+    table_name = foreign_key_column(instrumented_attr).table.name
+
+    return next(filter(
+        lambda mapper: mapper.class_.__tablename__ == table_name,
+        instrumented_attr.parent.registry.mappers
+    )).class_

sqlalchemyseed-1.0.7/src/sqlalchemyseed/constants.py

@@ -0,0 +1,4 @@
+MODEL_KEY = 'model'
+DATA_KEY = 'data'
+FILTER_KEY = 'filter'
+SOURCE_KEYS = [DATA_KEY, FILTER_KEY]

sqlalchemyseed-1.0.7/src/sqlalchemyseed/dynamic_seeder.py

@@ -0,0 +1,4 @@
+class DynamicSeeder:
+    """
+    DynamicSeeder class
+    """

{sqlalchemyseed-1.0.5 → sqlalchemyseed-1.0.7}/src/sqlalchemyseed/errors.py

@@ -1,43 +1,38 @@
 class ClassNotFoundError(Exception):
     """Raised when the class is not found"""
-    pass
 
 
 class MissingKeyError(Exception):
     """Raised when a required key is missing"""
-    pass
 
 
 class MaxLengthExceededError(Exception):
     """Raised when maximum length of data exceeded"""
-    pass
 
 
 class InvalidTypeError(Exception):
     """Raised when a type of data is not accepted"""
-    pass
 
 
 class EmptyDataError(Exception):
     """Raised when data is empty"""
-    pass
 
 
 class InvalidKeyError(Exception):
     """Raised when an invalid key is invoked"""
-    pass
 
 
 class ParseError(Exception):
     """Raised when parsing string fails"""
-    pass
 
 
 class UnsupportedClassError(Exception):
     """Raised when an unsupported class is invoked"""
-    pass
 
 
 class NotInModuleError(Exception):
     """Raised when a value is not found in module"""
-    pass
+
+
+class InvalidModelPath(Exception):
+    """Raised when an invalid model path is invoked"""

sqlalchemyseed-1.0.7/src/sqlalchemyseed/json.py

@@ -0,0 +1,168 @@
+from typing import Callable, List, Union
+
+
+class JsonWalker:
+    """
+    JsonWalker class
+    """
+
+    def __init__(self, json: Union[list, dict] = None) -> None:
+        self.path = []
+        self.root = json
+        self._current = json
+
+    @property
+    def json(self):
+        """
+        Returns current json
+        """
+        return self._current
+
+    def keys(self):
+        """
+        Returns list of keys either str or int
+        """
+        if self.json_is_dict:
+            return self._current.keys()
+
+        if self.json_is_list:
+            return list(map(lambda index: index, range(len(self._current))))
+
+        return []
+
+    @property
+    def current_key(self) -> Union[int, str]:
+        """
+        Returns the key of the current json
+        """
+        return self.path[-1]
+
+    def forward(self, keys: List[Union[int, str]]):
+        """
+        Move and replace current json forward.
+        Returns current json.
+        """
+
+        if len(keys) == 0:
+            return self._current
+
+        self._current = self.find_from_current(keys)
+        self.path.extend(keys)
+        return self._current
+
+    def backward(self):
+        """
+        Revert current json to its parent.
+        Returns reverted current json
+        """
+        if len(self.path) == 0:
+            raise ValueError('No parent found error')
+
+        self._current = self.find_from_root(self.path[:-1])
+        self.path.pop()
+
+    def find_from_current(self, keys: List[Union[int, str]]):
+        """
+        Find item from current json that correlates list of keys
+        """
+        return self._find(self._current, keys)
+
+    def _find(self, json: Union[list, dict], keys: List[Union[int, str]]):
+        """
+        Recursive call of finding item
+        """
+        return self._find(json[keys[0]], keys[1:]) if keys else json
+
+    def find_from_root(self, keys: List[Union[int, str]]):
+        """
+        Find item from the root json that correlates list of keys
+        """
+        return self._find(self.root, keys)
+
+    def reset(self, root=None):
+        """
+        Resets to initial state.
+        If root argument is supplied, self.root will be replaced.
+        """
+        if root is not None:
+            self.root = root
+
+        self._current = self.root
+        self.path.clear()
+
+    def exec_func_iter(self, func: Callable):
+        """
+        Executes function when iterating
+        """
+        current = self._current
+        if self.json_is_dict:
+            for key in current.keys():
+                self.forward([key])
+                func()
+                self.backward()
+        elif self.json_is_list:
+            for index in range(len(current)):
+                self.forward([index])
+                func()
+                self.backward()
+        else:
+            func()
+
+    def iter_as_list(self):
+        """
+        Iterates current as list.
+        Yields index and value.
+
+        Raises TypeError if current json is not list
+        """
+        if not self.json_is_list:
+            raise TypeError('json is not list')
+
+        current = self._current
+        for index, value in enumerate(current):
+            self.forward([index])
+            yield index, value
+            self.backward()
+
+    def iter_as_dict_items(self):
+        """
+        Iterates current as dict.
+        Yields key and value.
+
+        Raises TypeError if current json is not dict
+        """
+        if not self.json_is_dict:
+            raise TypeError('json is not dict')
+
+        current = self._current
+        for key, value in current.items():
+            self.forward([key])
+            yield key, value
+            self.backward()
+
+    @property
+    def json_is_dict(self):
+        """
+        Returns true if current json is dict
+        """
+        return isinstance(self._current, dict)
+
+    @property
+    def json_is_list(self):
+        """
+        Returns true if current json is list
+        """
+        return isinstance(self._current, list)
+
+
+def sort_json(json: Union[list, dict], reverse=False):
+    """
+    Sort json function
+    """
+    if isinstance(json, list):
+        return sorted(sorted(sort_json(item), reverse=reverse) for item in json)
+
+    if isinstance(json, dict):
+        return {key: sort_json(value, reverse=reverse) for key, value in json.items()}
+
+    return json

sqlalchemyseed-1.0.7/src/sqlalchemyseed/loader.py

@@ -0,0 +1,64 @@
+"""
+Text file loader module
+"""
+
+import csv
+import json
+import sys
+
+try:
+    import yaml
+except ModuleNotFoundError:  # pragma: no cover
+    pass
+
+
+def load_entities_from_json(json_filepath) -> dict:
+    """
+    Get entities from json
+    """
+    try:
+        with open(json_filepath, 'r', encoding='utf-8') as file:
+            entities = json.loads(file.read())
+    except FileNotFoundError as error:
+        raise FileNotFoundError from error
+
+    return entities
+
+
+def load_entities_from_yaml(yaml_filepath):
+    """
+    Get entities from yaml
+    """
+    if 'yaml' not in sys.modules:
+        raise ModuleNotFoundError(
+            'PyYAML is not installed and is required to run this function. '
+            'To use this function, py -m pip install "sqlalchemyseed[yaml]"'
+        )
+
+    try:
+        with open(yaml_filepath, 'r', encoding='utf-8') as file:
+            entities = yaml.load(file.read(), Loader=yaml.SafeLoader)
+    except FileNotFoundError as error:
+        raise FileNotFoundError from error
+
+    return entities
+
+
+def load_entities_from_csv(csv_filepath: str, model) -> dict:
+    """Load entities from csv file
+
+    :param csv_filepath: string csv file path
+    :param model: either str or class
+    :return: dict of entities
+    """
+    with open(csv_filepath, 'r', encoding='utf-8') as file:
+        source_data = list(
+            map(dict, csv.DictReader(file, skipinitialspace=True)))
+        if isinstance(model, str):
+            model_name = model
+        else:
+            model_name = '.'.join([model.__module__, model.__name__])
+
+        entities = {'model': model_name, 'data': source_data}
+
+    return entities