Limit line length in src/briefcase comments (ruff E501) (#2526)

Author: NMertsch

changes/2526.misc.rst

@@ -0,0 +1 @@
+Comments in ``src/briefcase`` now have a maximum line length of 88 characters (ruff rule ``E501``).

src/briefcase/commands/base.py

@@ -1090,20 +1090,21 @@ def update_cookiecutter_cache(self, template: str, branch="master"):
                         self.tools.shutil.rmtree(cached_template)
                     raise
                 except self.tools.git.exc.GitError as e:
-                    # The clone failed; to make sure the repo is in a clean state, clean up
-                    # any partial remnants of this initial clone.
+                    # The clone failed; to make sure the repo is in a clean state,
+                    # clean up any partial remnants of this initial clone.
                     # If we're getting a GitError, we know the directory must exist.
                     self.tools.shutil.rmtree(cached_template)
                     git_fatal_message = re.findall(
                         r"(?<=fatal: ).*?$", e.stderr, flags=re.DOTALL
                     )
                     if git_fatal_message:
-                        # GitError captures stderr with single quotes. Because the regex above
-                        # takes everything after git's "fatal" message, we need to strip that final single quote.
+                        # GitError captures stderr with single quotes. Because the regex
+                        # above takes everything after git's "fatal" message, we need to
+                        # strip that final single quote.
                         hint = git_fatal_message[0].rstrip("'").strip()
 
-                        # git is inconsistent with capitalisation of the first word of the message
-                        # and about periods at the end of the message.
+                        # git is inconsistent with capitalization of the first word of
+                        # the message and about periods at the end of the message.
                         hint = f"{hint[0].upper()}{hint[1:]}{'' if hint[-1] == '.' else '.'}"
                     else:
                         hint = (
@@ -1197,9 +1198,11 @@ def _generate_template(self, template, branch, output_path, extra_context):
                 no_input=True,
                 output_dir=str(output_path),
                 checkout=branch,
-                # Use a copy to prevent changes propagating among tests while test suite is running
+                # Use a copy to prevent changes propagating among tests
+                # while the test suite is running
                 extra_context=extra_context.copy(),
-                # Store replay data in the Briefcase template cache instead of ~/.cookiecutter_replay
+                # Store replay data in the Briefcase template cache
+                # instead of ~/.cookiecutter_replay
                 default_config={"replay_dir": str(self.template_cache_path(".replay"))},
             )
         except subprocess.CalledProcessError as e:
@@ -1233,7 +1236,8 @@ def generate_template(
 
         extra_context = extra_context.copy()
         # Additional context that can be used for the Briefcase template pyproject.toml
-        # header to include the version of Briefcase as well as the source of the template.
+        # header to include the version of Briefcase as well as the source of the
+        # template.
         extra_context.update(
             {
                 "template_source": template,

src/briefcase/commands/build.py

@@ -110,7 +110,8 @@ def __call__(
         **options,
     ) -> dict | None:
         # Has the user requested an invalid set of options?
-        # This can't be done with argparse, because it isn't a simple mutually exclusive group.
+        # This can't be done with argparse because it isn't
+        # a simple mutually exclusive group.
         if no_update:
             if update:
                 raise BriefcaseCommandError(

src/briefcase/commands/convert.py

@@ -522,7 +522,8 @@ def get_license_hint(self) -> tuple[str | None, str]:
         intro = "What license do you want to use for this project's code? "
         default = None
 
-        # If there is license information in the pyproject.toml file, use that, otherwise check the license file
+        # If there is license information in the pyproject.toml file, use that,
+        # otherwise check the license file
         if "text" in self.pep621_data.get("license", {}):
             default = self.get_license_from_text(self.pep621_data["license"]["text"])
             default_source = "the PEP621 formatted pyproject.toml"
@@ -638,9 +639,10 @@ def merge_or_copy_pyproject(self, briefcase_config_file: Path) -> None:
         if pyproject_file.exists():
             pep621_pyproject = pyproject_file.read_text(encoding="utf-8")
 
-            # The pyproject.toml file in the target directory has no briefcase keys, so it's
-            # safe to copy-paste the text, and that way also keep formatting and comments.
-            # We merge it this way to preserve comments in the original pyproject.toml file
+            # The pyproject.toml file in the target directory has no briefcase keys, so
+            # it's safe to copy-paste the text, and that way also keep formatting and
+            # comments. We merge it this way to preserve comments in the original
+            # pyproject.toml file
             briefcase_comment = "# content below this line added by briefcase convert"
             merged_pyproject = (
                 f"{pep621_pyproject}\n\n\n{briefcase_comment}\n{briefcase_pyproject}"

src/briefcase/commands/create.py

@@ -240,7 +240,8 @@ def generate_app_template(self, app: AppConfig):
                 # Ensure the output format is in the case we expect
                 "format": self.output_format.lower(),
                 # Properties of the generating environment
-                # The full Python version string, including minor and dev/a/b/c suffixes (e.g., 3.11.0rc2)
+                # The full Python version string, including minor and dev/a/b/c suffixes
+                # (e.g., 3.11.0rc2)
                 "python_version": platform.python_version(),
                 # The host architecture
                 "host_arch": self.tools.host_arch,
@@ -938,8 +939,9 @@ def create_app(self, app: AppConfig, **options):
         self.console.info("Generating application template...", prefix=app.app_name)
         self.generate_app_template(app=app)
 
-        # External apps (apps that define 'external_package_path') need the packaging metadata
-        # from the template, but not the app content, dependencies, support package etc.
+        # External apps (apps that define 'external_package_path') need the packaging
+        # metadata from the template, but not the app content, dependencies, support
+        # package, etc.
         if app.external_package_path:
             self.console.info("Removing generated app content...", prefix=app.app_name)
             self.tools.shutil.rmtree(self.bundle_package_path(app))

src/briefcase/commands/dev.py

@@ -21,13 +21,13 @@ class DevCommand(RunAppMixin, BaseCommand):
     output_format = ""
     description = "Run a Briefcase project in the dev environment."
 
-    # On macOS CoreFoundation/NSApplication will do its own independent parsing of argc/argv.
-    # This means that whatever we pass to the Python interpreter on start-up will also be
-    # visible to NSApplication which will interpret things like `-u` (used to make I/O
-    # unbuffered in CPython) as `-u [URL]` (a request to open a document by URL). This is,
-    # rather patently, Not Good.
-    # To avoid this causing unwanted hilarity, we use environment variables to configure the
-    # Python interpreter rather than command-line options.
+    # On macOS CoreFoundation/NSApplication will do its own independent parsing of
+    # argc/argv. This means that whatever we pass to the Python interpreter on start-up
+    # will also be visible to NSApplication which will interpret things like `-u` (used
+    # to make I/O unbuffered in CPython) as `-u [URL]` (a request to open a document by
+    # URL). This is, rather patently, Not Good.
+    # To avoid this causing unwanted hilarity, we use environment variables to configure
+    # the Python interpreter rather than command-line options.
     DEV_ENVIRONMENT: Mapping[str, str] = {
         # Equivalent of passing "-u"
         "PYTHONUNBUFFERED": "1",

src/briefcase/commands/run.py

@@ -55,11 +55,12 @@ def __call__(self, line):
             if filtered is None:
                 return
 
-            # If there's a cleaned line, we can determine if it should be included in analysis
+            # If there's a cleaned line, we can determine if it should be
+            # included in analysis
             clean_line, included = filtered
         else:
             # If we don't perform cleaning, we assume all content is potentially
-            # Python, and should be included in analysis
+            # Python and should be included in analysis
             clean_line = line
             included = True
 

src/briefcase/config.py

@@ -174,7 +174,8 @@ def validate_document_type_config(document_type_id, document_type):
         else:
             uti = None
 
-        # If an UTI is provided in LSItemContentTypes, that takes precedence over a MIME type
+        # If an UTI is provided in LSItemContentTypes,
+        # that takes precedence over a MIME type
         if is_uti_core_type(uti) or ((uti := mime_type_to_uti(mime_type)) is not None):
             macOS.setdefault("is_core_type", True)
             macOS.setdefault("LSItemContentTypes", [uti])

src/briefcase/console.py

@@ -186,8 +186,9 @@ def __init__(
         self.save_log = False
         # flag set by exceptions to skip writing the log; save_log takes precedence.
         self.skip_log = False
-        # Rich stacktraces of exceptions for logging to file.
-        # A list of tuples containing a label for the thread context, and the Trace object
+        # Rich stacktraces of exceptions for logging to a file.
+        # A list of tuples containing a label for the thread context,
+        # and the Trace object
         self.stacktraces: list[tuple[str, Trace]] = []
         # functions to run for additional logging if creating a logfile
         self.log_file_extras: list[Callable[[], object]] = []
@@ -511,13 +512,17 @@ def _build_log(self, command) -> str:
             f"Platform:        {platform.platform(aliased=True)}\n"
             "\n"
             f"Python exe:      {sys.executable}\n"
-            # replace line breaks with spaces (use chr(10) since '\n' isn't allowed in f-strings...)
+            # replace line breaks with spaces
+            # (use chr(10) since '\n' isn't allowed in f-strings...)
             f"Python version:  {sys.version.replace(chr(10), ' ')}\n"
             # sys.real_prefix was used in older versions of virtualenv.
-            # sys.base_prefix is always the python exe's original site-specific directory (e.g. /usr/local).
-            # sys.prefix is updated (from base_prefix's value) to the virtual env's site-specific directory.
+            # sys.base_prefix is always the python exe's original site-specific
+            #     directory (e.g. /usr/local).
+            # sys.prefix is updated (from base_prefix's value) to the virtual env's
+            #     site-specific directory.
             f"Virtual env:     {hasattr(sys, 'real_prefix') or sys.base_prefix != sys.prefix}\n"
-            # for conda, prefix and base_prefix are likely the same but contain a conda-meta dir.
+            # for conda, prefix and base_prefix are likely the same
+            # but contain a conda-meta dir.
             f"Conda env:       {(Path(sys.prefix) / 'conda-meta').exists()}\n"
             "\n"
             f"Briefcase:       {__version__}\n"
@@ -561,7 +566,7 @@ def is_color_enabled(self):
         the NO_COLOR environment variable; alternatively, the derived color system for
         the terminal is influenced by attributes of the platform as well as FORCE_COLOR.
         """
-        # no_color has precedence since color_system can be set even if color is disabled
+        # no_color has precedence: color_system can be set even if color is disabled
         if self._console_impl.no_color:
             return False
         else:
@@ -632,7 +637,8 @@ def wait_bar(
             self._wait_bar.start()
             yield NotDeadYet(console=self)
         except BaseException as e:
-            # capture BaseException so message is left on the screen even if user sends CTRL+C
+            # capture BaseException so the message is left on the screen
+            # even if the user sends CTRL+C
             error_message = "aborted" if isinstance(e, KeyboardInterrupt) else "errored"
             self.print(
                 f"{message} {error_message}", markup=markup, show=show_outcome_message

src/briefcase/integrations/android_sdk.py

@@ -292,8 +292,9 @@ def verify_install(
 """
                     )
             elif sdk.cmdline_tools_path.parent.exists():
-                # a cmdline-tools directory exists but the required version isn't installed.
-                # try to install the required version using the 'latest' version.
+                # a cmdline-tools directory exists,
+                # but the required version isn't installed.
+                # Try to install the required version using the 'latest' version.
                 if not sdk.install_cmdline_tools():
                     sdk = None
                     tools.console.warning(
@@ -412,8 +413,10 @@ def install(self):
         # So, the unpacking process is:
         #
         #  1. Make a <sdk_path>/cmdline-tools folder
-        #  2. Unpack the zip file into that folder, creating <sdk_path>/cmdline-tools/cmdline-tools
-        #  3. Move <sdk_path>/cmdline-tools/cmdline-tools to <sdk_path>/cmdline-tools/<cmdline-tools version>
+        #  2. Unpack the zip file into that folder, creating
+        #      <sdk_path>/cmdline-tools/cmdline-tools
+        #  3. Move <sdk_path>/cmdline-tools/cmdline-tools to
+        #      <sdk_path>/cmdline-tools/<cmdline-tools version>
 
         with self.tools.console.wait_bar(
             f"Installing Android SDK Command-Line Tools {self.SDK_MANAGER_VER}..."
@@ -1474,9 +1477,10 @@ def run(self, *arguments: SubprocessArgT, quiet: int = 0) -> str:
                 [self.tools.android_sdk.adb_path, "-s", self.device, *arguments],
                 quiet=quiet,
             )
-            # add returns status code 0 in the case of failure. The only tangible evidence
-            # of failure is the message "Failure [INSTALL_FAILED_OLDER_SDK]" in the,
-            # console output; so if that message exists in the output, raise an exception.
+            # add returns status code 0 in the case of failure.
+            # The only tangible evidence of failure is the message
+            # "Failure [INSTALL_FAILED_OLDER_SDK]" in the console output;
+            # so if that message exists in the output, raise an exception.
             if "Failure [INSTALL_FAILED_OLDER_SDK]" in output:
                 raise BriefcaseCommandError(
                     "Your device doesn't meet the minimum SDK requirements of this app."
@@ -1529,9 +1533,9 @@ def start_app(self, package: str, activity: str, passthrough: list[str]):
         :returns: `None` on success; raises an exception on failure.
         """
         try:
-            # `am start` also accepts string array extras, but we pass the arguments as a
-            # single JSON string, because JSON deals with edge cases like whitespace and
-            # escaping in a reliable and well-documented way.
+            # `am start` also accepts string array extras, but we pass the arguments as
+            # a single JSON string, because JSON deals with edge cases like whitespace
+            # and escaping in a reliable and well-documented way.
             output = self.run(
                 "shell",
                 "am",
@@ -1718,11 +1722,11 @@ def pidof(self, package: str, **kwargs) -> str | None:
         :returns: The PID of the given app as a string, or None if it isn't
         running.
         """
-        # The pidof command is available since API level 24. The level 23 emulator image also
-        # includes it, but it doesn't work correctly (it returns all processes).
+        # The pidof command is available since API level 24. The level 23 emulator image
+        # also includes it, but it doesn't work correctly (it returns all processes).
         try:
-            # Exit status is unreliable: some devices (e.g. Nexus 4) return 0 even when no
-            # process was found.
+            # Exit status is unreliable: some devices (e.g. Nexus 4) return 0
+            # even when no process was found.
             return self.run("shell", "pidof", "-s", package, **kwargs).strip() or None
         except subprocess.CalledProcessError:
             return None