Base Models#

validate_list_to_single(v)[source]#

Converts a list to a single value (the last element of the list)

Query parameters (in a URI) can be specified multiple times. Therefore, we will always convert them to a list in flask. But that means we have to convert them to single values here

class RestModelBase[source]#: Bases: BaseModel

class CommonBulkGetBody[source]#

Bases: RestModelBase

Common URL parameters for “get_*” functions

These functions typically take a list for ids, and a bool for missing_ok

Fields#
Field	Type	Required	Default
`exclude`	`list`[`str`] \| `None`	No	`None`
`ids`	`list`[`int`]	Yes
`include`	`list`[`str`] \| `None`	No	`None`
`missing_ok`	`bool`	No	`False`

ids: list[int]#

include: list[str] | None#

exclude: list[str] | None#

missing_ok: bool#

class CommonBulkGetNamesBody[source]#

Bases: RestModelBase

Common URL parameters for “get_*” functions

These functions typically take a list for ids, and a bool for missing_ok

Fields#
Field	Type	Required	Default
`exclude`	`list`[`str`] \| `None`	No	`None`
`include`	`list`[`str`] \| `None`	No	`None`
`missing_ok`	`bool`	No	`False`
`names`	`list`[`str`]	Yes

names: list[str]#

include: list[str] | None#

exclude: list[str] | None#

missing_ok: bool#

class ProjURLParameters[source]#

Bases: RestModelBase

Fields#
Field	Type	Required	Default
`exclude`	`list`[`str`] \| `None`	No	`None`
`include`	`list`[`str`] \| `None`	No	`None`

include: list[str] | None#

exclude: list[str] | None#

class QueryModelBase[source]#

Bases: RestModelBase

Common parameters for query_* functions, without include/exclude

These can be either URL parameters or part of a POST body

Fields#
Field	Type	Required	Default
`cursor`	`int` \| `None`	No	`None`
`limit`	`int` \| `None`	No	`None`

Validators#
Validator	Mode	Fields
`validate_lists`	before	`limit`, `cursor`

limit: int | None#

cursor: int | None#

classmethod validate_lists(v)[source]#

class QueryProjModelBase[source]#

Bases: QueryModelBase, ProjURLParameters

Common parameters for query_* functions, with include/exclude (projection)

These can be either URL parameters or part of a POST body

Fields#
Field	Type	Required	Default
`cursor`	`int` \| `None`	No	`None`
`exclude`	`list`[`str`] \| `None`	No	`None`
`include`	`list`[`str`] \| `None`	No	`None`
`limit`	`int` \| `None`	No	`None`

Validators#
Validator	Mode	Fields
`validate_lists`	before	`limit`, `cursor`

classmethod validate_lists(v)#

limit#

cursor#

include#

exclude#

class QueryIteratorBase[source]#

Bases: Generic[T]

Base class for all query result iterators

Query iterators are used to iterate intelligently over the result of a query. This handles pagination, where only batches are downloaded from the server.

__init__(client, query_filters, batch_limit)[source]#

Parameters:

query_filters (QueryModelBase)
batch_limit (int)

reset()[source]#: Starts retrieval of results from the beginning again