types-hvac

What it is and what it does

types-hvac is a type stub package that provides static type annotations for the hvac library, a Python client for HashiCorp Vault. It allows type checkers like mypy and pyright to understand the types and signatures of hvac's API, catching type errors at development time rather than runtime. The stubs are maintained as part of the typeshed project and target hvac version 2.4.*.

This package is intended for developers who use hvac and want to enable static type checking in their codebase. It has no runtime effect—it only provides metadata for type checkers. Installation is straightforward with low friction, requiring only the requests dependency that hvac itself uses.

Use it for:

• Enable mypy or pyright to catch type errors in code that calls hvac methods for Vault authentication and secret retrieval.
• Provide IDE autocomplete and type hints when writing hvac client code in editors that support type stubs.
• Validate that Vault client initialization and API calls match expected signatures during CI/CD type-checking passes.
• Document the expected types and return values of hvac's public API for developers unfamiliar with the library.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides type hints for the hvac package, enabling static type checkers like mypy and pyright to validate code that uses hvac.

Yes, if you use hvac and run static type checking. It adds no runtime overhead and enables type safety for Vault client code. Install it alongside hvac in projects where mypy or pyright is part of the development workflow. Not necessary if you do not use static type checking or do not use hvac.

Install

types-hvac on PyPI

pip install types-hvac

uv add types-hvac

poetry add types-hvac

Installing types-hvac

Before you install

Low friction installation with a single runtime dependency (requests). Actively maintained as part of the typeshed project with recent releases; last commit was 2026-08-14.

License in practice

Apache-2.0 permissive license allows use in most projects without restriction, including proprietary software.

Quickstart

pip install types-hvac

import hvac
# Type checker now understands hvac methods and attributes

Requires Python 3.10 or later; hvac package itself must be installed separately for runtime use.

Verify before relying

• Whether this stub package is automatically installed as a dependency of hvac or must be installed separately.
• Coverage completeness for hvac 2.4.* API surface beyond the tested type checkers.
• Typical Vault server configuration details needed for hvac client initialization.

Package facts

Evidence: types_hvac-2.4.0.20260731-py3-none-any.whl

Tags

More Software Development packages