Removed TODOs and tidied up.

Author: BiffoBear

adafruit_wiznet5k/adafruit_wiznet5k.py

@@ -150,7 +150,7 @@ def __init__(
         is_dhcp: bool = True,
         mac: Union[List[int], Tuple[int]] = DEFAULT_MAC,
         hostname: Optional[str] = None,
-        dhcp_timeout: float = 30,
+        dhcp_timeout: float = 30.0,
         debug: bool = False,
     ) -> None:
         """
@@ -162,7 +162,7 @@ def __init__(
             (0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED).
         :param str hostname: The desired hostname, with optional {} to fill in the MAC
             address, defaults to None.
-        :param float dhcp_timeout: Timeout in seconds for DHCP response, defaults to 30.
+        :param float dhcp_timeout: Timeout in seconds for DHCP response, defaults to 30.0.
         :param bool debug: Enable debugging output, defaults to False.
         """
         self._debug = debug
@@ -406,7 +406,6 @@ def remote_port(self, socket_num: int) -> Union[int, bytearray]:
 
         :return Union[int, bytearray]: The port number of the socket connection.
         """
-        # TODO: why return the buffer?
         if socket_num >= self.max_sockets:
             return self._pbuff
         for octet in range(2):
@@ -439,7 +438,6 @@ def ifconfig(
         :params Tuple[bytearray, bytearray, bytearray, Tuple[int, int, int, int]]: \
         Configuration settings - (ip_address, subnet_mask, gateway_address, dns_server).
         """
-        # TODO: Might be better if params can be str as well
         ip_address, subnet_mask, gateway_address, dns_server = params
 
         self.write(REG_SIPR, 0x04, ip_address)
@@ -455,7 +453,6 @@ def _w5100_init(self) -> int:
         :return int: 1 if the initialization succeeds, 0 if it fails.
         """
         time.sleep(1)
-        # TODO: Isn't the CS pin initialized in busio?
         self._cs.switch_to_output()
         self._cs.value = 1
 
@@ -525,7 +522,6 @@ def sw_reset(self) -> int:
 
         :return int: 0 if the reset succeeds, -1 if not.
         """
-        # TODO: mode_reg appears to be unused, maybe self._read_mr starts the reset?
         mode_reg = self._read_mr()
         self._write_mr(0x80)
         mode_reg = self._read_mr()
@@ -589,7 +585,6 @@ def write(
         :param int callback: Callback reference.
         :param Union[int, Sequence[Union[int, bytes]]] data: Data to write to the register address.
         """
-        # TODO: Call with int means an error in a previous function
         with self._device as bus_device:
             if self._chip_type == "w5500":
                 bus_device.write(bytes([addr >> 8]))  # pylint: disable=no-member
@@ -688,7 +683,7 @@ def socket_connect(
         # initialize a socket and set the mode
         res = self.socket_open(socket_num, conn_mode=conn_mode)
         if res == 1:
-            raise RuntimeError("Failed to initalize a connection with the socket.")
+            raise RuntimeError("Failed to initialize a connection with the socket.")
 
         # set socket destination IP and port
         self._write_sndipr(socket_num, dest)
@@ -758,7 +753,7 @@ def socket_listen(
         res = self.socket_open(socket_num, conn_mode=conn_mode)
         self.src_port = 0
         if res == 1:
-            raise RuntimeError("Failed to initalize the socket.")
+            raise RuntimeError("Failed to initialize the socket.")
         # Send listen command
         self._send_socket_cmd(socket_num, CMD_SOCK_LISTEN)
         # Wait until ready
@@ -979,7 +974,7 @@ def socket_write(
         assert socket_num <= self.max_sockets, "Provided socket exceeds max_sockets."
         status = 0
         ret = 0
-        free_size = 0  # TODO: Bug report
+        free_size = 0
         if len(buffer) > SOCK_SIZE:
             ret = SOCK_SIZE
         else:
@@ -1020,7 +1015,7 @@ def socket_write(
                 dst_addr = socket_num * SOCK_SIZE + 0x4000
                 self.write(dst_addr, 0x00, txbuf)
             else:
-                txbuf = buffer[:ret]  # TODO: Bug report
+                txbuf = buffer[:ret]
                 self.write(dst_addr, 0x00, buffer[:ret])
 
         # update sn_tx_wr to the value + data size
@@ -1153,5 +1148,4 @@ def _read_socket(self, sock: int, address: int) -> Optional[bytearray]:  # *1
         if self._chip_type == "w5100s":
             cntl_byte = 0
             return self.read(self._ch_base_msb + sock * CH_SIZE + address, cntl_byte)
-        # TODO: If the chip is not supported, this should raise an exception.
         return None

adafruit_wiznet5k/adafruit_wiznet5k_dhcp.py

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2009 Jordan Terell (blog.jordanterrell.com)
+# SPDX-FileCopyrightText: 2009 Jordan Terrell (blog.jordanterrell.com)
 # SPDX-FileCopyrightText: 2020 Brent Rubell for Adafruit Industries
 # SPDX-FileCopyrightText: 2021 Patrick Van Oosterwijck @ Silicognition LLC
 #

adafruit_wiznet5k/adafruit_wiznet5k_dns.py

@@ -68,7 +68,7 @@ def __init__(
         self._sock.settimeout(1)
 
         self._dns_server = dns_address
-        self._host = 0
+        self._host = b""
         self._request_id = 0  # request identifier
         self._pkt_buf = bytearray()
 
@@ -136,7 +136,7 @@ def _parse_dns_response(
         if not xid == self._request_id:
             if self._debug:
                 print(
-                    "* DNS ERROR: Received request identifer {} \
+                    "* DNS ERROR: Received request identifier {} \
                       does not match expected {}".format(
                         xid, self._request_id
                     )

adafruit_wiznet5k/adafruit_wiznet5k_ntp.py

@@ -38,7 +38,7 @@ def __init__(
         self,
         iface: WIZNET5K,
         ntp_address: str,
-        utc: int,
+        utc: float,
         debug: bool = False,
     ) -> None:
         """
@@ -64,7 +64,7 @@ def get_time(self) -> time.struct_time:
         """
         Get the time from the NTP server.
 
-        :return int: Time in seconds since the epoch.
+        :return time.struct_time: The local time.
         """
         self._sock.bind((None, 50001))
         self._sock.sendto(self._pkt_buf_, (self._ntp_server, 123))
@@ -73,6 +73,7 @@ def get_time(self) -> time.struct_time:
             if data:
                 sec = data[40:44]
                 int_cal = int.from_bytes(sec, "big")
-                cal = int_cal - 2208988800 + self._utc * 3600
+                # UTC offset may be a float as some offsets are half hours so force int.
+                cal = int(int_cal - 2208988800 + self._utc * 3600)
                 cal = time.localtime(cal)
                 return cal

adafruit_wiznet5k/adafruit_wiznet5k_socket.py

@@ -148,8 +148,8 @@ def __init__(
         family: int = AF_INET,
         type: int = SOCK_STREAM,
         proto: Any = 0,
-        fileno: Optional[Any] = None,
-        socknum: Optional[Any] = None,
+        fileno: Optional[int] = None,
+        socknum: Optional[int] = None,
     ) -> None:
         """
         :param int family: Socket address (and protocol) family, defaults to AF_INET.
@@ -315,7 +315,7 @@ def accept(
 
         new_listen_socknum, addr = _the_interface.socket_accept(self.socknum)
         current_socknum = self.socknum
-        # Create a new socket object and swap socket nums so we can continue listening
+        # Create a new socket object and swap socket nums, so we can continue listening
         client_sock = socket()
         client_sock._socknum = current_socknum  # pylint: disable=protected-access
         self._socknum = new_listen_socknum  # pylint: disable=protected-access

adafruit_wiznet5k/adafruit_wiznet5k_wsgiserver.py

@@ -181,7 +181,7 @@ def _get_environ(self, client: socket.socket) -> Dict:
         The application callable will be given the resulting environ dictionary.
         It contains metadata about the incoming request and the request body ("wsgi.input")
 
-        :param socket.socket client: socket to read the request from
+        :param socket.socket client: socket to read the request from.
 
         :return Dict: Data for the application callable.
         """