flowmachine.core.server.query_schemas.modal_location¶
Class InputToModalLocationSchema¶
InputToModalLocationSchema(*, only: 'types.StrSequenceOrSet | None' = None, exclude: 'types.StrSequenceOrSet' = (), many: 'bool | None' = None, context: 'dict | None' = None, load_only: 'types.StrSequenceOrSet' = (), dump_only: 'types.StrSequenceOrSet' = (), partial: 'bool | types.StrSequenceOrSet | None' = None, unknown: 'str | None' = None)
Schema for deserialising to one of a choice of query kinds.
The query_schemas
attribute is an iterable of allowed query schemas.
Attributes¶
Methods¶
dict_class¶
dict_class
type_schemas¶
type_schemas
Class ModalLocationExposed¶
ModalLocationExposed(locations, *, sampling=None)
Base class for exposed flowmachine queries. Note: this class and derived classes are not meant to be instantiated directly! Instead, they are instantiated automatically by the class FlowmachineQuerySchema. Example: FlowmachineQuerySchema().load({"query_kind": "dummy_query", "dummy_param": "foobar"})
Attributes¶
Methods¶
_flowmachine_query_obj¶
_flowmachine_query_obj
Return the underlying flowmachine query object which this class exposes.
Returns¶
Query
_unsampled_query_obj¶
_unsampled_query_obj
Return the underlying flowmachine ModalLocation object.
Returns¶
ModalLocation
query_id¶
query_id
Class ModalLocationSchema¶
ModalLocationSchema(*, only: 'types.StrSequenceOrSet | None' = None, exclude: 'types.StrSequenceOrSet' = (), many: 'bool | None' = None, context: 'dict | None' = None, load_only: 'types.StrSequenceOrSet' = (), dump_only: 'types.StrSequenceOrSet' = (), partial: 'bool | types.StrSequenceOrSet | None' = None, unknown: 'str | None' = None)
Base schema class with which to define custom schemas.
Example usage: .. code-block:: python import datetime as dt from dataclasses import dataclass from marshmallow import Schema, fields @dataclass class Album: title: str release_date: dt.date class AlbumSchema(Schema): title = fields.Str() release_date = fields.Date() album = Album("Beggars Banquet", dt.date(1968, 12, 6)) schema = AlbumSchema() data = schema.dump(album) data # {'release_date': '1968-12-06', 'title': 'Beggars Banquet'} :param only: Whitelist of the declared fields to select when instantiating the Schema. If None, all fields are used. Nested fields can be represented with dot delimiters. :param exclude: Blacklist of the declared fields to exclude when instantiating the Schema. If a field appears in both only
and exclude
, it is not used. Nested fields can be represented with dot delimiters. :param many: Should be set to True
if obj
is a collection so that the object will be serialized to a list. :param context: Optional context passed to :class:fields.Method
and :class:fields.Function
fields. :param load_only: Fields to skip during serialization (write-only fields) :param dump_only: Fields to skip during deserialization (read-only fields) :param partial: Whether to ignore missing fields and not require any fields declared. Propagates down to Nested
fields as well. If its value is an iterable, only missing fields listed in that iterable will be ignored. Use dot delimiters to specify nested fields. :param unknown: Whether to exclude, include, or raise an error for unknown fields in the data. Use EXCLUDE
, INCLUDE
or RAISE
. .. versionchanged:: 3.0.0 prefix
parameter removed. .. versionchanged:: 2.0.0 __validators__
, __preprocessors__
, and __data_handlers__
are removed in favor of marshmallow.decorators.validates_schema
, marshmallow.decorators.pre_load
and marshmallow.decorators.post_dump
. __accessor__
and __error_handler__
are deprecated. Implement the handle_error
and get_attribute
methods instead.
Attributes¶
Methods¶
validate_locations¶
validate_locations(self, values)
dict_class¶
dict_class