pycond 20200612

Lightweight Condition Parsing and Building of Evaluation Expressions

---

author: gk version: 20200612

---

pycond: Lightweight Declarative Condition Expressions

Table Of Contents

• What
• Why
  • Alternatives
• Mechanics
  • Parsing
  • Building
  • Structured Conditions
• Evaluation
  • Default Lookup
  • Passing State
    • Deep Lookup / Nested State / Lists
  • Prefixed Data
  • Custom Lookup And Value Passing
  • Lazy Evaluation
• Details
  • Debugging Lookups
  • Building Conditions From Text
    • Grammar
    • Atomic Conditions
  • Condition Operators
    • Using Symbolic Operators
    • Extending Condition Operators
    • Negation not
    • Reversal rev
    • Wrapping Condition Operators
      • Global Wrapping
      • Condition Local Wrapping
  • Combining Operations
    • Nesting
  • Tokenizing Details
    • Functioning
    • Separator sep
    • Apostrophes
    • Escaping
    • Building
    • Autoconv: Casting of values into python simple types
• Context On Demand And Lazy Evaluation
  • Caching
  • Named Conditions: Qualification
    • Partial Evaluation
• Streaming Data
  • Filtering
  • Streaming Classification
    • Selective Classification
  • Asyncronous Operations

What

You have a bunch of data, possibly streaming...

id,first_name,last_name,email,gender,ip_address
1,Rufe,Morstatt,[e-mail],Male,216.70.69.120
2,Kaela,Scott,[e-mail],Female,73.248.145.44,2
(...)

... and you need to filter. For now lets say we have them already as list of dicts.

You can do it imperatively:

foo_users = [ u for u in users
              if ([u['gender'] == 'Male' or u['last_name'] == 'Scott') and
                  '@' in u['email']) ]

or you have this module assemble a condition function from a declaration like:

from pycond import parse_cond
cond = 'email contains .de and gender eq Male or last_name eq Scott'
is_foo = parse_cond(cond)

and then apply as often as you need, against varying state / facts / models (...):

foo_users = [ u for u in users if is_foo(state=u) ]

with roughly the same performance (factor 2-3) than the handcrafted python.

In real life performance is often better then using imperative code, due to pycond's lazy evaluation feature.

Why

When the developer can decide upon the filters to apply on data he'll certainly use Python's excellent expressive possibilities directly, e.g. as shown above through list comprehensions.
But what if the filtering conditions are based on decisions outside of the program's control? I.e. from an end user, hitting the program via the network, in a somehow serialized form, which is rarely directly evaluatable Python.

This is the main use case for this module.

Alternatives

But why yet another tool for such a standard job?

There is a list of great tools and frameworks where condition parsing is a (small) part of them, e.g. pyke or durable and many in the django world or from SQL statement parsers.

1. I just needed a very slim tool for only the parsing into functions - but this pretty transparent and customizable

pycond allows to customize

• the list of condition operators
• the list of combination operators
• the general behavior of condition operators via global or condition local wrappers
• their names
• the tokenizer
• the value lookup function

and ships as zero dependency single module.

All evaluation is done via partials and not lambdas, i.e. operations can be introspected and debugged very simply, through breakpoints or custom logging operator or lookup wrappers.

2. Simplicity of the grammar: Easy to type directly, readable by non programmers but also synthesisable from structured data, e.g. from a web framework.

3. Performance: Good enough to have "pyconditions" used within stream filters. With the current feature set we are sometimes a factor 2-3 worse but (due to lazy eval) often better, compared with handcrafted list comprehensions.

Mechanics

Parsing

pycond parses the condition expressions according to a set of constraints given to the parser in the tokenizer function. The result of the tokenizer is given to the builder.

import pycond as pc

cond = '[a eq b and [c lt 42 or foo eq bar]]'
cond = pc.to_struct(pc.tokenize(cond, sep=' ', brkts='[]'))
print(cond)
return cond

Output:

[['a', 'eq', 'b', 'and', ['c', 'lt', '42', 'or', 'foo', 'eq', 'bar']]]

Building

After parsing the builder is assembling a nested set of operator functions, combined via combining operators. The functions are partials, i.e. not yet evaluated but information about the necessary keys is already available:

f, meta = pc.parse_cond('foo eq bar')
assert meta['keys'] == ['foo']

Structured Conditions

Other processes may deliver condition structures via serializable formats (e.g. json). If you hand such already tokenized constructs to pycond, then the tokenizer is bypassed:

cond = [['a', 'eq', 'b'], 'or', ['c', 'in', ['foo', 'bar']]]
assert pc.pycond(cond)(state={'a': 'b'}) == True
# json support is built in:
cond_as_json = json.dumps(cond)
assert pc.pycond(cond_as_json)(state={'a': 'b'}) == True

Evaluation

The result of the builder is a 'pycondition', which can be run many times against varying state of the system. How state is evaluated is customizable at build and run time.

Default Lookup

The default is to get lookup keys within expressions from an initially empty State dict within the module - which is not thread safe, i.e. not to be used in async or non cooperative multitasking environments.

f = pc.pycond('foo eq bar')
assert f() == False
pc.State['foo'] = 'bar'  # not thread safe!
assert f() == True

(pycond is a shortcut for parse_cond, when meta infos are not required).

Passing State

Use the state argument at evaluation:

assert pc.pycond('a gt 2')(state={'a': 42}) == True
assert pc.pycond('a gt 2')(state={'a': -2}) == False

Deep Lookup / Nested State / Lists

You may supply a path seperator for diving into nested structures like so:

m = {'a': {'b': [{'c': 1}]}}
assert pc.pycond('a.b.0.c', deep='.')(state=m) == True
assert pc.pycond('a.b.1.c', deep='.')(state=m) == False
assert pc.pycond('a.b.0.c eq 1', deep='.')(state=m) == True
# convencience argument for string conditions:
assert pc.pycond('deep: a.b.0.c')(state=m) == True

# This is how you express deep access via structured conditions:
assert pc.pycond([('a', 'b', 0, 'c'), 'eq', 1])(state=m) == True

# Since tuples are not transferrable in json, we also allow deep paths as list:
# We apply heuristics to exclude expressions or conditions:
c = [[['a', 'b', 0, 'c'], 'eq', 1], 'and', 'a']
f, nfos = pc.parse_cond(c)
# sorting order for keys: tuples at end, sorted by len, rest default py sorted:
assert f(state=m) == True and nfos['keys'] == ['a', ('a', 'b', 0, 'c')]
print(nfos)

Output:

{'keys': ['a', ('a', 'b', 0, 'c')], 'foo': 'bar1'}

Prefixed Data

When data is passed through processing pipelines, it often is passed with headers. So it may be useful to pass a global prefix to access the payload like so:

m = {'payload': {'b': [{'c': 1}], 'id': 123}}
assert pc.pycond('b.0.c', deep='.', prefix='payload')(state=m) == True

Custom Lookup And Value Passing

You can supply your own function for value acquisition.

• Signature: See example.
• Returns: The value for the key from the current state plus the compare value for the operator function.

# must return a (key, value) tuple:
model = {'eve': {'last_host': 'somehost'}}

def my_lu(k, v, req, user, model=model):
    print('user check. locals:', dict(locals()))
    return (model.get(user) or {}).get(k), req[v]

f = pc.pycond('last_host eq host', lookup=my_lu)

req = {'host': 'somehost'}
assert f(req=req, user='joe') == False
assert f(req=req, user='eve') == True

Output:

user check. locals: {'k': 'last_host', 'v': 'host', 'req': {'host': 'somehost'}, 'user': 'joe', 'model': {'eve': {'last_host': 'somehost'}}}
user check. locals: {'k': 'last_host', 'v': 'host', 'req': {'host': 'somehost'}, 'user': 'eve', 'model': {'eve': {'last_host': 'somehost'}}}

as you can see in the example, the state parameter is just a convention for pyconds' default lookup function.

Lazy Evaluation

This is avoiding unnecessary calculations in many cases:

When an evaluation branch contains an "and" or "and_not" combinator, then at runtime we evaluate the first expression - and stop if it is already False. Same when first expression is True, followed by "or" or "or_not".

That way expensive deep branch evaluations are omitted or, when the lookup is done lazy, the values won't be even fetched:

evaluated = []

def myget(key, val, cfg, state=None, **kw):
    evaluated.append(key)
    return pc.state_get(key, val, cfg, state, **kw)

f = pc.pycond('[a eq b] or foo eq bar and baz eq bar', lookup=myget)
assert f(state={'foo': 42}) == False
# the value for "baz" is not even fetched and the whole (possibly
# deep) branch after the last and is ignored:
assert evaluated == ['a', 'foo']
print(evaluated)
evaluated.clear()

f = pc.pycond('[[a eq b] or foo eq bar] and baz eq bar', lookup=myget)
assert f(state={'a': 'b', 'baz': 'bar'}) == True
# the value for "baz" is not even fetched and the whole (possibly
# deep) branch after the last and is ignored:
assert evaluated == ['a', 'baz']
print(evaluated)

Output:

['a', 'foo']
['a', 'baz']

Remember that all keys occurring in a condition (which may be provided by the user at runtime) are returned by the condition parser. Means that building of evaluation contexts can be done, based on the data actually needed and not more.

Details

Debugging Lookups

pycond provides a key getter which prints out every lookup.

f = pc.pycond('[[a eq b] or foo eq bar] or [baz eq bar]', lookup=pc.dbg_get)
assert f(state={'foo': 'bar'}) == True

Output:

Lookup: a b -> None
Lookup: foo bar -> bar

Building Conditions From Text

Condition functions are created internally from structured expressions - but those are hard to type, involving many apostropies.

The text based condition syntax is intended for situations when end users type them into text boxes directly.

Grammar

Combine atomic conditions with boolean operators and nesting brackets like:

[  <atom1> <and|or|and not|...> <atom2> ] <and|or...> [ [ <atom3> ....

Atomic Conditions

[not] <lookup_key> [ [rev] [not] <condition operator (co)> <value> ]

• When just lookup_key is given, then co is set to the truthy function:

def truthy(key, val=None):
    return operatur.truth(k)

so such an expression is valid and True:

pc.State.update({'foo': 1, 'bar': 'a', 'baz': []})
assert pc.pycond('[ foo and bar and not baz]')() == True

• When not lookup_key is given, then co is set to the falsy function:

m = {'x': 'y', 'falsy_val': {}}
# normal way
assert pc.pycond(['foo', 'eq', None])(state=m) == True
# using "not" as prefix:
assert pc.pycond('not foo')(state=m) == True
assert pc.pycond(['not', 'foo'])(state=m) == True
assert pc.pycond('not falsy_val')(state=m) == True
assert pc.pycond('x and not foo')(state=m) == True
assert pc.pycond('y and not falsy_val')(state=m) == False

Condition Operators

All boolean standardlib operators are available by default:

from pytest2md import html_table as tbl  # just a table gen.
from pycond import get_ops

for k in 'nr', 'str':
    s = 'Default supported ' + k + ' operators...(click to extend)'
    print(tbl(get_ops()[k], [k + ' operator', 'alias'], summary=s))

Default supported nr operators...(click to extend)

nr operator	alias
add	+
and_	&
eq	==
floordiv	//
ge	>=
gt	>
iadd	+=
iand	&=
ifloordiv	//=
ilshift	<<=
imod	%=
imul	*=
ior	|=
ipow	**=
irshift	>>=
is_	is
is_not	is
isub	-=
itruediv	/=
ixor	^=
le	<=
lshift	<<
lt	<
mod	%
mul	*
ne	!=
or_	|
pow	**
rshift	>>
sub	-
truediv	/
xor	^
itemgetter
length_hint

Default supported str operators...(click to extend)

str operator	alias
attrgetter
concat	+
contains
countOf
iconcat	+=
indexOf
methodcaller

Using Symbolic Operators

By default pycond uses text style operators.

• ops_use_symbolic switches processwide to symbolic style only.
• ops_use_symbolic_and_txt switches processwide to both notations allowed.

pc.ops_use_symbolic()
pc.State['foo'] = 'bar'
assert pc.pycond('foo == bar')() == True
try:
    # this raises now, text ops not known anymore:
    pc.pycond('foo eq bar')
except:
    pc.ops_use_symbolic_and_txt(allow_single_eq=True)
    assert pc.pycond('foo = bar')() == True
    assert pc.pycond('foo == bar')() == True
    assert pc.pycond('foo eq bar')() == True
    assert pc.pycond('foo != baz')() == True

Operator namespace(s) should be assigned at process start, they are global.

Extending Condition Operators

pc.OPS['maybe'] = lambda a, b: int(time.time()) % 2
# valid expression now:
assert pc.pycond('a maybe b')() in (True, False)

Negation not

Negates the result of the condition operator:

pc.State['foo'] = 'abc'
assert pc.pycond('foo eq abc')() == True
assert pc.pycond('foo not eq abc')() == False

Reversal rev

Reverses the arguments before calling the operator

pc.State['foo'] = 'abc'
assert pc.pycond('foo contains a')() == True
assert pc.pycond('foo rev contains abc')() == True

rev and not can be combined in any order.

Wrapping Condition Operators

Global Wrapping

You may globally wrap all evaluation time condition operations through a custom function:

l = []

def hk(f_op, a, b, l=l):
    l.append((getattr(f_op, '__name__', ''), a, b))
    return f_op(a, b)

pc.run_all_ops_thru(hk)  # globally wrap the operators

pc.State.update({'a': 1, 'b': 2, 'c': 3})
f = pc.pycond('a gt 0 and b lt 3 and not c gt 4')
assert l == []
f()
expected_log = [('gt', 1, 0.0), ('lt', 2, 3.0), ('gt', 3, 4.0)]
assert l == expected_log
pc.ops_use_symbolic_and_txt()

You may compose such wrappers via repeated application of the run_all_ops_thru API function.

Condition Local Wrapping

This is done through the ops_thru parameter as shown:

def myhk(f_op, a, b):
    return True

pc.State['a'] = 1
f = pc.pycond('a eq 2')
assert f() == False
f = pc.pycond('a eq 2', ops_thru=myhk)
assert f() == True

Using ops_thru is a good way to debug unexpected results, since you can add breakpoints or loggers there.

Combining Operations

You can combine single conditions with

• and
• and not
• or
• or not
• xor by default.

The combining functions are stored in pycond.COMB_OPS dict and may be extended.

Do not use spaces for the names of combining operators. The user may use them but they are replaced at before tokenizing time, like and not -> and_not.

Nesting

Combined conditions may be arbitrarily nested using brackets "[" and "]".

Via the brkts config parameter you may change those to other separators at build time.

Tokenizing Details

Brackets as strings in this flat list form, e.g. ['[', 'a', 'and' 'b', ']'...]

Functioning

The tokenizers job is to take apart expression strings for the builder.

Separator sep

Separates the different parts of an expression. Default is ' '.

pc.State['a'] = 42
assert pc.pycond('a.eq.42', sep='.')() == True

sep can be a any single character including binary.

Bracket characters do not need to be separated, the tokenizer will do:

# equal:
assert (
    pc.pycond('[[a eq 42] and b]')() == pc.pycond('[ [ a eq 42 ] and b ]')()
)

The condition functions themselves do not evaluate equal - those had been assembled two times.

Apostrophes

By putting strings into Apostrophes you can tell the tokenizer to not further inspect them, e.g. for the seperator:

pc.State['a'] = 'Hello World'
assert pc.pycond('a eq "Hello World"')() == True

Escaping

Tell the tokenizer to not interpret the next character:

pc.State['b'] = 'Hello World'
assert pc.pycond('b eq Hello\ World')() == True

Building

Autoconv: Casting of values into python simple types

Expression string values are automatically cast into bools and numbers via the public pycond.py_type function.

This can be prevented by setting the autoconv parameter to False or by using Apostrophes:

pc.State['a'] = '42'
assert pc.pycond('a eq 42')() == False
# compared as string now
assert pc.pycond('a eq "42"')() == True
# compared as string now
assert pc.pycond('a eq 42', autoconv=False)() == True

If you do not want to provide a custom lookup function (where you can do what you want) but want to have looked up keys autoconverted then use:

for id in '1', 1:
    pc.State['id'] = id
    assert pc.pycond('id lt 42', autoconv_lookups=True)

Context On Demand And Lazy Evaluation

Often the conditions are in user space, applied on data streams under the developer's control only at development time.

The end user might pick only a few keys from many offered within an API.

pycond's ctx_builder allows to only calculate those keys at runtime, the user decided to base conditions upon: At condition build time hand over a namespace for all functions which are available to build the ctx.

pycon will return a context builder function for you, calling only those functions which the condition actually requires.

pc.ops_use_symbolic_and_txt(allow_single_eq=True)

# Condition the end user configured, e.g. at program run time:
cond = [
    ['group_type', 'in', ['lab', 'first1k', 'friendly', 'auto']],
    'and',
    [
        [
            [
                [['cur_q', '<', 0.5], 'and', ['delta_q', '>=', 0.15],],
                'and',
                ['dt_last_enforce', '>', 28800],
            ],
            'and',
            ['cur_hour', 'in', [3, 4, 5]],
        ],
        'or',
        [
            [
                [['cur_q', '<', 0.5], 'and', ['delta_q', '>=', 0.15],],
                'and',
                ['dt_last_enforce', '>', 28800],
            ],
            'and',
            ['clients', '=', 0],
        ],
    ],
]

# Getters for API keys offered to the user, involving potentially
# expensive to fetch context delivery functions:
# Signature must provide minimum a positional for the current
# state:
class ApiCtxFuncs:
    def expensive_but_not_needed_here(ctx):
        raise Exception("Won't run with cond. from above")

    def group_type(ctx):
        raise Exception("Won't run since contained in example data")

    def cur_q(ctx):
        print('Calculating cur_q')
        return 0.1

    def cur_hour(ctx):
        print('Calculating cur_hour')
        return 4

    def dt_last_enforce(ctx):
        print('Calculating dt_last_enforce')
        return 10000000

    def delta_q(ctx):
        print('Calculating (expensive) delta_q')
        time.sleep(0.1)
        return 1

    def clients(ctx):
        print('Calculating clients')
        return 0

if sys.version_info[0] < 3:
    # we don't think it is a good idea to make the getter API stateful:
    p2m.convert_to_staticmethods(ApiCtxFuncs)

f, nfos = pc.parse_cond(cond, ctx_provider=ApiCtxFuncs)

# now we create (incomplete) data..
data1 = {'group_type': 'xxx'}, False
data2 = {'group_type': 'lab'}, True

# this key stores a context builder function, calculating the complete data:
make_ctx = nfos['complete_ctx']

t0 = time.time()
for event, expected in data1, data2:
    assert f(state=make_ctx(event)) == expected

print('Calc.Time (delta_q was called twice):', round(time.time() - t0, 4)),
return cond, ApiCtxFuncs

Output:

Calculating clients
Calculating cur_hour
Calculating cur_q
Calculating (expensive) delta_q
Calculating dt_last_enforce
Calculating clients
Calculating cur_hour
Calculating cur_q
Calculating (expensive) delta_q
Calculating dt_last_enforce
Calc.Time (delta_q was called twice): 0.2005

But we can do better - we still calculated values for keys which might be only needed in dead ends of a lazily evaluated condition.

Lets avoid calculating these values, remembering the custom lookup function feature.

pycond does generate such a custom lookup function readily for you, if you pass a getter namespace as lookup_provider.

Pycond then treats the condition keys as function names within that namespace and calls them, when needed, with the usual signature, except the key:

F = ApiCtxFuncs

# make signature compliant:
def wrap(fn, f):
    if callable(f):

        def wrapped(v, data, cfg, f=f, **kw):
            return f(data), v

        setattr(F, fn, wrapped)

[wrap(fn, getattr(F, fn)) for fn in dir(F) if fn not in ('__class__',)]

# we add a deep condition and let pycond generate the lookup function:
f = pc.pycond(cond, lookup_provider=F)
# Same events as above:
data1 = {'group_type': 'xxx'}, False
data2 = {'group_type': 'lab'}, True

t0 = time.time()
for event, expected in data1, data2:
    # we will lookup only once:
    assert f(state=event) == expected

print(
    'Calc.Time (delta_q was called just once):', round(time.time() - t0, 4),
)

# The deep switch keeps working:
cond2 = [cond, 'or', ['a-0-b', 'eq', 42]]
f = pc.pycond(cond2, lookup_provider=ApiCtxFuncs, deep='-')
data2[0]['a'] = [{'b': 42}]
assert f(state=data2[0]) == True

Output:

Calculating cur_q
Calculating (expensive) delta_q
Calculating dt_last_enforce
Calculating cur_hour
Calc.Time (delta_q was called just once): 0.1003
Calculating cur_q
Calculating (expensive) delta_q
Calculating dt_last_enforce
Calculating cur_hour

The output demonstrates that we did not even call the value provider functions for the dead branches of the condition.

NOTE: Instead of providing a class tree you may also provide a dict of functions as lookup_provider_dict argument, see qualify examples below.

Caching

Note: Currently you cannot override these defaults. Drop an issue if you need to.

• Builtin state lookups: Not cached
• Custom lookup functions: Not cached (you can implment caching within those functions)
• Lookup provider return values: Cached, i.e. called only once
• Named conditions (see below): Cached

Named Conditions: Qualification

Instead of just delivering booleans, pycond can be used to qualify a whole set of information about data, like so:

# We accept different forms of delivery.
# The first full text is restricted to simple flat dicts only:
for c in [
    'one: a gt 10, two: a gt 10 or foo eq bar',
    {'one': 'a gt 10', 'two': 'a gt 10 or foo eq bar'},
    {
        'one': ['a', 'gt', 10],
        'two': ['a', 'gt', 10, 'or', 'foo', 'eq', 'bar'],
    },
]:
    f = pc.qualify(c)
    r = f({'foo': 'bar', 'a': 0})
    assert r == {'one': False, 'two': True}

We may refer to results of other named conditions and also can pass named condition sets as lists instead of dicts:

def run(q):
    print('Running', q)
    f = pc.qualify(q)

    assert f({'a': 'b'}) == {
        'first': True,
        'listed': [False, False],
        'thrd': True,
        'zero': True,
    }
    res = f({'c': 'foo', 'x': 1})
    assert res == {
        'first': False,
        'listed': [False, True],
        'thrd': False,
        'zero': True,
    }

q = {
    'thrd': ['k', 'or', 'first'],
    'listed': [['foo'], ['c', 'eq', 'foo']],
    'zero': [['x', 'eq', 1], 'or', 'thrd'],
    'first': ['a', 'eq', 'b'],
}
run(q)

# The conditions may be passed as list as well:
q = [[k, v] for k, v in q.items()]
run(q)

Output:

Running {'thrd': ['k', 'or', 'first'], 'listed': [['foo'], ['c', 'eq', 'foo']], 'zero': [['x', 'eq', 1], 'or', 'thrd'], 'first': ['a', 'eq', 'b']}
Running [['thrd', ['k', 'or', 'first']], ['listed', [['foo'], ['c', 'eq', 'foo']]], ['zero', [['x', 'eq', 1], 'or', 'thrd']], ['first', ['a', 'eq', 'b']]]

WARNING: For performance reasons there is no built in circular reference check. You'll run into python's built in recursion checker!

Partial Evaluation

If you either supply a key called 'root' OR supply it as argument to qualify, pycond will only evaluate named conditions required to calculate the root key:

called = []

def expensive_func(v, data, cfg, **kw):
    called.append(data)
    return 1, v

def xx(v, data, cfg, **kw):
    called.append(data)
    return data.get('a'), v

funcs = {'exp': {'func': expensive_func}, 'xx': {'func': xx}}
q = {
    'root': ['foo', 'and', 'bar'],
    'bar': [['somecond'], 'or', [['exp', 'eq', 1], 'and', 'baz'],],
    'x': ['xx'],
    'baz': ['exp', 'lt', 10],
}
qualifier = pc.qualify(q, lookup_provider_dict=funcs, add_cached=True)

d = {'foo': 1}
r = qualifier(d)

# root, bar, baz had been calculated, not x
assert r == {'root': True, 'bar': True, 'baz': True, 'exp': 1}
# expensive_func result, which was cached, is also returned.
# expensive_func only called once allthough result evaluated for bar and baz:
assert len(called) == 1

called.clear()
f = pc.qualify(q, lookup_provider_dict=funcs, root='x', add_cached=True)
assert f({'a': 1}) == {'x': True, 'xx': 1}
assert f({'b': 1}) == {'x': False, 'xx': None}
assert called == [{'a': 1}, {'b': 1}]

This means pycond can be used as a lightweight declarative function dispatching framework.

Streaming Data

Since version 20200601 and Python 3.x versions, pycond can deliver ReactiveX compliant stream operators.

Lets first set up a test data stream, by defining a function rx_setup like so:

# simply `import rx as Rx and rx = rx.operators`:
# import pycond as pc, like always:
Rx, rx, GS = pc.import_rx('GS')

def push_through(*test_pipe, items=4):
    """
    Function which takes a set of operators and runs an 'rx.interval' stream, until count items are through
    """

    # stream sink result holder plus a stream completer:
    l, compl = [], rx.take(items)
    l.clear()  # clear any previous results

    def next_(x):
        # simply remember what went through in a list:
        l.append(x)

    def err(*a):
        # should never happen:
        print('exception', a)

    # creates integers: 0, then 1, then 2, ... and so on:
    stream = Rx.interval(0.01, GS)

    # turns the ints into dicts: {'i': 0}, then {'i': 1} and so on:
    stream = stream.pipe(
        rx.filter(lambda i: i > 0), rx.map(lambda i: {'i': i})
    )

    # defines the stream through the tested operators:
    test_pipe = test_pipe + (compl,)
    s = stream.pipe(*test_pipe)

    # runs the stream:
    d = s.subscribe(
        on_error=err,
        on_next=next_,
        on_completed=lambda: l.append('completed'),
    )

    # blocks until completed:
    while not (l and l[-1] == 'completed'):
        time.sleep(0.001)
    l.pop()  # removes completed indicator

    return l  # returns all processed messages

return Rx, rx, push_through

Lets test the setup by having some messages streamed through:

Rx, rx, push_through = rx_setup()
# test test setup:
r = push_through(items=3)
assert r == [{'i': 1}, {'i': 2}, {'i': 3}]

-> test setup works.

Filtering

This is the most simple operation: A simple stream filter.

Rx, rx, push_through = rx_setup()

# ask pycond for a stream filter based on a condition:
pcfilter = partial(pc.rxop, ['i', 'mod', 2])

r = push_through(pcfilter())
odds = [{'i': 1}, {'i': 3}, {'i': 5}, {'i': 7}]
assert r == odds

# try the stream filter with message headered data:
pl = 'payload'
r = push_through(rx.map(lambda i: {pl: i}), pcfilter(prefix=pl))
print('Full messages passed:', r)
r = [m[pl] for m in r]
assert len(r) == 4
assert r == odds

# We may pass a custom filter function, which will be called,
# when data streams through. It gets the built cond. as first argument:
def myf(my_built_filter, data):
    return my_built_filter(data) or data['i'] == 2

r = push_through(pcfilter(func=myf))
assert r == [{'i': 1}, {'i': 2}, {'i': 3}, {'i': 5}]

Output:

Full messages passed: [{'payload': {'i': 1}}, {'payload': {'i': 3}}, {'payload': {'i': 5}}, {'payload': {'i': 7}}]

Streaming Classification

Using named condition dicts we can classify data, i.e. tag it, in order to process subsequently:

Rx, rx, push_through = rx_setup()

# generate a set of classifiers:
conds = [['i', 'mod', i] for i in range(2, 4)]

def run(offs=0):

    # and get a classifying operator from pycond, adding the results in place, at key 'mod':
    r = push_through(pc.rxop(conds, into='mod'))
    i, j = 0 + offs, 1 + offs
    assert r == [
        {'i': 1, 'mod': {i: 1, j: 1}},
        {'i': 2, 'mod': {i: 0, j: 2}},
        {'i': 3, 'mod': {i: 1, j: 0}},
        {'i': 4, 'mod': {i: 0, j: 1}},
    ]

# we can also provide the names of the classifiers by passing a dict:
# here we pass 2 and 3 as those names:
conds = dict([(i, ['i', 'mod', i]) for i in range(2, 4)])
run(2)

Normally the data has headers, so thats a good place to keep the classification tags.

Selective Classification

We fall back to an alternative condition evaluation (which could be a function call) only when a previous condition evaluation returns something falsy - by providing a root condition. When it evaluated, possibly requiring evaluation of other conditions, we return:

Rx, rx, push_through = rx_setup()

# using the list style:
conds = [[i, [['i', 'mod', i], 'or', 'alt']] for i in range(2, 4)]
conds.append(['alt', ['i', 'gt', 1]])

# provide the root condition. Only when it evals falsy, the named "alt" condiction will be evaluated:
r = push_through(pc.rxop(conds, into='mod', root=2, add_cached=True))
assert r == [
    # evaluation of alt was not required:
    {'i': 1, 'mod': {2: True}},
    # evaluation of alt was required:
    {'i': 2, 'mod': {2: True, 'alt': True}},
    {'i': 3, 'mod': {2: True}},
    {'i': 4, 'mod': {2: True, 'alt': True}},
]

Asyncronous Operations

WARNING: Early Version. Only for the gevent platform.

Selective classification allows to call condition functions only when other criteria are met. That makes it possible to read e.g. from a database only when data is really required - and not always, "just in case".

pycond allows to define, that blocking operations should be run async within the stream, possibly giving up order.

_thn = lambda msg, data: print('thread:', cur_thread().name, msg, data)

Rx, rx, push_through = rx_setup()

class F:
    """
    Namespace for condition functions, which we can indicate to be run async. You may also pass a dict (lookup_provider_dict)
    """

    def odd(v, data, cfg, **kw):
        _thn('odd', data)
        return data['i'] % 2, v

    def blocking(v, data, cfg, **kw):
        i = data['i']
        _thn('blocking', data)
        if i == 1:
            # two others will "overtake the i=1 item,
            # since the interval stream is firing every 0.01 secs:
            time.sleep(0.028)
        elif i == 2:
            # Exceptions, incl. timeouts, will simply be forwarded to cfg['err_handler']
            # i.e. also timeout mgmt have to be done here, in the custom functions themselves.
            # Rationale: Async ops are done with libs, which ship with their own timeout params. No need to re-invent.
            # In that err handler, then further arrangements can be done.
            raise TimeoutError('ups')
        elif i == 5:
            1 / 0
        return data['i'], v

# Defining a simple 'set' of classifiers, here as list, with one single key: 2:
conds = [
    [
        2,
        [
            ['i', 'lt', 100],
            'and',
            [['odd', 'eq', 1], 'or', ['i', 'eq', 2]],
            'and_not',
            ['blocking', 'eq', 3],
        ],
    ]
]
timeouts = []

def handle_err(item, cfg, ctx, exc, t=timeouts, **kw):
    # args are: [item, cfg]
    if 'ups' in str(exc):
        assert item['i'] == 2
        assert exc.__class__ == TimeoutError
        t.append(item)
    else:
        assert item['i'] == 5
        assert exc.__class__ == ZeroDivisionError

# have the operator built for us:
rxop = pc.rxop(
    conds,
    into='mod',
    lookup_provider=F,
    err_handler=handle_err,
    asyn=['blocking'],
)
r = push_through(rxop, items=5)
assert [m['i'] for m in r] == [3, 1, 4, 6, 7]
assert [m['mod'][2] for m in r] == [False, True, False, False, True]
# item 2 caused a timeout:
assert timeouts[0]['i'] == 2

Output:

thread: DummyThread-10000 odd {'i': 1, 'mod': {}}
thread: DummyThread-10001 blocking {'i': 1, 'mod': {}}
thread: DummyThread-10002 odd {'i': 2, 'mod': {}}
thread: DummyThread-10003 blocking {'i': 2, 'mod': {}}
thread: DummyThread-10004 odd {'i': 3, 'mod': {}}
thread: DummyThread-10005 blocking {'i': 3, 'mod': {}}
thread: DummyThread-10006 odd {'i': 4, 'mod': {}}
thread: DummyThread-10007 odd {'i': 5, 'mod': {}}
thread: DummyThread-10008 blocking {'i': 5, 'mod': {}}
thread: DummyThread-10009 odd {'i': 6, 'mod': {}}
thread: DummyThread-10010 odd {'i': 7, 'mod': {}}
thread: DummyThread-10011 blocking {'i': 7, 'mod': {}}

*Auto generated by pytest2md, running ./tests/test_tutorial.py