isogeotoxlsx.utils.formatter module

class isogeotoxlsx.utils.formatter.Formatter(lang='FR', output_type='Excel')

Bases: object

Metadata formatter to avoid repeat operations on metadata during export in different formats.

Parameters:

• lang (str) – selected language
• output_type (str) – name of output type to format for. Defaults to ‘Excel’
• default_values (tuple) –

  values used to replace missing values. Structure:

  (

  str_for_missing_strings_and_integers, str_for_missing_dates

  )

conditions(md_cgus)

Render input metadata CGUs as a new list.

Parameters:md_cgus (list) – list of conditions extracted from an Isogeo metadata Return type:list Example:

# make a search including conditions
search = isogeo.search(include=("conditions",))

# parse results
for md in search.results:
    # load metadata as object
    md = Metadata.clean_attributes(md)

    # format conditions
    cgus_out = formatter.conditions(md.conditions)

frequency_as_explicit_str(update_frequency_code)

Transform ‘updateFrequency’ code value as an explicit string. See: https://github.com/isogeo/export-xlsx-py/issues/8

Parameters:update_frequency_code (str) – update frequency as stored in Isogeo API Returns:update frequency as explicit string. Return type:str Example:

>>> print(frequency_as_explicit_str("P1D"))
>>> "Every 1 day(s)"

limitations(md_limitations)

Render input metadata limitations as a new list.

Parameters:md_limitations (dict) – input dictionary extracted from an Isogeo metadata Return type:list

specifications(md_specifications)

Render input metadata specifications as a new list.

Parameters:md_specifications (dict) – input dictionary extracted from an Isogeo metadata Return type:list