Skip to content

Add "strictly_typed" field to manifest.json #898

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
KapJI wants to merge 2 commits into from
Closed

Add "strictly_typed" field to manifest.json #898

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bd8b691
Add "strictly_typed" field to manifest.json
KapJI Apr 23, 2021
3b6e8b7
Add link to mypy
KapJI Apr 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion docs/creating_integration_manifest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ Every integration has a manifest file to specify basic information about an inte
"codeowners": ["@balloob"],
"requirements": ["aiohue==1.9.1"],
"quality_scale": "platinum",
"iot_class": "local_polling"
"iot_class": "local_polling",
"strictly_typed": true
}
```

Expand Down Expand Up @@ -262,3 +263,16 @@ The following IoT classes are accepted in the manifest:
- `calculated`: The integration does not handle communication on it's own, but provides a calculated result.

[iot_class]: https://www.home-assistant.io/blog/2016/02/12/classifying-the-internet-of-things/#classifiers

## Strict type checks

If your integration is fully covered with type hints, we recommend you to enable strict mypy checks.
[Mypy](https://mypy.readthedocs.io/en/stable/) will check if all required type annotations are added and if all types are used correctly.
This can catch some potential issues in the code.


```json
{
"strictly_typed": true
}
```