Modify import of template and PEP257

This commit is contained in:
Fabian Affolter
2016-02-23 21:06:50 +01:00
parent 213cc920d0
commit 582394bc3b
25 changed files with 152 additions and 182 deletions

View File

@@ -1,7 +1,5 @@
"""
homeassistant.components.api
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Provides a Rest API for Home Assistant.
Rest API for Home Assistant.
For more details about the RESTful API, please refer to the documentation at
https://home-assistant.io/developers/api/
@@ -23,7 +21,7 @@ from homeassistant.const import (
URL_API_STREAM, URL_API_TEMPLATE)
from homeassistant.exceptions import TemplateError
from homeassistant.helpers.state import TrackStates
from homeassistant.util import template
from homeassistant.helpers import template
DOMAIN = 'api'
DEPENDENCIES = ['http']
@@ -35,7 +33,7 @@ _LOGGER = logging.getLogger(__name__)
def setup(hass, config):
""" Register the API with the HTTP interface. """
"""Register the API with the HTTP interface."""
# /api - for validation purposes
hass.http.register_path('GET', URL_API, _handle_get_api)
@@ -98,12 +96,12 @@ def setup(hass, config):
def _handle_get_api(handler, path_match, data):
""" Renders the debug interface. """
"""Renders the debug interface."""
handler.write_json_message("API running.")
def _handle_get_api_stream(handler, path_match, data):
""" Provide a streaming interface for the event bus. """
"""Provide a streaming interface for the event bus."""
gracefully_closed = False
hass = handler.server.hass
wfile = handler.wfile
@@ -116,7 +114,7 @@ def _handle_get_api_stream(handler, path_match, data):
restrict = restrict.split(',')
def write_message(payload):
""" Writes a message to the output. """
"""Writes a message to the output."""
with write_lock:
msg = "data: {}\n\n".format(payload)
@@ -129,7 +127,7 @@ def _handle_get_api_stream(handler, path_match, data):
block.set()
def forward_events(event):
""" Forwards events to the open request. """
"""Forwards events to the open request."""
nonlocal gracefully_closed
if block.is_set() or event.event_type == EVENT_TIME_CHANGED:
@@ -173,17 +171,17 @@ def _handle_get_api_stream(handler, path_match, data):
def _handle_get_api_config(handler, path_match, data):
""" Returns the Home Assistant config. """
"""Returns the Home Assistant configuration."""
handler.write_json(handler.server.hass.config.as_dict())
def _handle_get_api_states(handler, path_match, data):
""" Returns a dict containing all entity ids and their state. """
"""Returns a dict containing all entity ids and their state."""
handler.write_json(handler.server.hass.states.all())
def _handle_get_api_states_entity(handler, path_match, data):
""" Returns the state of a specific entity. """
"""Returns the state of a specific entity."""
entity_id = path_match.group('entity_id')
state = handler.server.hass.states.get(entity_id)
@@ -195,7 +193,7 @@ def _handle_get_api_states_entity(handler, path_match, data):
def _handle_post_state_entity(handler, path_match, data):
""" Handles updating the state of an entity.
"""Handles updating the state of an entity.
This handles the following paths:
/api/states/<entity_id>
@@ -242,12 +240,12 @@ def _handle_delete_state_entity(handler, path_match, data):
def _handle_get_api_events(handler, path_match, data):
""" Handles getting overview of event listeners. """
"""Handles getting overview of event listeners."""
handler.write_json(events_json(handler.server.hass))
def _handle_api_post_events_event(handler, path_match, event_data):
""" Handles firing of an event.
"""Handles firing of an event.
This handles the following paths:
/api/events/<event_type>
@@ -278,13 +276,13 @@ def _handle_api_post_events_event(handler, path_match, event_data):
def _handle_get_api_services(handler, path_match, data):
""" Handles getting overview of services. """
"""Handles getting overview of services."""
handler.write_json(services_json(handler.server.hass))
# pylint: disable=invalid-name
def _handle_post_api_services_domain_service(handler, path_match, data):
""" Handles calling a service.
"""Handles calling a service.
This handles the following paths:
/api/services/<domain>/<service>
@@ -300,8 +298,7 @@ def _handle_post_api_services_domain_service(handler, path_match, data):
# pylint: disable=invalid-name
def _handle_post_api_event_forward(handler, path_match, data):
""" Handles adding an event forwarding target. """
"""Handles adding an event forwarding target."""
try:
host = data['host']
api_password = data['api_password']
@@ -334,8 +331,7 @@ def _handle_post_api_event_forward(handler, path_match, data):
def _handle_delete_api_event_forward(handler, path_match, data):
""" Handles deleting an event forwarding target. """
"""Handles deleting an event forwarding target."""
try:
host = data['host']
except KeyError:
@@ -358,26 +354,25 @@ def _handle_delete_api_event_forward(handler, path_match, data):
def _handle_get_api_components(handler, path_match, data):
""" Returns all the loaded components. """
"""Returns all the loaded components."""
handler.write_json(handler.server.hass.config.components)
def _handle_get_api_error_log(handler, path_match, data):
""" Returns the logged errors for this session. """
"""Returns the logged errors for this session."""
handler.write_file(handler.server.hass.config.path(ERROR_LOG_FILENAME),
False)
def _handle_post_api_log_out(handler, path_match, data):
""" Log user out. """
"""Log user out."""
handler.send_response(HTTP_OK)
handler.destroy_session()
handler.end_headers()
def _handle_post_api_template(handler, path_match, data):
""" Log user out. """
"""Log user out."""
template_string = data.get('template', '')
try:
@@ -393,12 +388,12 @@ def _handle_post_api_template(handler, path_match, data):
def services_json(hass):
""" Generate services data to JSONify. """
"""Generate services data to JSONify."""
return [{"domain": key, "services": value}
for key, value in hass.services.services.items()]
def events_json(hass):
""" Generate event data to JSONify. """
"""Generate event data to JSONify."""
return [{"event": key, "listener_count": value}
for key, value in hass.bus.listeners.items()]