Add an '--offline' flag to avoid network requests

If you want to use circup but don't have an internet connection, you
currently cannot. This commit skips all network requests and will
try to perform the commands with whatever data is already downloaded.

Author: dunkmann00

circup/bundle.py

@@ -25,6 +25,9 @@ class Bundle:
     All the links and file names for a bundle
     """
 
+    #: Avoid requests to the internet
+    offline = False
+
     def __init__(self, repo):
         """
         Initialise a Bundle created from its github info.
@@ -132,9 +135,12 @@ def latest_tag(self):
         :return: The most recent tag value for the project.
         """
         if self._latest is None:
-            self._latest = get_latest_release_from_url(
-                self.url + "/releases/latest", logger
-            )
+            if self.offline:
+                self._latest = self._available[-1] if len(self._available) > 0 else None
+            else:
+                self._latest = get_latest_release_from_url(
+                    self.url + "/releases/latest", logger
+                )
         return self._latest
 
     @property

circup/command_utils.py

@@ -145,6 +145,10 @@ def ensure_bundle_tag(bundle, tag):
 
     :return: If the bundle is available.
     """
+    if tag is None:
+        logger.warning("Bundle version requested is 'None'.")
+        return False
+
     do_update = False
     if tag in bundle.available_tags:
         for platform in PLATFORMS:
@@ -155,6 +159,12 @@ def ensure_bundle_tag(bundle, tag):
         do_update = True
 
     if do_update:
+        if Bundle.offline:
+            logger.info(
+                "Bundle version not available but skipping update in offline mode."
+            )
+            return False
+
         logger.info("New version available (%s).", tag)
         try:
             get_bundle(bundle, tag)

circup/commands.py

@@ -68,6 +68,16 @@
     " You can optionally set an environment variable CIRCUP_WEBWORKFLOW_PASSWORD"
     " instead of passing this argument. If both exist the CLI arg takes precedent.",
 )
+@click.option(
+    "--offline",
+    is_flag=True,
+    help="Prevents Circup from accessing the internet for any reason. "
+    "Without this flag, Circup will fail with an error if it needs to access "
+    "the network and the network is not available. With this flag, Circup "
+    "will attempt to proceed without the network if possible. Circup will "
+    "only use bundles downloaded locally even if there might be newer "
+    "versions available.",
+)
 @click.option(
     "--timeout",
     default=30,
@@ -107,6 +117,7 @@ def main(  # pylint: disable=too-many-locals
     host,
     port,
     password,
+    offline,
     timeout,
     board_id,
     cpy_version,
@@ -121,6 +132,7 @@ def main(  # pylint: disable=too-many-locals
     ctx.obj["BUNDLE_TAGS"] = (
         parse_cli_bundle_tags(bundle_versions) if len(bundle_versions) > 0 else None
     )
+    Bundle.offline = offline
 
     if password is None:
         password = os.getenv("CIRCUP_WEBWORKFLOW_PASSWORD")
@@ -177,20 +189,22 @@ def main(  # pylint: disable=too-many-locals
 
     logger.info("### Started Circup ###")
 
-    # If a newer version of circup is available, print a message.
-    logger.info("Checking for a newer version of circup")
-    version = get_circup_version()
-    if version:
-        update_checker.update_check("circup", version)
+    if offline:
+        logger.info(
+            "'--offline' flag present, all update checks requiring the network will be skipped."
+        )
+    else:
+        # If a newer version of circup is available, print a message.
+        logger.info("Checking for a newer version of circup")
+        version = get_circup_version()
+        if version:
+            update_checker.update_check("circup", version)
 
     # stop early if the command is boardless
     if ctx.invoked_subcommand in BOARDLESS_COMMANDS or "--help" in sys.argv:
         return
 
     ctx.obj["DEVICE_PATH"] = device_path
-    latest_version = get_latest_release_from_url(
-        "https://github.com/adafruit/circuitpython/releases/latest", logger
-    )
 
     if device_path is None or not ctx.obj["backend"].is_device_present():
         click.secho("Could not find a connected CircuitPython device.", fg="red")
@@ -206,22 +220,27 @@ def main(  # pylint: disable=too-many-locals
                 board_id, device_path, cpy_version
             )
         )
-    try:
-        if VersionInfo.parse(cpy_version) < VersionInfo.parse(latest_version):
-            click.secho(
-                "A newer version of CircuitPython ({}) is available.".format(
-                    latest_version
-                ),
-                fg="green",
-            )
-            if board_id:
-                url_download = f"https://circuitpython.org/board/{board_id}"
-            else:
-                url_download = "https://circuitpython.org/downloads"
-            click.secho("Get it here: {}".format(url_download), fg="green")
-    except ValueError as ex:
-        logger.warning("CircuitPython has incorrect semver value.")
-        logger.warning(ex)
+
+    if not offline:
+        latest_version = get_latest_release_from_url(
+            "https://github.com/adafruit/circuitpython/releases/latest", logger
+        )
+        try:
+            if VersionInfo.parse(cpy_version) < VersionInfo.parse(latest_version):
+                click.secho(
+                    "A newer version of CircuitPython ({}) is available.".format(
+                        latest_version
+                    ),
+                    fg="green",
+                )
+                if board_id:
+                    url_download = f"https://circuitpython.org/board/{board_id}"
+                else:
+                    url_download = "https://circuitpython.org/downloads"
+                click.secho("Get it here: {}".format(url_download), fg="green")
+        except ValueError as ex:
+            logger.warning("CircuitPython has incorrect semver value.")
+            logger.warning(ex)
 
 
 @main.command()
@@ -392,7 +411,7 @@ def install(
                 upgrade,
             )
 
-            if stubs:
+            if stubs and not Bundle.offline:
                 # Check we are in a virtual environment
                 if not is_virtual_env_active():
                     if is_global_install_ok is None:
@@ -728,6 +747,10 @@ def bundle_add(ctx, bundle):
         )
         return
 
+    if Bundle.offline:
+        click.secho("Cannot add new bundle when '--offline' flag is present.", fg="red")
+        return
+
     bundles_dict = get_bundles_local_dict()
     modified = False
     for bundle_repo in bundle: