:py:mod:`vendor_fabric.vault.tools` =================================== .. py:module:: vendor_fabric.vault.tools .. autodoc2-docstring:: vendor_fabric.vault.tools :parser: myst :allowtitles: Module Contents --------------- Classes ~~~~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`ListSecretsSchema ` - .. autodoc2-docstring:: vendor_fabric.vault.tools.ListSecretsSchema :parser: myst :summary: * - :py:obj:`ReadSecretSchema ` - .. autodoc2-docstring:: vendor_fabric.vault.tools.ReadSecretSchema :parser: myst :summary: Functions ~~~~~~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`list_secrets ` - .. autodoc2-docstring:: vendor_fabric.vault.tools.list_secrets :parser: myst :summary: * - :py:obj:`read_secret ` - .. autodoc2-docstring:: vendor_fabric.vault.tools.read_secret :parser: myst :summary: Data ~~~~ .. list-table:: :class: autosummary longtable :align: left * - :py:obj:`TOOL_DEFINITIONS ` - .. autodoc2-docstring:: vendor_fabric.vault.tools.TOOL_DEFINITIONS :parser: myst :summary: API ~~~ .. py:class:: ListSecretsSchema(/, **data: typing.Any) :canonical: vendor_fabric.vault.tools.ListSecretsSchema Bases: :py:obj:`pydantic.BaseModel` .. autodoc2-docstring:: vendor_fabric.vault.tools.ListSecretsSchema :parser: myst .. rubric:: Initialization .. autodoc2-docstring:: vendor_fabric.vault.tools.ListSecretsSchema.__init__ :parser: myst .. py:attribute:: root_path :canonical: vendor_fabric.vault.tools.ListSecretsSchema.root_path :type: str :value: 'Field(...)' .. autodoc2-docstring:: vendor_fabric.vault.tools.ListSecretsSchema.root_path :parser: myst .. py:attribute:: mount_point :canonical: vendor_fabric.vault.tools.ListSecretsSchema.mount_point :type: str :value: 'Field(...)' .. autodoc2-docstring:: vendor_fabric.vault.tools.ListSecretsSchema.mount_point :parser: myst .. py:attribute:: max_depth :canonical: vendor_fabric.vault.tools.ListSecretsSchema.max_depth :type: int | None :value: 'Field(...)' .. autodoc2-docstring:: vendor_fabric.vault.tools.ListSecretsSchema.max_depth :parser: myst .. py:attribute:: model_config :canonical: vendor_fabric.vault.tools.ListSecretsSchema.model_config :type: typing.ClassVar[pydantic.config.ConfigDict] :value: 'ConfigDict(...)' .. py:method:: model_fields() -> dict[str, pydantic.fields.FieldInfo] :canonical: vendor_fabric.vault.tools.ListSecretsSchema.model_fields :classmethod: .. py:method:: model_computed_fields() -> dict[str, pydantic.fields.ComputedFieldInfo] :canonical: vendor_fabric.vault.tools.ListSecretsSchema.model_computed_fields :classmethod: .. py:property:: model_extra :canonical: vendor_fabric.vault.tools.ListSecretsSchema.model_extra :type: dict[str, typing.Any] | None .. py:property:: model_fields_set :canonical: vendor_fabric.vault.tools.ListSecretsSchema.model_fields_set :type: set[str] .. py:method:: model_construct(_fields_set: set[str] | None = None, **values: typing.Any) -> typing_extensions.Self :canonical: vendor_fabric.vault.tools.ListSecretsSchema.model_construct :classmethod: .. py:method:: model_copy(*, update: collections.abc.Mapping[str, typing.Any] | None = None, deep: bool = False) -> typing_extensions.Self :canonical: vendor_fabric.vault.tools.ListSecretsSchema.model_copy .. py:method:: model_dump(*, mode: typing.Literal[json, python] | str = 'python', include: pydantic.main.IncEx | None = None, exclude: pydantic.main.IncEx | None = None, context: typing.Any | None = None, by_alias: bool | None = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, exclude_computed_fields: bool = False, round_trip: bool = False, warnings: bool | typing.Literal[none, warn, error] = True, fallback: typing.Callable[[typing.Any], typing.Any] | None = None, serialize_as_any: bool = False, polymorphic_serialization: bool | None = None) -> dict[str, typing.Any] :canonical: vendor_fabric.vault.tools.ListSecretsSchema.model_dump .. py:method:: model_dump_json(*, indent: int | None = None, ensure_ascii: bool = False, include: pydantic.main.IncEx | None = None, exclude: pydantic.main.IncEx | None = None, context: typing.Any | None = None, by_alias: bool | None = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, exclude_computed_fields: bool = False, round_trip: bool = False, warnings: bool | typing.Literal[none, warn, error] = True, fallback: typing.Callable[[typing.Any], typing.Any] | None = None, serialize_as_any: bool = False, polymorphic_serialization: bool | None = None) -> str :canonical: vendor_fabric.vault.tools.ListSecretsSchema.model_dump_json .. py:method:: model_json_schema(by_alias: bool = True, ref_template: str = DEFAULT_REF_TEMPLATE, schema_generator: type[pydantic.json_schema.GenerateJsonSchema] = GenerateJsonSchema, mode: pydantic.json_schema.JsonSchemaMode = 'validation', *, union_format: typing.Literal[any_of, primitive_type_array] = 'any_of') -> dict[str, typing.Any] :canonical: vendor_fabric.vault.tools.ListSecretsSchema.model_json_schema :classmethod: .. py:method:: model_parametrized_name(params: tuple[type[typing.Any], ...]) -> str :canonical: vendor_fabric.vault.tools.ListSecretsSchema.model_parametrized_name :classmethod: .. py:method:: model_post_init(context: typing.Any, /) -> None :canonical: vendor_fabric.vault.tools.ListSecretsSchema.model_post_init .. py:method:: model_rebuild(*, force: bool = False, raise_errors: bool = True, _parent_namespace_depth: int = 2, _types_namespace: pydantic._internal._namespace_utils.MappingNamespace | None = None) -> bool | None :canonical: vendor_fabric.vault.tools.ListSecretsSchema.model_rebuild :classmethod: .. py:method:: model_validate(obj: typing.Any, *, strict: bool | None = None, extra: pydantic.config.ExtraValues | None = None, from_attributes: bool | None = None, context: typing.Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) -> typing_extensions.Self :canonical: vendor_fabric.vault.tools.ListSecretsSchema.model_validate :classmethod: .. py:method:: model_validate_json(json_data: str | bytes | bytearray, *, strict: bool | None = None, extra: pydantic.config.ExtraValues | None = None, context: typing.Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) -> typing_extensions.Self :canonical: vendor_fabric.vault.tools.ListSecretsSchema.model_validate_json :classmethod: .. py:method:: model_validate_strings(obj: typing.Any, *, strict: bool | None = None, extra: pydantic.config.ExtraValues | None = None, context: typing.Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) -> typing_extensions.Self :canonical: vendor_fabric.vault.tools.ListSecretsSchema.model_validate_strings :classmethod: .. py:method:: dict(*, include: pydantic.main.IncEx | None = None, exclude: pydantic.main.IncEx | None = None, by_alias: bool = False, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) -> typing.Dict[str, typing.Any] :canonical: vendor_fabric.vault.tools.ListSecretsSchema.dict .. py:method:: json(*, include: pydantic.main.IncEx | None = None, exclude: pydantic.main.IncEx | None = None, by_alias: bool = False, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: typing.Callable[[typing.Any], typing.Any] | None = PydanticUndefined, models_as_dict: bool = PydanticUndefined, **dumps_kwargs: typing.Any) -> str :canonical: vendor_fabric.vault.tools.ListSecretsSchema.json .. py:method:: parse_obj(obj: typing.Any) -> typing_extensions.Self :canonical: vendor_fabric.vault.tools.ListSecretsSchema.parse_obj :classmethod: .. py:method:: parse_raw(b: str | bytes, *, content_type: str | None = None, encoding: str = 'utf8', proto: pydantic.deprecated.parse.Protocol | None = None, allow_pickle: bool = False) -> typing_extensions.Self :canonical: vendor_fabric.vault.tools.ListSecretsSchema.parse_raw :classmethod: .. py:method:: parse_file(path: str | pathlib.Path, *, content_type: str | None = None, encoding: str = 'utf8', proto: pydantic.deprecated.parse.Protocol | None = None, allow_pickle: bool = False) -> typing_extensions.Self :canonical: vendor_fabric.vault.tools.ListSecretsSchema.parse_file :classmethod: .. py:method:: from_orm(obj: typing.Any) -> typing_extensions.Self :canonical: vendor_fabric.vault.tools.ListSecretsSchema.from_orm :classmethod: .. py:method:: construct(_fields_set: set[str] | None = None, **values: typing.Any) -> typing_extensions.Self :canonical: vendor_fabric.vault.tools.ListSecretsSchema.construct :classmethod: .. py:method:: copy(*, include: pydantic._internal._utils.AbstractSetIntStr | pydantic._internal._utils.MappingIntStrAny | None = None, exclude: pydantic._internal._utils.AbstractSetIntStr | pydantic._internal._utils.MappingIntStrAny | None = None, update: typing.Dict[str, typing.Any] | None = None, deep: bool = False) -> typing_extensions.Self :canonical: vendor_fabric.vault.tools.ListSecretsSchema.copy .. py:method:: schema(by_alias: bool = True, ref_template: str = DEFAULT_REF_TEMPLATE) -> typing.Dict[str, typing.Any] :canonical: vendor_fabric.vault.tools.ListSecretsSchema.schema :classmethod: .. py:method:: schema_json(*, by_alias: bool = True, ref_template: str = DEFAULT_REF_TEMPLATE, **dumps_kwargs: typing.Any) -> str :canonical: vendor_fabric.vault.tools.ListSecretsSchema.schema_json :classmethod: .. py:method:: validate(value: typing.Any) -> typing_extensions.Self :canonical: vendor_fabric.vault.tools.ListSecretsSchema.validate :classmethod: .. py:method:: update_forward_refs(**localns: typing.Any) -> None :canonical: vendor_fabric.vault.tools.ListSecretsSchema.update_forward_refs :classmethod: .. py:class:: ReadSecretSchema(/, **data: typing.Any) :canonical: vendor_fabric.vault.tools.ReadSecretSchema Bases: :py:obj:`pydantic.BaseModel` .. autodoc2-docstring:: vendor_fabric.vault.tools.ReadSecretSchema :parser: myst .. rubric:: Initialization .. autodoc2-docstring:: vendor_fabric.vault.tools.ReadSecretSchema.__init__ :parser: myst .. py:attribute:: path :canonical: vendor_fabric.vault.tools.ReadSecretSchema.path :type: str :value: 'Field(...)' .. autodoc2-docstring:: vendor_fabric.vault.tools.ReadSecretSchema.path :parser: myst .. py:attribute:: mount_point :canonical: vendor_fabric.vault.tools.ReadSecretSchema.mount_point :type: str :value: 'Field(...)' .. autodoc2-docstring:: vendor_fabric.vault.tools.ReadSecretSchema.mount_point :parser: myst .. py:attribute:: model_config :canonical: vendor_fabric.vault.tools.ReadSecretSchema.model_config :type: typing.ClassVar[pydantic.config.ConfigDict] :value: 'ConfigDict(...)' .. py:method:: model_fields() -> dict[str, pydantic.fields.FieldInfo] :canonical: vendor_fabric.vault.tools.ReadSecretSchema.model_fields :classmethod: .. py:method:: model_computed_fields() -> dict[str, pydantic.fields.ComputedFieldInfo] :canonical: vendor_fabric.vault.tools.ReadSecretSchema.model_computed_fields :classmethod: .. py:property:: model_extra :canonical: vendor_fabric.vault.tools.ReadSecretSchema.model_extra :type: dict[str, typing.Any] | None .. py:property:: model_fields_set :canonical: vendor_fabric.vault.tools.ReadSecretSchema.model_fields_set :type: set[str] .. py:method:: model_construct(_fields_set: set[str] | None = None, **values: typing.Any) -> typing_extensions.Self :canonical: vendor_fabric.vault.tools.ReadSecretSchema.model_construct :classmethod: .. py:method:: model_copy(*, update: collections.abc.Mapping[str, typing.Any] | None = None, deep: bool = False) -> typing_extensions.Self :canonical: vendor_fabric.vault.tools.ReadSecretSchema.model_copy .. py:method:: model_dump(*, mode: typing.Literal[json, python] | str = 'python', include: pydantic.main.IncEx | None = None, exclude: pydantic.main.IncEx | None = None, context: typing.Any | None = None, by_alias: bool | None = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, exclude_computed_fields: bool = False, round_trip: bool = False, warnings: bool | typing.Literal[none, warn, error] = True, fallback: typing.Callable[[typing.Any], typing.Any] | None = None, serialize_as_any: bool = False, polymorphic_serialization: bool | None = None) -> dict[str, typing.Any] :canonical: vendor_fabric.vault.tools.ReadSecretSchema.model_dump .. py:method:: model_dump_json(*, indent: int | None = None, ensure_ascii: bool = False, include: pydantic.main.IncEx | None = None, exclude: pydantic.main.IncEx | None = None, context: typing.Any | None = None, by_alias: bool | None = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, exclude_computed_fields: bool = False, round_trip: bool = False, warnings: bool | typing.Literal[none, warn, error] = True, fallback: typing.Callable[[typing.Any], typing.Any] | None = None, serialize_as_any: bool = False, polymorphic_serialization: bool | None = None) -> str :canonical: vendor_fabric.vault.tools.ReadSecretSchema.model_dump_json .. py:method:: model_json_schema(by_alias: bool = True, ref_template: str = DEFAULT_REF_TEMPLATE, schema_generator: type[pydantic.json_schema.GenerateJsonSchema] = GenerateJsonSchema, mode: pydantic.json_schema.JsonSchemaMode = 'validation', *, union_format: typing.Literal[any_of, primitive_type_array] = 'any_of') -> dict[str, typing.Any] :canonical: vendor_fabric.vault.tools.ReadSecretSchema.model_json_schema :classmethod: .. py:method:: model_parametrized_name(params: tuple[type[typing.Any], ...]) -> str :canonical: vendor_fabric.vault.tools.ReadSecretSchema.model_parametrized_name :classmethod: .. py:method:: model_post_init(context: typing.Any, /) -> None :canonical: vendor_fabric.vault.tools.ReadSecretSchema.model_post_init .. py:method:: model_rebuild(*, force: bool = False, raise_errors: bool = True, _parent_namespace_depth: int = 2, _types_namespace: pydantic._internal._namespace_utils.MappingNamespace | None = None) -> bool | None :canonical: vendor_fabric.vault.tools.ReadSecretSchema.model_rebuild :classmethod: .. py:method:: model_validate(obj: typing.Any, *, strict: bool | None = None, extra: pydantic.config.ExtraValues | None = None, from_attributes: bool | None = None, context: typing.Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) -> typing_extensions.Self :canonical: vendor_fabric.vault.tools.ReadSecretSchema.model_validate :classmethod: .. py:method:: model_validate_json(json_data: str | bytes | bytearray, *, strict: bool | None = None, extra: pydantic.config.ExtraValues | None = None, context: typing.Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) -> typing_extensions.Self :canonical: vendor_fabric.vault.tools.ReadSecretSchema.model_validate_json :classmethod: .. py:method:: model_validate_strings(obj: typing.Any, *, strict: bool | None = None, extra: pydantic.config.ExtraValues | None = None, context: typing.Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) -> typing_extensions.Self :canonical: vendor_fabric.vault.tools.ReadSecretSchema.model_validate_strings :classmethod: .. py:method:: dict(*, include: pydantic.main.IncEx | None = None, exclude: pydantic.main.IncEx | None = None, by_alias: bool = False, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) -> typing.Dict[str, typing.Any] :canonical: vendor_fabric.vault.tools.ReadSecretSchema.dict .. py:method:: json(*, include: pydantic.main.IncEx | None = None, exclude: pydantic.main.IncEx | None = None, by_alias: bool = False, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: typing.Callable[[typing.Any], typing.Any] | None = PydanticUndefined, models_as_dict: bool = PydanticUndefined, **dumps_kwargs: typing.Any) -> str :canonical: vendor_fabric.vault.tools.ReadSecretSchema.json .. py:method:: parse_obj(obj: typing.Any) -> typing_extensions.Self :canonical: vendor_fabric.vault.tools.ReadSecretSchema.parse_obj :classmethod: .. py:method:: parse_raw(b: str | bytes, *, content_type: str | None = None, encoding: str = 'utf8', proto: pydantic.deprecated.parse.Protocol | None = None, allow_pickle: bool = False) -> typing_extensions.Self :canonical: vendor_fabric.vault.tools.ReadSecretSchema.parse_raw :classmethod: .. py:method:: parse_file(path: str | pathlib.Path, *, content_type: str | None = None, encoding: str = 'utf8', proto: pydantic.deprecated.parse.Protocol | None = None, allow_pickle: bool = False) -> typing_extensions.Self :canonical: vendor_fabric.vault.tools.ReadSecretSchema.parse_file :classmethod: .. py:method:: from_orm(obj: typing.Any) -> typing_extensions.Self :canonical: vendor_fabric.vault.tools.ReadSecretSchema.from_orm :classmethod: .. py:method:: construct(_fields_set: set[str] | None = None, **values: typing.Any) -> typing_extensions.Self :canonical: vendor_fabric.vault.tools.ReadSecretSchema.construct :classmethod: .. py:method:: copy(*, include: pydantic._internal._utils.AbstractSetIntStr | pydantic._internal._utils.MappingIntStrAny | None = None, exclude: pydantic._internal._utils.AbstractSetIntStr | pydantic._internal._utils.MappingIntStrAny | None = None, update: typing.Dict[str, typing.Any] | None = None, deep: bool = False) -> typing_extensions.Self :canonical: vendor_fabric.vault.tools.ReadSecretSchema.copy .. py:method:: schema(by_alias: bool = True, ref_template: str = DEFAULT_REF_TEMPLATE) -> typing.Dict[str, typing.Any] :canonical: vendor_fabric.vault.tools.ReadSecretSchema.schema :classmethod: .. py:method:: schema_json(*, by_alias: bool = True, ref_template: str = DEFAULT_REF_TEMPLATE, **dumps_kwargs: typing.Any) -> str :canonical: vendor_fabric.vault.tools.ReadSecretSchema.schema_json :classmethod: .. py:method:: validate(value: typing.Any) -> typing_extensions.Self :canonical: vendor_fabric.vault.tools.ReadSecretSchema.validate :classmethod: .. py:method:: update_forward_refs(**localns: typing.Any) -> None :canonical: vendor_fabric.vault.tools.ReadSecretSchema.update_forward_refs :classmethod: .. py:function:: list_secrets(root_path: str = '/', mount_point: str = 'secret', max_depth: int | None = 10) -> extended_data.containers.ExtendedList[extended_data.containers.ExtendedDict] :canonical: vendor_fabric.vault.tools.list_secrets .. autodoc2-docstring:: vendor_fabric.vault.tools.list_secrets :parser: myst .. py:function:: read_secret(path: str, mount_point: str = 'secret') -> extended_data.containers.ExtendedDict :canonical: vendor_fabric.vault.tools.read_secret .. autodoc2-docstring:: vendor_fabric.vault.tools.read_secret :parser: myst .. py:data:: TOOL_DEFINITIONS :canonical: vendor_fabric.vault.tools.TOOL_DEFINITIONS :value: None .. autodoc2-docstring:: vendor_fabric.vault.tools.TOOL_DEFINITIONS :parser: myst