Merge ~lgp171188/lpci:lint-docstrings-pydocstyle into lpci:main

[Guruprasad]

Add the pydocstyle pre-commit hook to lint the docstrings

Also fix the existing errors reported by the linter.

[Jürgen Gmach (jugmac00)]

Looks good with a minor change request.

review: Approve

[Jürgen Gmach (jugmac00)]

See comment about setup.cfg/pyproject.toml

review: Needs Fixing

[Jürgen Gmach (jugmac00)]

Looks good!

Could you please add a NEWS entry?

Additionally I think it makes sense to merge this PR after https://code.launchpad.net/~jugmac00/lpcraft/+git/lpcraft/+merge/417965 has been merged.

[Jürgen Gmach (jugmac00)]

review: Approve

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index f1856e7..7364193 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -15,12 +15,18 @@ repos:
     rev: 4.0.1
     hooks:
     -   id: flake8
+-   repo: https://github.com/PyCQA/pydocstyle
+    rev: 6.1.1
+    hooks:
+    -   id: pydocstyle
+        additional_dependencies:
+        -   toml==0.10.2
 -   repo: https://github.com/PyCQA/isort
     rev: 5.10.0
     hooks:
     -   id: isort
 -   repo: https://github.com/psf/black
-    rev: 21.10b0
+    rev: 22.3.0
     hooks:
     -   id: black
 -   repo: https://github.com/asottile/setup-cfg-fmt
diff --git a/NEWS.rst b/NEWS.rst
index 5424c96..f4d3db9 100644
--- a/NEWS.rst
+++ b/NEWS.rst
@@ -7,6 +7,10 @@ Version history
 
 - Sphinx: Turn warnings into errors.
 
+- pre-commit: Update the ``black`` hook to fix an incompatibility with
+  ``click==8.1.0``.
+
+- pre-commit: Add the ``pydocstyle`` hook to lint the docstrings.
 
 0.0.5   (2022-03-30)
 ====================
diff --git a/lpcraft/config.py b/lpcraft/config.py
index b20322e..0777dd3 100644
--- a/lpcraft/config.py
+++ b/lpcraft/config.py
@@ -35,7 +35,7 @@ class ModelConfigDefaults(
 
 
 class OutputDistributeEnum(Enum):
-    """Valid values for `output.distribute.`"""
+    """Valid values for `output.distribute`."""
 
     artifactory = "artifactory"
 
diff --git a/lpcraft/main.py b/lpcraft/main.py
index 8dc181e..42a68e5 100644
--- a/lpcraft/main.py
+++ b/lpcraft/main.py
@@ -31,7 +31,7 @@ _configure_logger("craft_providers")
 
 
 def main(argv: Optional[List[str]] = None) -> int:
-    """lpcraft runs Launchpad CI jobs."""
+    """`lpcraft` runs Launchpad CI jobs."""
     parser = ArgumentParser(description="Run Launchpad CI jobs.")
     parser.add_argument(
         "--version",
diff --git a/lpcraft/plugin/hookspecs.py b/lpcraft/plugin/hookspecs.py
index cef7971..6b198ea 100644
--- a/lpcraft/plugin/hookspecs.py
+++ b/lpcraft/plugin/hookspecs.py
@@ -19,17 +19,17 @@ hookspec = pluggy.HookspecMarker(NAME)
 
 @hookspec  # type: ignore
 def lpcraft_install_packages() -> list[str]:
-    """system packages to be installed"""
+    """System packages to be installed."""
 
 
 @hookspec  # type: ignore
 def lpcraft_install_snaps() -> list[str]:
-    """snaps to be installed"""
+    """Snaps to be installed."""
 
 
 @hookspec  # type: ignore
 def lpcraft_execute_run() -> str:
-    """command to be executed"""
+    """Command to be executed."""
     # Please note: when both a plugin and the configuration file are
     # providing a `run` command, the one from the configuration file will be
     # used
@@ -37,7 +37,7 @@ def lpcraft_execute_run() -> str:
 
 @hookspec  # type: ignore
 def lpcraft_set_environment() -> dict[str, str | None]:
-    """environment variables to be set"""
+    """Environment variables to be set."""
     # Please note: when there is the same environment variable provided by
     # the plugin and the configuration file, the one in the configuration
     # file will be taken into account
diff --git a/lpcraft/providers/_base.py b/lpcraft/providers/_base.py
index 7650391..6ca78e2 100644
--- a/lpcraft/providers/_base.py
+++ b/lpcraft/providers/_base.py
@@ -19,7 +19,7 @@ from pydantic import StrictStr
 
 
 def sanitize_lxd_instance_name(name: str) -> str:
-    """LXD instance names need to follow a certain pattern
+    """LXD instance names need to follow a certain pattern.
 
     Make sure we follow this pattern:
     https://linuxcontainers.org/lxd/docs/master/instances/
diff --git a/lpcraft/providers/_lxd.py b/lpcraft/providers/_lxd.py
index a8db9e5..aae538e 100644
--- a/lpcraft/providers/_lxd.py
+++ b/lpcraft/providers/_lxd.py
@@ -145,8 +145,8 @@ class LXDProvider(Provider):
 
         for instance in instances:
             if re.match(
-                fr"^lpcraft-{re.escape(project_name)}-{re.escape(inode)}"
-                fr"-.+-.+$",
+                rf"^lpcraft-{re.escape(project_name)}-{re.escape(inode)}"
+                rf"-.+-.+$",
                 instance,
             ):
                 emit.trace(f"Deleting container {instance!r}.")
diff --git a/lpcraft/providers/tests/__init__.py b/lpcraft/providers/tests/__init__.py
index 835d1b6..e3e9569 100644
--- a/lpcraft/providers/tests/__init__.py
+++ b/lpcraft/providers/tests/__init__.py
@@ -38,8 +38,7 @@ def makeLXDProvider(
     lxd_project: str = "test-project",
     lxd_remote: str = "test-remote",
 ) -> LXDProvider:
-    """A helper function to allow creating a custom LXDProvider for tests."""
-
+    """Create a custom LXDProvider for tests."""
     if lxc is None:
         lxc = Mock(spec=LXC)
         lxc.remote_list.return_value = {}
diff --git a/lpcraft/providers/tests/test_buildd.py b/lpcraft/providers/tests/test_buildd.py
index e1226e8..0aeda3b 100644
--- a/lpcraft/providers/tests/test_buildd.py
+++ b/lpcraft/providers/tests/test_buildd.py
@@ -10,7 +10,7 @@ from lpcraft.providers._buildd import LPCraftBuilddBaseConfiguration
 
 class TestLPCraftBuilddBaseConfiguration(TestCase):
     def test_compare_configuration_with_other_type(self):
-        """The configuration should only be comparable to its own type"""
+        """The configuration should only be comparable to its own type."""
         with pytest.raises(TypeError):
             "foo" == LPCraftBuilddBaseConfiguration(
                 alias=BuilddBaseAlias.FOCAL,
diff --git a/setup.cfg b/setup.cfg
index 00e76e3..7b7909a 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -49,3 +49,6 @@ test =
 known_first_party = lpcraft
 line_length = 79
 profile = black
+
+[pydocstyle]
+add_ignore = D100,D101,D102,D103,D104,D105,D106,D107