Update docstrings (#7361)
* Update docstrings * Update docstrings * Update docstrings * Update docstrings * update docstrings * Update docstrings * Update docstrings * Update docstrings * Update docstrings * Update docstrings * Update tomato.py * Update isy994.py * Lint + fix tests * Lint
This commit is contained in:
1 parent
e22e70a01a
commit
3ee4d1060f
264 files changed
+1686
-1768
No files matched your search
@@ -1,7 +1,7 @@
|
||||
"""
|
||||
Native Home Assistant iOS app component.
|
||||
|
||||
For more details about this platform, please refer to the documentation at
|
||||
For more details about this component, please refer to the documentation at
|
||||
https://home-assistant.io/ecosystem/ios/
|
||||
"""
|
||||
import asyncio
|
||||
@@ -28,76 +28,76 @@ from homeassistant.const import (HTTP_INTERNAL_SERVER_ERROR,
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
DOMAIN = "ios"
|
||||
DOMAIN = 'ios'
|
||||
|
||||
DEPENDENCIES = ["device_tracker", "http", "zeroconf"]
|
||||
DEPENDENCIES = ['device_tracker', 'http', 'zeroconf']
|
||||
|
||||
CONF_PUSH = "push"
|
||||
CONF_PUSH_CATEGORIES = "categories"
|
||||
CONF_PUSH_CATEGORIES_NAME = "name"
|
||||
CONF_PUSH_CATEGORIES_IDENTIFIER = "identifier"
|
||||
CONF_PUSH_CATEGORIES_ACTIONS = "actions"
|
||||
CONF_PUSH = 'push'
|
||||
CONF_PUSH_CATEGORIES = 'categories'
|
||||
CONF_PUSH_CATEGORIES_NAME = 'name'
|
||||
CONF_PUSH_CATEGORIES_IDENTIFIER = 'identifier'
|
||||
CONF_PUSH_CATEGORIES_ACTIONS = 'actions'
|
||||
|
||||
CONF_PUSH_ACTIONS_IDENTIFIER = "identifier"
|
||||
CONF_PUSH_ACTIONS_TITLE = "title"
|
||||
CONF_PUSH_ACTIONS_ACTIVATION_MODE = "activationMode"
|
||||
CONF_PUSH_ACTIONS_AUTHENTICATION_REQUIRED = "authenticationRequired"
|
||||
CONF_PUSH_ACTIONS_DESTRUCTIVE = "destructive"
|
||||
CONF_PUSH_ACTIONS_BEHAVIOR = "behavior"
|
||||
CONF_PUSH_ACTIONS_CONTEXT = "context"
|
||||
CONF_PUSH_ACTIONS_TEXT_INPUT_BUTTON_TITLE = "textInputButtonTitle"
|
||||
CONF_PUSH_ACTIONS_TEXT_INPUT_PLACEHOLDER = "textInputPlaceholder"
|
||||
CONF_PUSH_ACTIONS_IDENTIFIER = 'identifier'
|
||||
CONF_PUSH_ACTIONS_TITLE = 'title'
|
||||
CONF_PUSH_ACTIONS_ACTIVATION_MODE = 'activationMode'
|
||||
CONF_PUSH_ACTIONS_AUTHENTICATION_REQUIRED = 'authenticationRequired'
|
||||
CONF_PUSH_ACTIONS_DESTRUCTIVE = 'destructive'
|
||||
CONF_PUSH_ACTIONS_BEHAVIOR = 'behavior'
|
||||
CONF_PUSH_ACTIONS_CONTEXT = 'context'
|
||||
CONF_PUSH_ACTIONS_TEXT_INPUT_BUTTON_TITLE = 'textInputButtonTitle'
|
||||
CONF_PUSH_ACTIONS_TEXT_INPUT_PLACEHOLDER = 'textInputPlaceholder'
|
||||
|
||||
ATTR_FOREGROUND = "foreground"
|
||||
ATTR_BACKGROUND = "background"
|
||||
ATTR_FOREGROUND = 'foreground'
|
||||
ATTR_BACKGROUND = 'background'
|
||||
|
||||
ACTIVATION_MODES = [ATTR_FOREGROUND, ATTR_BACKGROUND]
|
||||
|
||||
ATTR_DEFAULT_BEHAVIOR = "default"
|
||||
ATTR_TEXT_INPUT_BEHAVIOR = "textInput"
|
||||
ATTR_DEFAULT_BEHAVIOR = 'default'
|
||||
ATTR_TEXT_INPUT_BEHAVIOR = 'textInput'
|
||||
|
||||
BEHAVIORS = [ATTR_DEFAULT_BEHAVIOR, ATTR_TEXT_INPUT_BEHAVIOR]
|
||||
|
||||
ATTR_LAST_SEEN_AT = "lastSeenAt"
|
||||
ATTR_LAST_SEEN_AT = 'lastSeenAt'
|
||||
|
||||
ATTR_DEVICE = "device"
|
||||
ATTR_PUSH_TOKEN = "pushToken"
|
||||
ATTR_APP = "app"
|
||||
ATTR_PERMISSIONS = "permissions"
|
||||
ATTR_PUSH_ID = "pushId"
|
||||
ATTR_DEVICE_ID = "deviceId"
|
||||
ATTR_PUSH_SOUNDS = "pushSounds"
|
||||
ATTR_BATTERY = "battery"
|
||||
ATTR_DEVICE = 'device'
|
||||
ATTR_PUSH_TOKEN = 'pushToken'
|
||||
ATTR_APP = 'app'
|
||||
ATTR_PERMISSIONS = 'permissions'
|
||||
ATTR_PUSH_ID = 'pushId'
|
||||
ATTR_DEVICE_ID = 'deviceId'
|
||||
ATTR_PUSH_SOUNDS = 'pushSounds'
|
||||
ATTR_BATTERY = 'battery'
|
||||
|
||||
ATTR_DEVICE_NAME = "name"
|
||||
ATTR_DEVICE_LOCALIZED_MODEL = "localizedModel"
|
||||
ATTR_DEVICE_MODEL = "model"
|
||||
ATTR_DEVICE_PERMANENT_ID = "permanentID"
|
||||
ATTR_DEVICE_SYSTEM_VERSION = "systemVersion"
|
||||
ATTR_DEVICE_TYPE = "type"
|
||||
ATTR_DEVICE_SYSTEM_NAME = "systemName"
|
||||
ATTR_DEVICE_NAME = 'name'
|
||||
ATTR_DEVICE_LOCALIZED_MODEL = 'localizedModel'
|
||||
ATTR_DEVICE_MODEL = 'model'
|
||||
ATTR_DEVICE_PERMANENT_ID = 'permanentID'
|
||||
ATTR_DEVICE_SYSTEM_VERSION = 'systemVersion'
|
||||
ATTR_DEVICE_TYPE = 'type'
|
||||
ATTR_DEVICE_SYSTEM_NAME = 'systemName'
|
||||
|
||||
ATTR_APP_BUNDLE_IDENTIFER = "bundleIdentifer"
|
||||
ATTR_APP_BUILD_NUMBER = "buildNumber"
|
||||
ATTR_APP_VERSION_NUMBER = "versionNumber"
|
||||
ATTR_APP_BUNDLE_IDENTIFER = 'bundleIdentifer'
|
||||
ATTR_APP_BUILD_NUMBER = 'buildNumber'
|
||||
ATTR_APP_VERSION_NUMBER = 'versionNumber'
|
||||
|
||||
ATTR_LOCATION_PERMISSION = "location"
|
||||
ATTR_NOTIFICATIONS_PERMISSION = "notifications"
|
||||
ATTR_LOCATION_PERMISSION = 'location'
|
||||
ATTR_NOTIFICATIONS_PERMISSION = 'notifications'
|
||||
|
||||
PERMISSIONS = [ATTR_LOCATION_PERMISSION, ATTR_NOTIFICATIONS_PERMISSION]
|
||||
|
||||
ATTR_BATTERY_STATE = "state"
|
||||
ATTR_BATTERY_LEVEL = "level"
|
||||
ATTR_BATTERY_STATE = 'state'
|
||||
ATTR_BATTERY_LEVEL = 'level'
|
||||
|
||||
ATTR_BATTERY_STATE_UNPLUGGED = "Unplugged"
|
||||
ATTR_BATTERY_STATE_CHARGING = "Charging"
|
||||
ATTR_BATTERY_STATE_FULL = "Full"
|
||||
ATTR_BATTERY_STATE_UNKNOWN = "Unknown"
|
||||
ATTR_BATTERY_STATE_UNPLUGGED = 'Unplugged'
|
||||
ATTR_BATTERY_STATE_CHARGING = 'Charging'
|
||||
ATTR_BATTERY_STATE_FULL = 'Full'
|
||||
ATTR_BATTERY_STATE_UNKNOWN = 'Unknown'
|
||||
|
||||
BATTERY_STATES = [ATTR_BATTERY_STATE_UNPLUGGED, ATTR_BATTERY_STATE_CHARGING,
|
||||
ATTR_BATTERY_STATE_FULL, ATTR_BATTERY_STATE_UNKNOWN]
|
||||
|
||||
ATTR_DEVICES = "devices"
|
||||
ATTR_DEVICES = 'devices'
|
||||
|
||||
ACTION_SCHEMA = vol.Schema({
|
||||
vol.Required(CONF_PUSH_ACTIONS_IDENTIFIER): vol.Upper,
|
||||
@@ -167,7 +167,7 @@ IDENTIFY_SCHEMA = vol.Schema({
|
||||
vol.Optional(ATTR_PUSH_SOUNDS): list
|
||||
}, extra=vol.ALLOW_EXTRA)
|
||||
|
||||
CONFIGURATION_FILE = "ios.conf"
|
||||
CONFIGURATION_FILE = 'ios.conf'
|
||||
|
||||
CONFIG_FILE = {ATTR_DEVICES: {}}
|
||||
|
||||
@@ -196,7 +196,7 @@ def _load_config(filename):
|
||||
def _save_config(filename, config):
|
||||
"""Save configuration."""
|
||||
try:
|
||||
with open(filename, "w") as fdesc:
|
||||
with open(filename, 'w') as fdesc:
|
||||
fdesc.write(json.dumps(config, cls=JSONEncoder))
|
||||
except (IOError, TypeError) as error:
|
||||
_LOGGER.error("Saving config file failed: %s", error)
|
||||
@@ -237,7 +237,7 @@ def device_name_for_push_id(push_id):
|
||||
|
||||
|
||||
def setup(hass, config):
|
||||
"""Setup the iOS component."""
|
||||
"""Set up the iOS component."""
|
||||
# pylint: disable=global-statement, import-error
|
||||
global CONFIG_FILE
|
||||
global CONFIG_FILE_PATH
|
||||
@@ -249,9 +249,9 @@ def setup(hass, config):
|
||||
if CONFIG_FILE == {}:
|
||||
CONFIG_FILE[ATTR_DEVICES] = {}
|
||||
|
||||
discovery.load_platform(hass, "notify", DOMAIN, {}, config)
|
||||
discovery.load_platform(hass, 'notify', DOMAIN, {}, config)
|
||||
|
||||
discovery.load_platform(hass, "sensor", DOMAIN, {}, config)
|
||||
discovery.load_platform(hass, 'sensor', DOMAIN, {}, config)
|
||||
|
||||
hass.http.register_view(iOSIdentifyDeviceView)
|
||||
|
||||
@@ -265,8 +265,8 @@ def setup(hass, config):
|
||||
class iOSPushConfigView(HomeAssistantView):
|
||||
"""A view that provides the push categories configuration."""
|
||||
|
||||
url = "/api/ios/push"
|
||||
name = "api:ios:push"
|
||||
url = '/api/ios/push'
|
||||
name = 'api:ios:push'
|
||||
|
||||
def __init__(self, push_config):
|
||||
"""Init the view."""
|
||||
@@ -281,8 +281,8 @@ class iOSPushConfigView(HomeAssistantView):
|
||||
class iOSIdentifyDeviceView(HomeAssistantView):
|
||||
"""A view that accepts device identification requests."""
|
||||
|
||||
url = "/api/ios/identify"
|
||||
name = "api:ios:identify"
|
||||
url = '/api/ios/identify'
|
||||
name = 'api:ios:identify'
|
||||
|
||||
@asyncio.coroutine
|
||||
def post(self, request):
|
||||
|
||||
Reference in new issue
Block a user