:py:mod:`vendor_fabric.vendor_data` =================================== .. py:module:: vendor_fabric.vendor_data .. autodoc2-docstring:: vendor_fabric.vendor_data :parser: myst :allowtitles: Module Contents --------------- Classes ~~~~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`VendorCapability ` - .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorCapability :parser: myst :summary: * - :py:obj:`VendorData ` - .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorData :parser: myst :summary: Data ~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`SupportSpec ` - .. autodoc2-docstring:: vendor_fabric.vendor_data.SupportSpec :parser: myst :summary: API ~~~ .. py:data:: SupportSpec :canonical: vendor_fabric.vendor_data.SupportSpec :value: None .. autodoc2-docstring:: vendor_fabric.vendor_data.SupportSpec :parser: myst .. py:class:: VendorCapability :canonical: vendor_fabric.vendor_data.VendorCapability .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorCapability :parser: myst .. py:attribute:: provider :canonical: vendor_fabric.vendor_data.VendorCapability.provider :type: str :value: None .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorCapability.provider :parser: myst .. py:attribute:: operation :canonical: vendor_fabric.vendor_data.VendorCapability.operation :type: str :value: None .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorCapability.operation :parser: myst .. py:attribute:: method :canonical: vendor_fabric.vendor_data.VendorCapability.method :type: str :value: None .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorCapability.method :parser: myst .. py:attribute:: capability :canonical: vendor_fabric.vendor_data.VendorCapability.capability :type: str :value: 'operation' .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorCapability.capability :parser: myst .. py:attribute:: description :canonical: vendor_fabric.vendor_data.VendorCapability.description :type: str :value: .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorCapability.description :parser: myst .. py:attribute:: source :canonical: vendor_fabric.vendor_data.VendorCapability.source :type: str :value: 'method' .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorCapability.source :parser: myst .. py:method:: as_dict() -> extended_data.containers.ExtendedDict :canonical: vendor_fabric.vendor_data.VendorCapability.as_dict .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorCapability.as_dict :parser: myst .. py:class:: VendorData(value: typing.Any = None, *, fabric: vendor_fabric.connectors.ConnectorFabric | None = None, logger: extended_data.logging.Logging | None = None, capabilities: collections.abc.Iterable[vendor_fabric.vendor_data.VendorCapability] = (), **fabric_kwargs: typing.Any) :canonical: vendor_fabric.vendor_data.VendorData Bases: :py:obj:`extended_data.containers.ExtendedData` .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorData :parser: myst .. rubric:: Initialization .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorData.__init__ :parser: myst .. py:property:: value :canonical: vendor_fabric.vendor_data.VendorData.value :type: typing.Any .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorData.value :parser: myst .. py:property:: data_type :canonical: vendor_fabric.vendor_data.VendorData.data_type :type: str .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorData.data_type :parser: myst .. py:property:: shape :canonical: vendor_fabric.vendor_data.VendorData.shape :type: str .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorData.shape :parser: myst .. py:property:: active_provider :canonical: vendor_fabric.vendor_data.VendorData.active_provider :type: extended_data.containers.ExtendedString | None .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorData.active_provider :parser: myst .. py:method:: as_builtin() -> typing.Any :canonical: vendor_fabric.vendor_data.VendorData.as_builtin .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorData.as_builtin :parser: myst .. py:method:: as_extended() -> typing.Any :canonical: vendor_fabric.vendor_data.VendorData.as_extended .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorData.as_extended :parser: myst .. py:method:: cast(value: typing.Any) -> typing.Self :canonical: vendor_fabric.vendor_data.VendorData.cast .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorData.cast :parser: myst .. py:method:: open(provider_id: str, *, strict: bool = True, **kwargs: typing.Any) -> typing.Self :canonical: vendor_fabric.vendor_data.VendorData.open .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorData.open :parser: myst .. py:method:: open_provider(provider_id: str, **kwargs: typing.Any) -> typing.Any :canonical: vendor_fabric.vendor_data.VendorData.open_provider .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorData.open_provider :parser: myst .. py:method:: provider(provider_id: str, **kwargs: typing.Any) -> typing.Any :canonical: vendor_fabric.vendor_data.VendorData.provider .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorData.provider :parser: myst .. py:method:: provider_info(provider_id: str, *, include_unavailable: bool = True) -> extended_data.containers.ExtendedDict :canonical: vendor_fabric.vendor_data.VendorData.provider_info .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorData.provider_info :parser: myst .. py:method:: is_provider_available(provider_id: str) -> bool :canonical: vendor_fabric.vendor_data.VendorData.is_provider_available .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorData.is_provider_available :parser: myst .. py:method:: capabilities(provider_id: str | None = None, *, include_unavailable: bool = True) -> extended_data.containers.ExtendedList[typing.Any] :canonical: vendor_fabric.vendor_data.VendorData.capabilities .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorData.capabilities :parser: myst .. py:method:: capability_matrix(*, include_unavailable: bool = True) -> extended_data.containers.ExtendedDict :canonical: vendor_fabric.vendor_data.VendorData.capability_matrix .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorData.capability_matrix :parser: myst .. py:method:: supports(provider_id: str, operation: str, *, require_available: bool = False) -> bool :canonical: vendor_fabric.vendor_data.VendorData.supports .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorData.supports :parser: myst .. py:method:: call(operation: str, provider_id: str | None = None, *args: typing.Any, **kwargs: typing.Any) -> typing.Any :canonical: vendor_fabric.vendor_data.VendorData.call .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorData.call :parser: myst .. py:method:: declare_supports(connector_cls: type[vendor_fabric.base.ConnectorBase], supports: collections.abc.Mapping[str, vendor_fabric.vendor_data.SupportSpec]) -> None :canonical: vendor_fabric.vendor_data.VendorData.declare_supports :classmethod: .. autodoc2-docstring:: vendor_fabric.vendor_data.VendorData.declare_supports :parser: myst .. py:property:: is_mapping :canonical: vendor_fabric.vendor_data.VendorData.is_mapping :type: bool .. py:property:: is_sequence :canonical: vendor_fabric.vendor_data.VendorData.is_sequence :type: bool .. py:property:: is_string :canonical: vendor_fabric.vendor_data.VendorData.is_string :type: bool .. py:property:: is_set :canonical: vendor_fabric.vendor_data.VendorData.is_set :type: bool .. py:property:: is_scalar :canonical: vendor_fabric.vendor_data.VendorData.is_scalar :type: bool .. py:property:: is_none :canonical: vendor_fabric.vendor_data.VendorData.is_none :type: bool .. py:method:: from_value(value: typing.Any = None) -> extended_data.containers.data.ExtendedData :canonical: vendor_fabric.vendor_data.VendorData.from_value :classmethod: .. py:method:: decode(data: str | memoryview | bytes | bytearray, *, file_path: str | pathlib.Path | None = None, suffix: str | None = None) -> extended_data.containers.data.ExtendedData :canonical: vendor_fabric.vendor_data.VendorData.decode :classmethod: .. py:method:: read(file_path: str | pathlib.Path, *, suffix: str | None = None, charset: str = 'utf-8', errors: str = 'strict', headers: collections.abc.Mapping[str, str] | None = None, tld: pathlib.Path | None = None) -> extended_data.containers.data.ExtendedData :canonical: vendor_fabric.vendor_data.VendorData.read :classmethod: .. py:method:: copy() -> extended_data.containers.data.ExtendedData :canonical: vendor_fabric.vendor_data.VendorData.copy .. py:method:: map(transform: collections.abc.Callable[[typing.Any], typing.Any]) -> extended_data.containers.data.ExtendedData :canonical: vendor_fabric.vendor_data.VendorData.map .. py:method:: map_builtin(transform: collections.abc.Callable[[typing.Any], typing.Any]) -> extended_data.containers.data.ExtendedData :canonical: vendor_fabric.vendor_data.VendorData.map_builtin .. py:method:: transform(*steps: str) -> extended_data.containers.data.ExtendedData :canonical: vendor_fabric.vendor_data.VendorData.transform .. py:method:: merge(*mappings: collections.abc.Mapping[str, typing.Any]) -> extended_data.containers.data.ExtendedData :canonical: vendor_fabric.vendor_data.VendorData.merge .. py:method:: workflow() -> typing.Any :canonical: vendor_fabric.vendor_data.VendorData.workflow .. py:method:: sync_to_file(file_path: str | pathlib.Path, *, source: str = 'memory', encoding: str | None = None, charset: str = 'utf-8', allow_empty: bool = False, dry_run: bool = False, tld: pathlib.Path | None = None, metadata: collections.abc.Mapping[str, typing.Any] | None = None) -> typing.Any :canonical: vendor_fabric.vendor_data.VendorData.sync_to_file .. py:method:: write(file_path: str | pathlib.Path, *, encoding: str | None = None, charset: str = 'utf-8', allow_empty: bool = False, tld: pathlib.Path | None = None) -> pathlib.Path | None :canonical: vendor_fabric.vendor_data.VendorData.write .. py:method:: to_export_safe(*, export_to_yaml: bool = False) -> typing.Any :canonical: vendor_fabric.vendor_data.VendorData.to_export_safe .. py:method:: wrap_for_export(allow_encoding: bool | str = True, **format_opts: typing.Any) -> str :canonical: vendor_fabric.vendor_data.VendorData.wrap_for_export .. py:method:: get(key: typing.Any, default: typing.Any = None) -> typing.Any :canonical: vendor_fabric.vendor_data.VendorData.get .. py:method:: append(item: typing.Any) -> typing.Self :canonical: vendor_fabric.vendor_data.VendorData.append .. py:method:: extend(values: collections.abc.Iterable[typing.Any]) -> typing.Self :canonical: vendor_fabric.vendor_data.VendorData.extend .. py:method:: update(*args: typing.Any, **kwargs: typing.Any) -> typing.Self :canonical: vendor_fabric.vendor_data.VendorData.update .. py:method:: add(item: typing.Any) -> typing.Self :canonical: vendor_fabric.vendor_data.VendorData.add