rics.translation.factory#

Factory functions for translation classes.

Module Attributes

Functions

Classes

FetcherFactory#

A callable which creates new AbstractFetcher instances from a dict config.

Config format is described in Section: Fetching.

Parameters

• clazz – Type of AbstractFetcher to create.

• config – Keyword arguments for the fetcher class.

Returns

A Fetcher instance.

Raises

• exceptions.ConfigurationError – If config is invalid.

• TypeError – If clazz is not an AbstractFetcher subtype.

alias of Callable[[str, Dict[str, Any]], AbstractFetcher]

MapperFactory#

A callable which creates new Mapper instances from a dict config.

Config format is described in Subsection: Mapping.

If None is returned, a suitable default is used instead.

Parameters

• config – Keyword arguments for the Mapper.

• for_fetcher – Flag indicating that the Mapper returned will be used by an AbstractFetcher instance.

Returns

A Mapper instance or None.

Raises

ConfigurationError – If config is invalid.

alias of Callable[[Dict[str, Any], bool], Optional[Mapper]]

default_fetcher_factory(clazz: str, config: Dict[str, Any]) → AbstractFetcher[source]#

Create an AbstractFetcher from config.

default_mapper_factory(config: Dict[str, Any], for_fetcher: bool) → Optional[Mapper][source]#

Create a Mapper from config.

class TranslatorFactory(file: Union[str, bytes, PathLike], extra_fetchers: Iterable[Union[str, bytes, PathLike]])[source]#

Bases: Generic[NameType, SourceType, IdType]

Create a Translator from TOML inputs.

FETCHER_FACTORY(config: Dict[str, Any]) → AbstractFetcher#

A callable taking (name, kwargs) which returns an AbstractFetcher.

MAPPER_FACTORY(for_fetcher: bool) → Optional[Mapper]#

A callable taking (kwargs) which returns a Mapper.

create() → Translator[source]#

Create a Translator from a TOML file.