classic-criteria 0.0.1__tar.gz

classic-criteria-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Sergei Variasov
+
+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.

classic-criteria-0.0.1/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.1
+Name: classic-criteria
+Version: 0.0.1
+Summary: Provides criteria object
+Home-page: https://github.com/variasov/classic-criteria
+Author: Sergei Variasov
+Author-email: variasov@gmail.com
+Project-URL: Bug Tracker, https://github.com/variasov/classic-criteria/issues
+Classifier: Programming Language :: Python :: 3.10
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 4 - Beta
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest~=7.4.4; extra == "dev"
+Requires-Dist: pytest-cov~=4.1; extra == "dev"
+Requires-Dist: twine~=4.0; extra == "dev"
+Requires-Dist: build~=1.0; extra == "dev"
+
+# Classic Criteria
+
+Дает объект-критерий.
+
+Нужен для описания критериев объектов, чтобы затем определять,
+соответствуют ли те или иные объекты критерию, или для формирования запроса,
+к примеру, в SQL-хранилище.
+
+Пример:
+```python
+from datetime import datetime
+from dataclasses import dataclass
+from classic.criteria import Criteria
+
+
+@dataclass
+class Task:
+    created_at: datetime
+    finished_at: datetime
+
+    
+@dataclass
+class TaskOlderThan(Criteria[Task]):
+    date: datetime
+
+    def is_satisfied_by(self, candidate: Task) -> bool:
+        return candidate.created_at < self.date
+
+    
+@dataclass
+class TaskObsolete(Criteria[Task]):
+    days_to_work: int
+
+    def is_satisfied_by(self, candidate: Task) -> bool:
+        days_spent = candidate.finished_at - candidate.created_at
+        return days_spent.days > self.days_to_work
+
+    
+some_task = Task(
+    created_at=datetime(2024, 1, 1),
+    finished_at=datetime(2024, 1, 10),
+)
+criteria = TaskObsolete(3) & TaskOlderThan(datetime(2024, 1, 31))
+assert criteria.is_satisfied_by(some_task)
+
+
+some_task = Task(
+    created_at=datetime(2024, 1, 1),
+    finished_at=datetime(2024, 1, 1),
+)
+criteria = TaskObsolete(3) & TaskOlderThan(datetime(2024, 1, 31))
+assert not criteria.is_satisfied_by(some_task)
+```

classic-criteria-0.0.1/README.md

@@ -0,0 +1,53 @@
+# Classic Criteria
+
+Дает объект-критерий.
+
+Нужен для описания критериев объектов, чтобы затем определять,
+соответствуют ли те или иные объекты критерию, или для формирования запроса,
+к примеру, в SQL-хранилище.
+
+Пример:
+```python
+from datetime import datetime
+from dataclasses import dataclass
+from classic.criteria import Criteria
+
+
+@dataclass
+class Task:
+    created_at: datetime
+    finished_at: datetime
+
+    
+@dataclass
+class TaskOlderThan(Criteria[Task]):
+    date: datetime
+
+    def is_satisfied_by(self, candidate: Task) -> bool:
+        return candidate.created_at < self.date
+
+    
+@dataclass
+class TaskObsolete(Criteria[Task]):
+    days_to_work: int
+
+    def is_satisfied_by(self, candidate: Task) -> bool:
+        days_spent = candidate.finished_at - candidate.created_at
+        return days_spent.days > self.days_to_work
+
+    
+some_task = Task(
+    created_at=datetime(2024, 1, 1),
+    finished_at=datetime(2024, 1, 10),
+)
+criteria = TaskObsolete(3) & TaskOlderThan(datetime(2024, 1, 31))
+assert criteria.is_satisfied_by(some_task)
+
+
+some_task = Task(
+    created_at=datetime(2024, 1, 1),
+    finished_at=datetime(2024, 1, 1),
+)
+criteria = TaskObsolete(3) & TaskOlderThan(datetime(2024, 1, 31))
+assert not criteria.is_satisfied_by(some_task)
+```

classic-criteria-0.0.1/pyproject.toml

@@ -0,0 +1,6 @@
+[build-system]
+requires = [
+    "setuptools >= 40.6.0",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"

classic-criteria-0.0.1/setup.cfg

@@ -0,0 +1,37 @@
+[metadata]
+name = classic-criteria
+version = 0.0.1
+description = Provides criteria object
+author = Sergei Variasov
+author_email = variasov@gmail.com
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/variasov/classic-criteria
+project_urls = 
+	Bug Tracker = https://github.com/variasov/classic-criteria/issues
+classifiers = 
+	Programming Language :: Python :: 3.10
+	License :: OSI Approved :: MIT License
+	Operating System :: OS Independent
+	Development Status :: 4 - Beta
+
+[options]
+packages = find_namespace:
+python_requires = >=3.10
+package_dir = 
+	= sources
+
+[options.packages.find]
+where = sources
+
+[options.extras_require]
+dev = 
+	pytest~=7.4.4
+	pytest-cov~=4.1
+	twine~=4.0
+	build~=1.0
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

classic-criteria-0.0.1/setup.py

@@ -0,0 +1,3 @@
+from setuptools import setup
+
+setup()

classic-criteria-0.0.1/sources/classic/criteria/__init__.py

@@ -0,0 +1 @@
+from .criteria import Criteria

classic-criteria-0.0.1/sources/classic/criteria/criteria.py

@@ -0,0 +1,187 @@
+from typing import Generic, Optional, Self, TypeVar, get_args, Type
+
+
+Entity = TypeVar('Entity')
+
+
+class Criteria(Generic[Entity]):
+    """
+    Базовый объект-критерий.
+
+    Нужен для описания критериев объектов, чтобы затем определять,
+    соответствуют ли те или иные объекты критерию, или для формирования запроса,
+    к примеру, в SQL-хранилище.
+
+    Взят отсюда и чуть-чуть доработано:
+    https://gist.github.com/palankai/f73a18ce06751ab8f245
+
+    Пример:
+    >>> from datetime import datetime
+    ... from dataclasses import dataclass
+    ... from classic.criteria import Criteria
+    ...
+    ... @dataclass
+    ... class Task:
+    ...     created_at: datetime
+    ...     finished_at: datetime
+    ...
+    ... @dataclass
+    ... class TaskOlderThan(Criteria[Task]):
+    ...     date: datetime
+    ...
+    ...     def is_satisfied_by(self, candidate: Task) -> bool:
+    ...         return candidate.created_at < self.date
+    ...
+    ... @dataclass
+    ... class TaskObsolete(Criteria[Task]):
+    ...     days_to_work: int
+    ...
+    ...     def is_satisfied_by(self, candidate: Task) -> bool:
+    ...         days_spent = candidate.finished_at - candidate.created_at
+    ...         return days_spent.days > self.days_to_work
+    ...
+    ... some_task = Task(
+    ...     created_at=datetime(2024, 1, 1),
+    ...     finished_at=datetime(2024, 1, 10),
+    ... )
+    ... criteria = TaskObsolete(3) & TaskOlderThan(datetime(2024, 1, 31))
+    ... criteria.is_satisfied_by(some_task)
+    True
+    >>> some_task = Task(
+    ...     created_at=datetime(2024, 1, 1),
+    ...     finished_at=datetime(2024, 1, 1),
+    ... )
+    ... criteria = TaskObsolete(3) & TaskOlderThan(datetime(2024, 1, 31))
+    ... criteria.is_satisfied_by(some_task)
+    False
+    """
+
+    @property
+    def entity_cls(self) -> Type[object]:
+        args = get_args(self)
+        if len(args) >= 0:
+            return args[0]
+
+    def __and__(self, other):
+        return And(self, other)
+
+    def __or__(self, other):
+        return Or(self, other)
+
+    def __xor__(self, other):
+        return Xor(self, other)
+
+    def __invert__(self):
+        return Invert(self)
+
+    def is_satisfied_by(self, candidate: Entity) -> bool:
+        raise NotImplemented
+
+    def remainder_unsatisfied_by(self, candidate: Entity) -> Optional[Self]:
+        if self.is_satisfied_by(candidate):
+            return None
+        else:
+            return self
+
+
+class BoundCriteria(Criteria[Entity]):
+
+    def __init__(self, fn, *args, **kwargs):
+        self.fn = fn
+        self.args = args
+        self.kwargs = kwargs
+
+    def is_satisfied_by(self, candidate: Entity) -> bool:
+        assert isinstance(candidate, self.entity_cls)
+        return self.fn(candidate, *self.args, **self.kwargs)
+
+
+class CompositeCriteria(Criteria[Entity]):
+
+    def __init__(self, *criteria: Criteria[Entity]):
+        self.criteria = criteria
+
+    def is_satisfied_by(self, candidate: Entity) -> bool:
+        raise NotImplementedError
+
+
+class And(CompositeCriteria):
+
+    def __and__(self, other: Criteria[Entity]):
+        if isinstance(other, And):
+            self.criteria += other.criteria
+        else:
+            self.criteria += (other,)
+        return self
+
+    def is_satisfied_by(self, candidate: Entity):
+        satisfied = all([
+            criteria.is_satisfied_by(candidate)
+            for criteria in self.criteria
+        ])
+        return satisfied
+
+    def remainder_unsatisfied_by(self, candidate: Entity):
+        non_satisfied = [
+            criteria
+            for criteria in self.criteria
+            if not criteria.is_satisfied_by(candidate)
+        ]
+        if not non_satisfied:
+            return None
+        if len(non_satisfied) == 1:
+            return non_satisfied[0]
+        if len(non_satisfied) == len(self.criteria):
+            return self
+        return And(*non_satisfied)
+
+
+class Or(CompositeCriteria):
+
+    def __or__(self, other):
+        if isinstance(other, Or):
+            self.criteria += other.criteria
+        else:
+            self.criteria += (other,)
+        return self
+
+    def is_satisfied_by(self, candidate: Entity):
+        satisfied = any([
+            criteria.is_satisfied_by(candidate)
+            for criteria in self.criteria
+        ])
+        return satisfied
+
+
+class NestedCriteria(Criteria[Entity]):
+
+    def __init__(self, criteria: Criteria[Entity]):
+        self.criteria = criteria
+
+    def is_satisfied_by(self, candidate: Entity) -> bool:
+        raise NotImplementedError
+
+
+class Invert(NestedCriteria):
+
+    def is_satisfied_by(self, candidate: Entity):
+        return not self.criteria.is_satisfied_by(candidate)
+
+
+class BinaryCriteria(Criteria[Entity]):
+
+    def __init__(self, left: Criteria[Entity], right: Criteria[Entity]):
+        self.left = left
+        self.right = right
+
+    def is_satisfied_by(self, candidate: Entity) -> bool:
+        raise NotImplementedError
+
+
+class Xor(BinaryCriteria[Entity]):
+
+    def is_satisfied_by(self, candidate: Entity):
+        return (
+            self.left.is_satisfied_by(candidate) ^
+            self.right.is_satisfied_by(candidate)
+        )

classic-criteria-0.0.1/sources/classic_criteria.egg-info/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.1
+Name: classic-criteria
+Version: 0.0.1
+Summary: Provides criteria object
+Home-page: https://github.com/variasov/classic-criteria
+Author: Sergei Variasov
+Author-email: variasov@gmail.com
+Project-URL: Bug Tracker, https://github.com/variasov/classic-criteria/issues
+Classifier: Programming Language :: Python :: 3.10
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 4 - Beta
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest~=7.4.4; extra == "dev"
+Requires-Dist: pytest-cov~=4.1; extra == "dev"
+Requires-Dist: twine~=4.0; extra == "dev"
+Requires-Dist: build~=1.0; extra == "dev"
+
+# Classic Criteria
+
+Дает объект-критерий.
+
+Нужен для описания критериев объектов, чтобы затем определять,
+соответствуют ли те или иные объекты критерию, или для формирования запроса,
+к примеру, в SQL-хранилище.
+
+Пример:
+```python
+from datetime import datetime
+from dataclasses import dataclass
+from classic.criteria import Criteria
+
+
+@dataclass
+class Task:
+    created_at: datetime
+    finished_at: datetime
+
+    
+@dataclass
+class TaskOlderThan(Criteria[Task]):
+    date: datetime
+
+    def is_satisfied_by(self, candidate: Task) -> bool:
+        return candidate.created_at < self.date
+
+    
+@dataclass
+class TaskObsolete(Criteria[Task]):
+    days_to_work: int
+
+    def is_satisfied_by(self, candidate: Task) -> bool:
+        days_spent = candidate.finished_at - candidate.created_at
+        return days_spent.days > self.days_to_work
+
+    
+some_task = Task(
+    created_at=datetime(2024, 1, 1),
+    finished_at=datetime(2024, 1, 10),
+)
+criteria = TaskObsolete(3) & TaskOlderThan(datetime(2024, 1, 31))
+assert criteria.is_satisfied_by(some_task)
+
+
+some_task = Task(
+    created_at=datetime(2024, 1, 1),
+    finished_at=datetime(2024, 1, 1),
+)
+criteria = TaskObsolete(3) & TaskOlderThan(datetime(2024, 1, 31))
+assert not criteria.is_satisfied_by(some_task)
+```

classic-criteria-0.0.1/sources/classic_criteria.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+setup.cfg
+setup.py
+sources/classic/criteria/__init__.py
+sources/classic/criteria/criteria.py
+sources/classic_criteria.egg-info/PKG-INFO
+sources/classic_criteria.egg-info/SOURCES.txt
+sources/classic_criteria.egg-info/dependency_links.txt
+sources/classic_criteria.egg-info/requires.txt
+sources/classic_criteria.egg-info/top_level.txt

classic-criteria-0.0.1/sources/classic_criteria.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

classic-criteria-0.0.1/sources/classic_criteria.egg-info/requires.txt

@@ -0,0 +1,6 @@
+
+[dev]
+pytest~=7.4.4
+pytest-cov~=4.1
+twine~=4.0
+build~=1.0

classic-criteria-0.0.1/sources/classic_criteria.egg-info/top_level.txt

@@ -0,0 +1 @@
+classic