iker-python-common 1.0.1__tar.gz

iker_python_common-1.0.1/.editorconfig

@@ -0,0 +1,80 @@
+root = true
+
+[*.py]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 4
+
+ij_python_align_collections_and_comprehensions = true
+ij_python_align_multiline_imports = true
+ij_python_align_multiline_parameters = true
+ij_python_align_multiline_parameters_in_calls = true
+ij_python_blank_line_at_file_end = true
+ij_python_blank_lines_after_imports = 1
+ij_python_blank_lines_after_local_imports = 0
+ij_python_blank_lines_around_class = 1
+ij_python_blank_lines_around_method = 1
+ij_python_blank_lines_around_top_level_classes_functions = 2
+ij_python_blank_lines_before_first_method = 0
+ij_python_call_parameters_new_line_after_left_paren = false
+ij_python_call_parameters_right_paren_on_new_line = false
+ij_python_call_parameters_wrap = normal
+ij_python_dict_alignment = 0
+ij_python_dict_new_line_after_left_brace = false
+ij_python_dict_new_line_before_right_brace = false
+ij_python_dict_wrapping = 1
+ij_python_from_import_new_line_after_left_parenthesis = false
+ij_python_from_import_new_line_before_right_parenthesis = false
+ij_python_from_import_parentheses_force_if_multiline = false
+ij_python_from_import_trailing_comma_if_multiline = false
+ij_python_from_import_wrapping = 1
+ij_python_hang_closing_brackets = false
+ij_python_keep_blank_lines_in_code = 1
+ij_python_keep_blank_lines_in_declarations = 1
+ij_python_keep_indents_on_empty_lines = false
+ij_python_keep_line_breaks = true
+ij_python_method_parameters_new_line_after_left_paren = false
+ij_python_method_parameters_right_paren_on_new_line = false
+ij_python_method_parameters_wrap = normal
+ij_python_new_line_after_colon = false
+ij_python_new_line_after_colon_multi_clause = true
+ij_python_optimize_imports_always_split_from_imports = false
+ij_python_optimize_imports_case_insensitive_order = false
+ij_python_optimize_imports_join_from_imports_with_same_source = false
+ij_python_optimize_imports_sort_by_type_first = true
+ij_python_optimize_imports_sort_imports = true
+ij_python_optimize_imports_sort_names_in_from_imports = true
+ij_python_space_after_comma = true
+ij_python_space_after_number_sign = true
+ij_python_space_after_py_colon = true
+ij_python_space_before_backslash = true
+ij_python_space_before_comma = false
+ij_python_space_before_for_semicolon = false
+ij_python_space_before_lbracket = false
+ij_python_space_before_method_call_parentheses = false
+ij_python_space_before_method_parentheses = false
+ij_python_space_before_number_sign = true
+ij_python_space_before_py_colon = false
+ij_python_space_within_empty_method_call_parentheses = false
+ij_python_space_within_empty_method_parentheses = false
+ij_python_spaces_around_additive_operators = true
+ij_python_spaces_around_assignment_operators = true
+ij_python_spaces_around_bitwise_operators = true
+ij_python_spaces_around_eq_in_keyword_argument = false
+ij_python_spaces_around_eq_in_named_parameter = false
+ij_python_spaces_around_equality_operators = true
+ij_python_spaces_around_multiplicative_operators = true
+ij_python_spaces_around_power_operator = true
+ij_python_spaces_around_relational_operators = true
+ij_python_spaces_around_shift_operators = true
+ij_python_spaces_within_braces = false
+ij_python_spaces_within_brackets = false
+ij_python_spaces_within_method_call_parentheses = false
+ij_python_spaces_within_method_parentheses = false
+ij_python_use_continuation_indent_for_arguments = false
+ij_python_use_continuation_indent_for_collection_and_comprehensions = false
+ij_python_use_continuation_indent_for_parameters = false
+ij_python_wrap_long_lines = false

iker_python_common-1.0.1/.github/workflows/pr.yml

@@ -0,0 +1,45 @@
+name: Pull Request
+
+on:
+  pull_request:
+    branches: [ "master" ]
+
+env:
+  BUILD_NUMBER: ${{ github.run_number }}
+
+jobs:
+  build-python311:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Build and Test
+        run: |
+          sudo apt-get install libxml2-dev libxslt1-dev llvm-14-dev
+          python -m pip install --upgrade pip
+          python -m pip install .[test]
+          python -m pytest . --cov --cov-config pyproject.toml
+
+  build-python312:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Build and Test
+        run: |
+          sudo apt-get install libxml2-dev libxslt1-dev llvm-14-dev
+          python -m pip install --upgrade pip
+          python -m pip install .[test]
+          python -m pytest . --cov --cov-config pyproject.toml

iker_python_common-1.0.1/.github/workflows/push.yml

@@ -0,0 +1,28 @@
+name: Push
+
+on:
+  push:
+    branches: [ "master" ]
+
+env:
+  BUILD_NUMBER: ${{ github.run_number }}
+
+jobs:
+  push:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Build and Upload
+        run: |
+          sudo apt-get install libxml2-dev libxslt1-dev llvm-14-dev
+          python -m pip install --upgrade pip build twine
+          python -m pip install .
+          python -m build -sw .
+          python -m twine upload --username __token__ --password ${{ secrets.PYPI_TOKEN }} dist/*

iker_python_common-1.0.1/.gitignore

@@ -0,0 +1,187 @@
+# System junks
+*.[oa]
+*~
+.DS_Store
+Thumbs.db
+
+# Git
+.git/
+
+# General
+target/
+output/
+build/
+opt/
+gen/
+tmp/
+temp/
+
+# IDEs
+*.iml
+.idea/
+.classpath
+.project
+.settings/
+.vscode/
+
+
+# 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/

iker_python_common-1.0.1/MANIFEST.in

@@ -0,0 +1 @@
+include VERSION

iker_python_common-1.0.1/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.1
+Name: iker-python-common
+Version: 1.0.1
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: <3.13,>=3.11
+Requires-Dist: boto3~=1.34
+Requires-Dist: brotli~=1.0
+Requires-Dist: docker~=7.1
+Requires-Dist: jsonpath-ng~=1.6
+Requires-Dist: jsonschema~=4.23
+Requires-Dist: llvmlite~=0.43
+Requires-Dist: lxml~=4.9
+Requires-Dist: munch~=4.0
+Requires-Dist: numpy~=2.1
+Requires-Dist: pandas~=2.2
+Requires-Dist: psycopg2-binary~=2.9
+Requires-Dist: pygeodesy~=23.12
+Requires-Dist: pymysql~=1.1
+Requires-Dist: pyparsing~=3.1
+Requires-Dist: pyquaternion~=0.9
+Requires-Dist: pysocks~=1.7
+Requires-Dist: python-dateutil~=2.8
+Requires-Dist: pyyaml~=6.0
+Requires-Dist: requests~=2.31
+Requires-Dist: scipy~=1.14
+Requires-Dist: shapely~=2.0
+Requires-Dist: sqlalchemy~=2.0
+Requires-Dist: ujson~=5.10
+Provides-Extra: test
+Requires-Dist: ddt~=1.7; extra == "test"
+Requires-Dist: moto[all,ec2,s3]~=4.2; extra == "test"
+Requires-Dist: pytest-cov~=5.0; extra == "test"
+Requires-Dist: pytest-mock~=3.14; extra == "test"
+Requires-Dist: pytest-mysql~=3.0; extra == "test"
+Requires-Dist: pytest-order~=1.2; extra == "test"
+Requires-Dist: pytest-postgresql~=6.0; extra == "test"
+Requires-Dist: pytest~=8.3; extra == "test"

iker_python_common-1.0.1/README.md

@@ -0,0 +1,25 @@
+# Iker's Python Common Module
+
+## Build and Deploy
+
+### Using Conda
+
+We recommend using Conda. You need to install Anaconda packages from
+the [official site](https://www.anaconda.com/products/distribution)
+
+Create a Conda environment and install the modules and their dependencies in it
+
+```shell
+conda create -n iker python=3.12
+conda activate iker
+
+pip install .
+
+conda deactivate
+```
+
+To remove the existing Conda environment (and create a brand new one)
+
+```shell
+conda env remove -n iker
+```

iker_python_common-1.0.1/VERSION

@@ -0,0 +1 @@
+1.0

iker_python_common-1.0.1/pyproject.toml

@@ -0,0 +1,72 @@
+[build-system]
+requires = [
+    "setuptools~=72.0",
+    "setuptools-scm~=8.0",
+    "iker-python-setup~=1.0",
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "iker-python-common"
+dynamic = ["version"]
+requires-python = ">=3.11,<3.13"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+    "boto3~=1.34",
+    "brotli~=1.0",
+    "docker~=7.1",
+    "jsonpath-ng~=1.6",
+    "jsonschema~=4.23",
+    "llvmlite~=0.43",
+    "lxml~=4.9",
+    "munch~=4.0",
+    "numpy~=2.1",
+    "pandas~=2.2",
+    "psycopg2-binary~=2.9",
+    "pygeodesy~=23.12",
+    "pymysql~=1.1",
+    "pyparsing~=3.1",
+    "pyquaternion~=0.9",
+    "pysocks~=1.7",
+    "python-dateutil~=2.8",
+    "pyyaml~=6.0",
+    "requests~=2.31",
+    "scipy~=1.14",
+    "shapely~=2.0",
+    "sqlalchemy~=2.0",
+    "ujson~=5.10",
+]
+
+[project.optional-dependencies]
+test = [
+    "ddt~=1.7",
+    "moto[ec2,s3,all]~=4.2",
+    "pytest-cov~=5.0",
+    "pytest-mock~=3.14",
+    "pytest-mysql~=3.0",
+    "pytest-order~=1.2",
+    "pytest-postgresql~=6.0",
+    "pytest~=8.3",
+]
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+zip-safe = false
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+namespaces = true
+
+[tool.pytest.ini_options]
+pythonpath = ["test"]
+
+[tool.coverage.run]
+include = [
+    "src/iker/common/*",
+    "*/site-packages/iker/common/*",
+]

iker_python_common-1.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

iker_python_common-1.0.1/setup.py

@@ -0,0 +1,13 @@
+import argparse
+
+from iker.setup import setup, version_string
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="setup script integrating dynamic version printer")
+    parser.add_argument("--print-version-string", action="store_true", help="print version string and exit")
+
+    args, _ = parser.parse_known_args()
+    if args.print_version_string:
+        print(version_string())
+    else:
+        setup()

iker_python_common-1.0.1/src/iker/common/__init__.py

@@ -0,0 +1,6 @@
+import importlib.metadata
+
+try:
+    __version__ = importlib.metadata.version("iker-python-common")
+except importlib.metadata.PackageNotFoundError:
+    __version__ = "unknown"

iker_python_common-1.0.1/src/iker/common/core/exceptions.py

@@ -0,0 +1,64 @@
+import traceback
+
+
+class BaseTraceableException(Exception):
+    """
+    Base class of traceable exceptions and errors
+    """
+
+    def __init__(self, message: str, *args, **kwargs):
+        super(BaseTraceableException, self).__init__()
+        self.message = message
+        self.args = args
+        self.cause = kwargs.get("cause")
+        self.traceback = "" if kwargs.get("cause") is None else traceback.format_exc()
+
+    def __str__(self) -> str:
+        return self.message % self.args
+
+    def __traceback(self):
+        if self.cause is None or not isinstance(self.cause, BaseTraceableException):
+            return self.traceback
+        return self.traceback + self.cause.__traceback()
+
+    @staticmethod
+    def format_traceback(error):
+        if isinstance(error, BaseTraceableException):
+            return traceback.format_exc() + error.__traceback()
+        return traceback.format_exc()
+
+
+class RuntimeException(BaseTraceableException):
+    """
+    Represents runtime exception
+    """
+
+    def __init__(self, message: str, *args, **kwargs):
+        super(RuntimeException, self).__init__(message, *args, **kwargs)
+
+
+class InvalidTypeException(BaseTraceableException):
+    """
+    Represents invalid type exception
+    """
+
+    def __init__(self, message: str, *args, **kwargs):
+        super(InvalidTypeException, self).__init__(message, *args, **kwargs)
+
+
+class InvalidKeyException(BaseTraceableException):
+    """
+    Represents invalid key exception
+    """
+
+    def __init__(self, message: str, *args, **kwargs):
+        super(InvalidKeyException, self).__init__(message, *args, **kwargs)
+
+
+class InvalidValueException(BaseTraceableException):
+    """
+    Represents invalid value exception
+    """
+
+    def __init__(self, message: str, *args, **kwargs):
+        super(InvalidValueException, self).__init__(message, *args, **kwargs)