Merge branch 'main'

# Conflicts:
#	examples/wiznet5k_wsgiserver_test.py

Author: FoamyGuy

.github/workflows/build.yml

@@ -42,9 +42,9 @@ jobs:
       # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.)
       run: |
         source actions-ci/install.sh
-    - name: Pip install pylint, Sphinx, pre-commit
+    - name: Pip install Sphinx, pre-commit
       run: |
-        pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit
+        pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit
     - name: Library version
       run: git describe --dirty --always --tags
     - name: Pre-commit hooks

.pre-commit-config.yaml

@@ -18,17 +18,25 @@ repos:
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
 -   repo: https://github.com/pycqa/pylint
-    rev: pylint-2.7.1
+    rev: v2.11.1
     hooks:
     -   id: pylint
         name: pylint (library code)
         types: [python]
-        exclude: "^(docs/|examples/|setup.py$)"
--   repo: local
-    hooks:
-    -   id: pylint_examples
-        name: pylint (examples code)
+        args:
+          - --disable=consider-using-f-string
+        exclude: "^(docs/|examples/|tests/|setup.py$)"
+    -   id: pylint
+        name: pylint (example code)
         description: Run pylint rules on "examples/*.py" files
-        entry: /usr/bin/env bash -c
-        args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name $example; done)']
-        language: system
+        types: [python]
+        files: "^examples/"
+        args:
+        - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code
+    -   id: pylint
+        name: pylint (test code)
+        description: Run pylint rules on "tests/*.py" files
+        types: [python]
+        files: "^tests/"
+        args:
+        - --disable=missing-docstring,consider-using-f-string,duplicate-code

.pylintrc

@@ -55,7 +55,7 @@ confidence=
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
 # disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call
-disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation
+disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation,unspecified-encoding
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
@@ -252,7 +252,7 @@ ignore-docstrings=yes
 ignore-imports=yes
 
 # Minimum lines number of a similarity.
-min-similarity-lines=12
+min-similarity-lines=4
 
 
 [BASIC]

.readthedocs.yaml

@@ -0,0 +1,15 @@
+# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+python:
+  version: "3.7"
+  install:
+    - requirements: docs/requirements.txt
+    - requirements: requirements.txt

.readthedocs.yml

@@ -166,6 +166,11 @@ This example demonstrates a simple web server that allows setting the Neopixel c
         eth.maintain_dhcp_lease()
         # Could do any other background tasks here, like reading sensors
 
+Documentation
+=============
+
+API documentation for this library can be found on `Read the Docs <https://circuitpython.readthedocs.io/projects/wiznet5k/en/latest/>`_.
+
 Contributing
 ============
 

README.rst

@@ -192,8 +192,8 @@ def send_dhcp_message(self, state, time_elapsed, renew=False):
         # HW Type - ETH
         _BUFF[245] = 0x01
         # Client MAC Address
-        for mac in range(0, len(self._mac_address)):
-            _BUFF[246 + mac] = self._mac_address[mac]
+        for mac, val in enumerate(self._mac_address):
+            _BUFF[246 + mac] = val
 
         # Option - Host Name
         _BUFF[252] = 12
@@ -471,23 +471,24 @@ def _dhcp_state_machine(self):
                     print("* DHCP: Time to renew lease")
 
         if (
-            self._dhcp_state == STATE_DHCP_DISCOVER
-            or self._dhcp_state == STATE_DHCP_REQUEST
-        ) and time.monotonic() > (self._start_time + self._response_timeout):
+            self._dhcp_state
+            in (
+                STATE_DHCP_DISCOVER,
+                STATE_DHCP_REQUEST,
+            )
+            and time.monotonic() > (self._start_time + self._response_timeout)
+        ):
             self._dhcp_state = STATE_DHCP_WAIT
             if self._sock is not None:
                 self._sock.close()
                 self._sock = None
 
     def request_dhcp_lease(self):
         """Request to renew or acquire a DHCP lease."""
-        if self._dhcp_state == STATE_DHCP_LEASED or self._dhcp_state == STATE_DHCP_WAIT:
+        if self._dhcp_state in (STATE_DHCP_LEASED, STATE_DHCP_WAIT):
             self._dhcp_state = STATE_DHCP_START
 
-        while (
-            self._dhcp_state != STATE_DHCP_LEASED
-            and self._dhcp_state != STATE_DHCP_WAIT
-        ):
+        while self._dhcp_state not in (STATE_DHCP_LEASED, STATE_DHCP_WAIT):
             self._dhcp_state_machine()
 
         return self._dhcp_state == STATE_DHCP_LEASED

adafruit_wiznet5k/adafruit_wiznet5k_dhcp.py

@@ -0,0 +1,5 @@
+# SPDX-FileCopyrightText: 2021 Kattni Rembor for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
+sphinx>=4.0.0

docs/requirements.txt

@@ -31,24 +31,24 @@
 print("Wiznet5k Web Server Test")
 
 
-def get_mac(_i2c):
+def get_mac(i2c_obj):
     "Read MAC from 24AA02E48 chip and return it"
-    _mac = bytearray(6)
-    while not _i2c.try_lock():
+    mac_addr = bytearray(6)
+    while not i2c_obj.try_lock():
         pass
-    _i2c.writeto(0x50, bytearray((0xFA,)))
-    _i2c.readfrom_into(0x50, _mac, start=0, end=6)
-    _i2c.unlock()
-    return _mac
+    i2c_obj.writeto(0x50, bytearray((0xFA,)))
+    i2c_obj.readfrom_into(0x50, mac_addr, start=0, end=6)
+    i2c_obj.unlock()
+    return mac_addr
 
 
 def get_static_file(filename):
     "Static file generator"
     with open(filename, "rb") as f:
-        _bytes = None
-        while _bytes is None or len(_bytes) == 2048:
-            _bytes = f.read(2048)
-            yield _bytes
+        b = None
+        while b is None or len(b) == 2048:
+            b = f.read(2048)
+            yield b
 
 
 # Status LED