atomiq.arguments.json

Attributes

Classes

Module Contents

atomiq.arguments.json.logger
class atomiq.arguments.json.JSONArgumentProvider(url, use_class_defaults=True)[source]

Bases: atomiq.arguments.ArgumentProvider

Parameters:
  • url (str)

  • use_class_defaults (bool)

url
use_class_defaults = True
_build_arguments(target_class, arguments={})[source]

Build the argument dict.

This is intended to be overwritten by subclasses to implement the logic for the respective backend

Parameters:
  • target_class (type) -- The class of the target for which to build the arguments

  • arguments (dict) -- arguments to be considered additionally

Return type:

dict

static_arguments
get_arguments(target_class)

Query the arguments dict from the argument provider.

Parameters:

target_class (type) -- The class of the target for which to build the arguments

Returns:

Argument dictionary in the format required by atomiq

Return type:

dict

abstractmethod update_argument(name, arg_def)

Update the argument definition in the backend of the argument provider, i.e. store updated values

Parameters:
  • name (str) -- Name or identifier of the argument

  • arg_def (dict) -- dict with argument definition to be stored