interaction.base.common

random_token

ding.interaction.base.common.random_token(length: Optional[int] = None) → str

Overview:

Generate random hex token

Arguments:

• length (Optional[int]): Length of the random token (None means 64)

Returns:

• token (str): Generated random token

Example:

>>> random_token()  # '4eAbd5218e3d0da5e7AAFcBF48Ea0Df2dadED1bdDF0B8724FdE1569AA78F24A7'
>>> random_token(24)  # 'Cd1CdD98caAb8602ac6501aC'

ControllableContext

class ding.interaction.base.common.ControllableContext

Overview:

Basic context-supported class structure

Example:

• Common usage

>>> c = MyControllableContext()  # One of the superclasses if ControllableContext
>>> c.start()
>>> try:
>>>     pass  # do anything you like
>>> finally:
>>>     c.close()

• Use with keyword (the same as code above)

>>> c = MyControllableContext()  # One of the superclasses if ControllableContext
>>> with c as cc:   # cc is c, have the same id
>>>     pass  # do anything you like

__enter__()

Overview:

Enter the context

Returns:

• self (ControllableContext): Context object itself

__exit__(exc_type, exc_val, exc_tb)

Overview:

Exit the context

abstract close()

Overview:

Close the context

abstract start()

Overview:

Start the context

ControllableService

class ding.interaction.base.common.ControllableService

Overview:

Controllable service with context support, usually has concurrent feature.

Example:

• A common usage

>>> c = MyControllableService()  # One of its superclasses is ControllableService
>>> c.start()
>>> try:
>>>     pass  # do anything you like
>>> finally:
>>>     c.shutdown()  # shutdown the service
>>>     c.join()  # wait until service is down

• Use with keyword (the same as code above)

>>> c = MyControllableService()  # One of its superclasses is ControllableService
>>> with c as cc:   # cc is c, have the same id
>>>     pass  # do anything you like

__enter__()

Overview:

Enter the context

Returns:

• self (ControllableContext): Context object itself

__exit__(exc_type, exc_val, exc_tb)

Overview:

Exit the context

close()

Overview:

Close the service, wait until the service is down.

abstract join()

Overview:

Wait until the service is completely down

abstract shutdown()

Overview:

Shutdown the service (but service will not down immediately)

abstract start()

Overview:

Start the service

translate_dict_func

ding.interaction.base.common.translate_dict_func(d: Mapping[str, Callable[[...], Any]]) → Callable[[...], Dict[str, Any]]

Overview:

Transform dict with funcs to function generating dict.

Arguments:

• d (Mapping[str, Callable[..., Any]]): Dict with funcs

Returns:

• func (Callable[..., Dict[str, Any]]): Function generating dict

Example:

>>> f1 = lambda x, y: x + y
>>> f2 = lambda x, y: x - y
>>> f3 = lambda x, y: x * y
>>> fx = translate_dict_func({'a': f1, 'b': f2, 'c': f3})
>>> fx(2, 3)  # {'a': 5, 'b': -1, 'c': 6}
>>> fx(5, 11)  # ('a': 16, 'b': -6, 'c': 55}

default_func

ding.interaction.base.common.default_func(return_value=None) → Callable[[Callable[[...], Any]], Callable[[...], Any]]

Overview:

Transform optional function (maybe None) to function with default value

Argument:

• return_value (:obj:): Return value of the default function

Returns:

• decorator (Callable[[Callable[..., Any]], Callable[..., Any]]): A decorator function that can decorator optional function to real function (must be not None)

Example:

>>> f1 = None
>>> f2 = lambda x, y: x + y
>>> ff1 = default_func()(f1)
>>> ft1 = default_func(0)(f1)
>>> ff2 = default_func()(f2)
>>> ff1(2, 3)  # None
>>> ft1(2, 3)  # 0
>>> ff2(2, 3)  # 5