Developers’ documentation

Module fsa

Finite State Automata

class fsa4streams.fsa.FSA(structure, check_structure=True)

A Finite State Automaton.

classmethod from_str(json_str)

classmethod from_file(json_filelike)

classmethod from_dict(dictobj)

classmethod make_empty(**kw)

TODO doc: must call check_structure() in the end

add_state(stateid, **kw)

TODO doc

IMPORTANT: ‘target’ may not exist yet, so it not checked. Hence, check_structure() should be called in the end.

check_structure(raises=True)

allow_overlap

default_matcher

export_structure_as_dict()

export_structure_as_string(*args, **kw)

export_strutcure_to_file(fp, *args, **kw)

reset()

is_busy()

load_tokens_from_str(json_str, force=False)

load_tokens_from_file(json_filelike, force=False)

load_tokens_from_dict(dictobj, force=False)

export_tokens_as_dict()

export_tokens_as_string(*args, **kw)

export_tokens_to_file(fp, *args, **kw)

match(transition, event, token)

feed(event, timestamp=None)

I ingest event, and I return a list of matching tokens.

A matching token is a token that has reached a final state, and can not further progress in the FSA.

If provided, timestamp must be an integer greater or equal than all previous timestamps; the default value is the previous timestamp + 1. Timestamps are used to check max_duration constraints.

feed_all(iterable, finish=True)

feed_all_timestamps(iterable, finish=True)

finish()

Module state

class fsa4streams.state.State(fsa, stateid)

A proxy object for a state in a FSA.

fsa

id

terminal

TODO doc

max_noise

TODO doc

max_total_noise

TODO doc

max_duration

TODO doc

max_total_duration

TODO doc

default_transition

TODO doc

transitions

TODO doc

add_state(*args, **kw)

Shortcut method to self.fsa.add_state, useful for chaining them.

check_structure(raises=True)

Shortcut method to self.fsa.check_structure, useful for chaining them.

add_transition(condition, target, **kw)

TODO doc return this state to allow chaining IMPORTANT: ‘target’ may not exist yet, so it not checked. Hence, check_structure should be called in the end.

set_default_transition(target, **kw)

TODO doc return this state to allow chaining IMPORTANT: ‘target’ may not exist yet, so it not checked. Hence, check_structure should be called in the end.

Module matcher

fsa4streams.matcher.DIRECTORY = a dict

It originally contains all the matchers contained in this module.

fsa4streams.matcher.match_multiple_choices(transition, event, _token, _fsa)

The ‘multiple-choices’ matcher.

With this matcher, transition conditions must be lists of strings. It matches an event if that event is equal to one of the items of the list.

fsa4streams.matcher.match_regexp(transition, event, _token, _fsa)

The ‘regexp’ matcher.

With this matcher, transition conditions are interpreted as regular expressions. Note that the whole event must match the regular expression (this is ensured by automatically prepending ^ and appending $ to the condition).