def select()

in tbapi/__init__.py [0:0]

• 19 lines of code
• 1 McCabe index (conditional complexity)

    def select(self, timestamp: int, options: SelectionOptions, types: 'list[str]', entities: 'list[str]') -> 'TickCursor':
        '''Opens a cursor for reading data from this stream, according to the
        specified options. The messages
        are returned from the cursor strictly ordered by time. Within the same
        exact time stamp, the order of messages is undefined and may vary from
        call to call, i.e. it is non-deterministic.

        Note that the arguments of this method only determine the initial
        configuration of the cursor. The TickCursor interface provides
        methods for dynamically re-configuring the subscription, or jumping to
        a different timestamp.

        Args:
            timestamp (int): The start timestamp in millis.
            options (SelectionOptions): Selection options.
            types (list[str]): Specified message types to be subscribed. If null, then all types will be subscribed.
            entities (list[str]): Specified entities to be subscribed. If null, then all entities will be subscribed.

        Returns:
            TickCursor: A cursor used to read messages.
        '''
        return self.__select(timestamp, options, types, entities)