Merge branch 'main' into settings_dot_toml

FoamyGuy · FoamyGuy · commit de679a6796ad · 2023-07-07T12:51:41.000-05:00
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -4,21 +4,21 @@
 
 repos:
   - repo: https://github.com/python/black
-    rev: 22.3.0
+    rev: 23.3.0
     hooks:
       - id: black
   - repo: https://github.com/fsfe/reuse-tool
-    rev: v0.14.0
+    rev: v1.1.2
     hooks:
       - id: reuse
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.2.0
+    rev: v4.4.0
     hooks:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/pycqa/pylint
-    rev: v2.15.5
+    rev: v2.17.4
     hooks:
       - id: pylint
         name: pylint (library code)
diff --git a/.pylintrc b/.pylintrc
@@ -396,4 +396,4 @@ min-public-methods=1
 
 # Exceptions that will emit a warning when being caught. Defaults to
 # "Exception"
-overgeneral-exceptions=Exception
+overgeneral-exceptions=builtins.Exception
diff --git a/adafruit_minimqtt/adafruit_minimqtt.py b/adafruit_minimqtt/adafruit_minimqtt.py
@@ -191,7 +191,6 @@ def __init__(
         connect_retries: int = 5,
         user_data=None,
     ) -> None:
-
         self._socket_pool = socket_pool
         self._ssl_context = ssl_context
         self._sock = None
diff --git a/adafruit_minimqtt/matcher.py b/adafruit_minimqtt/matcher.py
@@ -70,11 +70,10 @@ def __delitem__(self, key: str) -> None:
             node.content = None
         except KeyError:
             raise KeyError(key) from None
-        else:  # cleanup
-            for parent, k, node in reversed(lst):
-                if node.children or node.content is not None:
-                    break
-                del parent.children[k]
+        for parent, k, node in reversed(lst):
+            if node.children or node.content is not None:
+                break
+            del parent.children[k]
 
     def iter_match(self, topic: str):
         """Return an iterator on all values associated with filters
diff --git a/docs/conf.py b/docs/conf.py
@@ -17,6 +17,7 @@
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
+    "sphinxcontrib.jquery",
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
     "sphinx.ext.todo",
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -3,3 +3,4 @@
 # SPDX-License-Identifier: Unlicense
 
 sphinx>=4.0.0
+sphinxcontrib-jquery
diff --git a/examples/cellular/minimqtt_adafruitio_cellular.py b/examples/cellular/minimqtt_adafruitio_cellular.py
@@ -36,6 +36,7 @@
 
 ### Code ###
 
+
 # Define callback methods which are called when events occur
 # pylint: disable=unused-argument, redefined-outer-name
 def connected(client, userdata, flags, rc):
diff --git a/examples/cellular/minimqtt_simpletest_cellular.py b/examples/cellular/minimqtt_simpletest_cellular.py
@@ -38,6 +38,7 @@
 
 ### Code ###
 
+
 # Define callback methods which are called when events occur
 # pylint: disable=unused-argument, redefined-outer-name
 def connect(client, userdata, flags, rc):
diff --git a/examples/cpython/minimqtt_adafruitio_cpython.py b/examples/cpython/minimqtt_adafruitio_cpython.py
@@ -25,6 +25,7 @@
 
 ### Code ###
 
+
 # Define callback methods which are called when events occur
 # pylint: disable=unused-argument, redefined-outer-name
 def connected(client, userdata, flags, rc):
diff --git a/examples/cpython/minimqtt_simpletest_cpython.py b/examples/cpython/minimqtt_simpletest_cpython.py
@@ -25,6 +25,7 @@
 # Use this topic if you'd like to connect to io.adafruit.com
 # mqtt_topic = secrets["aio_username"] + "/feeds/temperature"
 
+
 ### Code ###
 # Define callback methods which are called when events occur
 # pylint: disable=unused-argument, redefined-outer-name
diff --git a/examples/esp32spi/minimqtt_certificate_esp32spi.py b/examples/esp32spi/minimqtt_certificate_esp32spi.py
@@ -59,6 +59,7 @@
 
 ### Code ###
 
+
 # Define callback methods which are called when events occur
 # pylint: disable=unused-argument, redefined-outer-name
 def connect(client, userdata, flags, rc):
diff --git a/examples/esp32spi/minimqtt_pub_sub_blocking_topic_callbacks_esp32spi.py b/examples/esp32spi/minimqtt_pub_sub_blocking_topic_callbacks_esp32spi.py
@@ -50,6 +50,7 @@
 
 ### Code ###
 
+
 # Define callback methods which are called when events occur
 # pylint: disable=unused-argument, redefined-outer-name
 def connected(client, userdata, flags, rc):
diff --git a/examples/esp32spi/minimqtt_pub_sub_nonblocking_esp32spi.py b/examples/esp32spi/minimqtt_pub_sub_nonblocking_esp32spi.py
@@ -51,6 +51,7 @@
 default_topic = aio_username + "/feeds/testfeed"
 
 
+
 ### Code ###
 # Define callback methods which are called when events occur
 # pylint: disable=unused-argument, redefined-outer-name
diff --git a/examples/esp32spi/minimqtt_pub_sub_pyportal_esp32spi.py b/examples/esp32spi/minimqtt_pub_sub_pyportal_esp32spi.py
@@ -21,6 +21,7 @@
 # ------------- MQTT Topic Setup ------------- #
 mqtt_topic = "test/topic"
 
+
 ### Code ###
 # Define callback methods which are called when events occur
 # pylint: disable=unused-argument, redefined-outer-name
diff --git a/examples/ethernet/minimqtt_adafruitio_eth.py b/examples/ethernet/minimqtt_adafruitio_eth.py
@@ -34,6 +34,7 @@
 
 ### Code ###
 
+
 # Define callback methods which are called when events occur
 # pylint: disable=unused-argument, redefined-outer-name
 def connected(client, userdata, flags, rc):
diff --git a/examples/ethernet/minimqtt_simpletest_eth.py b/examples/ethernet/minimqtt_simpletest_eth.py
@@ -33,6 +33,7 @@
 
 ### Code ###
 
+
 # Define callback methods which are called when events occur
 # pylint: disable=unused-argument, redefined-outer-name
 def connect(client, userdata, flags, rc):
diff --git a/examples/minimqtt_simpletest.py b/examples/minimqtt_simpletest.py
@@ -50,6 +50,7 @@
 # Use this topic if you'd like to connect to io.adafruit.com
 mqtt_topic = aio_username + "/feeds/temperature"
 
+
 ### Code ###
 
 
diff --git a/examples/native_networking/minimqtt_adafruitio_native_networking.py b/examples/native_networking/minimqtt_adafruitio_native_networking.py
@@ -57,6 +57,16 @@ def message(client, topic, message):
 
 # Create a socket pool
 pool = socketpool.SocketPool(wifi.radio)
+ssl_context = ssl.create_default_context()
+
+# If you need to use certificate/key pair authentication (e.g. X.509), you can load them in the
+# ssl context by uncommenting the lines below and adding the following keys to the "secrets"
+# dictionary in your secrets.py file:
+# "device_cert_path" - Path to the Device Certificate
+# "device_key_path" - Path to the RSA Private Key
+# ssl_context.load_cert_chain(
+#     certfile=secrets["device_cert_path"], keyfile=secrets["device_key_path"]
+# )
 
 # Set up a MiniMQTT Client
 mqtt_client = MQTT.MQTT(
@@ -65,7 +75,7 @@ def message(client, topic, message):
     username=aio_username,
     password=aio_key,
     socket_pool=pool,
-    ssl_context=ssl.create_default_context(),
+    ssl_context=ssl_context,
 )
 
 # Setup the callback methods above
diff --git a/examples/native_networking/minimqtt_pub_sub_blocking_native_networking.py b/examples/native_networking/minimqtt_pub_sub_blocking_native_networking.py
@@ -30,6 +30,7 @@
 default_topic = aio_username + "/feeds/testfeed"
 
 
+
 ### Code ###
 # Define callback methods which are called when events occur
 # pylint: disable=unused-argument, redefined-outer-name
@@ -57,6 +58,16 @@ def message(client, topic, message):
 
 # Create a socket pool
 pool = socketpool.SocketPool(wifi.radio)
+ssl_context = ssl.create_default_context()
+
+# If you need to use certificate/key pair authentication (e.g. X.509), you can load them in the
+# ssl context by uncommenting the lines below and adding the following keys to the "secrets"
+# dictionary in your secrets.py file:
+# "device_cert_path" - Path to the Device Certificate
+# "device_key_path" - Path to the RSA Private Key
+# ssl_context.load_cert_chain(
+#     certfile=secrets["device_cert_path"], keyfile=secrets["device_key_path"]
+# )
 
 # Set up a MiniMQTT Client
 mqtt_client = MQTT.MQTT(
@@ -65,7 +76,7 @@ def message(client, topic, message):
     username=aio_username,
     password=aio_key,
     socket_pool=pool,
-    ssl_context=ssl.create_default_context(),
+    ssl_context=ssl_context,
 )
 
 # Setup the callback methods above
diff --git a/examples/native_networking/minimqtt_pub_sub_blocking_topic_callbacks_native_networking.py b/examples/native_networking/minimqtt_pub_sub_blocking_topic_callbacks_native_networking.py
@@ -64,6 +64,16 @@ def on_message(client, topic, message):
 
 # Create a socket pool
 pool = socketpool.SocketPool(wifi.radio)
+ssl_context = ssl.create_default_context()
+
+# If you need to use certificate/key pair authentication (e.g. X.509), you can load them in the
+# ssl context by uncommenting the lines below and adding the following keys to the "secrets"
+# dictionary in your secrets.py file:
+# "device_cert_path" - Path to the Device Certificate
+# "device_key_path" - Path to the RSA Private Key
+# ssl_context.load_cert_chain(
+#     certfile=secrets["device_cert_path"], keyfile=secrets["device_key_path"]
+# )
 
 # Set up a MiniMQTT Client
 client = MQTT.MQTT(
@@ -72,7 +82,7 @@ def on_message(client, topic, message):
     username=aio_username,
     password=aio_key,
     socket_pool=pool,
-    ssl_context=ssl.create_default_context(),
+    ssl_context=ssl_context,
 )
 
 # Setup the callback methods above

Original file line number	Diff line number	Diff line change
`@@ -3,3 +3,4 @@`
`3`	`3`	`# SPDX-License-Identifier: Unlicense`
`4`	`4`
`5`	`5`	`sphinx>=4.0.0`
	`6`	`+sphinxcontrib-jquery`