A filter library for python
Project description
filterlib
A filter library for python by Fabian Becker.
What for?
With a Filter
object you can easily check for attributes of an object to equal a given value.
Usage
How to create a filter
Create a filter using init()
Both attributes are optional.
operator: str = "AND"
("AND"
or "OR"
) sets the logical operator for the filter (checks all or any attributes).
allow_missing_attributes: bool = False
sets the tolerance for missing attributes. If set to true it will skip if the attribute is missing in the object to check.
Create a filter from its representation
The return value of a filters __repr__
attribute can be used to store and later on recreate a filter using filter_from_repr
from filterlib.filtermodule import Filter, filter_from_repr
f = Filter()
print(f == filter_from_repr(f.__repr__()))
# f and filter_from_repr(f.__repr__()) is the same
Additional attributes
The attribute a filter checks for are variable
from filterlib.filtermodule import Filter
# Use the following systax:
f = Filter(<attibute name><attributes magic method>=<value>)
# For example:
f = Filter(a__eq__=1)
# You can also use multiple attributes:
f = Filter(b__lte__=5,
c__gt__=2)
Use a filter
Make sure you use the filters __eq__
attribute.
# Make sure you use
Filter() == x
# instead of
x == Filter()
Example
from filterlib.filtermodule import Filter
from typing import Optional
class Person:
def __init__(self,
name: str,
age: int,
best_friend: Optional[Person] = None):
self.name = name
self.age = age
self.best_fiend = best_friend
f = Filter(name__eq__="John")
p = Person(name="John", age=35)
print(f == p)
# True
f = Filter(name__ne__="John")
p = Person(name="John", age=35)
print(f == p)
# False
f = Filter(name__eq__="John", age__lte=40)
p = Person(name="John", age=35)
print(f == p)
# True
f = Filter(name__eq__="John", age__lte=20)
p = Person(name="John", age=35)
print(f == p)
# False
f = Filter(operator="OR",
name__eq__="John",
age__lte=20)
p = Person(name="John", age=35)
print(f == p)
# True
p = Person(name="John",
age=35,
best_friend=Person(name="Thomas",
age=36))
f = Filter(best_friend__name__eq__="Thomas",
age__lte=40)
print(f == p)
# True
SQL compatability
You can use filters for sql statements
from filterlib.filtermodule import Filter
import sqlite3
db = sqlite3.connect("myDB.sqlite")
db.execute("CREATE TABLE users(id, name)")
f = Filter(id__eq__=1)
db.execute(f"SELECT name FROM users WHERE {f}")
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for filterlib-0.0.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d7aa0f4aabedecf94f58cbbb69d141a40643c2413c2396b9482fa6e35737b6a0 |
|
MD5 | 958a7bcf425c8e8b8a2b81ee07ddc800 |
|
BLAKE2b-256 | 5e0a22d424f8475b89ece7272c3be033611e14892884a035df54b2a064039d37 |