speasy.core.dataprovider module

class speasy.core.dataprovider.DataProvider(provider_name: str, provider_alt_names: List = None, inventory_disable_proxy=False, min_proxy_version=<Version('0.13.0')>)[source]

Bases: object

Base class for all data providers.

Parameters:
provider_name: str

The name of the data provider. This should be a unique identifier.

provider_alt_names: List or None

Alternative names for the data provider. These will also be used to register the provider’s inventory as valid aliases.

inventory_disable_proxy: bool

If True, the inventory will be fetched directly from the provider, bypassing any proxy settings.

min_proxy_version: str

Minimum required version of the proxy server to use for fetching the inventory.

build_inventory(root: SpeasyIndex) SpeasyIndex[source]

Override this method to build the inventory tree from the public inventory source.

build_private_inventory(root: SpeasyIndex) SpeasyIndex[source]

Override this method to add private inventory items that are not fetched from the public inventory source.

update_inventory()[source]
class speasy.core.dataprovider.ParameterRangeCheck[source]

Bases: object