10.5.3. Loaders for API Object Modules

pytan3.api_objects.load(api_type='soap', veq='', vmax='', vmin='', vshrink=True)[source]

Import an API module for version and type.

Parameters:
  • api_type (str, optional) –

    Type of object module to load, must be one of API_TYPES.

    Defaults to: DEFAULT_TYPE.

  • veq (str, optional) –

    Exact version of object module of type to load.

    Defaults to: “”.

  • vmin (str, optional) –

    Minimum version of object module of type to load.

    Defaults to: “”.

  • vmax (str, optional) –

    Maximum version of object module of type to load.

    Defaults to: “”.

  • vshrink (bool or int, optional) –

    If True, shrink API object module file version down to match the same length as veq, vmax, and vmin.

    If False, do not shrink API object module file version at all.

    If int, shrink API object module file version, veq, vmax, and vmin down to this length.

    Defaults to: True.

Raises:

exceptions.ModuleError – If api_type not in API_TYPES.

Returns:

ApiObjects