mirror of
https://github.com/home-assistant/core.git
synced 2025-09-06 19:56:22 +00:00
.devcontainer
.github
.vscode
docs
homeassistant
machine
pylint
rootfs
script
hassfest
scaffold
templates
__init__.py
__main__.py
const.py
docs.py
error.py
gather_info.py
generate.py
model.py
translations
__init__.py
bootstrap
check_dirty
check_format
gen_requirements_all.py
inspect_schemas.py
lazytox.py
lint
monkeytype
pip_check
run-in-env.sh
server
setup
update
version_bump.py
tests
.core_files.yaml
.coveragerc
.dockerignore
.gitattributes
.gitignore
.hadolint.yaml
.ignore
.pre-commit-config.yaml
.prettierignore
.readthedocs.yml
.strict-typing
.yamllint
CLA.md
CODEOWNERS
CODE_OF_CONDUCT.md
CONTRIBUTING.md
Dockerfile
Dockerfile.dev
LICENSE.md
MANIFEST.in
README.rst
build.yaml
codecov.yml
mypy.ini
pyproject.toml
requirements.txt
requirements_all.txt
requirements_docs.txt
requirements_test.txt
requirements_test_all.txt
requirements_test_pre_commit.txt
setup.cfg
tox.ini
91 lines
3.2 KiB
Python
91 lines
3.2 KiB
Python
"""Print links to relevant docs."""
|
|
from .model import Info
|
|
|
|
DATA = {
|
|
"backup": {
|
|
"title": "Backup",
|
|
"docs": "https://developers.home-assistant.io/docs/core/platform/backup",
|
|
},
|
|
"config_flow": {
|
|
"title": "Config Flow",
|
|
"docs": "https://developers.home-assistant.io/docs/en/config_entries_config_flow_handler.html",
|
|
},
|
|
"config_flow_helper": {
|
|
"title": "Helper Config Flow",
|
|
"docs": "https://developers.home-assistant.io/docs/en/config_entries_config_flow_handler.html#helper",
|
|
},
|
|
"config_flow_discovery": {
|
|
"title": "Discoverable Config Flow",
|
|
"docs": "https://developers.home-assistant.io/docs/en/config_entries_config_flow_handler.html#discoverable-integrations-that-require-no-authentication",
|
|
},
|
|
"config_flow_oauth2": {
|
|
"title": "OAuth2 Config Flow",
|
|
"docs": "https://developers.home-assistant.io/docs/en/next/config_entries_config_flow_handler.html#configuration-via-oauth2",
|
|
},
|
|
"device_action": {
|
|
"title": "Device Action",
|
|
"docs": "https://developers.home-assistant.io/docs/en/device_automation_action.html",
|
|
},
|
|
"device_condition": {
|
|
"title": "Device Condition",
|
|
"docs": "https://developers.home-assistant.io/docs/en/device_automation_condition.html",
|
|
},
|
|
"device_trigger": {
|
|
"title": "Device Trigger",
|
|
"docs": "https://developers.home-assistant.io/docs/en/device_automation_trigger.html",
|
|
},
|
|
"integration": {
|
|
"title": "Integration",
|
|
"docs": "https://developers.home-assistant.io/docs/en/creating_integration_file_structure.html",
|
|
},
|
|
"reproduce_state": {
|
|
"title": "Reproduce State",
|
|
"docs": "https://developers.home-assistant.io/docs/core/platform/reproduce_state",
|
|
"extra": "You will now need to update the code to make sure that every attribute that can occur in the state will cause the right service to be called.",
|
|
},
|
|
"significant_change": {
|
|
"title": "Significant Change",
|
|
"docs": "https://developers.home-assistant.io/docs/core/platform/significant_change",
|
|
"extra": "You will now need to update the code to make sure that entities with different device classes are correctly considered.",
|
|
},
|
|
}
|
|
|
|
|
|
def print_relevant_docs(template: str, info: Info) -> None:
|
|
"""Print relevant docs."""
|
|
data = DATA[template]
|
|
|
|
print()
|
|
print("**************************")
|
|
print()
|
|
print()
|
|
print(f"{data['title']} code has been generated")
|
|
print()
|
|
if info.files_added:
|
|
print("Added the following files:")
|
|
for file in info.files_added:
|
|
print(f"- {file}")
|
|
print()
|
|
|
|
if info.tests_added:
|
|
print("Added the following tests:")
|
|
for file in info.tests_added:
|
|
print(f"- {file}")
|
|
print()
|
|
|
|
if info.examples_added:
|
|
print(
|
|
"Because some files already existed, we added the following example files. Please copy the relevant code to the existing files."
|
|
)
|
|
for file in info.examples_added:
|
|
print(f"- {file}")
|
|
print()
|
|
|
|
print(
|
|
"The next step is to look at the files and deal with all areas marked as TODO."
|
|
)
|
|
|
|
if "extra" in data:
|
|
print()
|
|
print(data["extra"])
|