API Reference

This page contains only automatically generated documentation to functions, classes, methods, etc.

API

Low-level API

Utils functions

class dxfeed.core.utils.data_class.DequeWithLock(iterable=(), maxlen=None)

Class that provides lock mechanism to deque from collections for append, copy and get operations

append()

Add an element to the right side of the deque.

appendleft()

Add an element to the left side of the deque.

clear()

Remove all elements from the deque.

copy()

Return a shallow copy of a deque.

count(value) → integer -- return number of occurrences of value

extend()

Extend the right side of the deque with elements from the iterable

extendleft()

Extend the left side of the deque with elements from the iterable

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

insert()

D.insert(index, object) – insert object before index

maxlen

maximum size of a deque or None if unbounded

pop()

Remove and return the rightmost element.

popleft()

Remove and return the leftmost element.

remove()

D.remove(value) – remove first occurrence of value.

reverse()

D.reverse() – reverse IN PLACE

rotate()

Rotate the deque n steps to the right (default n=1). If n is negative, rotates left.

safe_append(data: Any)

Method appends data while locked :param data: Data to append :type data: any

safe_get(keep: bool = True)

Method that pops all the data with subsequent clearing

Parameters:

keep (bool) – When False clears internal collections.deque object after call. Default True.

Returns:

list_to_return – List filled with data

Return type:

list