figutils

find_arguments#

anyfig.figutils.find_arguments(callable_)[source]

Returns the arguments and required arguments for a function/class

save_config#

anyfig.figutils.save_config(config, path, save_readable=True)[source]

Serialize and saves the config. If save_readable is True, a path.txt is also created

register_globally#

anyfig.figutils.register_globally(config)[source]

Registers the config with anyfig to be accessible anywhere

check_allowed_input_argument#

anyfig.figutils.check_allowed_input_argument(config_obj, name, deep_name)[source]

Raises error if the input argument isn’t marked as “allowed”

post_init#

anyfig.figutils.post_init(config_obj)[source]

Recursively calls the post_init method on a config and it’s attributes

get_config_classes#

anyfig.figutils.get_config_classes(class_name=None)[source]

is_config_class#

anyfig.figutils.is_config_class(obj)[source]

Returns True if the config class definition is registered with anyfig

unregister_config_classes#

anyfig.figutils.unregister_config_classes()[source]

Unregisteres config classes with anyfig

default_config_attributes#

anyfig.figutils.default_config_attributes()[source]

Default attributes every config class instance will have

get_config#

anyfig.figutils.get_config()[source]

Returns the config object that is registered with anyfig

get_website#

anyfig.figutils.get_website()[source]

load_config#

anyfig.figutils.load_config(path)[source]

Loads the config from file

register_config_class#

anyfig.figutils.register_config_class(class_name, class_def)[source]

Saves the config class name and definition

get_allowed_cli_args#

anyfig.figutils.get_allowed_cli_args(config_obj)[source]

Returns the attribute names that can be be overwritten from command line input. Raises AttributeError if an attribute doesn’t exist