py-incl-excl-regex 0.1.0

Regex-based inclusion/exclusion filter loaded from JSON config

py-incl-excl-regex

Regex-based inclusion/exclusion filter for Python.

Install

pip install py-incl-excl-regex

Quick start

from incl_excl_regex import PatternFilter

f = PatternFilter(
    include=[r"sg\.gov\.sla"],
    exclude=[r"\.to(\.|$)", r"\.dao(\.|$)"],
)

f.matches("sg.gov.sla.stars.service.FooService")  # True
f.matches("sg.gov.sla.stars.to.FooTo")            # False — excluded
f.matches("com.example.Bar")                       # False — not included

Filter rules

• Include list: a value must match at least one include pattern to pass. Omitting include patterns accepts everything.
• Exclude list: a value must not match any exclude pattern.
• Exclude wins: if a value matches both an include and an exclude pattern, it is rejected.
• Patterns are matched with re.search — the pattern can match anywhere in the string.

Loading from a JSON file

f = PatternFilter.from_file("filter.json")

Expected JSON shape (both keys are optional):

{
  "include": ["sg\\.gov\\.sla"],
  "exclude": ["\\.to(\\.|$)", "\\.dao(\\.|$)"]
}

Anchoring

Patterns use re.search, so they match anywhere in the string by default. Use ^ and $ anchors when you need to match from the start or end:

PatternFilter(include=[r"^sg\.gov\.sla"])   # must start with sg.gov.sla
PatternFilter(exclude=[r"\.to$"])            # only rejects strings ending in .to