Merge pull request #51 from davidrecordon/line-lengths

Fix line length lint issues across codebase

Author: lawtancool

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 88

pyControl4/__init__.py

@@ -3,7 +3,8 @@ def __init__(self, C4Director, item_id):
         """Creates a Control4 object.
 
         Parameters:
-            `C4Director` - A `pyControl4.director.C4Director` object that corresponds to the Control4 Director that the device is connected to.
+            `C4Director` - A `pyControl4.director.C4Director` object that corresponds
+                to the Control4 Director that the device is connected to.
 
             `item_id` - The Control4 item ID.
         """

pyControl4/account.py

@@ -33,8 +33,10 @@ def __init__(
 
             `password` - Control4 account password.
 
-            `session` - (Optional) Allows the use of an `aiohttp.ClientSession` object for all network requests. This session will not be closed by the library.
-            If not provided, the library will open and close its own `ClientSession`s as needed.
+            `session` - (Optional) Allows the use of an `aiohttp.ClientSession`
+                object for all network requests. This session will not be closed
+                by the library. If not provided, the library will open and close
+                its own `ClientSession`s as needed.
         """
         self.username = username
         self.password = password
@@ -88,7 +90,10 @@ async def __sendAccountGetRequest(self, uri):
         try:
             headers = {"Authorization": "Bearer {}".format(self.account_bearer_token)}
         except AttributeError:
-            msg = "The account bearer token is missing - was your username/password correct? "
+            msg = (
+                "The account bearer token is missing. "
+                "Is your username/password correct?"
+            )
             _LOGGER.error(msg)
             raise
         if self.session is None:
@@ -108,12 +113,16 @@ async def __sendControllerAuthRequest(self, controller_common_name):
         entire JSON response from the Control4 auth API.
 
         Parameters:
-            `controller_common_name`: Common name of the controller. See `getAccountControllers()` for details.
+            `controller_common_name`: Common name of the controller.
+                See `getAccountControllers()` for details.
         """
         try:
             headers = {"Authorization": "Bearer {}".format(self.account_bearer_token)}
         except AttributeError:
-            msg = "The account bearer token is missing - was your username/password correct? "
+            msg = (
+                "The account bearer token is missing. "
+                "Is your username/password correct?"
+            )
             _LOGGER.error(msg)
             raise
         dataDictionary = {
@@ -150,12 +159,16 @@ async def getAccountBearerToken(self):
             self.account_bearer_token = jsonDictionary["authToken"]["token"]
             return self.account_bearer_token
         except KeyError:
-            msg = "Did not recieve an account bearer token. Is your username/password correct? "
+            msg = (
+                "Did not recieve an account bearer token. "
+                "Is your username/password correct?"
+            )
             _LOGGER.error(msg + data)
             raise
 
     async def getAccountControllers(self):
-        """Returns a dictionary of the information for all controllers registered to an account.
+        """Returns a dictionary of the information for all controllers registered
+        to an account.
 
         Returns:
             ```
@@ -174,7 +187,8 @@ async def getControllerInfo(self, controller_href):
         """Returns a dictionary of the information of a specific controller.
 
         Parameters:
-            `controller_href` - The API `href` of the controller (get this from the output of `getAccountControllers()`)
+            `controller_href` - The API `href` of the controller (get this from
+                the output of `getAccountControllers()`)
 
         Returns:
             ```
@@ -184,7 +198,7 @@ async def getControllerInfo(self, controller_href):
                 'blockNotifications': False,
                 'controllerCommonName': 'control4_MODEL_MACADDRESS',
                 'controller': {
-                    'href': 'https://apis.control4.com/account/v3/rest/accounts/000000/controller'
+                    'href': 'https://apis.control4.com/account/v3/rest/accounts/000000/controller'  # noqa: E501
                 },
                 'created': '2017-08-26T18:33:31Z',
                 'dealer': {
@@ -196,7 +210,7 @@ async def getControllerInfo(self, controller_href):
                 'id': 000000,
                 'lastCheckIn': '2020-06-13T21:52:34Z',
                 'licenses': {
-                    'href': 'https://apis.control4.com/account/v3/rest/accounts/000000/licenses'
+                    'href': 'https://apis.control4.com/account/v3/rest/accounts/000000/licenses'  # noqa: E501
                 },
                 'modified': '2020-06-13T21:52:34Z',
                 'name': 'Name',
@@ -206,7 +220,7 @@ async def getControllerInfo(self, controller_href):
                 },
                 'type': 'Consumer',
                 'users': {
-                    'href': 'https://apis.control4.com/account/v3/rest/accounts/000000/users'
+                    'href': 'https://apis.control4.com/account/v3/rest/accounts/000000/users'  # noqa: E501
                 }
             }
             ```
@@ -219,17 +233,20 @@ async def getControllerOSVersion(self, controller_href):
         """Returns the OS version of a controller as a string.
 
         Parameters:
-            `controller_href` - The API `href` of the controller (get this from the output of `getAccountControllers()`)
+            `controller_href` - The API `href` of the controller (get this from
+                the output of `getAccountControllers()`)
         """
         data = await self.__sendAccountGetRequest(controller_href + "/controller")
         jsonDictionary = json.loads(data)
         return jsonDictionary["osVersion"]
 
     async def getDirectorBearerToken(self, controller_common_name):
-        """Returns a dictionary with a director bearer token for making Control4 Director API requests, and its time valid in seconds (usually 86400 seconds)
+        """Returns a dictionary with a director bearer token for making Control4
+        Director API requests, and its time valid in seconds (usually 86400 seconds)
 
         Parameters:
-            `controller_common_name`: Common name of the controller. See `getAccountControllers()` for details.
+            `controller_common_name`: Common name of the controller.
+                See `getAccountControllers()` for details.
         """
         data = await self.__sendControllerAuthRequest(controller_common_name)
         jsonDictionary = json.loads(data)

pyControl4/alarm.py

@@ -1,12 +1,16 @@
-"""Controls Control4 security panel and contact sensor (door, window, motion) devices."""
+"""Controls Control4 security panel and contact sensor (door, window, motion)
+devices.
+"""
 
 import json
 from pyControl4 import C4Entity
 
 
 class C4SecurityPanel(C4Entity):
     async def getArmState(self):
-        """Returns the arm state of the security panel as "DISARMED", "ARMED_HOME", or "ARMED_AWAY"."""
+        """Returns the arm state of the security panel as "DISARMED", "ARMED_HOME",
+        or "ARMED_AWAY".
+        """
         disarmed = await self.director.getItemVariableValue(
             self.item_id, "DISARMED_STATE"
         )
@@ -47,22 +51,27 @@ async def getTroubleText(self):
     async def getPartitionState(self):
         """Returns the partition state of the security panel.
 
-        Possible values include "DISARMED_NOT_READY", "DISARMED_READY", "ARMED_HOME", "ARMED_AWAY", "EXIT_DELAY", "ENTRY_DELAY"
+        Possible values include "DISARMED_NOT_READY", "DISARMED_READY", "ARMED_HOME",
+        "ARMED_AWAY", "EXIT_DELAY", "ENTRY_DELAY"
         """
         partition_state = await self.director.getItemVariableValue(
             self.item_id, "PARTITION_STATE"
         )
         return partition_state
 
     async def getDelayTimeTotal(self):
-        """Returns the total exit delay time. Returns 0 if an exit delay is not currently running."""
+        """Returns the total exit delay time. Returns 0 if an exit delay is not
+        currently running.
+        """
         delay_time_total = await self.director.getItemVariableValue(
             self.item_id, "DELAY_TIME_TOTAL"
         )
         return delay_time_total
 
     async def getDelayTimeRemaining(self):
-        """Returns the remaining exit delay time. Returns 0 if an exit delay is not currently running."""
+        """Returns the remaining exit delay time. Returns 0 if an exit delay is
+        not currently running.
+        """
         delay_time_remaining = await self.director.getItemVariableValue(
             self.item_id, "DELAY_TIME_REMAINING"
         )
@@ -109,7 +118,8 @@ async def setArm(self, usercode, mode: str):
         Parameters:
             `usercode` - PIN/code for arming the system.
 
-            `mode` - Arm mode to use. This depends on what is supported by the security panel itself.
+            `mode` - Arm mode to use. This depends on what is supported by the
+                security panel itself.
         """
         usercode = str(usercode)
         await self.director.sendPostRequest(
@@ -168,7 +178,8 @@ async def triggerEmergency(self, type):
         )
 
     async def sendKeyPress(self, key):
-        """Sends a single keypress to the security panel's virtual keypad (if supported).
+        """Sends a single keypress to the security panel's virtual keypad (if
+        supported).
 
         Parameters:
             `key` - Keypress to send. Only one key at a time.
@@ -186,15 +197,18 @@ def __init__(self, C4Director, item_id):
         """Creates a Control4 Contact Sensor object.
 
         Parameters:
-            `C4Director` - A `pyControl4.director.C4Director` object that corresponds to the Control4 Director that the security panel is connected to.
+            `C4Director` - A `pyControl4.director.C4Director` object that corresponds
+                to the Control4 Director that the security panel is connected to.
 
             `item_id` - The Control4 item ID of the contact sensor.
         """
         self.director = C4Director
         self.item_id = item_id
 
     async def getContactState(self):
-        """Returns `True` if contact is triggered (door/window is closed, motion is detected), otherwise returns `False`."""
+        """Returns `True` if contact is triggered (door/window is closed, motion is
+        detected), otherwise returns `False`.
+        """
         contact_state = await self.director.getItemVariableValue(
             self.item_id, "ContactState"
         )

pyControl4/blind.py

@@ -5,15 +5,18 @@
 
 class C4Blind(C4Entity):
     async def getBatteryLevel(self):
-        """Returns the battery of a blind. We currently don't know the range or meaning."""
+        """Returns the battery of a blind. We currently don't know the range or
+        meaning.
+        """
         value = await self.director.getItemVariableValue(self.item_id, "Battery Level")
         if value is None:
             return None
         return int(value)
 
     async def getClosing(self):
-        """Returns an indication of whether the blind is moving in the closed direction as a boolean
-        (True=closing, False=opening). If the blind is stopped, reports the direction it last moved.
+        """Returns an indication of whether the blind is moving in the closed direction
+        as a boolean (True=closing, False=opening). If the blind is stopped, reports
+        the direction it last moved.
         """
         value = await self.director.getItemVariableValue(self.item_id, "Closing")
         if value is None:
@@ -46,16 +49,18 @@ async def getLevel(self):
         return int(value)
 
     async def getOpen(self):
-        """Returns an indication of whether the blind is open as a boolean (True=open, False=closed).
-        This is true even if the blind is only partially open."""
+        """Returns an indication of whether the blind is open as a boolean (True=open,
+        False=closed). This is true even if the blind is only partially open.
+        """
         value = await self.director.getItemVariableValue(self.item_id, "Open")
         if value is None:
             return None
         return bool(value)
 
     async def getOpening(self):
-        """Returns an indication of whether the blind is moving in the open direction as a boolean
-        (True=opening, False=closing). If the blind is stopped, reports the direction it last moved.
+        """Returns an indication of whether the blind is moving in the open direction
+        as a boolean (True=opening, False=closing). If the blind is stopped, reports
+        the direction it last moved.
         """
         value = await self.director.getItemVariableValue(self.item_id, "Opening")
         if value is None:
@@ -110,16 +115,19 @@ async def setLevelTarget(self, level):
         )
 
     async def stop(self):
-        """Stops the blind if it is moving. Shortly after stopping, the target level will be
-        set to the level the blind had actually reached when it stopped."""
+        """Stops the blind if it is moving. Shortly after stopping, the target level
+        will be set to the level the blind had actually reached when it stopped.
+        """
         await self.director.sendPostRequest(
             "/api/v1/items/{}/commands".format(self.item_id),
             "STOP",
             {},
         )
 
     async def toggle(self):
-        """Toggles the blind between open and closed. Has no effect if the blind is partially open."""
+        """Toggles the blind between open and closed. Has no effect if the blind is
+        partially open.
+        """
         await self.director.sendPostRequest(
             "/api/v1/items/{}/commands".format(self.item_id),
             "TOGGLE",

pyControl4/director.py

@@ -217,7 +217,8 @@ async def getItemBindings(self, item_id):
         return await self.sendGetRequest("/api/v1/items/{}/bindings".format(item_id))
 
     async def getUiConfiguration(self):
-        """Returns a dictionary of the JSON Control4 App UI Configuration enumerating rooms and capabilities
+        """Returns a dictionary of the JSON Control4 App UI Configuration enumerating
+        rooms and capabilities
 
         Returns:
 

pyControl4/light.py

@@ -14,7 +14,9 @@ async def getLevel(self):
         return int(value)
 
     async def getState(self):
-        """Returns the power state of a dimmer or switch as a boolean (True=on, False=off)."""
+        """Returns the power state of a dimmer or switch as a boolean (True=on,
+        False=off).
+        """
         value = await self.director.getItemVariableValue(self.item_id, "LIGHT_STATE")
         if value is None:
             return None

pyControl4/relay.py

@@ -1,4 +1,6 @@
-"""Controls Control4 Relay devices. These can include locks, and potentially other types of devices."""
+"""Controls Control4 Relay devices. These can include locks, and potentially other
+types of devices.
+"""
 
 from pyControl4 import C4Entity