services

deepdataspace.services

This module wraps all service components for dds and provides a common interface to control them.

celery

deepdataspace.services.celery

The celery service manager.

class Celery

Bases: Service

start()

config

deepdataspace.services.config

This file defines global config variables shared by all services.

log_and_save_env(name: str, value)

Save an export statement to the env file, and log it to the console. The saved statements will be loaded by ddsop command.

load_all_env()

Load environment variables from the env file. The env file is generated by dds command.

save_all_env()

print_if_verbose(*args, **kwargs)

Only print message when VERBOSE_LOG is On.

generate_redis_conf(config_path: str)

setup_redis_password(config_path: str)

Generate a random password in the redis config file

read_redis_password(config_path: str)

Read redis password from config file.

generate_mongodb_conf(config_path: str)

setup_mongodb_password(config_path: str)

Generate a random password for mongodb. It’s not directly used by mongodb server, but read by dds tool to set up the server.

read_mongodb_password(config_path: str)

Read mongodb password from config file.

dds

deepdataspace.services.dds

The dds service manager. This is the main entry point for dds, which controls all other services.

class DDS(*args, **kwargs)

Bases: object

argument_or_config(key, value, default)

exit_or_raise(msg: str)

prefight_checks()

init_samples()

init_envs()

Init all global environments. These environments will be read by subprocesses, especially celery and django.

init()

Make preparations before start the services.

start_db()

start_redis()

start_mongodb()

start_celery()

start_django()

static close_process(pid: int)

Close a process by pid. Try p.terminate first, then p.kill if it survives more than 1 second.

close_all_started()

Close all started subprocesses.

start_all()

Start all services.

greeting()

Print startup messages to the console.

static loop()

Block the main process. Don’t use os.waitpid, it is not Windows compatible.

start()

stop()

django

deepdataspace.services.django

The django service manager.

class Django

Bases: Service

migrate_db()

start()

mongodb

deepdataspace.services.mongodb

The mongodb service manager.

class MongoDB

Bases: Service

start()

redis

deepdataspace.services.redis

The redis service manager.

class Redis

Bases: Service

start()

service

deepdataspace.services.service

Base class and common interfaces for all services.

terminate_all_children(sig, frame)

progress_log(log_prefix: str)

Print a dynamic log message while we start services in the background. So users won’t mistake that our process is dead.

class Service(name: str, cmd_list: list)

Bases: object

static close_process(pid: int)

Close a process by pid. Try p.terminate first, then p.kill if it survives more than 1 second.

clean_process()

Close all process identified by cmd_id

open_process(cmd: list, wait: int = 2)

Start a subprocess with cmd and argument. :param cmd: the cmd and arguments used to start the subprocess :param wait: num of seconds to wait after init the subprocess

check_process()

Check if the process identified by cmd_is is running.

start_process(cmd_list: list, wait: int = 2)

Start a subprocess with the command line arguments. :param cmd_list: the command line arguments to start the process :param cmd_id: the command line identifier, this must be unique enough to identify the process from all processes :param wait: how many seconds to wait after the subprocess is called

sqlite

deepdataspace.services.sqlite

The sqlite db service manager.

class SQLite

Bases: object

We don’t need to ‘start’ sqlite, we just implement this to unify controller API.

start()