server.common

module documentation

Undocumented

Function	`get_scrypt_instance`	Return initialized Scrypt instance.
Async Function	`halt_skill_and_wait`	Halt the given skill and wait until it finished and is in the Halted state.
Async Function	`halt_skills_parallel_and_wait`	Halt all given skills in 'parallel'.
Async Function	`reset_skill_and_wait`	Reset the given skill and wait until it finished (successfully reached Ready state or Halted on failure).
Async Function	`reset_skills_parallel_and_wait`	Reset all given skills in 'parallel'.
Constant	`SECRET_KEY_NAME`	The name of the environment variable containing the secret key/pepper.
Constant	`_LOGGER`	Undocumented

def get_scrypt_instance() -> Scrypt: ¶

Return initialized Scrypt instance.

The pepper is read from base64 encoded environment variable.

Raises
`RuntimeError`	If either the pepper environment variable is missing or does not contain valid Base64.

async def halt_skill_and_wait(skill: AbstractSkill, *, timeout: float | None = 60.0): ¶

Halt the given skill and wait until it finished and is in the Halted state.

async def halt_skills_parallel_and_wait(skills: Iterable[AbstractSkill], *, timeout: float | None = 60.0): ¶

Halt all given skills in 'parallel'.

async def reset_skill_and_wait(skill: AbstractSkill, *, timeout: float | None = 60.0): ¶

Reset the given skill and wait until it finished (successfully reached Ready state or Halted on failure).

Note: This will only wait for the 'Halting' skill state, but not for other skill transition states!

async def reset_skills_parallel_and_wait(skills: Iterable[AbstractSkill], *, timeout: float | None = 60.0): ¶

Reset all given skills in 'parallel'.

SECRET_KEY_NAME: str = ¶

The name of the environment variable containing the secret key/pepper.

Value

'OPEN_SMI_SECRET_KEY'

_LOGGER = ¶

Undocumented

Value

structlog.get_logger('opensmi.common')