Resolver

Resolver

Attributes Summary

options

Return the normalized option names.

synonym_attribute

Get the synonnym attribute for the class used for synonym lookup.

Methods Summary

docdata(query, *path[, default])

Lookup an element and get its docdata.

extract_name(element)

Get the name for an element.

extract_synonyms(element)

Get synonyms from an element.

from_entrypoint(group, **kwargs)

Make a resolver from the elements registered at the given entrypoint.

from_subclasses(base, *[, skip, ...])

Make a resolver from the subclasses of a given class.

get_option(*flags[, as_string, default, ...])

Get a click option for this resolver.

lookup(query[, default])

Lookup a class.

make(query[, pos_kwargs])

Instantiate a class with optional kwargs.

make_from_kwargs(data, key, *[, kwargs_suffix])

Instantiate a class, by looking up query/pos_kwargs from a dictionary.

make_many([queries, kwargs])

Resolve and compose several queries together.

make_safe(query[, pos_kwargs])

Run make, but pass through a none query.

make_table([key_fmt, cls_fmt, header, table_fmt])

Render the table of options in a format suitable for Sphinx documentation.

normalize(s)

Normalize the string with this resolve's suffix.

normalize_cls(cls)

Normalize the class name.

normalize_inst(x)

Normalize the class name of the instance.

optuna_lookup(trial, name)

Suggest an element from this resolver for hyper-parameter optimization in Optuna.

register(element[, synonyms, raise_on_conflict])

Register an additional element with this resolver.

register_entrypoint(group)

Register additional entries from an entrypoint.

signature(query)

Get the signature for the given class via inspect.signature().

supports_argument(query, parameter_name)

Determine if the class constructor supports the given argument.

Attributes Documentation

Methods Documentation

alias of ClassResolver