Add a pytest hook to lint examples in docstrings

See frequenz-floss/frequenz-repo-config-python#27
for more details.

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

py/conftest.py

@@ -0,0 +1,13 @@
+# License: MIT
+# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
+
+"""Validate docstring code examples.
+
+Code examples are often wrapped in triple backticks (```) within docstrings.
+This plugin extracts these code examples and validates them using pylint.
+"""
+
+from frequenz.repo.config.pytest import examples
+from sybil import Sybil
+
+pytest_collect_file = Sybil(**examples.get_sybil_arguments()).pytest()

pyproject.toml

@@ -52,11 +52,14 @@ dev-mypy = [
 ]
 dev-noxfile = ["nox == 2022.11.21", "frequenz-repo-config[api] == 0.2.0"]
 dev-pylint = [
-  "pylint == 2.17.1",
+  "pylint == 2.17.3",
   # For checking the noxfile, docs/ script, and tests
   "frequenz-api-dispatch[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
-dev-pytest = ["pytest == 7.2.2"]
+dev-pytest = [
+  "pytest == 7.3.1",
+  "frequenz-repo-config[extra-lint-examples] == 0.5.2",
+]
 dev = [
   "frequenz-api-dispatch[dev-mkdocs,dev-docstrings,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",
 ]