hat-event 0.9.27__cp310.cp311.cp312.cp313-abi3-win_amd64.whl

hat/event/common/encoder.py

@@ -0,0 +1,305 @@
+import datetime
+import struct
+
+from hat import json
+from hat import sbs
+from hat import util
+
+from hat.event.common.common import (Event,
+                                     EventId,
+                                     EventPayload,
+                                     EventPayloadBinary,
+                                     EventPayloadJson,
+                                     Order,
+                                     OrderBy,
+                                     QueryLatestParams,
+                                     QueryParams,
+                                     QueryResult,
+                                     QueryServerParams,
+                                     QueryTimeseriesParams,
+                                     RegisterEvent,
+                                     Status,
+                                     Timestamp)
+
+
+def timestamp_to_bytes(t: Timestamp) -> util.Bytes:
+    """Convert timestamp to 12 byte representation
+
+    Bytes [0, 8] are big endian unsigned `Timestamp.s` + 2^63 and
+    bytes [9, 12] are big endian unsigned `Timestamp.us`.
+
+    """
+    return struct.pack(">QI", t.s + (1 << 63), t.us)
+
+
+def timestamp_from_bytes(data: util.Bytes) -> Timestamp:
+    """Create new timestamp from 12 byte representation
+
+    Bytes representation is same as defined for `timestamp_to_bytes` function.
+
+    """
+    s, us = struct.unpack(">QI", data)
+    return Timestamp(s - (1 << 63), us)
+
+
+def timestamp_to_float(t: Timestamp) -> float:
+    """Convert timestamp to floating number of seconds since 1970-01-01 UTC
+
+    For precise serialization see `timestamp_to_bytes`/`timestamp_from_bytes`.
+
+    """
+    return t.s + t.us * 1E-6
+
+
+def timestamp_from_float(ts: float) -> Timestamp:
+    """Create timestamp from floating number of seconds since 1970-01-01 UTC
+
+    For precise serialization see `timestamp_to_bytes`/`timestamp_from_bytes`.
+
+    """
+    s = int(ts)
+    if ts < 0:
+        s = s - 1
+
+    us = round((ts - s) * 1E6)
+
+    if us == 1_000_000:
+        return Timestamp(s + 1, 0)
+
+    else:
+        return Timestamp(s, us)
+
+
+def timestamp_to_datetime(t: Timestamp) -> datetime.datetime:
+    """Convert timestamp to datetime (representing utc time)
+
+    For precise serialization see `timestamp_to_bytes`/`timestamp_from_bytes`.
+
+    """
+    try:
+        dt_from_s = datetime.datetime.fromtimestamp(t.s, datetime.timezone.utc)
+
+    except OSError:
+        dt_from_s = (
+            datetime.datetime(1970, 1, 1, tzinfo=datetime.timezone.utc) +
+            datetime.timedelta(seconds=t.s))
+
+    return datetime.datetime(
+        year=dt_from_s.year,
+        month=dt_from_s.month,
+        day=dt_from_s.day,
+        hour=dt_from_s.hour,
+        minute=dt_from_s.minute,
+        second=dt_from_s.second,
+        microsecond=t.us,
+        tzinfo=datetime.timezone.utc)
+
+
+def timestamp_from_datetime(dt: datetime.datetime) -> Timestamp:
+    """Create new timestamp from datetime
+
+    If `tzinfo` is not set, it is assumed that provided datetime represents
+    utc time.
+
+    For precise serialization see `timestamp_to_bytes`/`timestamp_from_bytes`.
+
+    """
+    if not dt.tzinfo:
+        dt = dt.replace(tzinfo=datetime.timezone.utc)
+
+    s = int(dt.timestamp())
+
+    if dt.timestamp() < 0:
+        s = s - 1
+
+    return Timestamp(s=s, us=dt.microsecond)
+
+
+def timestamp_to_sbs(t: Timestamp) -> sbs.Data:
+    """Convert timestamp to SBS data"""
+    return {'s': t.s, 'us': t.us}
+
+
+def timestamp_from_sbs(data: sbs.Data) -> Timestamp:
+    """Create new timestamp from SBS data"""
+    return Timestamp(s=data['s'], us=data['us'])
+
+
+def status_to_sbs(status: Status) -> sbs.Data:
+    """Convert Status to SBS data"""
+    return status.value, None
+
+
+def status_from_sbs(status: sbs.Data) -> Status:
+    """Create Status based on SBS data"""
+    return Status(status[0])
+
+
+def event_to_sbs(event: Event) -> sbs.Data:
+    """Convert Event to SBS data"""
+    return {'id': _event_id_to_sbs(event.id),
+            'type': list(event.type),
+            'timestamp': timestamp_to_sbs(event.timestamp),
+            'sourceTimestamp': _optional_to_sbs(event.source_timestamp,
+                                                timestamp_to_sbs),
+            'payload': _optional_to_sbs(event.payload, event_payload_to_sbs)}
+
+
+def event_from_sbs(data: sbs.Data) -> Event:
+    """Create Event based on SBS data"""
+    return Event(id=_event_id_from_sbs(data['id']),
+                 type=tuple(data['type']),
+                 timestamp=timestamp_from_sbs(data['timestamp']),
+                 source_timestamp=_optional_from_sbs(data['sourceTimestamp'],
+                                                     timestamp_from_sbs),
+                 payload=_optional_from_sbs(data['payload'],
+                                            event_payload_from_sbs))
+
+
+def register_event_to_sbs(event: RegisterEvent) -> sbs.Data:
+    """Convert RegisterEvent to SBS data"""
+    return {'type': list(event.type),
+            'sourceTimestamp': _optional_to_sbs(event.source_timestamp,
+                                                timestamp_to_sbs),
+            'payload': _optional_to_sbs(event.payload, event_payload_to_sbs)}
+
+
+def register_event_from_sbs(data: sbs.Data) -> RegisterEvent:
+    """Create RegisterEvent based on SBS data"""
+    return RegisterEvent(
+        type=tuple(data['type']),
+        source_timestamp=_optional_from_sbs(data['sourceTimestamp'],
+                                            timestamp_from_sbs),
+        payload=_optional_from_sbs(data['payload'], event_payload_from_sbs))
+
+
+def query_params_to_sbs(params: QueryParams) -> sbs.Data:
+    """Convert QueryParams to SBS data"""
+    if isinstance(params, QueryLatestParams):
+        return 'latest', {
+            'eventTypes': _optional_to_sbs(params.event_types,
+                                           _event_types_to_sbs)}
+
+    if isinstance(params, QueryTimeseriesParams):
+        return 'timeseries', {
+            'eventTypes': _optional_to_sbs(params.event_types,
+                                           _event_types_to_sbs),
+            'tFrom': _optional_to_sbs(params.t_from, timestamp_to_sbs),
+            'tTo': _optional_to_sbs(params.t_to, timestamp_to_sbs),
+            'sourceTFrom': _optional_to_sbs(params.source_t_from,
+                                            timestamp_to_sbs),
+            'sourceTTo': _optional_to_sbs(params.source_t_to,
+                                          timestamp_to_sbs),
+            'order': (params.order.value, None),
+            'orderBy': (params.order_by.value, None),
+            'maxResults': _optional_to_sbs(params.max_results),
+            'lastEventId': _optional_to_sbs(params.last_event_id,
+                                            _event_id_to_sbs)}
+
+    if isinstance(params, QueryServerParams):
+        return 'server', {
+            'serverId': params.server_id,
+            'persisted': params.persisted,
+            'maxResults': _optional_to_sbs(params.max_results),
+            'lastEventId': _optional_to_sbs(params.last_event_id,
+                                            _event_id_to_sbs)}
+
+    raise ValueError('unsupported params type')
+
+
+def query_params_from_sbs(data: sbs.Data) -> QueryParams:
+    """Create QueryParams based on SBS data"""
+    if data[0] == 'latest':
+        return QueryLatestParams(
+            event_types=_optional_from_sbs(data[1]['eventTypes'],
+                                           _event_types_from_sbs))
+
+    if data[0] == 'timeseries':
+        return QueryTimeseriesParams(
+            event_types=_optional_from_sbs(data[1]['eventTypes'],
+                                           _event_types_from_sbs),
+            t_from=_optional_from_sbs(data[1]['tFrom'], timestamp_from_sbs),
+            t_to=_optional_from_sbs(data[1]['tTo'], timestamp_from_sbs),
+            source_t_from=_optional_from_sbs(data[1]['sourceTFrom'],
+                                             timestamp_from_sbs),
+            source_t_to=_optional_from_sbs(data[1]['sourceTTo'],
+                                           timestamp_from_sbs),
+            order=Order(data[1]['order'][0]),
+            order_by=OrderBy(data[1]['orderBy'][0]),
+            max_results=_optional_from_sbs(data[1]['maxResults']),
+            last_event_id=_optional_from_sbs(data[1]['lastEventId'],
+                                             _event_id_from_sbs))
+
+    if data[0] == 'server':
+        return QueryServerParams(
+            server_id=data[1]['serverId'],
+            persisted=data[1]['persisted'],
+            max_results=_optional_from_sbs(data[1]['maxResults']),
+            last_event_id=_optional_from_sbs(data[1]['lastEventId'],
+                                             _event_id_from_sbs))
+
+    raise ValueError('unsupported params type')
+
+
+def query_result_to_sbs(result: QueryResult) -> sbs.Data:
+    """Convert QueryResult to SBS data"""
+    return {'events': [event_to_sbs(event) for event in result.events],
+            'moreFollows': result.more_follows}
+
+
+def query_result_from_sbs(data: sbs.Data) -> QueryResult:
+    """Create QueryResult based on SBS data"""
+    return QueryResult(events=[event_from_sbs(i) for i in data['events']],
+                       more_follows=data['moreFollows'])
+
+
+def event_payload_to_sbs(payload: EventPayload) -> sbs.Data:
+    """Convert EventPayload to SBS data"""
+    if isinstance(payload, EventPayloadBinary):
+        return 'binary', {'type': payload.type,
+                          'data': payload.data}
+
+    if isinstance(payload, EventPayloadJson):
+        return 'json', json.encode(payload.data)
+
+    raise ValueError('unsupported payload type')
+
+
+def event_payload_from_sbs(data: sbs.Data) -> EventPayload:
+    """Create EventPayload based on SBS data"""
+    if data[0] == 'binary':
+        return EventPayloadBinary(type=data[1]['type'],
+                                  data=data[1]['data'])
+
+    if data[0] == 'json':
+        return EventPayloadJson(data=json.decode(data[1]))
+
+    raise ValueError('unsupported payload type')
+
+
+def _event_id_to_sbs(event_id):
+    return {'server': event_id.server,
+            'session': event_id.session,
+            'instance': event_id.instance}
+
+
+def _event_id_from_sbs(data):
+    return EventId(server=data['server'],
+                   session=data['session'],
+                   instance=data['instance'])
+
+
+def _event_types_to_sbs(event_types):
+    return [list(event_type) for event_type in event_types]
+
+
+def _event_types_from_sbs(data):
+    return [tuple(i) for i in data]
+
+
+def _optional_to_sbs(value, fn=lambda i: i):
+    return ('value', fn(value)) if value is not None else ('none', None)
+
+
+def _optional_from_sbs(data, fn=lambda i: i):
+    return fn(data[1]) if data[0] == 'value' else None

hat/event/common/json_schema_repo.json

@@ -0,0 +1 @@
+{"hat-event": {"monitor_data.yaml": {"$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "hat-event://monitor_data.yaml", "title": "monitor data", "description": "data property of monitor component info", "type": "object", "required": ["server_id", "eventer_server", "server_token"], "properties": {"server_id": {"type": "integer"}, "eventer_server": {"type": "object", "required": ["host", "port"], "properties": {"host": {"type": "string"}, "port": {"type": "integer"}}}, "server_token": {"type": ["string", "null"]}}}, "events.yaml": {"$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "hat-event://events.yaml", "definitions": {"events": {"engine": {"enum": ["STARTED", "STOPPED"]}, "eventer": {"enum": ["CONNECTED", "DISCONNECTED"]}, "synced": {"oneOf": [{"type": "object", "required": ["state"], "properties": {"state": {"const": "CONNECTED"}}}, {"type": "object", "required": ["state"], "properties": {"state": {"const": "SYNCING"}}}, {"type": "object", "required": ["state", "count"], "properties": {"state": {"const": "SYNCED"}, "count": {"type": ["integer", "null"]}}}]}}}}, "server.yaml": {"$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "hat-event://server.yaml", "title": "Event Server", "description": "Event Server's configuration", "type": "object", "required": ["name", "server_id", "backend", "modules", "eventer_server"], "properties": {"type": {"const": "event", "description": "configuration type identification"}, "version": {"type": "string", "description": "component version"}, "log": {"$ref": "hat-json://logging.yaml"}, "name": {"type": "string", "description": "component name"}, "server_id": {"type": "integer", "description": "server identifier"}, "server_token": {"type": ["string", "null"], "description": "server token"}, "backend": {"$ref": "hat-event://server.yaml#/$defs/backend"}, "modules": {"type": "array", "items": {"$ref": "hat-event://server.yaml#/$defs/module"}}, "eventer_server": {"type": "object", "required": ["host", "port"], "properties": {"host": {"type": "string", "default": "127.0.0.1"}, "port": {"type": "integer", "default": 23012}}}, "adminer_server": {"type": "object", "required": ["host", "port"], "properties": {"host": {"type": "string", "default": "127.0.0.1"}, "port": {"type": "integer", "default": 23015}}}, "monitor_component": {"type": "object", "required": ["host", "port", "group"], "properties": {"host": {"type": "string", "default": "127.0.0.1"}, "port": {"type": "integer", "default": 23010}, "group": {"type": "string"}}}}, "$defs": {"backend": {"type": "object", "description": "structure of backend configuration depends on backend type\n", "required": ["module"], "properties": {"module": {"type": "string", "description": "full python module name that implements backend"}}}, "module": {"type": "object", "description": "structure of module configuration depends on module type\n", "required": ["module"], "properties": {"module": {"type": "string", "description": "full python module name that implements module"}}}}}, "backends/lmdb.yaml": {"$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "hat-event://backends/lmdb.yaml", "title": "LMDB backend", "type": "object", "required": ["db_path", "identifier", "flush_period", "cleanup_period", "conditions", "latest", "timeseries"], "properties": {"db_path": {"type": "string"}, "identifier": {"type": ["null", "string"]}, "flush_period": {"type": "number"}, "cleanup_period": {"type": "number"}, "conditions": {"type": "array", "items": {"type": "object", "required": ["subscriptions", "condition"], "properties": {"subscriptions": {"$ref": "hat-event://backends/lmdb.yaml#/$defs/event_types"}, "condition": {"$ref": "hat-event://backends/lmdb.yaml#/$defs/condition"}}}}, "latest": {"type": "object", "required": ["subscriptions"], "properties": {"subscriptions": {"$ref": "hat-event://backends/lmdb.yaml#/$defs/event_types"}}}, "timeseries": {"type": "array", "items": {"type": "object", "required": ["order_by", "subscriptions"], "properties": {"order_by": {"enum": ["TIMESTAMP", "SOURCE_TIMESTAMP"]}, "subscriptions": {"$ref": "hat-event://backends/lmdb.yaml#/$defs/event_types"}, "limit": {"$ref": "hat-event://backends/lmdb.yaml#/$defs/limit"}}}}}, "$defs": {"event_types": {"type": "array", "items": {"type": "array", "items": {"type": "string"}}}, "limit": {"type": "object", "properties": {"min_entries": {"type": "number", "description": "number of entries kept despite of other limits\n"}, "max_entries": {"type": "number", "description": "maximum number of entries\n"}, "duration": {"type": "number", "description": "limit for the persisted history based on keys\nexpressed as duration in seconds\n"}, "size": {"type": "number", "description": "memory consumption size in bytes that triggers\nadditional cleanup based on average entry size\n"}}}, "condition": {"oneOf": [{"$ref": "hat-event://backends/lmdb.yaml#/$defs/conditions/all"}, {"$ref": "hat-event://backends/lmdb.yaml#/$defs/conditions/any"}, {"$ref": "hat-event://backends/lmdb.yaml#/$defs/conditions/json"}]}, "conditions": {"all": {"type": "object", "required": ["type", "conditions"], "properties": {"type": {"const": "all"}, "conditions": {"type": "array", "items": {"$ref": "hat-event://backends/lmdb.yaml#/$defs/condition"}}}}, "any": {"type": "object", "required": ["type", "conditions"], "properties": {"type": {"const": "any"}, "conditions": {"type": "array", "items": {"$ref": "hat-event://backends/lmdb.yaml#/$defs/condition"}}}}, "json": {"type": "object", "required": ["type"], "properties": {"type": {"const": "json"}, "data_path": {"$ref": "hat-event://backends/lmdb.yaml#/$defs/path"}, "data_type": {"enum": ["null", "boolean", "string", "number", "array", "object"]}, "data_value": {}}}}, "path": {"oneOf": [{"type": "string"}, {"type": "integer"}, {"type": "array", "items": {"$ref": "hat-event://backends/lmdb.yaml#/$defs/path"}}]}}}, "backends/sqlite.yaml": {"$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "hat-event://backends/sqlite.yaml", "title": "Sqlite backend", "description": "Sqlite backend configuration", "type": "object", "required": ["db_path", "query_pool_size"], "properties": {"db_path": {"type": "string", "description": "path to sqlite database file"}, "query_pool_size": {"type": "integer", "description": "number of connections in a pool used for querying\n"}}}}}

hat/event/common/matches.py

@@ -0,0 +1,44 @@
+from hat.event.common.common import EventType
+
+
+def matches_query_type(event_type: EventType,
+                       query_type: EventType
+                       ) -> bool:
+    """Determine if event type matches query type
+
+    Event type is tested if it matches query type according to the following
+    rules:
+
+        * Matching is performed on subtypes in increasing order.
+        * Event type is a match only if all its subtypes are matched by
+          corresponding query subtypes.
+        * Matching is finished when all query subtypes are exhausted.
+        * Query subtype '?' matches exactly one event subtype of any value.
+          The subtype must exist.
+        * Query subtype '*' matches 0 or more event subtypes of any value. It
+          must be the last query subtype.
+        * All other values of query subtype match exactly one event subtype
+          of the same value.
+        * Query type without subtypes is matched only by event type with no
+          subtypes.
+
+    As a consequence of aforementioned matching rules, event subtypes '*' and
+    '?' cannot be directly matched and it is advisable not to use them in event
+    types.
+
+    """
+    is_variable = bool(query_type and query_type[-1] == '*')
+    if is_variable:
+        query_type = query_type[:-1]
+
+    if len(event_type) < len(query_type):
+        return False
+
+    if len(event_type) > len(query_type) and not is_variable:
+        return False
+
+    for i, j in zip(event_type, query_type):
+        if j != '?' and i != j:
+            return False
+
+    return True

hat/event/common/module.py

@@ -0,0 +1,142 @@
+from collections.abc import Collection, Iterable
+import abc
+import enum
+import importlib
+import typing
+
+from hat import aio
+from hat import json
+
+from hat.event.common.common import (Event,
+                                     QueryParams,
+                                     QueryResult,
+                                     RegisterEvent)
+from hat.event.common.subscription import Subscription
+
+
+class SourceType(enum.Enum):
+    EVENTER = 1
+    MODULE = 2
+    ENGINE = 3
+    SERVER = 4
+
+
+class Source(typing.NamedTuple):
+    type: SourceType
+    id: int
+
+
+class Engine(aio.Resource):
+    """Engine ABC"""
+
+    @property
+    @abc.abstractmethod
+    def server_id(self) -> int:
+        """Event server identifier"""
+
+    @abc.abstractmethod
+    async def register(self,
+                       source: Source,
+                       events: Collection[RegisterEvent]
+                       ) -> Collection[Event] | None:
+        """Register events"""
+
+    @abc.abstractmethod
+    async def query(self,
+                    params: QueryParams
+                    ) -> QueryResult:
+        """Query events"""
+
+    @abc.abstractmethod
+    def get_client_names(self) -> Iterable[tuple[Source, str]]:
+        """Get client names connected to local eventer server"""
+
+    @abc.abstractmethod
+    def restart(self):
+        """Schedule engine restart"""
+
+    @abc.abstractmethod
+    def reset_monitor_ready(self):
+        """Schedule reseting of monitor component's ready flag"""
+
+
+class Module(aio.Resource):
+    """Module ABC"""
+
+    @property
+    @abc.abstractmethod
+    def subscription(self) -> Subscription:
+        """Subscribed event types filter.
+
+        `subscription` is constant during module's lifetime.
+
+        """
+
+    async def on_session_start(self, session_id: int):
+        """Called on start of a session, identified by session_id.
+
+        This method can be coroutine or regular function.
+
+        """
+
+    async def on_session_stop(self, session_id: int):
+        """Called on stop of a session, identified by session_id.
+
+        This method can be coroutine or regular function.
+
+        """
+
+    @abc.abstractmethod
+    async def process(self,
+                      source: Source,
+                      event: Event
+                      ) -> Iterable[RegisterEvent] | None:
+        """Process new session event.
+
+        Provided event is matched by modules subscription filter.
+
+        Processing of session event can result in registration of
+        new register events.
+
+        Single module session process is always called sequentially.
+
+        This method can be coroutine or regular function.
+
+        """
+
+
+ModuleConf: typing.TypeAlias = json.Data
+"""Module configuration"""
+
+CreateModule: typing.TypeAlias = aio.AsyncCallable[
+    [ModuleConf, Engine, Source],
+    Module]
+"""Create module callable"""
+
+
+class ModuleInfo(typing.NamedTuple):
+    """Module info
+
+    Module is implemented as python module which is dynamically imported.
+    It is expected that this module contains `info` which is instance of
+    `ModuleInfo`.
+
+    If module defines JSON schema repository and JSON schema id, JSON schema
+    repository will be used for additional validation of module configuration
+    with JSON schema id.
+
+    """
+    create: CreateModule
+    json_schema_id: str | None = None
+    json_schema_repo: json.SchemaRepository | None = None
+
+
+def import_module_info(py_module_str: str) -> ModuleInfo:
+    """Import module info"""
+    py_module = importlib.import_module(py_module_str)
+    info = py_module.info
+
+    if not isinstance(info, ModuleInfo):
+        raise Exception('invalid module implementation')
+
+    return info

hat/event/common/sbs_repo.json

@@ -0,0 +1 @@
+[{"name": "HatEventer", "type_defs": {"MsgInitReq": {"name": "MsgInitReq", "args": [], "type": {"module": null, "name": "Record", "entries": [{"name": "clientName", "type": {"module": null, "name": "String", "entries": [], "args": []}}, {"name": "clientToken", "type": {"module": null, "name": "Optional", "entries": [], "args": [{"module": null, "name": "String", "entries": [], "args": []}]}}, {"name": "subscriptions", "type": {"module": null, "name": "Array", "entries": [], "args": [{"module": null, "name": "EventType", "entries": [], "args": []}]}}, {"name": "serverId", "type": {"module": null, "name": "Optional", "entries": [], "args": [{"module": null, "name": "Integer", "entries": [], "args": []}]}}, {"name": "persisted", "type": {"module": null, "name": "Boolean", "entries": [], "args": []}}], "args": []}}, "MsgInitRes": {"name": "MsgInitRes", "args": [], "type": {"module": null, "name": "Choice", "entries": [{"name": "success", "type": {"module": null, "name": "Status", "entries": [], "args": []}}, {"name": "error", "type": {"module": null, "name": "String", "entries": [], "args": []}}], "args": []}}, "MsgStatusNotify": {"name": "MsgStatusNotify", "args": [], "type": {"module": null, "name": "Status", "entries": [], "args": []}}, "MsgEventsNotify": {"name": "MsgEventsNotify", "args": [], "type": {"module": null, "name": "Array", "entries": [], "args": [{"module": null, "name": "Event", "entries": [], "args": []}]}}, "MsgEventsAck": {"name": "MsgEventsAck", "args": [], "type": {"module": null, "name": "None", "entries": [], "args": []}}, "MsgRegisterReq": {"name": "MsgRegisterReq", "args": [], "type": {"module": null, "name": "Array", "entries": [], "args": [{"module": null, "name": "RegisterEvent", "entries": [], "args": []}]}}, "MsgRegisterRes": {"name": "MsgRegisterRes", "args": [], "type": {"module": null, "name": "Choice", "entries": [{"name": "events", "type": {"module": null, "name": "Array", "entries": [], "args": [{"module": null, "name": "Event", "entries": [], "args": []}]}}, {"name": "failure", "type": {"module": null, "name": "None", "entries": [], "args": []}}], "args": []}}, "MsgQueryReq": {"name": "MsgQueryReq", "args": [], "type": {"module": null, "name": "QueryParams", "entries": [], "args": []}}, "MsgQueryRes": {"name": "MsgQueryRes", "args": [], "type": {"module": null, "name": "QueryResult", "entries": [], "args": []}}, "Status": {"name": "Status", "args": [], "type": {"module": null, "name": "Choice", "entries": [{"name": "standby", "type": {"module": null, "name": "None", "entries": [], "args": []}}, {"name": "starting", "type": {"module": null, "name": "None", "entries": [], "args": []}}, {"name": "operational", "type": {"module": null, "name": "None", "entries": [], "args": []}}, {"name": "stopping", "type": {"module": null, "name": "None", "entries": [], "args": []}}], "args": []}}, "Timestamp": {"name": "Timestamp", "args": [], "type": {"module": null, "name": "Record", "entries": [{"name": "s", "type": {"module": null, "name": "Integer", "entries": [], "args": []}}, {"name": "us", "type": {"module": null, "name": "Integer", "entries": [], "args": []}}], "args": []}}, "EventId": {"name": "EventId", "args": [], "type": {"module": null, "name": "Record", "entries": [{"name": "server", "type": {"module": null, "name": "Integer", "entries": [], "args": []}}, {"name": "session", "type": {"module": null, "name": "Integer", "entries": [], "args": []}}, {"name": "instance", "type": {"module": null, "name": "Integer", "entries": [], "args": []}}], "args": []}}, "Order": {"name": "Order", "args": [], "type": {"module": null, "name": "Choice", "entries": [{"name": "descending", "type": {"module": null, "name": "None", "entries": [], "args": []}}, {"name": "ascending", "type": {"module": null, "name": "None", "entries": [], "args": []}}], "args": []}}, "OrderBy": {"name": "OrderBy", "args": [], "type": {"module": null, "name": "Choice", "entries": [{"name": "timestamp", "type": {"module": null, "name": "None", "entries": [], "args": []}}, {"name": "sourceTimestamp", "type": {"module": null, "name": "None", "entries": [], "args": []}}], "args": []}}, "EventType": {"name": "EventType", "args": [], "type": {"module": null, "name": "Array", "entries": [], "args": [{"module": null, "name": "String", "entries": [], "args": []}]}}, "EventPayload": {"name": "EventPayload", "args": [], "type": {"module": null, "name": "Choice", "entries": [{"name": "binary", "type": {"module": null, "name": "EventPayloadBinary", "entries": [], "args": []}}, {"name": "json", "type": {"module": null, "name": "EventPayloadJson", "entries": [], "args": []}}], "args": []}}, "EventPayloadBinary": {"name": "EventPayloadBinary", "args": [], "type": {"module": null, "name": "Record", "entries": [{"name": "type", "type": {"module": null, "name": "String", "entries": [], "args": []}}, {"name": "data", "type": {"module": null, "name": "Bytes", "entries": [], "args": []}}], "args": []}}, "EventPayloadJson": {"name": "EventPayloadJson", "args": [], "type": {"module": null, "name": "String", "entries": [], "args": []}}, "Event": {"name": "Event", "args": [], "type": {"module": null, "name": "Record", "entries": [{"name": "id", "type": {"module": null, "name": "EventId", "entries": [], "args": []}}, {"name": "type", "type": {"module": null, "name": "EventType", "entries": [], "args": []}}, {"name": "timestamp", "type": {"module": null, "name": "Timestamp", "entries": [], "args": []}}, {"name": "sourceTimestamp", "type": {"module": null, "name": "Optional", "entries": [], "args": [{"module": null, "name": "Timestamp", "entries": [], "args": []}]}}, {"name": "payload", "type": {"module": null, "name": "Optional", "entries": [], "args": [{"module": null, "name": "EventPayload", "entries": [], "args": []}]}}], "args": []}}, "RegisterEvent": {"name": "RegisterEvent", "args": [], "type": {"module": null, "name": "Record", "entries": [{"name": "type", "type": {"module": null, "name": "EventType", "entries": [], "args": []}}, {"name": "sourceTimestamp", "type": {"module": null, "name": "Optional", "entries": [], "args": [{"module": null, "name": "Timestamp", "entries": [], "args": []}]}}, {"name": "payload", "type": {"module": null, "name": "Optional", "entries": [], "args": [{"module": null, "name": "EventPayload", "entries": [], "args": []}]}}], "args": []}}, "QueryParams": {"name": "QueryParams", "args": [], "type": {"module": null, "name": "Choice", "entries": [{"name": "latest", "type": {"module": null, "name": "QueryLatestParams", "entries": [], "args": []}}, {"name": "timeseries", "type": {"module": null, "name": "QueryTimeseriesParams", "entries": [], "args": []}}, {"name": "server", "type": {"module": null, "name": "QueryServerParams", "entries": [], "args": []}}], "args": []}}, "QueryLatestParams": {"name": "QueryLatestParams", "args": [], "type": {"module": null, "name": "Record", "entries": [{"name": "eventTypes", "type": {"module": null, "name": "Optional", "entries": [], "args": [{"module": null, "name": "Array", "entries": [], "args": [{"module": null, "name": "EventType", "entries": [], "args": []}]}]}}], "args": []}}, "QueryTimeseriesParams": {"name": "QueryTimeseriesParams", "args": [], "type": {"module": null, "name": "Record", "entries": [{"name": "eventTypes", "type": {"module": null, "name": "Optional", "entries": [], "args": [{"module": null, "name": "Array", "entries": [], "args": [{"module": null, "name": "EventType", "entries": [], "args": []}]}]}}, {"name": "tFrom", "type": {"module": null, "name": "Optional", "entries": [], "args": [{"module": null, "name": "Timestamp", "entries": [], "args": []}]}}, {"name": "tTo", "type": {"module": null, "name": "Optional", "entries": [], "args": [{"module": null, "name": "Timestamp", "entries": [], "args": []}]}}, {"name": "sourceTFrom", "type": {"module": null, "name": "Optional", "entries": [], "args": [{"module": null, "name": "Timestamp", "entries": [], "args": []}]}}, {"name": "sourceTTo", "type": {"module": null, "name": "Optional", "entries": [], "args": [{"module": null, "name": "Timestamp", "entries": [], "args": []}]}}, {"name": "order", "type": {"module": null, "name": "Order", "entries": [], "args": []}}, {"name": "orderBy", "type": {"module": null, "name": "OrderBy", "entries": [], "args": []}}, {"name": "maxResults", "type": {"module": null, "name": "Optional", "entries": [], "args": [{"module": null, "name": "Integer", "entries": [], "args": []}]}}, {"name": "lastEventId", "type": {"module": null, "name": "Optional", "entries": [], "args": [{"module": null, "name": "EventId", "entries": [], "args": []}]}}], "args": []}}, "QueryServerParams": {"name": "QueryServerParams", "args": [], "type": {"module": null, "name": "Record", "entries": [{"name": "serverId", "type": {"module": null, "name": "Integer", "entries": [], "args": []}}, {"name": "persisted", "type": {"module": null, "name": "Boolean", "entries": [], "args": []}}, {"name": "maxResults", "type": {"module": null, "name": "Optional", "entries": [], "args": [{"module": null, "name": "Integer", "entries": [], "args": []}]}}, {"name": "lastEventId", "type": {"module": null, "name": "Optional", "entries": [], "args": [{"module": null, "name": "EventId", "entries": [], "args": []}]}}], "args": []}}, "QueryResult": {"name": "QueryResult", "args": [], "type": {"module": null, "name": "Record", "entries": [{"name": "events", "type": {"module": null, "name": "Array", "entries": [], "args": [{"module": null, "name": "Event", "entries": [], "args": []}]}}, {"name": "moreFollows", "type": {"module": null, "name": "Boolean", "entries": [], "args": []}}], "args": []}}}}, {"name": "HatEventAdminer", "type_defs": {"MsgGetLogConfReq": {"name": "MsgGetLogConfReq", "args": [], "type": {"module": null, "name": "None", "entries": [], "args": []}}, "MsgGetLogConfRes": {"name": "MsgGetLogConfRes", "args": [], "type": {"module": null, "name": "Response", "entries": [], "args": [{"module": null, "name": "String", "entries": [], "args": []}]}}, "MsgSetLogConfReq": {"name": "MsgSetLogConfReq", "args": [], "type": {"module": null, "name": "String", "entries": [], "args": []}}, "MsgSetLogConfRes": {"name": "MsgSetLogConfRes", "args": [], "type": {"module": null, "name": "Response", "entries": [], "args": [{"module": null, "name": "None", "entries": [], "args": []}]}}, "Response": {"name": "Response", "args": ["T"], "type": {"module": null, "name": "Choice", "entries": [{"name": "success", "type": {"module": null, "name": "T", "entries": [], "args": []}}, {"name": "error", "type": {"module": null, "name": "String", "entries": [], "args": []}}], "args": []}}}}]

hat/event/common/subscription/__init__.py

@@ -0,0 +1,22 @@
+from collections.abc import Iterable
+
+from hat.event.common.common import EventType
+from hat.event.common.subscription.common import Subscription
+from hat.event.common.subscription.pysubscription import PySubscription
+
+try:
+    from hat.event.common.subscription.csubscription import CSubscription
+
+except ImportError:
+    CSubscription = None
+
+
+__all__ = ['Subscription',
+           'create_subscription']
+
+
+def create_subscription(query_types: Iterable[EventType]) -> Subscription:
+    if CSubscription is not None:
+        return CSubscription(query_types)
+
+    return PySubscription(query_types)