jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-23 21:27:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add validation schema as optional argument to service registration.

Browse Source
This commit is contained in:
Jan Harkes 2016-03-31 14:36:59 -04:00
parent bcb0eb53f3
commit 64030b9d48
1 changed files with 20 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
homeassistant/core.py
View File

@ -14,6 +14,8 @@ import threading
import time import time
from types import MappingProxyType from types import MappingProxyType
import voluptuous as vol
import homeassistant.helpers.temperature as temp_helper import homeassistant.helpers.temperature as temp_helper
import homeassistant.util as util import homeassistant.util as util
import homeassistant.util.dt as dt_util import homeassistant.util.dt as dt_util
@ -494,13 +496,14 @@ class StateMachine(object):
class Service(object): class Service(object):
"""Represents a callable service.""" """Represents a callable service."""
__slots__ = ['func', 'description', 'fields'] __slots__ = ['func', 'description', 'fields', 'schema']
def __init__(self, func, description, fields): def __init__(self, func, description, fields, schema):
"""Initialize a service.""" """Initialize a service."""
self.func = func self.func = func
self.description = description or '' self.description = description or ''
self.fields = fields or {} self.fields = fields or {}
self.schema = schema
def as_dict(self): def as_dict(self):
"""Return dictionary representation of this service.""" """Return dictionary representation of this service."""
@ -560,16 +563,20 @@ class ServiceRegistry(object):
"""Test if specified service exists.""" """Test if specified service exists."""
return service in self._services.get(domain, []) return service in self._services.get(domain, [])
def register(self, domain, service, service_func, description=None): # pylint: disable=too-many-arguments
def register(self, domain, service, service_func, description=None,
schema=None):
""" """
Register a service. Register a service.
Description is a dict containing key 'description' to describe Description is a dict containing key 'description' to describe
the service and a key 'fields' to describe the fields. the service and a key 'fields' to describe the fields.
Schema is called to coerce and validate the service data.
""" """
description = description or {} description = description or {}
service_obj = Service(service_func, description.get('description'), service_obj = Service(service_func, description.get('description'),
description.get('fields', {})) description.get('fields', {}), schema)
with self._lock: with self._lock:
if domain in self._services: if domain in self._services:
self._services[domain][service] = service_obj self._services[domain][service] = service_obj
@ -635,6 +642,15 @@ class ServiceRegistry(object):
return return
service_handler = self._services[domain][service] service_handler = self._services[domain][service]
service_validator = service_handler.schema
try:
if service_validator:
service_data = service_validator(service_data)
except vol.MultipleInvalid as ex:
_LOGGER.error('Invalid service data for %s.%s: %s',
domain, service, ex)
return
service_call = ServiceCall(domain, service, service_data, call_id) service_call = ServiceCall(domain, service, service_data, call_id)
# Add a job to the pool that calls _execute_service # Add a job to the pool that calls _execute_service