Skip to main content

A compact predicate DSL for matching criteria against any object

Project description

koalify

A compact predicate DSL for matching criteria against any Python object. Zero runtime dependencies.

Installation

pip install koalify

Quick Start

from koalify import F, all_of, any_of

# Build rules with Python operators
is_eligible = (
    (F.status == "active")
    & (F.age >= 18)
    & (F.role.in_({"admin", "moderator", "editor"}))
    & F.score.between(50, 100)
)

# Evaluate against any object with attributes
is_eligible(user)  # True / False

# Nested fields
lives_in_london = F.address.city == "London"

# Compose with OR / NOT
can_access = is_eligible | (lives_in_london & ~(F.status == "banned"))

# Dynamic composition from a list
conditions = [F.status == "active", F.age >= 18]
rule = all_of(*conditions)

Examples

Dataclasses

from dataclasses import dataclass
from koalify import F, all_of

@dataclass
class Order:
    product: str
    quantity: int
    price: float
    fulfilled: bool

needs_review = (F.quantity > 100) & (F.price >= 500) & (F.fulfilled == False)

order = Order(product="Widget", quantity=200, price=750.0, fulfilled=False)
needs_review(order)  # True

Pydantic

from pydantic import BaseModel
from koalify import F, any_of

class Address(BaseModel):
    city: str
    country: str

class Customer(BaseModel):
    name: str
    tier: str
    address: Address

is_priority = (F.tier.in_({"gold", "platinum"})) | (F.address.country == "US")

customer = Customer(name="Alice", tier="gold", address=Address(city="London", country="UK"))
is_priority(customer)  # True

Dynamic rule composition

from koalify import F, all_of

def build_filter(min_age: int | None = None, status: str | None = None, roles: set[str] | None = None):
    criteria = []
    if min_age is not None:
        criteria.append(F.age >= min_age)
    if status is not None:
        criteria.append(F.status == status)
    if roles is not None:
        criteria.append(F.role.in_(roles))
    return all_of(*criteria) if criteria else lambda _: True

user_filter = build_filter(min_age=18, roles={"admin", "editor"})

API

Symbol Description
F.field Reference a field (supports nesting: F.a.b.c)
== != > >= < <= Comparison operators on FieldRef
.in_(values) Set membership
.between(lo, hi) Inclusive range check
& AND (flattens nested ANDs)
| OR (flattens nested ORs)
~ NOT
all_of(*criteria) AND from a list
any_of(*criteria) OR from a list

How It Works

F.field_name returns a FieldRef. Comparison operators on FieldRef produce Criterion objects. Criteria compose with &, |, and ~. Calling a criterion resolves field values via getattr — works with dataclasses, Pydantic models, namedtuples, or any object with attributes.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

koalify-0.2.3.tar.gz (4.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

koalify-0.2.3-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

Details for the file koalify-0.2.3.tar.gz.

File metadata

  • Download URL: koalify-0.2.3.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.2 CPython/3.12.12 Linux/6.14.0-1017-azure

File hashes

Hashes for koalify-0.2.3.tar.gz
Algorithm Hash digest
SHA256 ceda1f1e1ec74394e1d892bba7ae5f93aed2d34dd98325774b4049bc82ec2a34
MD5 79898eea3bb554df0e2bc546a5aa6c53
BLAKE2b-256 24fb537b133ab81d726400b4be0f17eb4b26c3f4877711d3bb04f3320c158c85

See more details on using hashes here.

File details

Details for the file koalify-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: koalify-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 5.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.2 CPython/3.12.12 Linux/6.14.0-1017-azure

File hashes

Hashes for koalify-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8af567a362d6ad6008702cbf1ec9f1bb2e29830fbda974111fcfba067820bd42
MD5 cf0808ee74836c5af348433708e768aa
BLAKE2b-256 b99169cddd35b0211b37c9ddb07b0b92fa294a439b5815c9336d437b4a569ce8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page