jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-25 10:17:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add some more details and use extend

Browse Source
This commit is contained in:
Fabian Affolter 2016-08-14 10:06:15 +02:00
parent e6b65dd855
commit 860c4a932c
No known key found for this signature in database
GPG Key ID: DDF3D6F44AAB1336
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
source/developers/development_validation.markdown
View File

@ -21,6 +21,12 @@ Beside the [voluptuous](https://pypi.python.org/pypi/voluptuous) default types a
To validate plaforms using [MQTT](/components/mqtt/) there are `valid_subscribe_topic` and `valid_publish_topic` present. To validate plaforms using [MQTT](/components/mqtt/) there are `valid_subscribe_topic` and `valid_publish_topic` present.
Some things to keep in mind:
- Use the constants which are definded in `const.py`.
- Import `PLATFORM_SCHEMA` from parent component and extend it.
- Preferred order is `required` first, then `optional`.
### {% linkable_title Snippets %} ### {% linkable_title Snippets %}
This section contains a couple of snippets for the validation we use. This section contains a couple of snippets for the validation we use.
@ -30,7 +36,7 @@ This section contains a couple of snippets for the validation we use.
```python ```python
DEFAULT_NAME = 'Sensor name' DEFAULT_NAME = 'Sensor name'
PLATFORM_SCHEMA = vol.Schema({ PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
... ...
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string, vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
``` ```
@ -42,8 +48,8 @@ As all port numbers are coming out of the range 1 till 65535 a range check shoul
```python ```python
DEFAULT_PORT = 993 DEFAULT_PORT = 993
PLATFORM_SCHEMA = vol.Schema({ PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
[...] ...
vol.Optional(CONF_PORT, default=DEFAULT_PORT): vol.Optional(CONF_PORT, default=DEFAULT_PORT):
vol.All(vol.Coerce(int), vol.Range(min=1, max=65535)), vol.All(vol.Coerce(int), vol.Range(min=1, max=65535)),
``` ```
@ -58,8 +64,8 @@ SENSOR_TYPES = {
'average_download_rate': ('Average Speed', 'MB/s'), 'average_download_rate': ('Average Speed', 'MB/s'),
} }
PLATFORM_SCHEMA = vol.Schema({ PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
.... ...
vol.Optional(CONF_MONITORED_VARIABLES, default=[]): vol.Optional(CONF_MONITORED_VARIABLES, default=[]):
[vol.In(SENSOR_TYPES)], [vol.In(SENSOR_TYPES)],
``` ```