python-jsonlogic 0.0.1__tar.gz → 0.2.0__tar.gz

python_jsonlogic-0.2.0/.github/workflows/ci.yml

@@ -0,0 +1,130 @@
+name: ci
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - '**'
+  pull_request: {}
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    name: Run tests with pytest
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.11', '3.12', '3.13', '3.14', '3.15']
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true # zizmor: ignore[cache-poisoning] (Job does not produce release artifacts and does not have sensitive permissions)
+
+      - name: Install tox
+        run: uv tool install --managed-python --python 3.13 tox --with tox-uv --with tox-gh
+
+      - name: Install Python ${{ matrix.python-version }}
+        run: uv python install --managed-python ${{ matrix.python-version }}
+
+      - name: Test with tox
+        run: tox run
+        env:
+          TOX_GH_MAJOR_MINOR: ${{ matrix.python-version }}
+          UV_PYTHON_DOWNLOADS: never
+
+  docs:
+    name: Build and check documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - name: Set up Python 3.14
+        uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          python-version: '3.14'
+          enable-cache: true # zizmor: ignore[cache-poisoning] (Job does not produce release artifacts and does not have sensitive permissions)
+
+      - name: Install dependencies
+        run: uv sync --group docs
+
+      - name: Lint docs with sphinx-lint
+        run: |
+          uv run sphinx-lint docs
+
+      - name: Build docs and check the integrity of external links
+        run: |
+          uv run sphinx-build --builder linkcheck --fail-on-warning "source" "build"
+          uv run sphinx-build --builder html --fail-on-warning "source" "build"
+        working-directory: ./docs
+
+  build:
+    name: Build project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          enable-cache: false
+
+      - run: uv sync --no-install-project --only-group build
+
+      - name: Build library
+        run: uv run --no-sync python -m build --installer uv
+
+      - run: ls -lh dist/
+
+      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: pypi_files
+          path: dist
+
+  release:
+    needs: [tests, docs, build]
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/')
+    environment: release
+
+    permissions:
+      id-token: write
+      contents: write
+
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          enable-cache: false
+
+      - run: uv sync --no-install-project --only-group build
+
+      - name: Get dist artifacts
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: pypi_files
+          path: dist
+
+      - name: Test artifacts integrity
+        run: |
+          for whl in dist/*.whl; do unzip -qt "$whl"; done
+          uv run --no-sync twine check --strict dist/*
+
+      - name: Upload package to PyPI
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
+        with:
+          packages-dir: dist/

python_jsonlogic-0.2.0/.github/workflows/lint.yml

@@ -0,0 +1,83 @@
+name: lint
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - '**'
+  pull_request: {}
+
+permissions:
+  contents: read
+
+jobs:
+  prek:
+    name: Run prek pre-commit hooks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - uses: j178/prek-action@4e14d07f9231acabce116ccfca13b13dd9755ece # v3.0.0
+
+  ruff-format:
+    name: Check code formatting with Ruff
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - name: Set up Python 3.14
+        uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          python-version: '3.14'
+          enable-cache: true # zizmor: ignore[cache-poisoning] (Job does not produce release artifacts and does not have sensitive permissions)
+
+      - name: Install dependencies
+        run: uv sync --group dev
+
+      - name: Run Ruff formatter
+        run: uv run ruff format --diff
+
+  ruff-check:
+    name: Check code linting with Ruff
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - name: Set up Python 3.14
+        uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          python-version: '3.14'
+          enable-cache: true # zizmor: ignore[cache-poisoning] (Job does not produce release artifacts and does not have sensitive permissions)
+
+      - name: Install dependencies
+        run: uv sync --group dev
+
+      - name: Run Ruff formatter
+        run: uv run ruff check --output-format=github
+
+  typecheck:
+    name: Run typechecking with pyright
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+
+      - name: Set up Python 3.14
+        uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
+        with:
+          python-version: '3.14'
+          enable-cache: true # zizmor: ignore[cache-poisoning] (Job does not produce release artifacts and does not have sensitive permissions)
+
+      - name: Install dependencies
+        run: uv sync --group dev
+
+      - name: Run pyright
+        run: uv run pyright

python_jsonlogic-0.2.0/.gitignore

@@ -0,0 +1,165 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Ruff linter
+.ruff_cache/
+
+# Cython debug symbols
+cython_debug/
+
+.vscode/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

python_jsonlogic-0.2.0/.yamlfmt.yaml

@@ -0,0 +1,5 @@
+formatter:
+  type: basic
+  retain_line_breaks_single: true
+  scan_folded_as_literal: true
+  force_quote_style: single

python_jsonlogic-0.2.0/PKG-INFO

@@ -0,0 +1,120 @@
+Metadata-Version: 2.5
+Name: python-jsonlogic
+Version: 0.2.0
+Summary: An extensible and sane implementation of JsonLogic
+Author-email: Victorien <contact@vctrn.dev>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: typing-extensions>=4.10.0; python_version < '3.13'
+Description-Content-Type: text/x-rst
+
+================
+python-jsonlogic
+================
+
+|Pythons| |PyPI| |Ruff|
+
+.. |Pythons| image:: https://img.shields.io/pypi/pyversions/python-jsonlogic.svg
+  :alt: Supported Python versions
+  :target: https://pypi.org/project/python-jsonlogic/
+
+.. |PyPI| image:: https://img.shields.io/pypi/v/python-jsonlogic.svg
+  :alt: PyPI - Version
+  :target: https://pypi.org/project/python-jsonlogic/
+
+.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+  :alt: PyPI - Version
+  :target: https://github.com/astral-sh/ruff
+
+``python-jsonlogic`` is an extensible and sane implementation of `JsonLogic`_, making use of the `JSON Schema`_ specification.
+
+.. _`JSON Schema`: https://json-schema.org/
+
+Motivation
+----------
+
+While the `JsonLogic`_ format can be great to serialize logic, it lacks a formal specification
+and some aspects are unclear/unspecified:
+
+* `operators <https://jsonlogic.com/operations.html>`_ arguments can take any value. For instance,
+  `comparison operators <https://jsonlogic.com/operations.html#---and->`_ are said to work with "numeric" values,
+  however the `JavaScript playground <https://jsonlogic.com/play.html>`_ doesn't validate inputs. It is
+  also convenient to allow such comparison operators for date and datetime objects as well.
+* Operators `accessing data <https://jsonlogic.com/operations.html#accessing-data>`_ use a dot-like notation,
+  which is ambiguous when dealing with keys such as ``my.key``.
+* Operators such as `map <https://jsonlogic.com/operations.html#map-reduce-and-filter>`_ provides their own data scope,
+  making it impossible to access higher-level data inside the operator expression.
+
+For these reasons, ``python-jsonlogic`` provides a way to typecheck your JSON Logic expressions at "compile" time,
+before applying input data to them.
+
+.. _`JsonLogic`: https://jsonlogic.com/
+
+Installation
+------------
+
+From PyPI:
+
+.. code:: bash
+
+    pip install python-jsonlogic
+
+The library can be imported from the ``jsonlogic`` module.
+
+Usage
+-----
+
+.. code-block:: python
+
+    # 1. Create or use an already existing operator registry:
+    from jsonlogic.operators import operator_registry
+
+    # 2. Parse the JSON Logic expression:
+    from jsonlogic import JSONLogicExpression
+
+    expr = JSONLogicExpression.from_json({"map": [
+        [1, 2],
+        {"*": [{"var": ""}, {"var": "/my_int@1"}]},
+    ]})
+
+    # 3. Create an operator tree:
+    root_op = expr.as_operator_tree(operator_registry)
+
+    # 4. Typecheck the expression:
+    from jsonlogic.typechecking import typecheck
+
+    typ, diagnostics = typecheck(
+        root_op,
+        data_schema={
+          "type": "object",
+          "properties": {
+                "my_int": {"type": "integer"}
+            },
+        }
+    )
+    print(typ)
+    #> ArrayType(IntegerType())
+
+    # 5. Evaluate with data:
+    from jsonlogic.evaluation import evaluate
+    value = evaluate(
+        root_op,
+        data={"my_int": 2},
+        data_schema=None,
+    )
+    print(value)
+    #> [2, 4]

python_jsonlogic-0.2.0/README.rst

@@ -0,0 +1,96 @@
+================
+python-jsonlogic
+================
+
+|Pythons| |PyPI| |Ruff|
+
+.. |Pythons| image:: https://img.shields.io/pypi/pyversions/python-jsonlogic.svg
+  :alt: Supported Python versions
+  :target: https://pypi.org/project/python-jsonlogic/
+
+.. |PyPI| image:: https://img.shields.io/pypi/v/python-jsonlogic.svg
+  :alt: PyPI - Version
+  :target: https://pypi.org/project/python-jsonlogic/
+
+.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+  :alt: PyPI - Version
+  :target: https://github.com/astral-sh/ruff
+
+``python-jsonlogic`` is an extensible and sane implementation of `JsonLogic`_, making use of the `JSON Schema`_ specification.
+
+.. _`JSON Schema`: https://json-schema.org/
+
+Motivation
+----------
+
+While the `JsonLogic`_ format can be great to serialize logic, it lacks a formal specification
+and some aspects are unclear/unspecified:
+
+* `operators <https://jsonlogic.com/operations.html>`_ arguments can take any value. For instance,
+  `comparison operators <https://jsonlogic.com/operations.html#---and->`_ are said to work with "numeric" values,
+  however the `JavaScript playground <https://jsonlogic.com/play.html>`_ doesn't validate inputs. It is
+  also convenient to allow such comparison operators for date and datetime objects as well.
+* Operators `accessing data <https://jsonlogic.com/operations.html#accessing-data>`_ use a dot-like notation,
+  which is ambiguous when dealing with keys such as ``my.key``.
+* Operators such as `map <https://jsonlogic.com/operations.html#map-reduce-and-filter>`_ provides their own data scope,
+  making it impossible to access higher-level data inside the operator expression.
+
+For these reasons, ``python-jsonlogic`` provides a way to typecheck your JSON Logic expressions at "compile" time,
+before applying input data to them.
+
+.. _`JsonLogic`: https://jsonlogic.com/
+
+Installation
+------------
+
+From PyPI:
+
+.. code:: bash
+
+    pip install python-jsonlogic
+
+The library can be imported from the ``jsonlogic`` module.
+
+Usage
+-----
+
+.. code-block:: python
+
+    # 1. Create or use an already existing operator registry:
+    from jsonlogic.operators import operator_registry
+
+    # 2. Parse the JSON Logic expression:
+    from jsonlogic import JSONLogicExpression
+
+    expr = JSONLogicExpression.from_json({"map": [
+        [1, 2],
+        {"*": [{"var": ""}, {"var": "/my_int@1"}]},
+    ]})
+
+    # 3. Create an operator tree:
+    root_op = expr.as_operator_tree(operator_registry)
+
+    # 4. Typecheck the expression:
+    from jsonlogic.typechecking import typecheck
+
+    typ, diagnostics = typecheck(
+        root_op,
+        data_schema={
+          "type": "object",
+          "properties": {
+                "my_int": {"type": "integer"}
+            },
+        }
+    )
+    print(typ)
+    #> ArrayType(IntegerType())
+
+    # 5. Evaluate with data:
+    from jsonlogic.evaluation import evaluate
+    value = evaluate(
+        root_op,
+        data={"my_int": 2},
+        data_schema=None,
+    )
+    print(value)
+    #> [2, 4]

python_jsonlogic-0.2.0/changelog/entry.rst.jinja

@@ -0,0 +1,8 @@
+{% set refs = [] %}
+{% if metadata.gh_issue %}{% set _ = refs.append("Issue :issue:`%s`" % metadata.gh_issue) %}{% endif %}
+{% if metadata.gh_pr %}{% set _ = refs.append("PR :pr:`%s`" % metadata.gh_pr) %}{% endif %}
+{% set refs = refs | join(", ") %}
+{% if metadata.gh_author %}{% set refs = (refs ~ " by :user:`%s`" % metadata.gh_author) | trim %}{% endif %}
+{# References are attached to the first paragraph, so that multi-paragraph entries (e.g. with a code example) stay valid: #}
+{% set first, _, rest = content.partition("\n\n") %}
+{{ first }}{% if refs %} ({{ refs }}).{% endif %}{% if rest %}{{ "\n\n" ~ rest }}{% endif %}

python_jsonlogic-0.2.0/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     = source
+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)

python_jsonlogic-0.2.0/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=source
+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

python_jsonlogic-0.2.0/docs/source/api/core.rst

@@ -0,0 +1,5 @@
+Core
+----
+
+.. automodule:: jsonlogic.core
+    :members:

python_jsonlogic-0.2.0/docs/source/api/evaluation.rst

@@ -0,0 +1,5 @@
+Evaluation
+==========
+
+.. automodule:: jsonlogic.evaluation
+    :members:

python_jsonlogic-0.2.0/docs/source/api/index.rst

@@ -0,0 +1,15 @@
+.. _api:
+
+API Reference
+=============
+
+.. toctree::
+    :maxdepth: 2
+
+    evaluation
+    core
+    json_schema
+    registry
+    resolving
+    typechecking
+    typing_helpers