geoips.interfaces package

Subpackages

• geoips.interfaces.module_based package
  • Submodules
  • geoips.interfaces.module_based.algorithms module
    • AlgorithmsInterface
      • AlgorithmsInterface.name
      • AlgorithmsInterface.required_args
      • AlgorithmsInterface.required_kwargs
  • geoips.interfaces.module_based.colormappers module
    • ColormappersInterface
      • ColormappersInterface.allowable_kwargs
      • ColormappersInterface.name
      • ColormappersInterface.required_args
      • ColormappersInterface.required_kwargs
  • geoips.interfaces.module_based.coverage_checkers module
    • CoverageCheckersInterface
      • CoverageCheckersInterface.allowable_kwargs
      • CoverageCheckersInterface.get_plugin_for_product()
      • CoverageCheckersInterface.name
      • CoverageCheckersInterface.required_args
      • CoverageCheckersInterface.required_kwargs
  • geoips.interfaces.module_based.databases module
    • DatabasesInterface
      • DatabasesInterface.name
      • DatabasesInterface.required_args
      • DatabasesInterface.required_kwargs
  • geoips.interfaces.module_based.filename_formatters module
    • FilenameFormattersInterface
      • FilenameFormattersInterface.name
      • FilenameFormattersInterface.required_args
      • FilenameFormattersInterface.required_kwargs
  • geoips.interfaces.module_based.interpolators module
    • InterpolatorsInterface
      • InterpolatorsInterface.name
      • InterpolatorsInterface.required_args
      • InterpolatorsInterface.required_kwargs
  • geoips.interfaces.module_based.output_checkers module
    • OutputCheckersBasePlugin
      • OutputCheckersBasePlugin.compare_outputs()
      • OutputCheckersBasePlugin.get_compare_products()
      • OutputCheckersBasePlugin.get_out_diff_fname()
      • OutputCheckersBasePlugin.gunzip_product()
      • OutputCheckersBasePlugin.is_gz()
      • OutputCheckersBasePlugin.perform_comparisons()
      • OutputCheckersBasePlugin.test_products()
    • OutputCheckersInterface
      • OutputCheckersInterface.get_plugin()
      • OutputCheckersInterface.identify_checker()
      • OutputCheckersInterface.name
      • OutputCheckersInterface.plugin_class
      • OutputCheckersInterface.required_args
      • OutputCheckersInterface.required_kwargs
      • OutputCheckersInterface.valid_plugin()
    • get_missing_products()
    • gunzip_product()
    • is_gz()
    • write_bad_comparisons_to_file()
    • write_good_comparisons_to_file()
    • write_missing_comparisons_to_file()
    • write_missing_products_to_file()
    • write_remove_temp_files_to_file()
  • geoips.interfaces.module_based.output_formatters module
    • OutputFormattersInterface
      • OutputFormattersInterface.name
      • OutputFormattersInterface.required_args
      • OutputFormattersInterface.required_kwargs
  • geoips.interfaces.module_based.procflows module
    • ProcflowsInterface
      • ProcflowsInterface.name
      • ProcflowsInterface.required_args
      • ProcflowsInterface.required_kwargs
  • geoips.interfaces.module_based.readers module
    • ReadersInterface
      • ReadersInterface.call_files_and_get_top_level_metadata()
      • ReadersInterface.concatenate_metadata()
      • ReadersInterface.name
      • ReadersInterface.read_data_to_xarray_dict()
      • ReadersInterface.required_args
      • ReadersInterface.required_kwargs
  • geoips.interfaces.module_based.sector_adjusters module
    • SectorAdjustersInterface
      • SectorAdjustersInterface.name
      • SectorAdjustersInterface.required_args
      • SectorAdjustersInterface.required_kwargs
  • geoips.interfaces.module_based.sector_metadata_generators module
    • SectorMetadataGeneratorsInterface
      • SectorMetadataGeneratorsInterface.name
      • SectorMetadataGeneratorsInterface.required_args
      • SectorMetadataGeneratorsInterface.required_kwargs
  • geoips.interfaces.module_based.sector_spec_generators module
    • SectorSpecGeneratorsInterface
      • SectorSpecGeneratorsInterface.name
      • SectorSpecGeneratorsInterface.required_args
      • SectorSpecGeneratorsInterface.required_kwargs
  • geoips.interfaces.module_based.title_formatters module
    • TitleFormattersInterface
      • TitleFormattersInterface.name
      • TitleFormattersInterface.required_args
      • TitleFormattersInterface.required_kwargs
  • Module contents
• geoips.interfaces.yaml_based package
  • Submodules
  • geoips.interfaces.yaml_based.feature_annotators module
    • FeatureAnnotatorsInterface
      • FeatureAnnotatorsInterface.name
      • FeatureAnnotatorsInterface.validator
  • geoips.interfaces.yaml_based.gridline_annotators module
    • GridlineAnnotatorsInterface
      • GridlineAnnotatorsInterface.label_kwargs
      • GridlineAnnotatorsInterface.name
  • geoips.interfaces.yaml_based.product_defaults module
    • ProductDefaultsInterface
      • ProductDefaultsInterface.name
  • geoips.interfaces.yaml_based.products module
    • ProductsInterface
      • ProductsInterface.get_plugin()
      • ProductsInterface.get_plugin_metadata()
      • ProductsInterface.get_plugins()
      • ProductsInterface.name
      • ProductsInterface.plugin_is_valid()
      • ProductsInterface.test_interface()
      • ProductsInterface.validator
    • ProductsPluginValidator
      • ProductsPluginValidator.validate()
      • ProductsPluginValidator.validate_product()
  • geoips.interfaces.yaml_based.sectors module
    • SectorPluginBase
      • SectorPluginBase.area_definition
      • SectorPluginBase.create_test_plot()
    • SectorsInterface
      • SectorsInterface.name
      • SectorsInterface.plugin_class
  • geoips.interfaces.yaml_based.workflows module
    • WorkflowsInterface
      • WorkflowsInterface.name
      • WorkflowsInterface.validator
  • Module contents

Submodules

geoips.interfaces.base module

Base classes for interfaces, plugins, and plugin validation machinery.

class geoips.interfaces.base.BaseInterface

Bases: ABC

Base class for GeoIPS interfaces.

This class should not be instantiated directly. Instead, interfaces should be accessed by importing them from geoips.interfaces. For example: ` from geoips.interfaces import algorithms ` will retrieve an instance of AlgorithmsInterface which will provide access to the GeoIPS algorithm plugins.

call_create_plugin_registries(yaml=False)

Run command ‘create_plugin_registries’ as a subprocess.

This should be done whenever a plugin is attempted to be loaded but fails because it isn’t an entry in the plugin registry. If the plugin still cannot be found after this function is ran, then report the issue to the user.

Parameters:

yaml (bool (default=False)) –

• Truth value as to whether or not we want to create a .yaml registry. If false, then create the default .json registry instead.

abstract get_plugin(name, rebuild_registries=True)

Abstract function for retrieving a plugin under a certain interface.

Parameters:

• name (str or tuple(str)) –

  • The name of the yaml-based plugin. Either a single string or a tuple of strings for product plugins.

• rebuild_registries (bool (default=True)) –

  • Whether or not to rebuild the registries if get_plugin fails. If set to true and get_plugin fails, rebuild the plugin registry, call then call get_plugin once more with rebuild_registries toggled off, so it only gets rebuilt once.

  • rbr (ReBuildRegistries) is set in geoips.filenames.base_paths with a default value of True. Users and developers can change this if desired.

get_plugin_metadata(name)

Retrieve a plugin’s metadata.

Where the metadata of the plugin matches the plugin’s corresponding entry in the plugin registry.

Parameters:

name (str or tuple(str)) –

• The name of the plugin whose metadata we want.

Returns:

metadata –

• A dictionary of metadata for the requested plugin.

Return type:

dict

interface_type = None

name = 'BaseInterface'

plugin_registry = <geoips.plugin_registry.PluginRegistry object>

plugin_registry_module = <module 'geoips.plugin_registry' from '/opt/hostedtoolcache/Python/3.10.17/x64/lib/python3.10/site-packages/geoips/plugin_registry.py'>

rbr = True

property registered_module_based_plugins

Return a dictionary of registered module-based plugins.

This property provides centeralized error handling for missing plugin registries.

property registered_yaml_based_plugins

Return a dictionary of registered yaml-based plugins.

This property provides centeralized error handling for missing plugin registries.

retry_get_plugin(name, rebuild_registries, err_str, err_type=<class 'geoips.errors.PluginError'>)

Re-run self.get_plugin, but call ‘create_plugin_registries’ beforehand.

By running ‘create_plugin_registries’, we automate the registration of plugins in GeoIPS. If the plugin persists not to be found, then we’ll raise an appropriate PluginError as denoted by ‘err_str’.

Parameters:

• name (str or tuple(str)) –

  • The name of the yaml plugin. Either a single string or a tuple of strings for product plugins.

• rebuild_registries (bool) –

  • Whether or not to rebuild the registries if get_plugin fails. If set to true and get_plugin fails, rebuild the plugin registry, call then call get_plugin once more with rebuild_registries toggled off, so it only gets rebuilt once.

• err_str (string) –

  • The error to be reported.

• err_type (Exception-based Class) –

  • The class of exception to be raised.

class geoips.interfaces.base.BaseModuleInterface

Bases: BaseInterface

Base Class for GeoIPS Interfaces.

This class should not be instantiated directly. Instead, interfaces should be accessed by importing them from geoips.interfaces. For example: ` from geoips.interfaces import algorithms ` will retrieve an instance of AlgorithmsInterface which will provide access to the GeoIPS algorithm plugins.

get_plugin(name, rebuild_registries=None)

Retrieve a plugin from this interface by name.

Parameters:

• name (str) –

  • The name the desired plugin.

• rebuild_registries (bool (default=None)) –

  • Whether or not to rebuild the registries if get_plugin fails. If set to None, default to what we have set in geoips.filenames.base_paths, which defaults to True. If specified, use the input value of rebuild_registries, which should be a boolean value. If rebuild registries is true and get_plugin fails, rebuild the plugin registry, call then call get_plugin once more with rebuild_registries toggled off, so it only gets rebuilt once.

Returns:

• An object of type <interface>Plugin where <interface> is the name of

• this interface.

Raises:

PluginError – If the specified plugin isn’t found within the interface.

get_plugins()

Get a list of plugins for this interface.

interface_type = 'module_based'

name = 'BaseModuleInterface'

plugin_is_valid(name)

Check that an interface is valid.

Check that the requested interface function has the correct call signature. Return values should be as specified below, but are not programmatically verified.

Parameters:

name (str) – Name of the interface to be validated

Returns:

True if valid, False if invalid

Return type:

bool

plugins_all_valid()

Test the current interface by validating every Plugin.

Return type:

True if all plugins are valid, False if any plugin is invalid.

required_args = {}

test_interface()

Test the current interface by validating each Plugin and testing each method.

Test this interface by opening every Plugin available to the interface, and validating each plugin by calling plugin_is_valid for each. Additionally, ensure all methods of this interface work as expected:

• get_plugins

• get_plugin

• plugin_is_valid

• plugins_all_valid

Returns:

• A dictionary containing three keys

• ’by_family’, ‘validity_check’, ‘func’, and ‘family’. The value for each

• of these keys is a dictionary whose keys are the names of the Plugins.

• - ‘by_family’ contains a dictionary of plugin names sorted by family.

• - ‘validity_check’ contains a dict whose keys are plugin names and whose – values are bools where True indicates that the Plugin’s function is valid according to plugin_is_valid.

• - ‘func’ contains a dict whose keys are plugin names and whose values are – the function for each Plugin.

• - ‘family’ contains a dict whose keys are plugin names and whose vlaues – are the contents of the ‘family’ attribute for each Plugin.

class geoips.interfaces.base.BaseModulePlugin

Bases: object

Base class for GeoIPS plugins.

class geoips.interfaces.base.BaseYamlInterface

Bases: BaseInterface

Base class for GeoIPS yaml-based plugin interfaces.

This class should not be instantiated directly. Instead, interfaces should be accessed by importing them from geoips.interfaces. For example: ` from geoips.interfaces import products ` will retrieve an instance of ProductsInterface which will provide access to the GeoIPS products plugins.

get_plugin(name, rebuild_registries=None)

Get a plugin by its name.

This default method can be overridden to provide different search functionality for an interface. An example of this is in the ProductsInterface which uses a tuple containing ‘source_name’ and ‘name’.

Parameters:

• name (str or tuple(str)) –

  • The name of the yaml-based plugin. Either a single string or a tuple of strings for product plugins.

• rebuild_registries (bool (default=None)) –

  • Whether or not to rebuild the registries if get_plugin fails. If set to None, default to what we have set in geoips.filenames.base_paths, which defaults to True. If specified, use the input value of rebuild_registries, which should be a boolean value. If rebuild registries is true and get_plugin fails, rebuild the plugin registry, call then call get_plugin once more with rebuild_registries toggled off, so it only gets rebuilt once.

get_plugins()

Retrieve a plugin by name.

interface_type = 'yaml_based'

name = 'BaseYamlInterface'

plugin_is_valid(name)

Plugin is valid method.

plugins_all_valid()

Plugins all valid method.

test_interface()

Test interface method.

validator = <geoips.interfaces.base.YamlPluginValidator object>

class geoips.interfaces.base.BaseYamlPlugin(*args, **kwargs)

Bases: dict

Base class for GeoIPS plugins.

class geoips.interfaces.base.YamlPluginValidator

Bases: object

PluginValidator class.

property schemas

Return a list of jsonschema schemas for GeoIPS.

This performs a lazy-load for the schema to avoid loading them if not needed. This reduces the import time for geoips.interfaces.

validate(plugin, validator_id=None)

Validate a YAML plugin against the relevant schema.

The relevant schema is determined based on the interface and family of the plugin.

validate_list(plugin)

Validate a list of YAML plugins.

Some interfaces allow a ‘list’ family. These list plugins will contain a property that is the same as the interface’s name. Under that is a list of individual plugins.

This function will add the interface property to each plugin in the list, then validate each plugin.

property validators

Return schema validators.

This performs a lazy-load for the validators to avoid loading them if not needed. This reduces the import time for geoips.interfaces.

geoips.interfaces.base.extend_with_default(validator_class)

Extend a jsonschema validator to make it respect default values.

Note: This does not pollute the input validator object. Calling jsonschema.validators.extend returns a new object.

This will cause the validator to fill in fields that have default values. In cases where fields with default values are contained inside a mapping, that mapping must have default: {} and may not have requires.

geoips.interfaces.base.get_schemas(path, validator)

Collect all of the interface schema.

geoips.interfaces.base.get_validators(schema_dict, validator_class)

Create validators for each schema in schema_dict.

Parameters:

schema_dict (dict) – A dictionary whose keys are schema $id and whose values are the full schema.

Returns:

A dictionary whose keys are schema $id and whose values are jsonschema validator instances.

Return type:

dict

geoips.interfaces.base.plugin_repr(obj)

Repr plugin string.

Module contents

GeoIPS interface module.