py linting

Author: mscosti

adafruit_esp32spi/adafruit_esp32spi.py

@@ -624,26 +624,28 @@ def socket_close(self, socket_num):
         if resp[0][0] != 1:
             raise RuntimeError("Failed to close socket")
 
-    def start_server(self, port, socket_num, conn_mode=TCP_MODE, ip=None):
+    def start_server(self, port, socket_num, conn_mode=TCP_MODE, ip=None): # pylint: disable=invalid-name
+        """Opens a server on the specified port, using the ESP32's internal reference number"""
         if self._debug:
             print("*** starting server")
         self._socknum_ll[0][0] = socket_num
         port_param = struct.pack('>H', port)
         if ip:      # use the 4 arg version
             resp = self._send_command_get_response(_START_SERVER_TCP_CMD,
-                                                    (ip,
+                                                   (ip,
                                                     port_param,
                                                     self._socknum_ll[0],
                                                     (conn_mode,)))
         else:       # use the 3 arg version
             resp = self._send_command_get_response(_START_SERVER_TCP_CMD,
-                                                (port_param,
-                                                self._socknum_ll[0],
-                                                (conn_mode,)))
+                                                   (port_param,
+                                                    self._socknum_ll[0],
+                                                    (conn_mode,)))
         if resp[0][0] != 1:
             raise RuntimeError("Could not start server")
 
     def get_server_state(self, socket_num):
+        """Get the state of the ESP32's internal reference server socket number"""
         self._socknum_ll[0][0] = socket_num
         resp = self._send_command_get_response(_GET_STATE_TCP_CMD, self._socknum_ll)
         return resp[0][0]

adafruit_esp32spi/adafruit_esp32spi_requests.py

@@ -204,7 +204,7 @@ def request(method, url, data=None, json=None, headers=None, stream=False, timeo
         reason = ""
         if len(line) > 2:
             reason = line[2].rstrip()
-        resp.headers = self.parse_headers(sock)
+        resp.headers = parse_headers(sock)
         if "chunked" in resp.headers.get("transfer-encoding"):
             raise ValueError("Unsupported " + line)
         elif resp.headers.get("location") and not 200 <= status <= 299:

adafruit_esp32spi/adafruit_esp32spi_server.py

@@ -29,6 +29,7 @@
 
 * Author(s): Matt Costi
 """
+# pylint: disable=no-name-in-module
 
 from micropython import const
 import adafruit_esp32spi.adafruit_esp32spi_socket as socket
@@ -78,10 +79,20 @@ def on(self, method, path, request_handler):
         self._listeners[self._get_listener_key(method, path)] = request_handler
 
     def update_poll(self):
+        """
+        Call this method inside your main event loop to get the server
+        check for new incoming client requests. When a request comes in for
+        which a request handler has been registered with 'on' method, that
+        request handler will be invoked.
+
+        Unrecognized requests will be automatically be responded to with a 404.
+        """
         client = self.client_available()
         if (client and client.available()):
             line = client.readline()
-            method, path, ver = line.split(None, 2)
+            line = line.split(None, 2)
+            method = line[0]
+            path = line[1]
             key = self._get_listener_key(method, path)
             if key in self._listeners:
                 headers = parse_headers(client)
@@ -90,7 +101,7 @@ def update_poll(self):
                 print("body: ", body)
                 self._listeners[key](headers, body, client)
             else:
-                # TODO: support optional custom 404 callback?
+                # TODO: support optional custom 404 handler?
                 client.write(b"HTTP/1.1 404 NotFound\r\n")
                 client.close()
 
@@ -127,5 +138,5 @@ def client_available(self):
 
         return None
 
-    def _get_listener_key(self, method, path):
+    def _get_listener_key(self, method, path): # pylint: disable=no-self-use
         return "{0}|{1}".format(str(method.lower(), 'utf-8'), str(path, 'utf-8'))

adafruit_esp32spi/adafruit_esp32spi_socket.py

@@ -32,7 +32,6 @@
 
 import time
 import gc
-import adafruit_esp32spi as esp
 from micropython import const
 
 _the_interface = None   # pylint: disable=invalid-name
@@ -92,7 +91,7 @@ def readline(self):
         stamp = time.monotonic()
         while b'\r\n' not in self._buffer:
             # there's no line already in there, read some more
-            avail = min(_the_interface.socket_available(self._socknum), MAX_PACKET)
+            avail = self.available()
             if avail:
                 self._buffer += _the_interface.socket_read(self._socknum, avail)
             elif self._timeout > 0 and time.monotonic() - stamp > self._timeout:
@@ -108,7 +107,7 @@ def read(self, size=0):
         #print("Socket read", size)
         if size == 0:   # read as much as we can at the moment
             while True:
-                avail = min(_the_interface.socket_available(self._socknum), MAX_PACKET)
+                avail = self.available()
                 if avail:
                     self._buffer += _the_interface.socket_read(self._socknum, avail)
                 else:
@@ -124,7 +123,7 @@ def read(self, size=0):
         received = []
         while to_read > 0:
             #print("Bytes to read:", to_read)
-            avail = min(_the_interface.socket_available(self._socknum), MAX_PACKET)
+            avail = self.available()
             if avail:
                 stamp = time.monotonic()
                 recv = _the_interface.socket_read(self._socknum, min(to_read, avail))
@@ -151,11 +150,13 @@ def settimeout(self, value):
         self._timeout = value
 
     def available(self):
+        """Returns how many bytes of data are available to be read (up to the MAX_PACKET length)"""
         if self.socknum != NO_SOCKET_AVAIL:
             return min(_the_interface.socket_available(self._socknum), MAX_PACKET)
         return 0
 
     def connected(self):
+        """Whether or not we are connected to the socket"""
         if self.socknum == NO_SOCKET_AVAIL:
             return False
         elif self.available():
@@ -178,6 +179,7 @@ def connected(self):
 
     @property
     def socknum(self):
+        """The socket number"""
         return self._socknum
 
     def close(self):

adafruit_esp32spi/adafruit_esp32spi_wifimanager.py

@@ -38,6 +38,7 @@ class ESPSPI_WiFiManager:
     """
     A class to help manage the Wifi connection
     """
+    # pylint: disable=too-many-arguments
     def __init__(self, esp, secrets, status_pixel=None, attempts=2, debug=False):
         """
         :param ESP_SPIcontrol esp: The ESP object we are using
@@ -56,6 +57,7 @@ def __init__(self, esp, secrets, status_pixel=None, attempts=2, debug=False):
         requests.set_interface(self.esp)
         self.statuspix = status_pixel
         self.pixel_status(0)
+    # pylint: enable=too-many-arguments
 
     def reset(self):
         """