ubdcc_shared_modules package

Submodules

ubdcc_shared_modules.App module

class ubdcc_shared_modules.App.App(app_name=None, cwd=None, mgmt_port=None, logger=None, service=None, service_call=None, stop_call=None)

Bases: object

static generate_string(length)

async get_backup_from_node(host, port) → dict | None

get_backup_timestamp() → float | None

async get_backup_timestamp_from_node(host, port) → float | None

get_cluster_mgmt_address()

get_dcn_uid_unused_longest_time(selection: list = None) → str | None

get_fastapi_instance() → FastAPI

get_k8s_nodes() → dict

get_k8s_runtime_information()

static get_unix_timestamp()

static get_version() → str

static is_compiled() → bool

is_shutdown() → bool

register_graceful_shutdown() → None

async register_or_restart(ubldc_version: str = None)

async static request(url, method, params=None, headers=None, timeout=10) → dict

async send_backup_to_node(host, port) → dict

set_api_rest_port()

set_status_running() → bool

shutdown(message=None) → None

sigterm_handler(signal, frame) → None

async sleep(seconds: int = 10) → bool

static sort_dict(input_dict: dict, reverse: bool = False) → dict

start() → None

stdout_msg(msg=None, log=None, stdout=True) → bool

async ubdcc_assign_credentials(account_group: str = None) → dict | None

Ask mgmt for a credential assigned to this DCN uid for the given account_group. Returns {id, account_group, api_key, api_secret} or None when no keys are configured / error.

async ubdcc_get_responsible_dcn_addresses(exchange: str = None, market: str = None)

async ubdcc_node_cancellation()

async ubdcc_node_registration(ubldc_version: str = None, retries: int = 30) → bool

async ubdcc_node_sync() → bool

async ubdcc_update_depthcache_distribution(exchange: str = None, market: str = None, last_restart_time: int = None, status: str = None) → bool

ubdcc_shared_modules.Database module

class ubdcc_shared_modules.Database.Database(app=None)

Bases: object

add_credentials(account_group: str = None, api_key: str = None, api_secret: str = None) → str

Store a Binance API key pair for the given account group. Returns the generated credential id (UUID). Raises ValueError on invalid parameters or unknown account_group.

add_depthcache(exchange: str = None, market: str = None, desired_quantity: int = None, update_interval: int = None, refresh_interval: int = None) → bool

add_depthcache_distribution(exchange: str = None, market: str = None, pod_uid: str = None, scheduled_start_time: float = None) → bool

add_pod(name: str = None, uid: str = None, node: str = None, role: str = None, ip: str = None, api_port_rest: int = None, status: str = None, ubldc_version: str = None, version: str = None) → bool

assign_credentials(uid: str = None, account_group: str = None) → dict | None

Assign (or return already-assigned) credential to a DCN uid. Load-balanced: picks credential with fewest ASSIGNED_DCNS. Returns full credential dict (incl. secret) or None if no keys available.

delete(key: str = None) → bool

delete_credentials(credential_id: str = None) → bool

Remove a stored credential. Returns True on success, False when the id was not found.

delete_depthcache(exchange: str = None, market: str = None) → bool

delete_depthcache_distribution(exchange: str = None, market: str = None, pod_uid: str = None) → bool

delete_old_pods() → bool

delete_pod(uid: str = None) → bool

exists_depthcache(exchange: str = None, market: str = None) → bool

exists_pod(uid: str = None) → bool

get(key: str = None)

get_all() → dict

get_available_dcn_pods() → dict

get_backup_dict() → dict

get_best_dcn(available_pods: dict = None, excluded_pods: list = None) → str | None

get_credentials(credential_id: str = None) → dict | None

Return the full credential record (incl. secret) for the given id, or None if not found. Internal use only — do not leak through public endpoints.

get_credentials_list(reveal_secrets: bool = False) → list

Return list of credentials. With reveal_secrets=False (default) api_key/api_secret are masked for public consumption.

get_dcn_responsibilities() → list

get_depthcache_info(exchange: str = None, market: str = None) → dict

get_depthcache_list() → dict

get_pod_by_address(address: str = None) → dict | None

get_pod_by_uid(uid=None) → dict | None

get_responsible_dcn_addresses(exchange: str = None, market: str = None) → list

get_worst_dcn(available_pods: dict | None = None, excluded_pods: list = None) → str | None

is_empty() → bool

manage_distribution() → bool

release_credentials(uid: str = None) → bool

Remove uid from ASSIGNED_DCNS of all credentials (called when DCN pod disappears).

remove_orphaned_credential_assignments() → bool

remove_orphaned_distribution_entries() → bool

replace_data(data: dict = None)

revise() → bool

set(key: str = None, value: dict | str | float | list | set | tuple = None) → bool

update_depthcache(desired_quantity: int = None, exchange: str = None, refresh_interval: int = None, market: str = None, update_interval: int = None) → bool

update_depthcache_distribution(exchange: str = None, market: str = None, pod_uid: str = None, last_restart_time: float = None, status: str = None) → bool

update_nodes() → bool

update_pod(uid: str = None, node: str = None, ip: str = None, api_port_rest: int = None, status: str = None) → bool

ubdcc_shared_modules.RestEndpointsBase module

class ubdcc_shared_modules.RestEndpointsBase.RestEndpointsBase(app=None)

Bases: object

create_cluster_info_response() → dict

static create_debug_response(process_start_time: float = None, url: str = None, post_body: dict = None, used_pods: list = None) → dict

create_depthcache_info_response(exchange: str = None, market: str = None) → dict

create_depthcache_list_response() → dict

get_error_response(event: str = None, error_id: str = None, message: str = None, params: dict = None, process_start_time: float = None, url: str = None, post_body: dict = None, used_pods: list = None)

get_fastapi_instance()

get_ok_response(event: str = None, params: dict = None, process_start_time: float = None, url: str = None, post_body: dict = None, used_pods: list = None, error: str = None, error_id: str = None)

is_ready()

register()

async shutdown(request: Request)

async test(request: Request)

throw_error_if_mgmt_not_ready(request: Request, event: str = None)

async ubdcc_mgmt_backup(request: Request)

ubdcc_shared_modules.RestServer module

class ubdcc_shared_modules.RestServer.RestServer(app=None, endpoints=None, port=None)

Bases: Thread

run() → None

Method representing the thread’s activity.

You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.

stop() → bool

ubdcc_shared_modules.ServiceBase module

class ubdcc_shared_modules.ServiceBase.ServiceBase(app_name=None, cwd=None, mgmt_port=None)

Bases: object

db_init() → bool

static is_port_free(port, host='127.0.0.1')

async main() → None

run() → None

async start_rest_server(endpoints=None) → bool

stop() → bool

Module contents