Skip to content

flowmachine.core.server.query_schemas.pareto_interactions

Class ParetoInteractionsExposed

ParetoInteractionsExposed(*, start_date, end_date, proportion, event_types, subscriber_subset=None, sampling=None, hours=None)
Source: flowmachine/core/server/query_schemas/pareto_interactions.py

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
Source: flowmachine/core/server/query_schemas/base_query_with_sampling.py

Return the underlying flowmachine query object which this class exposes.

Returns
  • Query

_unsampled_query_obj

_unsampled_query_obj
Source: flowmachine/core/server/query_schemas/pareto_interactions.py

Return the underlying flowmachine pareto_interactions object.

Returns
  • Query

query_id

query_id
Source: flowmachine/core/server/query_schemas/base_exposed_query.py

Class ParetoInteractionsSchema

ParetoInteractionsSchema(*, 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)
Source: flowmachine/core/server/query_schemas/pareto_interactions.py

Base schema class with which to define 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.

Attributes

Methods

dict_class

dict_class
Source: marshmallow/schema.py

dict type to return when serializing.

Returns
  • type[dict]