object-filtering 0.1.11__tar.gz

object_filtering-0.1.11/.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/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/
+/docs/object_filtering.ebnf
+/dist_old
+/.vscode

object_filtering-0.1.11/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Scott Ratchford
+
+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.

object_filtering-0.1.11/PKG-INFO

@@ -0,0 +1,44 @@
+Metadata-Version: 2.3
+Name: object_filtering
+Version: 0.1.11
+Summary: A module for determining whether arbitrary Python objects meet a set of defined criteria.
+Project-URL: Homepage, https://github.com/KyberCritter/Object-Filtering
+Project-URL: Issues, https://github.com/KyberCritter/Object-Filtering/issues
+Author-email: Scott Ratchford <object_filtering@scottratchford.com>
+License-File: LICENSE.txt
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: File Formats :: JSON
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# Object Filtering
+
+A Python module that functions for determining whether arbitrary Python objects meet a set of defined criteria. Filters use JSON to represent a set of criteria that objects must meet. Filters can be arbitrarily nested and can contain conditional logic.
+
+See `/docs/filter_specifications.md` for details on filter implementation.
+
+## Installation Options
+
+1. Download the latest version of `object_filtering` from PyPi by running the command `pip install object_filtering`.
+2. Download the latest version of `object_filtering` from the Releases tab on GitHub and install the wheel (`.whl`).
+
+## Making Modifications
+
+1. Clone this repository.
+2. Make modifications to the source code.
+3. (Optional) Change the module version in `pyproject.toml`.
+4. Run `pytest` from the root of the repository to run unit tests. Only continue if all tests pass.
+5. Build the module by running `py -m build` from the root of the repository.
+6. Install the newly built wheel file.
+
+## License
+
+(c) 2024 Scott Ratchford.
+
+`object_filtering` is licensed under the MIT License. See `LICENSE.txt` for details.

object_filtering-0.1.11/Pipfile

@@ -0,0 +1,11 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+
+[dev-packages]
+
+[requires]
+python_version = "3.12"

object_filtering-0.1.11/README.md

@@ -0,0 +1,25 @@
+# Object Filtering
+
+A Python module that functions for determining whether arbitrary Python objects meet a set of defined criteria. Filters use JSON to represent a set of criteria that objects must meet. Filters can be arbitrarily nested and can contain conditional logic.
+
+See `/docs/filter_specifications.md` for details on filter implementation.
+
+## Installation Options
+
+1. Download the latest version of `object_filtering` from PyPi by running the command `pip install object_filtering`.
+2. Download the latest version of `object_filtering` from the Releases tab on GitHub and install the wheel (`.whl`).
+
+## Making Modifications
+
+1. Clone this repository.
+2. Make modifications to the source code.
+3. (Optional) Change the module version in `pyproject.toml`.
+4. Run `pytest` from the root of the repository to run unit tests. Only continue if all tests pass.
+5. Build the module by running `py -m build` from the root of the repository.
+6. Install the newly built wheel file.
+
+## License
+
+(c) 2024 Scott Ratchford.
+
+`object_filtering` is licensed under the MIT License. See `LICENSE.txt` for details.

object_filtering-0.1.11/docs/filter_specifications.md

@@ -0,0 +1,175 @@
+# Filter Specifications
+
+(c) 2024 Scott Ratchford
+
+This file is licensed under the MIT License. See LICENSE.txt for details.
+
+Filters are JSON objects containing conditional checks and comparisons to perform on the instance variables, properties, and methods of any Python object. To use a method in a filter, the method definition must be decorated with the `@filter_criterion'. Instance variables and properties can be used without the decorator.
+
+## Extended Backus-Naur Form of Filter Specifications
+
+This format defines the representation of a filter in JSON. When parsing filters, whitespace between components is ignored.
+
+```EBNF
+# filter, the highest level. Always defines at least 1 logical_component.
+filter ::= "{\"name\":" string ", \"description\":" string ",\"priority\":" nonnegative_integer ",\"object_types\": [" object_types "], \"logical_component\":" logical_component "}"
+
+# Non-logic information for filter
+object_types ::= string | string "," object_types
+
+# logical_components, the second level. All logical_components are interchangeable in any circumstance.
+logical_components ::= logical_component | logical_component logical_components
+logical_component ::= filter | rule | conditional_statement | group_expression
+rule ::= "\"criterion:\"" string ", \"operator\":" operator ", \"comparison_value:\"" comparison_value ", \"parameters:\"" parameter_list ", \"multi_object_behavior:\"" multi_object_behavior
+conditional_statement ::= "{\"if\":" logical_components ", \"then\":" logical_components ", \"else\":" logical_components "}"
+group_expression ::= "{ \"condition\":" condition ", \"logical_components\":" logical_components "}"
+
+# Portions of logical_components. Cannot be used on their own.
+operator ::= "\"<\"" | "\"<=\"" | "\"==\"" | "\"!=\"" | "\">=\"" | "\">\""
+comparison_value ::= integer | float | string | boolean
+condition ::= "and" | "or"
+parameter_list ::= "[]" | "[" parameters "]"
+parameters ::= comparison_value | comparison_value "," parameters
+multi_object_behavior ::= "\"none\"" | "\"add\"" | "\"each_meets_criterion\"" | "\"each_equal_in_object\""
+
+# Basic data types. Equivalent to their JSON EBNF. (nonnegative_integer is not a data type in JSON.)
+integer ::= "-" digits | nonnegative_integer
+digits ::= digit | digit digits
+digit ::= "0" | nonzero_digit
+nonzero_digit ::= "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"
+nonnegative_integer ::= "0" | nonzero_digit digits | digits
+
+float ::= integer "." nonnegative_integer | integer "." nonnegative_integer exponent | integer exponent
+exponent ::= exponent_letter "+" nonnegative_integer | exponent_letter integer
+exponent_letter ::= "e" | "E"
+
+string ::=  "\"\"" | "\"" chars "\""
+chars ::= char | char chars
+char ::= " " | "!" | "\"" | "#" | "$" | "%" | "&" | "'" | "(" | ")" | "*" | "+" | "," | "-" | "." | "/" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | ":" | ";" | "<" | "=" | ">" | "?" | "@" | "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z" | "[" | "\\" | "]" | "^" | "_" | "`" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "{" | "|" | "}" | "~"
+
+boolean ::= "true" | "false"
+```
+
+## Terms
+
+- **Logical Expression**: A single boolean value, rule, group expression, conditional expression, or filter.
+- **Boolean Value**: The literal value True or False.
+- **Rule**: The lowest-level logical expression, which cannot contain any other logical expressions. Evaluates to True or False based on the criterion within.
+- **Group Expression**: A group of logical expressions, joined with a logical operator.
+- **Conditional Expression**: Logical expressions that evaluate based on the criteria of the other logical expressions within.
+- **Operator**: Comparison symbols. <, <=, ==, !=, >=, >.
+- **Logical Operator**: Terms that define how many logical expressions within must evaluate to True for the whole group to be True. "and" or "or".
+
+## Detailed Filter Structure
+
+### Filter
+
+A filter is an object that includes several key elements:
+
+- **name**: The name of the filter.
+- **description**: A brief explanation of what the filter does.
+- **priority**: A number indicating how important the filter is (lower numbers indicate higher priority, must be >= 0).
+- **object_types**: A list of types of objects the filter applies to.
+- **logical_expression**: A single logical expression, as defined above.
+
+### Rule
+
+A rule specifies a single condition to check and includes:
+
+- **Criterion**: The property to check (e.g., width, height).
+- **Operator**: The operator used to compare the criterion with the comparison value. Defined above.
+- **Comparison Value**: The value to compare the property against.
+- **Parameters**: Additional values to use in the comparison, if the criterion is a method.
+- **Multi Value Behavior**: How a list of values returned by evaluating the criterion should be evaluated. For advanced usage only. "none", "add", "each_meets_criterion", or "each_equal_in_object".
+
+### Operators
+
+Operators define how to compare values:
+
+| Operator | Meaning           |
+|----------|-------------------|
+| <        | Less than         |
+| <=       | Less than or equal|
+| ==       | Equal to          |
+| !=       | Not equal to      |
+| >=       | Greater than or equal |
+| >        | Greater than      |
+
+### Group Expressions
+
+Group expressions define the conditions and rules that the filter uses. They use a logical operator (defined above) to determine how many of the logical expressions must evaluate to **True** for the whole group expression to evaluate to **True**.
+
+- **logical_operator**: The logical operator to use. "and" indicates that all logical expressions evaluate to **True** for the group expression to be **True**. "or" indicates that 1 or more logical expressions must evaluate to **True** for the group expression to be **True**.
+- **logical_expressions**: One or more logical expressions of any kind. Surrounded by `[ ]`.
+
+### Conditional Expression
+
+A conditional expression includes three parts:
+
+- **if**: The first logical expression to evaluate. If the logical expression evaluates to **True**, the *then* conditional expression will be evaluated. If the *if* portion evaluates to **False**, the *else* portion will be evaluated.
+- **then**: A logical expression, only evaluated if *if* is **True**. If *if* is **True** and *then* is **True**, then the conditional expression is **True**. If *if* is **True** and *then* is **False**, then the conditional expression is **False**.
+- **else**: A logical expression, only evaluated if *if* is **False**. If *if* is **False** and *else* is **True**, then the conditional expression is **True**. If *if* is **False** and *else* is **False**, then the conditional expression is **False**.
+
+To evaluate to **True**, either the *if* and *then* conditions must evaluate to **True**, or the *if* conditions must evaluate to **False** and the *else* conditions must evaluate to **True**.
+
+```JSON
+{
+    "name": "Fits in Box",
+    "description": "A sample filter demonstrating potential conditions for an animal to fit in a cardboard box.",
+    "priority": 2,
+    "object_types": ["Animal"],
+    "logical_expression": [
+        {
+            "logical_operator": "or",
+            "logical_expressions": [
+                {
+                    "if": {
+                        "logical_operator": "and",
+                        "logical_expressions": [
+                            {"criterion": "species", "operator": "==", "comparison_value": "cat", "parameters": [], "multi_value_behavior": "none"},
+                            {"criterion": "weight", "operator": "<", "comparison_value": 8.9, "parameters": [], "multi_value_behavior": "none"},
+                        ]
+                    },
+                    "then": {
+                        "logical_operator": "or",
+                        "logical_expressions": [
+                            {"criterion": "height", "operator": "<=", "comparison_value": 1.5, "parameters": [], "multi_value_behavior": "none"},
+                            {"criterion": "length", "operator": "<=", "comparison_value": 2, "parameters": [], "multi_value_behavior": "none"}
+                        ]
+                    },
+                    "else": {
+                        "logical_operator": "and",
+                        "logical_expressions": [
+                            {"criterion": "species", "operator": "==", "comparison_value": "cat", "parameters": [], "multi_value_behavior": "none"}
+                        ]
+                    }
+                },
+                {
+                    "if": {
+                        "condition": "and",
+                        "rules": [
+                            {"criterion": "species", "operator": "==", "comparison_value": "dog", "parameters": [], "multi_value_behavior": "none"},
+                            {"criterion": "weight", "operator": "<", "comparison_value": 8.9, "parameters": [], "multi_value_behavior": "none"},
+                        ]
+                    },
+                    "then": {
+                        "condition": "or",
+                        "rules": [
+                            {"criterion": "height", "operator": "<=", "comparison_value": 1.5, "parameters": [], "multi_value_behavior": "none"},
+                            {"criterion": "length", "operator": "<=", "comparison_value": 2.5, "parameters": [], "multi_value_behavior": "none"}
+                        ]
+                    },
+                    "else": false,
+                }
+            ]
+        },
+        {
+            "logical_operator": "and",
+            "logical_expressions": [
+                {"criterion": "width", "operator": "<=", "comparison_value": 20, "parameters": [], "multi_value_behavior": "none"},
+                {"criterion": "rounded_length", "operator": "<=", "comparison_value": 62, "parameters": [], "multi_value_behavior": "none"}
+            ]
+        }
+    ]
+}
+```

object_filtering-0.1.11/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.setuptools]
+packages = ["object_filtering"]
+
+[project]
+name = "object_filtering"
+version = "0.1.11"
+authors = [
+    { name="Scott Ratchford", email="object_filtering@scottratchford.com" },
+]
+description = "A module for determining whether arbitrary Python objects meet a set of defined criteria."
+readme = "README.md"
+requires-python = ">=3.12"
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.12",
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Topic :: File Formats :: JSON",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Utilities",
+]
+
+[project.urls]
+Homepage = "https://github.com/KyberCritter/Object-Filtering"
+Issues = "https://github.com/KyberCritter/Object-Filtering/issues"
+
+[tool.pytest.ini_options]
+pythonpath = [
+  "."
+]

object_filtering-0.1.11/src/object_filtering/__init__.py

@@ -0,0 +1,4 @@
+# (c) 2024 Scott Ratchford
+# This file is licensed under the MIT License. See LICENSE.txt for details.
+
+from .object_filtering import *