Skip to main content

pytest-homeassistant-custom-component

HA core version

Package to automatically extract testing plugins from Home Assistant for custom component testing. The goal is to provide the same functionality as the tests in home-assistant/core. pytest-homeassistant-custom-component is updated daily according to the latest homeassistant release including beta.

Usage:

  • All pytest fixtures can be used as normal, like hass
  • For helpers:
    • home-assistant/core native test: from tests.common import MockConfigEntry
    • custom component test: from pytest_homeassistant_custom_component.common import MockConfigEntry
  • If your integration is inside a custom_components folder, a custom_components/__init__.py file or changes to sys.path may be required.
  • enable_custom_integrations fixture is required (versions >=2021.6.0b0)
  • pytest-asyncio might now require asyncio_mode = auto config, see #129.
  • If using load_fixture, the files need to be in a fixtures folder colocated with the tests. For example, a test in test_sensor.py can load data from some_data.json using load_fixture from this structure:
tests/
   fixtures/
      some_data.json
   test_sensor.py
  • When using syrupy snapshots, add a snapshot fixture to conftest.py to make sure the snapshots are loaded from snapshot folder colocated with the tests.
    from pytest_homeassistant_custom_component.syrupy import HomeAssistantSnapshotExtension
    from syrupy.assertion import SnapshotAssertion


    @pytest.fixture
    def snapshot(snapshot: SnapshotAssertion) -> SnapshotAssertion:
        """Return snapshot assertion fixture with the Home Assistant extension."""
        return snapshot.use_extension(HomeAssistantSnapshotExtension)

Examples:

More Info

This repository is set up to be nearly fully automatic.

  • Version of home-assistant/core is given in ha_version, pytest_homeassistant_custom_component.const, and in the README above.
  • This package is generated against published releases of homeassistant and updated daily.
  • PRs should not include changes to the pytest_homeassistant_custom_component files. CI testing will automatically generate the new files.

Version Strategy

  • When changes in extraction are required, there will be a change in the minor version.
  • A change in the patch version indicates that it was an automatic update with a homeassistant version.
  • This enables tracking back to which versions of pytest-homeassistant-custom-component can be used for extracting testing utilities from which version of homeassistant.

This package was inspired by pytest-homeassistant by @boralyl, but is intended to more closely and automatically track the home-assistant/core library.

Metadata

Release files for pytest-homeassistant-custom-component 0.13.304

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pytest-homeassistant-custom-component 0.13.304
File Size Uploaded Provenance Actions
pytest_homeassistant_custom_component-0.13.304.tar.gz 63.9 kB Without provenance Details for pytest_homeassistant_custom_component-0.13.304.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pytest-homeassistant-custom-component 0.13.304
File Interpreter ABI Platform Actions
pytest_homeassistant_custom_component-0.13.304-py3-none-any.whl Python 3 none any Details for pytest_homeassistant_custom_component-0.13.304-py3-none-any.whl

Total release size: 133.7 kB

Release files / pytest_homeassistant_custom_component-0.13.304.tar.gz

Download URL pytest_homeassistant_custom_component-0.13.304.tar.gz
Size 63.9 kB
Tags Source
SHA-256 checksum
How to use checksums
47f6621f912a719e68f31805e5ba5adf735d23f55dba1b0db58a7a7ec97d377c
BLAKE2b-256 checksum
How to use checksums
0c75d1d9c5eb7df0d4ec78ca088ffcc59e927f19d29e074d669acfcb6bc3c221
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / pytest_homeassistant_custom_component-0.13.304-py3-none-any.whl

Download URL pytest_homeassistant_custom_component-0.13.304-py3-none-any.whl
Size 69.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
357d8a81a7165e23b25fa0dadb5cef42047f2d41d4d0a96676c96201d4e6293a
BLAKE2b-256 checksum
How to use checksums
ccfd97373e50b9b08bd69b75a51748e93e496023d62b276fb91a77390f810e8a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Security for pytest-homeassistant-custom-component 0.13.304

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.13.304 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page