assemble

assemble(configuration: Configuration, *, refresh_source: bool = False, refresh_raw: bool = False, refresh_processed: bool = False, return_type: Literal[AssembleReturnType.none] = AssembleReturnType.none) → None[source]
assemble(configuration: Configuration, *, refresh_source: bool = False, refresh_raw: bool = False, refresh_processed: bool = False, return_type: Literal[AssembleReturnType.all] = AssembleReturnType.all) → MappingPack
assemble(configuration: Configuration, *, refresh_source: bool = False, refresh_raw: bool = False, refresh_processed: bool = False, return_type: Literal[AssembleReturnType.priority] = AssembleReturnType.priority) → list[Mapping]

Get prioritized mappings based on an assembly configuration.

Parameters:

  • configuration – The mapping assembly configuration

  • refresh_processed – This the least aggressive option, where raw mappings are re-used if available and only re-processing and re-prioritization is done.

  • refresh_raw – This is the medium aggressive option, where raw mappings are re-generaged by processing the source data.

  • refresh_source – This is the most aggressive option, where the data sources are re-downloaded (and the other options refresh_processed and refresh_raw are automatically switched to true)

  • return_type –

    What artifacts should be returned? This is controlled with the values in the GetMappingReturnType enumeration.

    • GetMappingReturnType.none returns nothing

    • GetMappingReturnType.priority returns the priority mapping set

    • GetMappingReturnType.all returns a data structure containing the raw mappings, processed mappings, and priority mappings as three seperate lists.

  • progress – Should progress bars be shown during processing? Defaults to true.

Returns:

Returns based on the return_type. By default, returns None