jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-11-12 12:31:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

o-r-integrations: add glossary reference to config file (#32761)

Browse Source
This commit is contained in:
c0ffeeca7
2024-05-14 15:40:15 +02:00
committed by GitHub
parent 5e853cf251
commit 42c3b4524b
14 changed files with 51 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
source/_integrations/python_script.markdown
View File

@@ -11,15 +11,15 @@ ha_integration_type: integration
This integration allows you to write Python scripts that are exposed as services in Home Assistant. Each Python file created in the `<config>/python_scripts/` folder will be exposed as a service. The content is not cached so you can easily develop: edit file, save changes, call service. The scripts are run in a sandboxed environment. The following variables are available in the sandbox:
| Name | Description |
| ---- | ----------- |
| `hass` | The Home Assistant object. Access is only allowed to call services, set/remove states and fire events. [API reference][hass-api]
| `data` | The data passed to the Python Script service call.
| `logger` | A logger to allow you to log messages: `logger.info()`, `logger.warning()`, `logger.error()`. [API reference][logger-api]
| `time` | The stdlib `time` available as limited access.
| `datetime` | The stdlib `datetime` available as limited access.
| `dt_util` | The ` homeassistant.util.dt` module.
| `output` | An empty dictionary. Add items to return data as [`response_variable`](/docs/scripts/service-calls#use-templates-to-handle-response-data).
| Name | Description |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `hass` | The Home Assistant object. Access is only allowed to call services, set/remove states and fire events. [API reference][hass-api] |
| `data` | The data passed to the Python Script service call. |
| `logger` | A logger to allow you to log messages: `logger.info()`, `logger.warning()`, `logger.error()`. [API reference][logger-api] |
| `time` | The stdlib `time` available as limited access. |
| `datetime` | The stdlib `datetime` available as limited access. |
| `dt_util` | The ` homeassistant.util.dt` module. |
| `output` | An empty dictionary. Add items to return data as [`response_variable`](/docs/scripts/service-calls#use-templates-to-handle-response-data). |
Other imports like `min`, `max` are available as builtins. See the [python_script](https://github.com/home-assistant/core/blob/dev/homeassistant/components/python_script/__init__.py) source code for up-to-date information on the available objects inside the script.
@@ -45,7 +45,7 @@ It is created as a first step, to help with:
Start by enabling the Python Scripts integration and create the first script.
- Add to `configuration.yaml`: `python_script:`
- Add to {% term "`configuration.yaml`" %}: `python_script:`
- Create the folder `<config>/python_scripts`
- Create a file `<config>/python_scripts/hello_world.py` in the folder and give it this content:
@@ -69,7 +69,7 @@ data:
Running this script show absolutely no output on the screen, but it logs with level `info`. You must have the [Logger](/integrations/logger/) enabled at least for level `info`.
Your `configuration.yaml` should include something like this.
Your {% term "`configuration.yaml`" %} should include something like this.
```yaml
logger: