-
Notifications
You must be signed in to change notification settings - Fork 20
/
subscriber_degree.py
66 lines (56 loc) · 2.01 KB
/
subscriber_degree.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
from marshmallow import fields
from marshmallow.validate import OneOf
from flowmachine.features import SubscriberDegree
from .custom_fields import EventTypes, SubscriberSubset, ISODateTime
from .base_query_with_sampling import (
BaseQueryWithSamplingSchema,
BaseExposedQueryWithSampling,
)
__all__ = ["SubscriberDegreeSchema", "SubscriberDegreeExposed"]
class SubscriberDegreeExposed(BaseExposedQueryWithSampling):
def __init__(
self,
*,
start,
stop,
direction,
event_types,
subscriber_subset=None,
sampling=None
):
# Note: all input parameters need to be defined as attributes on `self`
# so that marshmallow can serialise the object correctly.
self.start = start
self.stop = stop
self.direction = direction
self.event_types = event_types
self.subscriber_subset = subscriber_subset
self.sampling = sampling
@property
def _unsampled_query_obj(self):
"""
Return the underlying flowmachine subscriber_degree object.
Returns
-------
Query
"""
return SubscriberDegree(
start=self.start,
stop=self.stop,
direction=self.direction,
tables=self.event_types,
subscriber_subset=self.subscriber_subset,
)
class SubscriberDegreeSchema(BaseQueryWithSamplingSchema):
query_kind = fields.String(validate=OneOf(["subscriber_degree"]))
start = ISODateTime(required=True)
stop = ISODateTime(required=True)
direction = fields.String(
required=False, validate=OneOf(["in", "out", "both"]), default="both"
) # TODO: use a globally defined enum for this
event_types = EventTypes()
subscriber_subset = SubscriberSubset()
__model__ = SubscriberDegreeExposed