Restore Docformatter pre-commit check. (#2412)

Author: freakboy3742

.pre-commit-config.yaml

@@ -8,12 +8,11 @@ repos:
       - id: check-docstring-first
       - id: end-of-file-fixer
       - id: trailing-whitespace
-  # Docformatter 1.7.5 isn't compatible with Pre-commit 4.0
-  # - repo: https://github.com/PyCQA/docformatter
-  #   rev: v1.7.5
-  #   hooks:
-  #     - id: docformatter
-  #       args: [--in-place, --black]
+  - repo: https://github.com/PyCQA/docformatter
+    rev: v1.7.7
+    hooks:
+      - id: docformatter
+        args: [--in-place, --black]
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.12.4
     hooks:

src/briefcase/bootstraps/base.py

@@ -123,8 +123,8 @@ def pyproject_extra_content(self) -> str | None:
     def post_generate(self, base_path: Path) -> None:
         """Runs after the template has been generated.
 
-        This can be used to produce any additional files that the base
-        template doesn't provide.
+        This can be used to produce any additional files that the base template doesn't
+        provide.
 
         :param base_path: The path to the root of the generated project.
         """

src/briefcase/commands/base.py

@@ -442,8 +442,8 @@ def unbuilt_executable_path(self, app) -> Path:
         return self.binary_executable_path(app).parent / f"Stub{suffix}"
 
     def bundle_package_path(self, app):
-        """The root path of the content in the bundle generated by Briefcase
-        that will be packaged for distribution.
+        """The root path of the content in the bundle generated by Briefcase that will
+        be packaged for distribution.
 
         This may be overridden if the user manually specifies external_package_path.
 
@@ -466,8 +466,8 @@ def package_path(self, app):
             return self.bundle_package_path(app)
 
     def bundle_package_executable_path(self, app):
-        """The path, relative to the package path generated by Briefcase, of the
-        binary in the packaged app that is executed as the app.
+        """The path, relative to the package path generated by Briefcase, of the binary
+        in the packaged app that is executed as the app.
 
         This may be overridden if the user manually specifies a
         external_package_executable_path.
@@ -481,8 +481,8 @@ def bundle_package_executable_path(self, app):
         raise NotImplementedError()
 
     def package_executable_path(self, app):
-        """The path, relative to the package path, of the binary that is
-        executed as the app.
+        """The path, relative to the package path, of the binary that is executed as the
+        app.
 
         :param app: The app config
         """
@@ -777,7 +777,8 @@ def verify_app_template(self, app: AppConfig):
             )
 
     def verify_required_python(self, app: AppConfig):
-        """Verify that the running version of Python meets the project's specifications."""
+        """Verify that the running version of Python meets the project's
+        specifications."""
 
         requires_python = getattr(self.global_config, "requires_python", None)
         if not requires_python:

src/briefcase/commands/convert.py

@@ -807,8 +807,8 @@ def find_changelog_filename(base_path):
     """Find a valid changelog file in a given directory.
 
     :param base_path: The directory to search
-    :returns: The filename of the changelog that was found; None if a changelog
-        with a known name could not be found.
+    :returns: The filename of the changelog that was found; None if a changelog with a
+        known name could not be found.
     """
     changelog_formats = [
         f"{name}{extension}"

src/briefcase/commands/create.py

@@ -524,9 +524,9 @@ def _write_requirements_file(
         :param requires: The full list of requirements
         :param requirements_path: The full path to a requirements.txt file that will be
             written.
-        :param requirement_installer_args_path: The full path to where newline
-            delimited additional requirement installer argumentss should be written if
-            the template supports it.
+        :param requirement_installer_args_path: The full path to where newline delimited
+            additional requirement installer argumentss should be written if the
+            template supports it.
         """
 
         with self.console.wait_bar("Writing requirements file..."):

src/briefcase/commands/package.py

@@ -48,8 +48,8 @@ def clean_dist_folder(self, app, **options):
         :param app: The app being packaged
         :param options: Any additional arguments passed to the package command. This is
             required because backends that need to *resume* packaging (e.g.,
-            notarization on macOS), need to ignore the "clean" behavior and preserve
-            the existing artefact.
+            notarization on macOS), need to ignore the "clean" behavior and preserve the
+            existing artefact.
         """
         if self.distribution_path(app).exists():
             self.distribution_path(app).unlink()

src/briefcase/config.py

@@ -246,7 +246,7 @@ def parsed_version(version):
 
 
 def parse_boolean(value: str) -> bool:
-    """Takes a string value and attempts to convert to a boolean value"""
+    """Takes a string value and attempts to convert to a boolean value."""
 
     truth_vals = {"true", "t", "yes", "y", "1", "on"}
     false_vals = {"false", "f", "no", "n", "0", "off"}
@@ -283,14 +283,14 @@ def copy(self):
         return type(self)(**self.__dict__)
 
     def setdefault(self, field_name, default_value):
-        """Return the field_name field or, if it does not exist, create it
-        to hold default_value.
+        """Return the field_name field or, if it does not exist, create it to hold
+        default_value.
 
         Behaves similarly to dict.setdefault().
 
         :param field_name: The name of the desired/new field.
-        :param default_value: The value to assign to self.field_name if it
-            does not already exist.
+        :param default_value: The value to assign to self.field_name if it does not
+            already exist.
         """
         if not hasattr(self, field_name):
             setattr(self, field_name, default_value)

src/briefcase/console.py

@@ -969,7 +969,7 @@ def boolean_question(
         default: bool | None = None,
         override_value: str | None = None,
     ) -> bool:
-        """Ask the user a boolean question who's answer requires selecting yes/no
+        """Ask the user a boolean question who's answer requires selecting yes/no.
 
         :param description: A short description of the question being asked. This text
             is used in prompts and a header bar prefacing the question.
@@ -978,7 +978,8 @@ def boolean_question(
         :param override_value: A pre-selected answer for the question. This can be used
             to shortcut asking the question, such as when a command line option provides
             a value. If provided and valid, the header bar will be displayed, but the
-            intro paragraph and option list will not. Will take the provided string and attempt to parse into bool
+            intro paragraph and option list will not. Will take the provided string and
+            attempt to parse into bool
         :returns: The user's chosen answer or none if closed without input
         """
 

src/briefcase/integrations/android_sdk.py

@@ -1629,8 +1629,8 @@ def logcat_tail(self, since: datetime):
             raise BriefcaseCommandError("Error starting ADB logcat.") from e
 
     def forward(self, host_port: int, device_port: int):
-        """Use the forward command to set up arbitrary port forwarding, which
-        forwards requests on a specific host port to a different port on a device.
+        """Use the forward command to set up arbitrary port forwarding, which forwards
+        requests on a specific host port to a different port on a device.
 
         :param host_port: The port on the host that should be forwarded to the device
         :param device_port: The port on the device
@@ -1669,8 +1669,8 @@ def forward_remove(self, host_port: int):
             raise BriefcaseCommandError("Error starting 'adb forward --remove'.") from e
 
     def reverse(self, device_port: int, host_port: int):
-        """Use the reverse command to set up arbitrary port forwarding, which
-        forwards requests on a specific device port to a different port on the host.
+        """Use the reverse command to set up arbitrary port forwarding, which forwards
+        requests on a specific device port to a different port on the host.
 
         :param device_port: The port on the device that should be forwarded to the host
         :param host_port: The port on the host

src/briefcase/integrations/cookiecutter.py

@@ -141,7 +141,7 @@ def bool_attr(obj):
             return "true" if obj else "false"
 
         def xml_escape(obj):
-            """Filter to escape characters <, >, &, " and '"""
+            """Filter to escape characters <, >, &, " and '."""
             return escape(obj)
 
         def xml_attr(obj):