ota.update: Breaking change: Change handling of auth args for requests.

Drop support for `username` and `password` arguments in OTA methods.

Instead, any additional keyword arguments will be passed as keyword
arguments to `requests.get()`, eg:

- `ota.update.from_file(
    "http://nas.local/micropython.bin",
    auth=("username", "password"))`.

Author: glenn20

README.md

@@ -166,7 +166,7 @@ convenience functions which use `OTA` to perform simple OTA firmware updates:
 `from_file()` and `from_json()`.
 
 - function `ota.update.from_file(url: str, sha="", length=0, verify=True,
-  verbose=True, reboot=True, username="", password="")`
+  verbose=True, reboot=True, **request_args)`
 
   Read a micropython firmware from url and write it to the next ota partition.
   sha and length are used to validate the data written to the partition.
@@ -180,11 +180,16 @@ convenience functions which use `OTA` to perform simple OTA firmware updates:
   - `verbose=True` (optional) prints out verbose information of what it is doing
   - `reboot=True` (optional) Performs a `machine.hard_reset()` 10 seconds after
     a successful OTA update.
-  - 'username' (optional) Username for http authentication.
-  - 'password' (optional) Password for http authentication.
+  - `request_args`: any additional keyword arguments will be passed as
+    keyword arguments to `requests.get()`, eg:
+    - `ota.update.from_file("http://nas.local/micropython.bin",
+      auth=("username", "password"))`.
+
+  **Note:** The `username` and `password` arguments have been deprecated in
+  favour of `request-args`.
 
 - function `ota.update.from_json(url: str, sha="", length=0, verify=True,
-  verbose=True, reboot=True, username="", password="")`
+  verbose=True, reboot=True, **request_args)`
 
   Read a JSON file from **url** (must end in ".json") containing the **url**,
   **sha** and **length** of the firmware file. Then, read the firmware file and
@@ -228,7 +233,7 @@ updates.
       - **sha** and **length** may instead be provided as arguments to some
         methods below.
 
-- Method: `OTA.from_firmware_file(url: str, sha="", length=0) -> int`
+- Method: `OTA.from_firmware_file(url: str, sha="", length=0, **request_args) -> int`
 
   - Read a micropython firmware from **url** and write it to the next **ota**
     partition. **sha** and **length** are used to validate the data written to
@@ -237,8 +242,10 @@ updates.
     - `url` is a http[s] url or a filename on the device
     - `sha` (optional) is the expected sha256sum of the firmware file
     - `length` (optional) is the expected length of the firmware file (in bytes)
+    - `request_args`: any additional keyword arguments will be passed as
+      keyword arguments to `requests.get()`.
 
-- Method: `OTA.from_json(url: str) -> int`
+- Method: `OTA.from_json(url: str, **request_args) -> int`
 
   - Read a JSON file from **url** (must end in ".json") containing the **url**,
     **sha** and **length** of the firmware file. Then, read the firmware file
@@ -298,28 +305,26 @@ updates.
 #### Examples
 
 ```py
-from ota.update import OTA
+import ota.update
 
 # Write firmware from a url provided in a JSON file
-with OTA() as ota:
-    ota.from_json("http://nas.local/micropython/micropython.json")
+ota.update.from_json("http://nas.local/micropython/micropython.json")
 
 # Write firmware from a url or filename and reboot if successful and verified
-with OTA(reboot=True) as ota:
-    ota.from_firmware_file(
-        "http://nas.local/micropython/micropython.bin",
-        sha="7920d527d578e90ce074b23f9050ffe4ebbd8809b79da0b81493f6ba721d110e",
-        length=1558512)
+ota.update.from_firmware_file(
+    "http://nas.local/micropython/micropython.bin",
+    sha="7920d527d578e90ce074b23f9050ffe4ebbd8809b79da0b81493f6ba721d110e",
+    length=1558512)
 
 # Write firmware from an open stream:
-with OTA() as ota:
+with ota.update.OTA() as ota:
     with open("/sdcard/micropython.bin", "rb") as f:
         ota.from_stream(f)
 
 # Read a firmware file from a serial uart
 remaining = 1558512
 sha = "7920d527d578e90ce074b23f9050ffe4ebbd8809b79da0b81493f6ba721d110e"
-with OTA(length=remaining, sha=sha) as ota:
+with ota.update.OTA(length=remaining, sha=sha) as ota:
     data = memoryview(bytearray(1024))
     gc.collect()
     while remaining > 0:
@@ -328,7 +333,7 @@ with OTA(length=remaining, sha=sha) as ota:
         remaining -= n
 
 # Used without the "with" statement - must call close() explicitly
-ota = OTA()
+ota = ota.update.OTA()
 ota.from_json("http://nas.local/micropython/micropython.json")
 ota.close()
 ```

mip/ota/update.py

@@ -27,22 +27,18 @@ def __exit__(self, e_t, e_v, e_tr):
 
 
 # Open a file or a URL and return a File-like object for reading
-def open_url(url: str, username=None, password=None) -> io.BufferedReader:
-    if url.split(":", 1)[0] not in ("http", "https"):
-        return open(url, "rb")
-    else:
+def open_url(url_or_filename: str, **kw) -> io.BufferedReader:
+    if url_or_filename.split(":", 1)[0] in ("http", "https"):
         import requests
 
-        if username and password:
-            r = requests.get(url, auth = (username, password))
-        else:
-            r = requests.get(url)
-
+        r = requests.get(url_or_filename, **kw)
         code: int = r.status_code
         if code != 200:
             r.close()
             raise ValueError(f"HTTP Error: {code}")
         return SocketWrapper(r.raw)  # type: ignore
+    else:
+        return open(url_or_filename, "rb")
 
 
 # OTA manages a MicroPython firmware update over-the-air. It checks that there
@@ -110,24 +106,25 @@ def from_stream(self, f: io.BufferedReader, sha: str = "", length: int = 0) -> i
     # - url: a filename or a http[s] url for the micropython.bin firmware.
     # - sha: the sha256sum of the firmware file
     # - length: the length (in bytes) of the firmware file
-    def from_firmware_file(self, url: str, sha: str = "", length: int = 0, username=None, password=None) -> int:
+    def from_firmware_file(self, url: str, sha: str = "", length: int = 0, **kw) -> int:
         if self.verbose:
             print(f"Opening firmware file {url}...")
-        with open_url(url, username, password) as f:
+        with open_url(url, **kw) as f:
             return self.from_stream(f, sha, length)
 
     # Load a firmware file, the location of which is read from a json file
     # containing the url for the firmware file, the sha and length of the file.
     # - url: the name of a file or url containing the json.
-    def from_json(self, url: str) -> int:
+    # - kw: extra keywords arguments that will be passed to `requests.get()`
+    def from_json(self, url: str, **kw) -> int:
         if not url.endswith(".json"):
             raise ValueError("Url does not end with '.json'")
         if self.verbose:
             print(f"Opening json file {url}...")
-        with open_url(url) as f:
-            import json
+        with open_url(url, **kw) as f:
+            from json import load
 
-            data: dict = json.load(f)
+            data: dict = load(f)
         try:
             firmware: str = data["firmware"]
             sha: str = data["sha"]
@@ -136,20 +133,20 @@ def from_json(self, url: str) -> int:
                 # If firmware filename is relative, append to base of url of json file
                 baseurl, *_ = url.rsplit("/", 1)
                 firmware = f"{baseurl}/{firmware}"
-            return self.from_firmware_file(firmware, sha, length)
+            return self.from_firmware_file(firmware, sha, length, **kw)
         except KeyError as err:
             print('OTA json must include "firmware", "sha" and "length" keys.')
             raise err
 
 
 # Convenience functions which use the OTA class to perform OTA updates.
 def from_file(
-    url: str, sha="", length=0, verify=True, verbose=True, reboot=True, username=None, password=None
+    url: str, sha="", length=0, verify=True, verbose=True, reboot=True, **kw
 ) -> None:
     with OTA(verify, verbose, reboot) as ota_update:
-        ota_update.from_firmware_file(url, sha, length, username, password)
+        ota_update.from_firmware_file(url, sha, length, **kw)
 
 
-def from_json(url: str, verify=True, verbose=True, reboot=True, username=None, password=None):
+def from_json(url: str, verify=True, verbose=True, reboot=True, **kw) -> None:
     with OTA(verify, verbose, reboot) as ota_update:
-        ota_update.from_json(url, username, password)
+        ota_update.from_json(url, **kw)