mgqpy 0.1__tar.gz

mgqpy-0.1/.gitignore

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

mgqpy-0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Chiawei Ong
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mgqpy-0.1/PKG-INFO

@@ -0,0 +1,7 @@
+Metadata-Version: 2.1
+Name: mgqpy
+Version: 0.1
+Summary: mongo query as a python filter predicate
+Author-email: Chiawei Ong <ongchiawei@gmail.com>
+Classifier: License :: OSI Approved :: MIT License
+Project-URL: Home, https://github.com/weiliddat/mgqpy

mgqpy-0.1/README.md

@@ -0,0 +1,55 @@
+# mgqpy
+
+mongo query as a python filter predicate
+
+```python
+from mgqpy import Query
+
+predicate = Query({"foo.bar": 1})
+
+inputs = [
+    {"foo": [{"bar": [1]}]},
+    {"foo": {"bar": 1}},
+    {"foo": None},
+]
+
+filtered = filter(predicate.match, inputs)
+
+assert list(filtered) == [
+    {"foo": [{"bar": [1]}]},
+    {"foo": {"bar": 1}},
+]
+```
+
+## Supported operators
+
+Comparison query operators
+
+- [x] \$eq
+- [x] \$eq (implicit), e.g. `{"foo": None}`
+- [ ] \$ne
+- [ ] \$gt
+- [ ] \$gte
+- [ ] \$lt
+- [ ] \$lte
+- [ ] \$in
+- [ ] \$nin
+
+Logical query operators
+
+- [ ] \$and
+- [x] \$and (implicit), e.g. `{"foo": 1, "bar": "baz"}`
+- [ ] \$or
+- [ ] \$not
+- [ ] \$nor
+
+Evaluation query operators
+
+- [ ] \$regex
+- [ ] \$mod
+
+Array query operators
+
+- [ ] \$all
+- [ ] \$elemMatch
+- [ ] \$size

mgqpy-0.1/mgqpy/__init__.py

@@ -0,0 +1,90 @@
+"""mongo query as a python filter predicate"""
+
+__version__ = "0.1"
+
+# Terminology
+#
+# Query refers to the document that is passed to the compiler / mongodb find that holds
+#   the query conditions (can be multiple),
+#   e.g. { "fruits.type": { "$eq": "berry", "$ne": "aggregate" }, "fruits": { "$size": 3 }}
+#
+# Cond (conditions) refers to a single path-expression pair,
+#   e.g. { "fruits.type": { "$eq": "berry", "$ne": "aggregate" }
+#
+# Path refers to dot-separated fields,
+#   e.g. "fruits.type"
+#
+# Exp (expression) refers to the object that holds operator and value pairs (can be multiple),
+#   e.g. { "$eq": "berry", "$ne": "aggregate" }
+#
+# Op (operator) refers to the logical operator that is matched against the value,
+#   e.g. "$eq"
+#
+# Ov (operator value) refers to the value that you are matching against in
+#   the context of a single operator e.g. "berry"
+#
+# Doc refers to the object that is passed to the compiled filter function
+
+from typing import List
+
+cmp_ops = {
+    "$eq",
+    "$gt",
+    "$gte",
+    "$in",
+    "$lt",
+    "$lte",
+    "$ne",
+    "$nin",
+}
+
+
+class Query:
+    def __init__(self, query):
+        self._query = query
+        pass
+
+    def match(self, doc) -> bool:
+        results: List[bool] = []
+
+        for path in self._query:
+            exp_or_ov = self._query[path]
+            is_all_ops = (
+                exp_or_ov
+                and isinstance(exp_or_ov, dict)
+                and all(key in cmp_ops for key in exp_or_ov.keys())
+            )
+
+            path_parts = path.split(".")
+
+            if is_all_ops:
+                if "$eq" in exp_or_ov:
+                    results.append(_match_eq(doc, path_parts, exp_or_ov["$eq"]))
+            else:
+                results.append(_match_eq(doc, path_parts, exp_or_ov))
+
+        return all(results)
+
+
+def _match_eq(doc: dict, path: List[str], ov) -> bool:
+    if len(path) == 0:
+        if isinstance(doc, list) and any([_match_eq(d, path, ov) for d in doc]):
+            return True
+
+        return doc == ov
+
+    key = path[0]
+    rest = path[1:]
+
+    if isinstance(doc, dict) and key in doc:
+        return _match_eq(doc[key], rest, ov)
+
+    if isinstance(doc, list) and key.isdigit():
+        idx = int(key)
+        if idx < len(doc):
+            return _match_eq(doc[idx], rest, ov)
+
+    if isinstance(doc, list):
+        return any([_match_eq(d, path, ov) for d in doc])
+
+    return ov is None

mgqpy-0.1/pyproject.toml

@@ -0,0 +1,17 @@
+[build-system]
+requires = ["flit_core >=3.2,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "mgqpy"
+authors = [{name = "Chiawei Ong", email = "ongchiawei@gmail.com"}]
+license = {file = "LICENSE"}
+classifiers = ["License :: OSI Approved :: MIT License"]
+dynamic = ["version", "description"]
+
+[project.urls]
+Home = "https://github.com/weiliddat/mgqpy"
+
+[tool.pytest.ini_options]
+pythonpath = ["."]
+testpaths = ["tests"]

mgqpy-0.1/requirements.txt

@@ -0,0 +1,4 @@
+iniconfig==2.0.0
+packaging==24.1
+pluggy==1.5.0
+pytest==8.2.2

mgqpy-0.1/tests/test_and.py

@@ -0,0 +1,25 @@
+import pytest
+from mgqpy import Query
+
+
+testcases = [
+    (
+        "implicit $and",
+        {"foo": "bar", "baz": 2},
+        [
+            {"foo": "bar", "baz": 2},
+            {},
+            {"foo": "bar"},
+            {"baz": 2},
+            {"foo": {"foo": "bar"}},
+        ],
+        [{"foo": "bar", "baz": 2}],
+    ),
+]
+
+
+@pytest.mark.parametrize("name,query,input,expected", testcases)
+def test_mgqpy_and(name, query, input, expected):
+    q = Query(query)
+    actual = filter(q.match, input)
+    assert list(actual) == expected, name

mgqpy-0.1/tests/test_eq.py

@@ -0,0 +1,202 @@
+import pytest
+from mgqpy import Query
+
+
+testcases = [
+    (
+        "explicit $eq",
+        {"foo": {"$eq": "bar"}},
+        [{"foo": "bar"}, {}, {"foo": "baz"}, {"foo": {"foo": "bar"}}],
+        [{"foo": "bar"}],
+    ),
+    (
+        "implicit $eq",
+        {"foo": "bar"},
+        [{"foo": "bar"}, {}, {"foo": "baz"}, {"foo": {"foo": "bar"}}],
+        [{"foo": "bar"}],
+    ),
+    (
+        "implicit $eq, full object match",
+        {"foo": {"bar": 1, " $size": 2}},
+        [
+            {"foo": "bar"},
+            {},
+            {"foo": [{"bar": 1}, {"bar": 2}]},
+            {"foo": {"bar": 1, " $size": 2}},
+        ],
+        [{"foo": {"bar": 1, " $size": 2}}],
+    ),
+    (
+        "explicit $eq, full object match",
+        {"foo": {"$eq": {"bar": 1, " $size": 2}}},
+        [
+            {"foo": "bar"},
+            {},
+            {"foo": [{"bar": 1}, {"bar": 2}]},
+            {"foo": {"bar": 1, " $size": 2}},
+        ],
+        [{"foo": {"bar": 1, " $size": 2}}],
+    ),
+    (
+        "nested object path, explicit $eq",
+        {"foo.bar": {"$eq": "baz"}},
+        [
+            {"foo": {"bar": "baz"}},
+            {},
+            {"foo": "bar"},
+            {"foo": {"bar": "qux"}},
+        ],
+        [{"foo": {"bar": "baz"}}],
+    ),
+    (
+        "nested object path, implicit $eq",
+        {"foo.bar": "baz"},
+        [
+            {"foo": {"bar": "baz"}},
+            {},
+            {"foo": "bar"},
+            {"foo": {"bar": "qux"}},
+        ],
+        [{"foo": {"bar": "baz"}}],
+    ),
+    (
+        "nested object path, full object match",
+        {"foo.bar": {"baz": "qux", "$eq": "bar"}},
+        [
+            {"foo": {"bar": {"baz": "qux", "$eq": "bar"}}},
+            {"foo": {"bar": {"baz": "qux", "bla": "jaz"}}},
+            {},
+            {"foo": "bar"},
+            {"foo": {"bar": "baz"}},
+        ],
+        [{"foo": {"bar": {"baz": "qux", "$eq": "bar"}}}],
+    ),
+    (
+        "nested object path, full object match",
+        {"foo.bar": {"baz": "qux"}},
+        [
+            {"foo": {"bar": {"baz": "qux"}}},
+            {"foo": {"bar": {"baz": "qux", "bla": "jaz"}}},
+            {},
+            {"foo": "bar"},
+            {"foo": {"bar": "baz"}},
+        ],
+        [{"foo": {"bar": {"baz": "qux"}}}],
+    ),
+    (
+        "implicit $eq, object against null",
+        {"foo.bar": None},
+        [
+            {"foo": {"bar": None}},
+            {"foo": {"bar": "baz"}},
+            {"foo": None},
+            {"foo": "bar"},
+            {},
+        ],
+        [{"foo": {"bar": None}}, {"foo": None}, {"foo": "bar"}, {}],
+    ),
+    (
+        "explicit $eq, object against null",
+        {"foo.bar": {"$eq": None}},
+        [
+            {"foo": {"bar": None}},
+            {"foo": {"bar": "baz"}},
+            {"foo": None},
+            {"foo": "bar"},
+            {},
+        ],
+        [{"foo": {"bar": None}}, {"foo": None}, {"foo": "bar"}, {}],
+    ),
+    (
+        "match against arrays on ov",
+        {"foo.bar": ["baz"]},
+        [
+            {"foo": {"bar": "baz"}},
+            {"foo": {"bar": ["baz"]}},
+            {"foo": {"bar": [["baz"]]}},
+            {"foo": {"bar": ["baz", ["baz"]]}},
+            {"foo": {"bar": ["baz", "bar"]}},
+            {},
+            {"foo": "bar"},
+            {"foo": [{"bar": "qux"}]},
+        ],
+        [
+            {"foo": {"bar": ["baz"]}},
+            {"foo": {"bar": [["baz"]]}},
+            {"foo": {"bar": ["baz", ["baz"]]}},
+        ],
+    ),
+    (
+        "match against arrays on doc",
+        {"foo.bar": "baz"},
+        [
+            {"foo": {"bar": ["bar"]}},
+            {"foo": {"bar": ["baz", "bar"]}},
+            {},
+            {"foo": "bar"},
+            {"foo": [{"bar": "qux"}]},
+        ],
+        [{"foo": {"bar": ["baz", "bar"]}}],
+    ),
+    (
+        "unindexed nested object path with intermediate arrays on doc",
+        {"a.b.c.d": 1},
+        [
+            {"a": {"b": {"c": [{"d": [1]}]}}},
+            {"a": [{"b": [{"c": [{"d": 1}]}]}]},
+            {"a": [{"b": {"c": [{"d": 1}]}}]},
+            {"a": {"b": {"c": [None, {"d": 1}]}}},
+            {"a": [{"b": [{"c": [{"d": 2}]}]}]},
+            {"a": {}},
+            {},
+        ],
+        [
+            {"a": {"b": {"c": [{"d": [1]}]}}},
+            {"a": [{"b": [{"c": [{"d": 1}]}]}]},
+            {"a": [{"b": {"c": [{"d": 1}]}}]},
+            {"a": {"b": {"c": [None, {"d": 1}]}}},
+        ],
+    ),
+    (
+        "unindexed nested object path against null",
+        {"foo.bar": None},
+        [
+            {"foo": [{"bar": "baz"}]},
+            {},
+            {"foo": "bar"},
+            {"foo": {"bar": None}},
+            {"foo": [{"bar": "qux"}]},
+        ],
+        [{}, {"foo": "bar"}, {"foo": {"bar": None}}],
+    ),
+    (
+        "indexed nested object path with intermediate arrays on doc",
+        {"foo.1.bar": "baz"},
+        [
+            {"foo": [{}, {"bar": "baz"}]},
+            {"foo": [{"bar": "baz"}, {}]},
+            {},
+            {"foo": "bar"},
+            {"foo": [{"bar": "qux"}]},
+        ],
+        [{"foo": [{}, {"bar": "baz"}]}],
+    ),
+    (
+        "nested arrays on doc",
+        {"foo.bar.baz": "qux"},
+        [
+            {"foo": [{"bar": [{"baz": "qux"}]}]},
+            {},
+            {"foo": "bar"},
+            {"foo": [{"bar": "baz"}]},
+        ],
+        [{"foo": [{"bar": [{"baz": "qux"}]}]}],
+    ),
+]
+
+
+@pytest.mark.parametrize("name,query,input,expected", testcases)
+def test_mgqpy_eq(name, query, input, expected):
+    q = Query(query)
+    actual = filter(q.match, input)
+    assert list(actual) == expected, name