-
Notifications
You must be signed in to change notification settings - Fork 20
/
location_event_counts.py
76 lines (66 loc) · 2.57 KB
/
location_event_counts.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
67
68
69
70
71
72
73
74
75
76
# 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 TotalLocationEvents
from flowmachine.features.location.redacted_total_events import RedactedTotalEvents
from .base_exposed_query import BaseExposedQuery
from .base_schema import BaseSchema
from .custom_fields import EventTypes, SubscriberSubset, ISODateTime
from .aggregation_unit import AggregationUnitMixin
__all__ = ["LocationEventCountsSchema", "LocationEventCountsExposed"]
class LocationEventCountsExposed(BaseExposedQuery):
def __init__(
self,
*,
start_date,
end_date,
interval,
direction,
event_types,
aggregation_unit,
subscriber_subset=None
):
# Note: all input parameters need to be defined as attributes on `self`
# so that marshmallow can serialise the object correctly.
self.start_date = start_date
self.end_date = end_date
self.interval = interval
self.direction = direction
self.event_types = event_types
self.aggregation_unit = aggregation_unit
self.subscriber_subset = subscriber_subset
@property
def _flowmachine_query_obj(self):
"""
Return the underlying flowmachine daily_location object.
Returns
-------
Query
"""
return RedactedTotalEvents(
total_events=TotalLocationEvents(
start=self.start_date,
stop=self.end_date,
interval=self.interval,
direction=self.direction,
table=self.event_types,
spatial_unit=self.aggregation_unit,
subscriber_subset=self.subscriber_subset,
)
)
class LocationEventCountsSchema(AggregationUnitMixin, BaseSchema):
# query_kind parameter is required here for claims validation
query_kind = fields.String(validate=OneOf(["location_event_counts"]))
start_date = ISODateTime(required=True)
end_date = ISODateTime(required=True)
interval = fields.String(
required=True, validate=OneOf(TotalLocationEvents.allowed_intervals)
)
direction = fields.String(
required=True, validate=OneOf(["in", "out", "both"])
) # TODO: use a globally defined enum for this
event_types = EventTypes()
subscriber_subset = SubscriberSubset()
__model__ = LocationEventCountsExposed