From b5a8e2406358a5bc041f952215715e0768ab40d3 Mon Sep 17 00:00:00 2001 From: matveyvarg Date: Tue, 1 Aug 2023 20:07:11 +0200 Subject: [PATCH] init --- .coveragerc | 23 + .dockerignore | 292 ++++++++++++ .github/workflows/github-actions.yml | 233 +++++++++ .gitignore | 150 ++++++ .pre-commit-config.yaml | 156 +++++++ LICENSE | 674 +++++++++++++++++++++++++++ MANIFEST.in | 3 + README.md | 9 + deker_tools/__init__.py | 0 deker_tools/data.py | 15 + deker_tools/path.py | 56 +++ deker_tools/slices.py | 361 ++++++++++++++ deker_tools/time.py | 27 ++ docs/Makefile | 20 + docs/conf.py | 120 +++++ docs/index.rst | 59 +++ docs/make.bat | 35 ++ docs/source/api/data.rst | 8 + docs/source/api/modules.rst | 10 + docs/source/api/path.rst | 7 + docs/source/api/slices.rst | 7 + docs/source/api/time.rst | 7 + pyproject.toml | 96 ++++ requirements.txt | 1 + requirements_dev.txt | 21 + requirements_docs.txt | 2 + setup.cfg | 81 ++++ setup.py | 3 + tests/__init__.py | 0 tests/test_data.py | 16 + tests/test_path.py | 33 ++ tests/test_slices.py | 185 ++++++++ tox.ini | 36 ++ 33 files changed, 2746 insertions(+) create mode 100644 .coveragerc create mode 100644 .dockerignore create mode 100644 .github/workflows/github-actions.yml create mode 100644 .gitignore create mode 100644 .pre-commit-config.yaml create mode 100644 LICENSE create mode 100644 MANIFEST.in create mode 100644 README.md create mode 100644 deker_tools/__init__.py create mode 100644 deker_tools/data.py create mode 100644 deker_tools/path.py create mode 100644 deker_tools/slices.py create mode 100644 deker_tools/time.py create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/make.bat create mode 100755 docs/source/api/data.rst create mode 100644 docs/source/api/modules.rst create mode 100755 docs/source/api/path.rst create mode 100755 docs/source/api/slices.rst create mode 100755 docs/source/api/time.rst create mode 100644 pyproject.toml create mode 100644 requirements.txt create mode 100644 requirements_dev.txt create mode 100644 requirements_docs.txt create mode 100644 setup.cfg create mode 100644 setup.py create mode 100644 tests/__init__.py create mode 100644 tests/test_data.py create mode 100644 tests/test_path.py create mode 100644 tests/test_slices.py create mode 100644 tox.ini diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 0000000..81d1d08 --- /dev/null +++ b/.coveragerc @@ -0,0 +1,23 @@ +[run] +branch = True +omit = + tests/* + tmp.py + setup.py + +[html] +directory = tests/code_coverage + +[report] +fail_under=50 +exclude_lines = + no cov + pragma: no cover + if typing.TYPE_CHECKING: + if TYPE_CHECKING: + if __name__ == .__main__.: + pass + raise NotImplementedError + except ImportError + except ModuleNotFoundError + except Exception diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..06d6fe4 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,292 @@ +### JetBrains template +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider +# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 + +# User-specific stuff +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml +.idea/**/libraries + +# Gradle and Maven with auto-import +# When using Gradle or Maven with auto-import, you should exclude module files, +# since they will be recreated, and may cause churn. Uncomment if using +# auto-import. +# .idea/artifacts +# .idea/compiler.xml +# .idea/jarRepositories.xml +# .idea/modules.xml +# .idea/*.iml +# .idea/modules +# *.iml +# *.ipr + +# CMake +cmake-build-*/ + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# File-based project format +*.iws + +# IntelliJ +out/ + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + +# Editor-based Rest Client +.idea/httpRequests + +# Android studio 3.1+ serialized cache file +.idea/caches/build_file_checksums.ser + +### VirtualEnv template +# Virtualenv +# http://iamzed.com/2009/05/07/a-primer-on-virtualenv/ +.Python +[Bb]in +[Ii]nclude +[Ll]ib +[Ll]ib64 +[Ll]ocal +[Ss]cripts +pyvenv.cfg +.venv +pip-selfcheck.json + +### Eclipse template +.metadata +bin/ +tmp/ +*.tmp +*.bak +*.swp +*~.nib +local.properties +.settings/ +.loadpath +.recommenders + +# External tool builders +.externalToolBuilders/ + +# Locally stored "Eclipse launch configurations" +*.launch + +# PyDev specific (Python IDE for Eclipse) +*.pydevproject + +# CDT-specific (C/C++ Development Tooling) +.cproject + +# CDT- autotools +.autotools + +# Java annotation processor (APT) +.factorypath + +# PDT-specific (PHP Development Tools) +.buildpath + +# sbteclipse plugin +.target + +# Tern plugin +.tern-project + +# TeXlipse plugin +.texlipse + +# STS (Spring Tool Suite) +.springBeans + +# Code Recommenders +.recommenders/ + +# Annotation Processing +.apt_generated/ +.apt_generated_test/ + +# Scala IDE specific (Scala & Java development for Eclipse) +.cache-main +.scala_dependencies +.worksheet + +# Uncomment this line if you wish to ignore the project description file. +# Typically, this file would be tracked if it contains build/dependency configurations: +#.project + +### Python template +# 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 + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +*.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/ + +# YOUR IGNORINGS HERE +*/tmp.py diff --git a/.github/workflows/github-actions.yml b/.github/workflows/github-actions.yml new file mode 100644 index 0000000..cf4df44 --- /dev/null +++ b/.github/workflows/github-actions.yml @@ -0,0 +1,233 @@ +name: pipeline + +on: + push: + pull_request: + +env: + PYTHON_IMAGE: 3.9 + DOCKER_IMAGE: docker:20.10.23 + PYTHON_PACKAGE_NAME: deker_tools + DOCKER_REG_IMAGE: ${{ secrets.CI_REGISTRY_IMAGE }} + +jobs: + setup: + runs-on: ubuntu-latest + timeout-minutes: 60 + + steps: + - name: Checkout code + uses: actions/checkout@v2 + + - name: Set up Python + uses: actions/setup-python@v3 + with: + python-version: ${{ env.PYTHON_IMAGE }} + + - name: Install dependencies + run: | + pip install --upgrade pip + pip install virtualenv + virtualenv venv + source venv/bin/activate + pip install -r requirements.txt + pip install -r requirements_dev.txt + pip list + + - name: Cache virtual environment + uses: actions/cache@v2 + with: + path: venv + key: ${{ runner.os }}-venv-${{ env.PYTHON_IMAGE }}-${{ hashFiles('requirements.txt', 'requirements_dev.txt') }} + + linters: + needs: setup + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v2 + + - name: Set up Python + uses: actions/setup-python@v3 + with: + python-version: ${{ env.PYTHON_IMAGE }} + + - name: Load virtual environment + uses: actions/cache@v2 + with: + path: venv + key: ${{ runner.os }}-venv-${{ env.PYTHON_IMAGE }}-${{ hashFiles('requirements.txt', 'requirements_dev.txt') }} + + - name: Run linters and checks + run: | + source venv/bin/activate + isort ./${{ env.PYTHON_PACKAGE_NAME }} + black ./${{ env.PYTHON_PACKAGE_NAME }} + mypy ./${{ env.PYTHON_PACKAGE_NAME }} --install-types --non-interactive --config-file pyproject.toml + env: + PIP_DISABLE_PIP_VERSION_CHECK: 1 + + - name: Save linter reports + if: always() + uses: actions/upload-artifact@v2 + with: + name: linter-reports + path: report.xml + + tests: + needs: setup + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v2 + + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: ${{ env.PYTHON_IMAGE }} + + - name: Load virtual environment + uses: actions/cache@v2 + with: + path: venv + key: ${{ runner.os }}-venv-${{ env.PYTHON_IMAGE }}-${{ hashFiles('requirements.txt', 'requirements_dev.txt') }} + + - name: Run shuffled tests + run: | + source venv/bin/activate + pytest --random-order --junitxml=tests.xml + env: + PIP_DISABLE_PIP_VERSION_CHECK: 1 + + - name: Save test reports + if: always() + uses: actions/upload-artifact@v2 + with: + name: test-reports + path: tests.xml + + coverage: + needs: setup + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v2 + + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: ${{ env.PYTHON_IMAGE }} + + - name: Load virtual environment + uses: actions/cache@v2 + with: + path: venv + key: ${{ runner.os }}-venv-${{ env.PYTHON_IMAGE }}-${{ hashFiles('requirements.txt', 'requirements_dev.txt') }} + + - name: Run coverage + run: | + source venv/bin/activate + coverage run -m pytest --junitxml=report.xml + coverage report + coverage xml + env: + PIP_DISABLE_PIP_VERSION_CHECK: 1 + + - name: Save coverage reports + if: always() + uses: actions/upload-artifact@v2 + with: + name: coverage-reports + path: coverage.xml + + tox_tests: + needs: setup + runs-on: ubuntu-latest + if: startsWith(github.ref, 'refs/tags/v') + container: + image: ghcr.io/openweathermap/deker/deker-embedded/tox:latest + env: + PACKAGE_VERSION: ${{ github.REF_NAME }} + credentials: + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + steps: + - name: Set python versions + run: pyenv global 3.9 3.10 3.11 + + - name: Checkout code + uses: actions/checkout@v2 + - name: Install tox + run: | + pip install tox + env: + PIP_DISABLE_PIP_VERSION_CHECK: 1 + - name: Run tox tests + run: tox + env: + PIP_DISABLE_PIP_VERSION_CHECK: 1 + PACKAGE_VERSION: ${{ github.REF_NAME }} + + build_wheels: + name: Build wheels on ${{ matrix.os }} + needs: tox_tests + if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') + runs-on: ${{ matrix.os }} + env: + PACKAGE_VERSION: ${{ github.REF_NAME }} + strategy: + matrix: + os: [ubuntu-22.04] + + steps: + - uses: actions/checkout@v3 + + - name: Build wheels + run: | + pip wheel -w ./wheelhouse . + + + build_sdist: + needs: tox_tests + env: + PACKAGE_VERSION: ${{ github.REF_NAME }} + name: Build source distribution + if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + + - name: Build sdist + run: pipx run build --sdist + + - uses: actions/upload-artifact@v3 + with: + path: dist/*.tar.gz + + upload_pypi: + needs: [build_wheels, build_sdist] + runs-on: ubuntu-latest + permissions: + id-token: write + if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') + environment: + name: pypi + url: https://pypi.org/p/deker-tools + + steps: + - uses: actions/download-artifact@v3 + with: + # unpacks default artifact into dist/ + # if `name: artifact` is omitted, the action will create extra parent dir + name: artifact + path: dist + + - name: Publish package distributions to PyPI + uses: pypa/gh-action-pypi-publish@release/v1 + + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9f7f011 --- /dev/null +++ b/.gitignore @@ -0,0 +1,150 @@ +### Python template +# 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 + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +*.env +../*.env +../../*.env +.venv +env/ +venv/ +ENV/ +../ENV/ +../../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/ + +# YOUR IGNORINGS HERE +.idea/ +tests/code_coverage/ +*/tmp.py +deker_tools/tmp.py diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..b1ec974 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,156 @@ +# https://pre-commit.com/ + +default_stages: [ commit, push ] +default_language_version: +# python: python3.7 + python: python3.8 +# python: python3.9 +# python: python3.10 + +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.4.0 # Possible releases: https://github.com/pre-commit/pre-commit-hooks/releases + hooks: + - id: no-commit-to-branch + always_run: true + + - id: check-ast + always_run: true + + - id: check-json + always_run: true + + - id: pretty-format-json + always_run: true + args: [ --autofix, --indent=4 ] + + - id: check-toml + always_run: true + + - id: check-yaml + always_run: true + + - id: check-xml + always_run: true + + - id: fix-encoding-pragma + always_run: true + args: [ --remove ] + + - id: end-of-file-fixer + always_run: true + + - id: check-docstring-first + always_run: true + + - id: trailing-whitespace + exclude: .md$ + always_run: true + + - id: check-added-large-files + always_run: true + + - id: detect-private-key + always_run: true + + - id: detect-aws-credentials + always_run: true + args: [ --allow-missing-credentials ] + + - repo: https://github.com/bwhmather/ssort + rev: v0.11.6 # Possible releases: https://github.com/bwhmather/ssort/releases + hooks: + - id: ssort + entry: ssort + always_run: false + stages: + - commit + + - repo: https://github.com/pycqa/isort + rev: 5.12.0 # Possible releases: https://github.com/pycqa/isort/releases + hooks: + - id: isort + always_run: false + name: isort (python) + entry: isort + args: [ --profile=black ] + stages: + - commit + + - repo: https://github.com/hadialqattan/pycln + rev: v2.1.5 # Possible releases: https://github.com/hadialqattan/pycln/releases + hooks: + - id: pycln + args: [ --config=pyproject.toml ] + + - repo: https://github.com/psf/black + rev: 23.3.0 # Possible releases: https://github.com/psf/black/releases + hooks: + - id: black + always_run: false + stages: + - commit + + - repo: https://github.com/PyCQA/flake8 + rev: 6.0.0 # Possible releases: https://github.com/PyCQA/flake8/releases + hooks: + - id: flake8 + name: flake8 + files: ^deker_tools/ + always_run: false + additional_dependencies: + - flake8-bugbear + - flake8-pytest-style + - flake8-docstrings + - flake8-import-order + - darglint + stages: + - commit + + - repo: https://github.com/pre-commit/mirrors-mypy + rev: v1.3.0 # Possible releases: https://github.com/python/mypy/tags + hooks: + - id: mypy + name: mypy + files: ^deker_tools/ + always_run: false + args: [ + --install-types, + --non-interactive, + --no-strict-optional, + --ignore-missing-imports, + --scripts-are-modules, + --allow-redefinition, + --disallow-untyped-defs, + --no-implicit-optional, + --no-warn-no-return, + --warn-return-any, + --show-error-context, + --show-column-numbers, + --show-error-codes, + --no-color-output + ] + stages: + - commit + + - repo: local + hooks: + - id: pytest + name: pytest + entry: pytest + files: ^tests/ + language: system + pass_filenames: false + always_run: false + stages: + - push + + - id: doctest + name: doctest + entry: pytest --doctest-modules deker_tools/slices.py + files: ^tests/ + language: system + pass_filenames: false + always_run: false + stages: + - push diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..51cd401 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,3 @@ +include requirements.txt +include RELEASE-VERSION +include version.py diff --git a/README.md b/README.md new file mode 100644 index 0000000..62a4603 --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# Deker Tools + +Deker Tools is a utility package for the Deker project. It includes tools for working with data, paths, slices and time. + +## Installation +You can install the tools as a part of the Deker project. + +## Documentation +link diff --git a/deker_tools/__init__.py b/deker_tools/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/deker_tools/data.py b/deker_tools/data.py new file mode 100644 index 0000000..d685c08 --- /dev/null +++ b/deker_tools/data.py @@ -0,0 +1,15 @@ +import math + + +def convert_size_to_human(size_bytes: int) -> str: + """Convert bytes to human size. + + :param size_bytes: size in Bytes + """ + if size_bytes == 0: + return "0 B" + size_name = ("B", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB") + i = int(math.floor(math.log(size_bytes, 1024))) + p = math.pow(1024, i) + s = round(size_bytes / p, 2) + return f"{s} {size_name[i]}" diff --git a/deker_tools/path.py b/deker_tools/path.py new file mode 100644 index 0000000..f38bdb0 --- /dev/null +++ b/deker_tools/path.py @@ -0,0 +1,56 @@ +import errno +import os +import sys + +from pathlib import Path +from typing import Union + + +__all__ = ["is_empty", "is_path_valid"] + +Pathlike = Union[Path, str] + + +def is_empty(path: Pathlike) -> bool: + """Check if directory is empty. + + :param path: Path to check + """ + if isinstance(path, Path): + path = str(path) + + if not os.path.isdir(path): + raise IsADirectoryError(f"Path {path} is not a directory") + + with os.scandir(path) as iterator: + if any(iterator): + return False + return True + + +def is_path_valid(path: Pathlike) -> None: + """Check if directory path is valid. + + :param path: path to a directory + """ + if isinstance(path, Path): + path = str(path) + + if os.path.exists(path): + if not os.path.isdir(path): + raise IsADirectoryError(f"Path {path} is not a directory") + + _, path = os.path.splitdrive(path) + root_dirname = os.environ.get("HOMEDRIVE", "C:") if sys.platform == "win32" else os.path.sep + if not os.path.isdir(root_dirname): + raise IsADirectoryError(f"Path {root_dirname} is not a directory") + root_dirname = root_dirname.rstrip(os.path.sep) + os.path.sep + for part in path.split(os.path.sep): + try: + os.lstat(root_dirname + part) + except OSError as exc: + if hasattr(exc, "winerror"): + if exc.winerror == 123: + raise + elif exc.errno in {errno.ENAMETOOLONG, errno.ERANGE}: + raise diff --git a/deker_tools/slices.py b/deker_tools/slices.py new file mode 100644 index 0000000..196f263 --- /dev/null +++ b/deker_tools/slices.py @@ -0,0 +1,361 @@ +"""Tools for working with slices and index expressions.""" + +import builtins +import datetime +import re + +from typing import Iterable, List, Optional, Tuple, Union + +import numpy as np + +from numpy.lib.index_tricks import IndexExpression + + +__all__ = ["match_slice_size", "create_shape_from_slice", "slice_converter", "SliceConversionError"] + +Slice = Union[ # type: ignore[valid-type] + IndexExpression, slice, type(Ellipsis), int, Tuple[Union[slice, int, type(Ellipsis), None], ...] +] + +FancySlice = Union[ # type: ignore[valid-type] + IndexExpression, + slice, + type(Ellipsis), + int, + float, + str, + datetime.datetime, + Tuple[Union[slice, int, float, str, datetime.datetime, type(Ellipsis), None], ...], +] + + +def match_slice_size(dim_len: int, slice_: Optional[slice] = None) -> Tuple[int, int, int]: + """Convert slice into a sequence and get its length. + + :param dim_len: length of the corresponding Dimension + :param slice_: slice to be converted + """ + if slice_ is None: + start, stop, step = 0, dim_len, 1 + else: + start = 0 if slice_.start is None else (slice_.start if slice_.start >= 0 else dim_len + slice_.start) + stop = dim_len if slice_.stop is None else (slice_.stop if slice_.stop >= 0 else dim_len + slice_.stop) + step = 1 if slice_.step is None else slice_.step + return start, stop, step + + +# TODO: [Optimization] +def create_shape_from_slice( + array_shape: Tuple[int, ...], index_exp: Slice # type: ignore[valid-type] +) -> Tuple[int, ...]: + """Calculate shape of a subset from the index expression passed to __getitem__. + + :param array_shape: shape of the parent array + :param index_exp: index expression passed to the array __getitem__ method + """ + if ( + isinstance(index_exp, type(builtins.Ellipsis)) + or (isinstance(index_exp, slice) and index_exp == slice(None, None, None)) + or (isinstance(index_exp, tuple) and not index_exp) + ): + return array_shape + + index_exp: List[Optional[slice]] = list(np.index_exp[index_exp]) # type: ignore[arg-type] + + len_item: int = len(index_exp) + len_shape: int = len(array_shape) + + if len_item > len_shape: + raise IndexError(f"Too many indices for array: array is {len_shape}-dimensional, but {len_item} were indexed") + + if len_item < len_shape: + for _ in range(len_shape - len_item): + index_exp.append(slice(None, None, None)) + + exclude: List[int] = [] + if all(isinstance(i, (slice, type(builtins.Ellipsis), int)) for i in index_exp): + for n, i in enumerate(index_exp): # type: ignore[arg-type] + if isinstance(i, slice) and i.step is not None and i.step != 1: + raise IndexError("step should be equal to 1") + if isinstance(i, type(builtins.Ellipsis)): + index_exp[n] = slice(None, None, None) + if isinstance(i, int): + exclude.append(n) + if exclude: + exclude.sort() + exclude.reverse() + for p in exclude: + index_exp[p] = None # type: ignore[union-attr, index] + del exclude + shape = tuple( + len(tuple(range(*match_slice_size(array_shape[i], exp)))) for i, exp in enumerate(index_exp) if exp is not None + ) + + return shape + + +class SliceConversionError(Exception): + """If something goes wrong during slice conversion.""" + + pass + + +class _StringEscape(type): + """Sets escape symbol for string.""" + + _string_escape = "`" + + @classmethod + def _wrap_with_escape(cls, string: str) -> str: + """Enclose string with escape symbols. + + :param string: string to be wrapped + """ + return f"{cls._string_escape}{string}{cls._string_escape}" + + @classmethod + def _is_wrapped_with_escape(cls, string: str) -> bool: + """Check if string is wrapped with escape symbols. + + :param string: string to be checked + """ + return string.startswith(cls._string_escape) and string.endswith(cls._string_escape) + + @classmethod + def _unwrap(cls, string: str) -> str: + """Disclose string from escape symbols. + + :param string: string to be unwrapped + """ + return string.strip(cls._string_escape) + + +class _StringToSliceMixin(type, metaclass=_StringEscape): + """Converts string to slices.""" + + # maps default non-numeric slices values + _str_to_slice = {"None": None, "": None, "...": ..., "()": ()} + _isostring_regex = re.compile(r"(\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?((\+|-)(\d{2}:\d{2}))?)") + + @classmethod + def _process_string(cls, string: str) -> Optional[Union[int, float, str, slice]]: + """Validate and get value from string. + + :param string: string to be processed + """ + string = string.strip() + str_for_check = string + + # try to validate negative numbers + if string.startswith("-"): + str_for_check = string[1:] + + # check if string is None or ... + if str_for_check in cls._str_to_slice: + return cls._str_to_slice[string] # type: ignore[return-value] + + # check if string is empty + if str_for_check is False or str_for_check.isspace(): + return None + + # check if string is integer + if str_for_check.isdigit(): + return int(string) + + # check if string is float + if str_for_check.replace(".", "").isdigit(): + return float(string) + + if isinstance(str_for_check, str): + if cls._is_wrapped_with_escape(str_for_check): + if str_for_check.count(cls._string_escape) == 2: + str_for_check = cls._unwrap(str_for_check) + return str_for_check + + raise TypeError(f"Invalid unit '{string}' type: {type(string)}") + + @classmethod + def _convert_str_to_slice(cls, slice_string: str) -> slice: + """Convert a slice string to a slice object. + + :param slice_string: slice string to convert + """ + slice_parameters = [] + for i in slice_string.split(":"): + pos = cls._process_string(i.strip()) + slice_parameters.append(pos) + return slice(*slice_parameters) + + @classmethod + def _parse_datetime(cls, slice_string: str, match_list: list) -> Union[slice, str]: + """Parse datetime isostrings and convert them to a slice object. + + :param slice_string: initial slice string to convert + :param match_list: list of matched datetime isostrings to convert + """ + slice_string = slice_string.replace(cls._string_escape, "").strip() + slice_parameters = [i[0] for i in match_list if i] + length = 3 + slice_parameters_length = len(slice_parameters) + if len(slice_parameters) < length: + first: str = slice_parameters[0] + split_by_time = slice_string.split(first) + if len(slice_parameters) == 1 and ( + len(split_by_time) == 1 or (len(split_by_time) == 2 and all(not s for s in split_by_time)) + ): + return first + if not slice_string.startswith(first): + split = slice_string.split(first) + start = split[0].strip(cls._string_escape).strip(":").strip(cls._string_escape).strip() + slice_parameters.insert(0, cls._process_string(start)) + if split[-1] != split[0]: + step = split[-1].strip(cls._string_escape).strip(":").strip(cls._string_escape).strip() + slice_parameters.append(cls._process_string(step)) + else: + slice_parameters.extend(None for _ in range(length - slice_parameters_length)) + + return slice(*slice_parameters) + + @classmethod + def _str_to_slices(cls, slice_: str) -> FancySlice: # type: ignore[valid-type] + """Convert a slice string to a list of slices. + + :param slice_: string to convert + """ + # split the input string into slice strings and convert each one to a slice object + if not slice_.startswith("[") or not slice_.endswith("]"): + raise SliceConversionError(f"Invalid slice string: {slice_}; shall be enclosed in brackets: '[{slice_}]'") + slices_str_no_brackets: str = slice_[1:-1] + if not slices_str_no_brackets or slices_str_no_brackets.isspace(): + raise SliceConversionError(f"Invalid slice string: {slice_} is empty") + + slices_str = slices_str_no_brackets.split(",") + + res: list = [] + for slice_str in slices_str: + # check if string is an ordinary string, datetime or slice + # ":" may appear both in slices and datetime isostrings + if ":" in slice_str: + match = re.findall(cls._isostring_regex, slice_str) + if match: # dimension represents datetime + pos = cls._parse_datetime(slice_str, match) # type: ignore[assignment] + else: # all other dimensions represent any other values except time + pos = cls._convert_str_to_slice(slice_str) # type: ignore[assignment] + else: + pos = cls._process_string(slice_str) # type: ignore[assignment] + res.append(pos) + + return tuple(res) if len(res) != 1 else res[0] # type: ignore[no-any-return] + + +class _SliceToStringMixin(type, metaclass=_StringEscape): + """Converts indexes and slices to string.""" + + # maps default non-numeric slices values + _slice_to_str = {None: ":", ...: "...", (): "()"} + + @classmethod + def _slices_to_str(cls, slice_: Optional[FancySlice]) -> str: # type: ignore[valid-type] + """Convert a slice object(s) to a slice string. + + :param slice_: slice or slices tuple to convert + """ + + def convert_slice(_slice_: Optional[FancySlice]) -> str: # type: ignore[valid-type] + """Convert a slice object to a slice string. + + :param _slice_: slice to convert + """ + if _slice_ is None or _slice_ is Ellipsis: + return cls._slice_to_str[_slice_] + + slice_parameters = [] + if isinstance(_slice_, slice): + for attr in ("start", "stop", "step"): + el = getattr(_slice_, attr) + if isinstance(el, datetime.datetime): + el = cls._wrap_with_escape(el.isoformat()) + elif isinstance(el, str): + el = cls._wrap_with_escape(el) + slice_parameters.append(str(el)) + + slice_string = ":".join(slice_parameters).replace("None", "") + if slice_string.endswith(":"): + slice_string = slice_string[:-1] + return slice_string + + if isinstance(_slice_, str): + return cls._wrap_with_escape(_slice_) + if isinstance(_slice_, (int, float)): + return str(_slice_) + if isinstance(_slice_, datetime.datetime): + return cls._wrap_with_escape(_slice_.isoformat()) + + raise TypeError(f"Invalid unit '{_slice_}' type: {type(_slice_)}") + + if slice_ == (): + return f"[{cls._slice_to_str[slice_]}]" + + if isinstance(slice_, Iterable): + slice_strs = [convert_slice(sl) for sl in slice_] # type: ignore[union-attr] + return f"[{', '.join(slice_strs)}]" + return f"[{convert_slice(slice_)}]" + + +class _SliceConverter(_SliceToStringMixin, _StringToSliceMixin): + """Converts slices to string and vice versa. Check slice_converter class for interface.""" + + def __getitem__(cls, item: Union[FancySlice, str]) -> Union[str, FancySlice]: # type: ignore[valid-type] + """Call slices_to_str or str_to_slices depending on item type. + + :param item: item to convert + """ + try: + if isinstance(item, tuple) and item.count(...) > 1: + raise IndexError("An index can only have a single ellipsis ('...')") + if isinstance(item, str): + return cls._str_to_slices(item) + return cls._slices_to_str(item) + except Exception as e: + raise SliceConversionError(e) + + +class slice_converter(object, metaclass=_SliceConverter): # noqa: N801 + """Converts slices to string and vice versa. + + Standard index expressions + >>> slice_converter[5] + '[5]' + >>> slice_converter[1, :] + '[1, :]' + >>> slice_converter["[1, :]"] + (1, slice(None, None, None)) + + Index expressions with datetime and floats + >>> slice_converter[datetime.datetime(2023,1,1):datetime.datetime(2023,2,1), 0.1:0.9:0.05] + '[`2023-01-01T00:00:00`:`2023-02-01T00:00:00`, 0.1:0.9:0.05]' + >>> slice_converter["[`2023-01-01T00:00:00`:`2023-02-01T00:00:00`, 0.1:0.9:0.05]"] + (slice('2023-01-01T00:00:00', '2023-02-01T00:00:00', None), slice(0.1, 0.9, 0.05)) + + Timezone and microseconds are also acceptable + >>> slice_converter[datetime.datetime(2023,1,1,0,0,0,123456)] + '[`2023-01-01T00:00:00.123456`]' + >>> slice_converter['[`2023-01-01T00:00:00-03:30`]'] + '2023-01-01T00:00:00-03:30' + >>> slice_converter['[`2023-01-01T00:00:00.123456+05:00`]'] + '2023-01-01T00:00:00.123456+05:00' + + Index expressions with strings + >>> slice_converter["1a":"10b":"5c"] + '[`1a`:`10b`:`5c`]' + >>> slice_converter['[1a:10b:5c]'] + slice('1a', '10b', '5c') + >>> slice_converter["1":"10":"5.2"] + '[`1`:`10`:`5.2`]' + >>> slice_converter["1", "10", "5.2"] + '[`1`, `10`, `5.2`]' + >>> slice_converter['[`1`, `10`, `5.2`]'] + ('1', '10', '5.2') + >>> slice_converter['[`1`:`10`:`5.2`]'] + slice('1', '10', '5.2') + """ diff --git a/deker_tools/time.py b/deker_tools/time.py new file mode 100644 index 0000000..2317d61 --- /dev/null +++ b/deker_tools/time.py @@ -0,0 +1,27 @@ +from datetime import datetime, timezone +from typing import Optional, Union + + +def get_utc(dt: Optional[Union[str, int, float, datetime]] = None) -> datetime: + """Convert datetime with any timezone or without it to UTC. + + If dt is ``None`` - UTC current time will be returned + + :param dt: ``datetime.datetime`` object, timestamp, datetime iso-string or ``None``; + """ + if dt is None: + return datetime.utcnow().replace(tzinfo=timezone.utc) + + if isinstance(dt, datetime): + dt = dt.isoformat() # convert any timezone objects to native format + elif isinstance(dt, (float, int)): + dt = datetime.utcfromtimestamp(dt).isoformat() + + dt_object = datetime.fromisoformat(dt) + + if dt_object.tzinfo is None: + dt_object = dt_object.replace(tzinfo=timezone.utc) + elif dt_object.tzinfo != timezone.utc: + tm = dt_object.timestamp() + dt_object = datetime.utcfromtimestamp(tm).replace(tzinfo=timezone.utc) + return dt_object \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..3ae1ea4 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,120 @@ +#!/usr/bin/env python3 +# +# Deker documentation build configuration file, created by +# sphinx-quickstart on Sun Dec 25 18:07:21 2016. +# +# This file is execfile()d with the current directory set to its +# containing dir. + +import os +import sys + + +project = "Deker tools" +copyright = "2023, Openweather Ltd." +author = "Openweather Ltd." + +# Add support for auto-doc + +# Ensure that sanic is present in the path, to allow sphinx-apidoc to +# autogenerate documentation from docstrings +sys.path.insert(0, os.path.abspath("..")) + + +# -- General configuration ------------------------------------------------ + +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", + "m2r2", + "enum_tools.autoenum", +] + +templates_path = ["_templates"] + +# Enable support for both Restructured Text and Markdown +source_suffix = [".rst", ".md"] + +# The master toctree document. +master_doc = "index" + +# web page tab logo +# html_logo = "./_static/sanic-framework-logo-white-400x97.png" + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = "v1.0.0" +# The full version, including alpha/beta/rc tags. +release = version + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = "en" + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +# +# modules.rst is generated by sphinx-apidoc but is unused. This suppresses +# a warning about it. +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "modules.rst"] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx" + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = "sphinx_rtd_theme" +html_theme_options = { + "analytics_id": "G-XXXXXXXXXX", # Provided by Google in your dashboard + "analytics_anonymize_ip": False, + "logo_only": False, + "display_version": True, + "prev_next_buttons_location": "bottom", + "style_external_links": False, + "vcs_pageview_mode": "", + "style_nav_header_background": "white", + # Toc options + "collapse_navigation": True, + "sticky_navigation": True, + "navigation_depth": 4, + "includehidden": True, + "titles_only": False, +} +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] +# html_css_files = ["custom.css"] +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = "Dekerdoc" + +# -- Custom Settings ------------------------------------------------------- + +suppress_warnings = ["image.nonlocal_uri"] + + +autodoc_typehints = "description" +autodoc_default_options = { + "member-order": "groupwise", +} + +html_theme_options = { + "style_external_links": False, +} + +intersphinx_mapping = { + "deker": ("http://de1.owm.io:10000", None), +} diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..3e6404b --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,59 @@ +Deker Tools +=========== + +Deker Tools is a collection of utility functions and classes designed to assist in common data processing tasks. It consists of modules that handle data conversion, path validation, and slice manipulation. + +data +---- + +This module provides `convert_size_to_human` method for converting data size units:: + + > convert_size_to_human(1052810) + "1.0 MB" + +path +---- + +This module provides functions to validate and handle filesystem paths:: + + is_empty(path) + is_path_valid(path) + +slices +------ +Calculate shape of a subset from the index expression:: + + > shape = (361, 720, 4) + > index_exp = (slice(None, None, None), slice(None, None, None), 0) + > create_shape_from_slice(shape, index_exp) + (361, 720) + +Convert slice into a sequence and get its length:: + + > match_slice_size(10, slice(10)) + (0, 10, 1) + +Convert slices to string and vice versa with slice_converter:: + + > slice_converter[5] + '[5]' + + > slice_converter[datetime.datetime(2023,1,1):datetime.datetime(2023,2,1), 0.1:0.9:0.05] + '[`2023-01-01T00:00:00`:`2023-02-01T00:00:00`, 0.1:0.9:0.05]' + +time +------ + +This module provides `get_utc` function which returns timezone with UTC or current time by default:: + + > get_utc() + 2023-07-26 15:42:05.539317+00:00 + + > get_utc(datetime.now()) + 2023-07-26 15:42:05.539317+00:00 + +.. toctree:: + :maxdepth: 4 + :hidden: + + Deker tools API diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..954237b --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/source/api/data.rst b/docs/source/api/data.rst new file mode 100755 index 0000000..85907dc --- /dev/null +++ b/docs/source/api/data.rst @@ -0,0 +1,8 @@ +Data +=========== + +.. automodule:: deker_tools.data + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs/source/api/modules.rst b/docs/source/api/modules.rst new file mode 100644 index 0000000..e564798 --- /dev/null +++ b/docs/source/api/modules.rst @@ -0,0 +1,10 @@ +Deker tools API +===== + +.. toctree:: + :maxdepth: 4 + + data + path + slices + time \ No newline at end of file diff --git a/docs/source/api/path.rst b/docs/source/api/path.rst new file mode 100755 index 0000000..fab78f1 --- /dev/null +++ b/docs/source/api/path.rst @@ -0,0 +1,7 @@ +Path +=========== + +.. automodule:: deker_tools.path + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/slices.rst b/docs/source/api/slices.rst new file mode 100755 index 0000000..c7634cb --- /dev/null +++ b/docs/source/api/slices.rst @@ -0,0 +1,7 @@ +Slices +============= + +.. automodule:: deker_tools.slices + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/api/time.rst b/docs/source/api/time.rst new file mode 100755 index 0000000..94612ee --- /dev/null +++ b/docs/source/api/time.rst @@ -0,0 +1,7 @@ +Time +=========== + +.. automodule:: deker_tools.time + :members: + :undoc-members: + :show-inheritance: diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..a9a1eb9 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,96 @@ +# https://black.readthedocs.io/en/stable/ +[tool.black] +line-length = 120 +target-version = ['py37', 'py38', 'py39'] +#target-version = ['py310'] +include = '\.pyi?$' +extend-exclude = ''' +# A regex preceded with ^/ will apply only to files and directories +# in the root of the project. +^/foo.py # exclude a file named foo.py in the root of the project (in addition to the defaults) +''' + +# https://mypy.readthedocs.io/en/stable/ +# https://pypi.org/project/mypy-extensions/ +[tool.mypy] +python_version = '3.8' +ignore_missing_imports = true +scripts_are_modules = true +allow_redefinition = true +disallow_untyped_defs = true +no_implicit_optional = true +warn_no_return = false +show_error_context = true +show_column_numbers = true +show_error_codes = true + +color_output = false +pretty = true +exclude = [ + '^setup\.py$', + '^tmp\.py$', + '^venv/', + '^test+\.py$', + '^conftest\.py$', + '^tests/' +] + +# https://pycqa.github.io/isort/ +[tool.isort] +py_version = 38 +sections = ['FUTURE', 'STDLIB', 'THIRDPARTY', 'FIRSTPARTY', 'LOCALFOLDER'] +known_local_folder = ['deker_tools', ] +profile = 'black' +atomic = true +include_trailing_comma = true +line_length = 120 +lines_after_imports = 2 +lines_between_types = 1 +multi_line_output = 3 +extend_skip = ['.md', '.json'] + +[build-system] +requires = ["setuptools>=45", "setuptools_scm[toml]>=6.2"] + +[project] +name = "deker_tools" +requires-python = ">=3.9" +dynamic = ["version", "readme", "dependencies"] +authors = [ + {name = "OpenWeather", email = "info@openweathermap.org"}, +] +maintainers = [ + {name = "OpenWeather", email = "info@openweathermap.org"}, +] +description = "Interactive shell for Deker" +license = {text = "GPL-3.0-only"} + +classifiers = [ + "Development Status :: 4 - Beta", + "Intended Audience :: Developers", + "Intended Audience :: Information Technology", + "Intended Audience :: Science/Research", + "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", + "Topic :: Software Development :: Libraries :: Python Modules", + "Operating System :: Unix", + "Operating System :: POSIX :: Linux", + "Operating System :: MacOS :: MacOS X", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", +] +[project.urls] +'Homepage' = 'https://deker.io/' +'Documentation' = 'https://docs.deker.io/' +'Repository' = 'https://github.com/openweathermap/deker-tools' + +[tool.setuptools.dynamic] +readme = {file = ["README.md"], content-type='text/markdown'} +dependencies = {file = ["requirements.txt"]} + +[tool.setuptools] +packages = ["deker_tools"] +license-files=["LICENSE"] +[tool.setuptools_scm] diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..0e72872 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +numpy>=1.18 diff --git a/requirements_dev.txt b/requirements_dev.txt new file mode 100644 index 0000000..2f32154 --- /dev/null +++ b/requirements_dev.txt @@ -0,0 +1,21 @@ +black +coverage +darglint +flake8 +flake8-bugbear +flake8-docstrings +flake8-import-order +flake8-pytest-style +isort +mypy +mypy-extensions +pep8-naming +pre-commit +pycln +pytest==6.2.5 +pytest-asyncio==0.18.0 +pytest-cov +pytest-pythonpath # requires 2.5.2 >= (pytest < 7); pytest >= 7 does not need this package +pytest-random-order +pytest-sugar +ssort diff --git a/requirements_docs.txt b/requirements_docs.txt new file mode 100644 index 0000000..7b44c76 --- /dev/null +++ b/requirements_docs.txt @@ -0,0 +1,2 @@ +sphinx==7.1.0 +sphinx-rtd-theme==1.2.2 diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..e2ac607 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,81 @@ +; https://flake8.pycqa.org/en/latest/ +; https://pypi.org/project/flake8-bugbear +; https://pypi.org/project/flake8-docstrings/ +; https://pypi.org/project/flake8-import-order/ +; https://pypi.org/project/flake8-pytest-style/ +; https://pypi.org/project/pep8-naming/ +[flake8] +min_python_version = 3.8 +max-complexity = 20 +max-doc-length = 120 +max-line-length = 120 +strictness = full +docstring_style = sphinx +docstring-convention = pep257 +application_import_names = deker_tools +import-order-style = pycharm +exclude = + venv/*, + .git/*, + __pycache__/*, + .mypy_cache/*, + .pytest_cache/*, + .idea/* +extend-select = D417 +per-file-ignores = + __init__.py: D104, F401, F403, F405, +ignore = + B012, + D100, + D104, + D105, + D106, + D107, + D203, + D404, + DAR003, + DAR104, + DAR105, + DAR201, + DAR401, + I201, + I202, + N805, + N807, + N813, + W503, + W504, + +; https://pypi.org/project/darglint +[darglint] +strictness = full +docstring_style = sphinx +ignore = + DAR003, + DAR104, + DAR105, + DAR201, + DAR401 + +; https://docs.pytest.org +; https://pypi.org/project/pytest-asyncio/ +; https://pytest-cov.readthedocs.io/en/latest/ +; https://pypi.org/project/pytest-pythonpath/ +; https://pypi.org/project/pytest-sugar/ +[tool:pytest] +minversion = 6.2.5 +addopts = --ignore=tmp.py + +norecursedirs = data + +testpaths = ./tests + +; for pytest < 7.0 +python_paths = ./deker_tools ./venv +; for pytest >= 7.0 +;pythonpath = ./deker_tools ./venv + +filterwarnings = + ignore::UserWarning + ignore::DeprecationWarning + ignore::ResourceWarning diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..6068493 --- /dev/null +++ b/setup.py @@ -0,0 +1,3 @@ +from setuptools import setup + +setup() diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/test_data.py b/tests/test_data.py new file mode 100644 index 0000000..07f8ec7 --- /dev/null +++ b/tests/test_data.py @@ -0,0 +1,16 @@ +import pytest + +from deker_tools.data import convert_size_to_human + + +@pytest.mark.parametrize( + ("bytes", "expected"), + [ + (1052810, "1.0 MB"), + (10489994, "10.0 MB"), + (104861834, "100.0 MB"), + (1073746058, "1.0 GB"), + ], +) +def test_convert_size_to_human(bytes, expected): + assert convert_size_to_human(bytes) == expected diff --git a/tests/test_path.py b/tests/test_path.py new file mode 100644 index 0000000..16e38c1 --- /dev/null +++ b/tests/test_path.py @@ -0,0 +1,33 @@ +import tempfile + +import pytest + +from deker_tools.path import is_empty, is_path_valid + + +class TestIsEmpty: + dir = "." + + def test_is_not_empty(self): + assert not is_empty(self.dir) + + def test_is_empty(self): + with tempfile.TemporaryDirectory(dir=self.dir) as dir: + assert is_empty(dir) + + def test_is_empty_raises(self): + with pytest.raises(IsADirectoryError): + assert is_empty(__file__) + + +class TestIsPathValid: + def test_is_path_valid(self): + assert is_path_valid(".") is None + + def test_is_path_valid_raises_for_file(self): + with pytest.raises(IsADirectoryError): + assert is_path_valid(__file__) + + +if __name__ == "__main__": + pytest.main() diff --git a/tests/test_slices.py b/tests/test_slices.py new file mode 100644 index 0000000..fb40233 --- /dev/null +++ b/tests/test_slices.py @@ -0,0 +1,185 @@ +from datetime import datetime, timezone + +import numpy as np +import pytest + +from deker_tools.slices import SliceConversionError, create_shape_from_slice, match_slice_size, slice_converter + + +class TestSliceConverter: + @pytest.mark.parametrize( + ("exp", "exp_str"), + [ + (1, "[1]"), + ((-1, 0, 1), "[-1, 0, 1]"), + (..., "[...]"), + (slice(None, None, None), "[:]"), + (slice(1, None, None), "[1:]"), + (slice(None, 0, None), "[:0]"), + ((..., slice(None, None, 1)), "[..., ::1]"), + ((slice(None, None, None), slice(1, None, None)), "[:, 1:]"), + ((slice(1, 1, 1), slice(None, -2, None)), "[1:1:1, :-2]"), + ((slice(None, None, None), 1, ..., slice(None, None, 4)), "[:, 1, ..., ::4]"), + (None, "[:]"), + (np.index_exp[1], "[1]"), + (np.index_exp[:], "[:]"), + (np.index_exp[...], "[...]"), + (np.index_exp[-1, 0, 1], "[-1, 0, 1]"), + (np.index_exp[..., ::1], "[..., ::1]"), + (np.index_exp[:, 1:], "[:, 1:]"), + (np.index_exp[1:1:1, :-2], "[1:1:1, :-2]"), + (np.index_exp[:, 1, ..., ::4], "[:, 1, ..., ::4]"), + (np.index_exp[()], "[()]"), + ( + np.index_exp[ + datetime(2023, 6, 12, 16, 29, 18, 317633, tzinfo=timezone.utc).timestamp() : datetime.fromisoformat( + "2023-06-12T16:29:18.317633+00:00" + ) : -1.4, + -0.26, + "mama":"-mama":"+mama", + -1:1, + ], + "[1686587358.317633:`2023-06-12T16:29:18.317633+00:00`:-1.4, -0.26, `mama`:`-mama`:`+mama`, -1:1]", + ), + (np.index_exp["2023-06-11T00:00:00.000001-03:00"], "[`2023-06-11T00:00:00.000001-03:00`]"), + ( + slice("2023-06-12T00:00:00.000001-03:00", "2023-06-12T16:29:18.317633+00:00", None), + "[`2023-06-12T00:00:00.000001-03:00`:`2023-06-12T16:29:18.317633+00:00`]", + ), + ( + slice( + "2023-06-12T00:00:00.000001-03:00", + "2023-06-12T16:29:18.317633+00:00", + "2023-06-12T16:29:18.317633+00:00", + ), + "[`2023-06-12T00:00:00.000001-03:00`:`2023-06-12T16:29:18.317633+00:00`:`2023-06-12T16:29:18.317633+00:00`]", + ), + ( + np.index_exp[ + "2023-06-11T00:00:00.000001-03:00", + "2023-06-12T00:00:00.000001-03:00":"2023-06-12T16:29:18.317633+00:00", + "2023-06-12T00:00:00.000001-03:00":"2023-06-12T16:29:18.317633+00:00":"2023-06-12T16:29:18.317633+00:00", + ], + "[`2023-06-11T00:00:00.000001-03:00`, `2023-06-12T00:00:00.000001-03:00`:`2023-06-12T16:29:18.317633+00:00`, `2023-06-12T00:00:00.000001-03:00`:`2023-06-12T16:29:18.317633+00:00`:`2023-06-12T16:29:18.317633+00:00`]", + ), + ], + ) + def test_slice_converter_slice_to_str(self, exp, exp_str): + assert slice_converter[exp] == exp_str + + @pytest.mark.parametrize( + ("exp_str", "exp"), + [ + ("[1]", 1), + ("[-1, 0, 1]", (-1, 0, 1)), + ("[...]", ...), + ("[:]", slice(None, None, None)), + ("[1:]", slice(1, None, None)), + ("[:0]", slice(None, 0, None)), + ("[..., ::1]", (..., slice(None, None, 1))), + ("[:, 1:]", (slice(None, None, None), slice(1, None, None))), + ("[1:1:1, :-2]", (slice(1, 1, 1), slice(None, -2, None))), + ("[:, 1, ..., ::4]", (slice(None, None, None), 1, ..., slice(None, None, 4))), + ("[()]", ()), + ( + "[1686587358.317633:2023-06-12T16:29:18.317633+00:00:-1.4, -0.26, mama:-mama:+mama, -1:1]", + ( + slice(1686587358.317633, "2023-06-12T16:29:18.317633+00:00", -1.4), + -0.26, + slice("mama", "mama", "+mama"), + slice(-1, 1, None), + ), + ), + ( + "[`2023-06-11T00:00:00.000001-03:00`]", + "2023-06-11T00:00:00.000001-03:00", + ), + ( + "[`2023-06-12T00:00:00.000001-03:00`:`2023-06-12T16:29:18.317633+00:00`]", + slice("2023-06-12T00:00:00.000001-03:00", "2023-06-12T16:29:18.317633+00:00", None), + ), + ( + "[`2023-06-12T00:00:00.000001-03:00`:`2023-06-12T16:29:18.317633+00:00`:`2023-06-12T16:29:18.317633+00:00`]", + slice( + "2023-06-12T00:00:00.000001-03:00", + "2023-06-12T16:29:18.317633+00:00", + "2023-06-12T16:29:18.317633+00:00", + ), + ), + ( + "[`2023-06-11T00:00:00.000001-03:00`, `2023-06-12T00:00:00.000001-03:00`:`2023-06-12T16:29:18.317633+00:00`, `2023-06-12T00:00:00.000001-03:00`:`2023-06-12T16:29:18.317633+00:00`:`2023-06-12T16:29:18.317633+00:00`]", + ( + "2023-06-11T00:00:00.000001-03:00", + slice("2023-06-12T00:00:00.000001-03:00", "2023-06-12T16:29:18.317633+00:00", None), + slice( + "2023-06-12T00:00:00.000001-03:00", + "2023-06-12T16:29:18.317633+00:00", + "2023-06-12T16:29:18.317633+00:00", + ), + ), + ), + ], + ) + def test_slice_converter_str_to_slice(self, exp, exp_str): + assert slice_converter[exp_str] == exp + + @pytest.mark.parametrize( + "string", + [ + "1,3,:", + "hello, world", + "", + " ", + "[]", + "[ ]", + "()", + "( )", + ], + ) + def test_slice_converter_error_on_strings(self, string): + with pytest.raises(SliceConversionError): + assert slice_converter[string] + + @pytest.mark.parametrize( + "index", + [ + np.index_exp[..., ...], + np.index_exp[..., 0.52, 1:8:5, ...], + ], + ) + def test_slice_converter_error_on_index(self, index): + with pytest.raises(SliceConversionError): + assert slice_converter[index] + + +@pytest.mark.parametrize( + ("slice_", "result"), + [ + ((slice(1, None, None),), (360, 720, 4)), + ((slice(1, None, None), slice(1, None, None)), (360, 719, 4)), + ((slice(None, None, None), slice(None, None, None)), (361, 720, 4)), + ((slice(None, None, None), slice(None, None, None), 0), (361, 720)), + (0, (720, 4)), + ], +) +def test_create_shape_from_slice(slice_, result): + shape = (361, 720, 4) + new_shape = create_shape_from_slice(shape, slice_) + assert new_shape == result + + +@pytest.mark.parametrize( + ("dim_size", "slice_", "result"), + [ + (10, None, (0, 10, 1)), + (10, slice(10), (0, 10, 1)), + (10, slice(1, 5, 3), (1, 5, 3)), + (2, slice(1, 5, 3), (1, 5, 3)), + ], +) +def test_match_slice_size(dim_size, slice_, result): + assert match_slice_size(dim_size, slice_) == result + + +if __name__ == "__main__": + pytest.main() diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..a45026d --- /dev/null +++ b/tox.ini @@ -0,0 +1,36 @@ +[tox] +requires = + tox>=4 +env_list = {py39,py310,py311}-lint, py{39,310,311}-test + +[testenv:{py39,py310,py311}-test] +description = run unit tests +deps = + pytest>=7 + pytest-sugar + pytest-mock==3.10.0 + numpy>=1.18 +commands = + pytest {posargs:tests} + + +[testenv:{py39,py310,py311}-lint] +ignore_base_python_conflict = true +description = run linters +deps = black==23.1.0 + coverage==7.1.0 + darglint==1.8.1 + flake8==6.0.0 + isort==5.12.0 + mypy==1.0.0 + mypy-extensions==1.0.0 + pep8-naming==0.13.3 + ssort==0.11.6 + deepdiff==6.3.0 +commands = isort {posargs:deker_tools} + black {posargs:deker_tools} + flake8 {posargs:deker_tools} + mypy {posargs:deker_tools} --install-types --non-interactive --config-file pyproject.toml + +set_env = + PIP_EXTRA_INDEX_URL = {env:PIP_EXTRA_INDEX_URL}