flowmachine.features.subscriber.calendar_activity

Source: flowmachine/features/subscriber/calendar_activity.py

A subscriber's activity calendar - an array of datetimes they had some activity in.

Class CalendarActivity

CalendarActivity(start: str, total_periods: int, period_length: int = 1, period_unit: str = 'days', hours: Optional[Tuple[int, int]] = None, table: Union[str, List[str]] = 'all', subscriber_identifier: str = 'msisdn', subscriber_subset: Optional[flowmachine.core.query.Query] = None)

Source: flowmachine/features/subscriber/calendar_activity.py

Class representing the calendar days that a subscriber was active in some period.

Attributes

• cache

• column_names

• column_names_as_string_list

• dependencies

• fully_qualified_table_name

• index_cols

• is_stored

• query_id

• query_state

• query_state_str

• table_name

Parameters

• start: str

  iso-format start datetime

• hours: typing.Optional, default None

  Restrict the analysis to only a certain set of hours within each day.

• subscriber_identifier: str, default msisdn

  Either msisdn, or imei, the column that identifies the subscriber.

• subscriber_subset: typing.Optional, default None

  If provided, string or list of string which are msisdn or imeis to limit results to; or, a query or table which has a column with a name matching subscriber_identifier (typically, msisdn), to limit results to.

• table: typing.Union, default all

  Can be a string of a single table (with the schema) or a list of these. The keyword all is to select all subscriber tables

• total_periods: int

  Total number of periods to break your time span into

• period_length: int, default 1

  Total number of days per period.

• period_unit: str, default days

  Split this time frame into hours or days etc.

Methods

cache

cache

Source: flowmachine/core/query.py

Returns

• bool

  True is caching is switched on.

column_names

column_names

Source: flowmachine/features/subscriber/calendar_activity.py

Returns the column names.

Returns

• typing.List

  List of the column names of this query.

column_names_as_string_list

column_names_as_string_list

Source: flowmachine/core/query.py

Get the column names as a comma separated list

Returns

• str

  Comma separated list of column names

dependencies

dependencies

Source: flowmachine/core/query.py

Returns

• set

  The set of queries which this one is directly dependent on.

fully_qualified_table_name

fully_qualified_table_name

Source: flowmachine/core/query.py

Returns a unique fully qualified name for the query to be stored as under the cache schema, based on a hash of the parameters, class, and subqueries.

Returns

• str

  String form of the table's fqn

index_cols

index_cols

Source: flowmachine/core/query.py

A list of columns to use as indexes when storing this query.

Returns

• ixen: list

  By default, returns the location columns if they are present and self.spatial_unit is defined, and the subscriber column.

Examples

daily_location("2016-01-01").index_cols
[['name'], '"subscriber"']

is_stored

is_stored

Source: flowmachine/core/query.py

Returns

• bool

  True if the table is stored, and False otherwise.

query_id

query_id

Source: flowmachine/core/query.py

Generate a uniquely identifying hash of this query, based on the parameters of it and the subqueries it is composed of.

Returns

• str

  query_id hash string

query_state

query_state

Source: flowmachine/core/query.py

Return the current query state.

Returns

• QueryState

  The current query state

query_state_str

query_state_str

Source: flowmachine/core/query.py

Return the current query state as a string

Returns

• str

  The current query state. The possible values are the ones defined in flowmachine.core.query_state.QueryState.

table_name

table_name

Source: flowmachine/core/query.py

Returns a uniquename for the query to be stored as, based on a hash of the parameters, class, and subqueries.

Returns

• str

  String form of the table's fqn