Modify docstrings to match PEP257

This commit is contained in:
Fabian Affolter
2016-03-07 17:45:06 +01:00
parent 6ac9210919
commit 032f06e015
7 changed files with 27 additions and 39 deletions

View File

@@ -1,6 +1,4 @@
"""
homeassistant.components.camera.mjpeg
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Support for IP Cameras.
For more details about this platform, please refer to the documentation at
@@ -23,7 +21,7 @@ _LOGGER = logging.getLogger(__name__)
# pylint: disable=unused-argument
def setup_platform(hass, config, add_devices_callback, discovery_info=None):
""" Adds a mjpeg IP Camera. """
"""Setup a MJPEG IP Camera."""
if not validate_config({DOMAIN: config}, {DOMAIN: ['mjpeg_url']},
_LOGGER):
return None
@@ -45,7 +43,7 @@ class MjpegCamera(Camera):
self._mjpeg_url = device_info['mjpeg_url']
def camera_stream(self):
""" Return a mjpeg stream image response directly from the camera. """
"""Return a MJPEG stream image response directly from the camera."""
if self._username and self._password:
return requests.get(self._mjpeg_url,
auth=HTTPBasicAuth(self._username,
@@ -56,10 +54,9 @@ class MjpegCamera(Camera):
stream=True)
def camera_image(self):
""" Return a still image response from the camera. """
"""Return a still image response from the camera."""
def process_response(response):
""" Take in a response object, return the jpg from it. """
"""Take in a response object, return the jpg from it."""
data = b''
for chunk in response.iter_content(1024):
data += chunk
@@ -73,7 +70,7 @@ class MjpegCamera(Camera):
return process_response(response)
def mjpeg_stream(self, handler):
""" Generate an HTTP MJPEG stream from the camera. """
"""Generate an HTTP MJPEG stream from the camera."""
response = self.camera_stream()
content_type = response.headers[CONTENT_TYPE_HEADER]
@@ -88,5 +85,5 @@ class MjpegCamera(Camera):
@property
def name(self):
""" Return the name of this device. """
"""Return the name of this camera."""
return self._name