geoips.interfaces.yaml_based package#
Submodules#
geoips.interfaces.yaml_based.feature_annotators module#
Feature Annotator interface module.
- class geoips.interfaces.yaml_based.feature_annotators.FeatureAnnotatorsInterface[source]#
Bases:
BaseYamlInterface
Interface for feature annotator plugins.
- name = 'feature_annotators'#
geoips.interfaces.yaml_based.gridline_annotators module#
Gridline Annotator interface module.
- class geoips.interfaces.yaml_based.gridline_annotators.GridlineAnnotatorsInterface[source]#
Bases:
BaseYamlInterface
Interface for gridline annotator plugins.
- name = 'gridline_annotators'#
geoips.interfaces.yaml_based.product_defaults module#
Product Defaults interface module.
- class geoips.interfaces.yaml_based.product_defaults.ProductDefaultsInterface[source]#
Bases:
BaseYamlInterface
Default values that can be applied to products.
- name = 'product_defaults'#
geoips.interfaces.yaml_based.products module#
Products interface module.
- class geoips.interfaces.yaml_based.products.ProductsInterface[source]#
Bases:
BaseYamlInterface
GeoIPS interface for Products plugins.
- get_plugin(source_name, name, product_spec_override=None)[source]#
Retrieve a Product plugin by source_name, name, and product_spec_override.
If product_spec_override dict is passed, values contained within product_spec_override will be used in place of those found in products list and product_defaults.
product_spec_override[product_name] matches the format of the product “spec” field.
Additionall, if the special key product_spec_override[“all”] is included, it will apply to all products not specified by name within the dictionary.
- name = 'products'#
- validator = <geoips.interfaces.yaml_based.products.ProductsPluginValidator object>#
- class geoips.interfaces.yaml_based.products.ProductsPluginValidator[source]#
Bases:
YamlPluginValidator
Validator for Products plugins.
This differs from other validators for two reasons:
Most plugins are identified solely by ‘name’. Products are identified by ‘source_name’ and ‘name.
Most plugins supply their ‘family’ directly. Products can supply it directly, but can, alternatively, specify a ‘product_defaults’ plugin from which to pull ‘family’ and most other properties. This validator handles filling in a product plugin based on its specified product defaults plugin.
geoips.interfaces.yaml_based.sectors module#
Sector interface module.
- class geoips.interfaces.yaml_based.sectors.SectorsInterface[source]#
Bases:
BaseYamlInterface
Interface for sector plugins.
- name = 'sectors'#
Module contents#
YAML based interfaces init file.