swimlane.core.fields.base.cursor module

class swimlane.core.fields.base.cursor.CursorField(*args, **kwargs)

Bases: Field

Returns a proxy-like FieldCursor instance to support additional functionality

property cursor

Cache and return cursor_class instance

cursor_class = None

for_json()

Return list of all cursor items, calling .for_json() if available for best representations

get_initial_elements()

Return initial elements to be passed with cursor instantiation

get_python()

Create, cache, and return the appropriate cursor instance

class swimlane.core.fields.base.cursor.FieldCursor(field, initial_elements=None)

Bases: Cursor, SwimlaneResolver

Base class for encapsulating a field instance’s complex logic

Useful in abstracting away extra request(s), lazy evaluation, pagination, intensive calculations, etc.