Update pytest and sybil (#221)

fixes #219

Author: llucax

RELEASE_NOTES.md

@@ -6,7 +6,9 @@
 
 ## Upgrading
 
-<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
+- Once you upgraded, you'll be able to upgrade to `pytest` 8, and indirectly to `sybil` 6, which includes types hints. If you do so, you should remove the `mypy` exception for `sybil` in the `pyproject.toml` file.
+
+  Search for the `tool.mypy.overrides` section and remove the `"sybil", "sybil.*"` enties from the `module` list.
 
 ### Cookiecutter template
 
@@ -86,7 +88,7 @@ To upgrade without regenerating the project, you can follow these steps:
 
 ## New Features
 
-<!-- Here goes the main new features and examples or instructions on how to use them -->
+- Add support for `pytest` 8.
 
 ### Cookiecutter template
 

cookiecutter/{{cookiecutter.github_repo_name}}/pyproject.toml

@@ -98,7 +98,7 @@ dev-pylint = [
   "{{cookiecutter.pypi_package_name}}[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-pytest = [
-  "pytest == 7.4.2",
+  "pytest == 8.0.0",
   "frequenz-repo-config[extra-lint-examples] == 0.8.0",
 {%- if cookiecutter.type != "api" %}
   "pytest-mock == 3.11.1",

pyproject.toml

@@ -63,8 +63,8 @@ lib = []
 model = []
 extra-lint-examples = [
   "pylint >= 2.17.3, < 4",
-  "pytest >= 7.3.0, < 8",
-  "sybil >= 5.0.3, < 6",
+  "pytest >= 7.3.0, < 9",
+  "sybil >= 5.0.3, < 7",
 ]
 dev-flake8 = [
   "flake8 == 6.1.0",
@@ -101,11 +101,11 @@ dev-pylint = [
   "frequenz-repo-config[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-pytest = [
-  "pytest == 7.4.2",
+  "pytest == 8.0.0",
   "pylint == 3.0.2",       # We need this to check for the examples
   "cookiecutter == 2.1.1", # For checking the cookiecutter scripts
   "jinja2 == 3.1.2",       # For checking the cookiecutter scripts
-  "sybil == 5.0.3",        # Should be consistent with the extra-lint-examples dependency
+  "sybil == 6.0.3",        # Should be consistent with the extra-lint-examples dependency
 ]
 dev = [
   "frequenz-repo-config[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",
@@ -188,8 +188,6 @@ module = [
   "github_action_utils",
   "mkdocs_macros.*",
   "semver.version",
-  "sybil",
-  "sybil.*",
 ]
 ignore_missing_imports = true
 

src/frequenz/repo/config/__init__.py

@@ -164,7 +164,7 @@
   "my-package[dev-mkdocs,dev-pytest]",
 ]
 dev-pytest = [
-  "pytest == 7.2.2",
+  "pytest == 8.0.0",
   "pytest-asyncio == 0.21.0",
   "pytest-mock == 3.10.0",
 ]

src/frequenz/repo/config/pytest/examples.py

@@ -25,12 +25,12 @@
 import ast
 import os
 import subprocess
+import textwrap
 from pathlib import Path
 from typing import Any
 
 from sybil import Example
 from sybil.evaluators.python import pad
-from sybil.parsers.abstract.lexers import textwrap
 from sybil.parsers.myst import CodeBlockParser
 
 _PYLINT_DISABLE_COMMENT = (
@@ -116,9 +116,7 @@ def _path_to_import_statement(path: Path) -> str:
     return import_statement
 
 
-# We need to add the type ignore comment here because the Sybil library does not
-# have type annotations.
-class _CustomPythonCodeBlockParser(CodeBlockParser):  # type: ignore[misc]
+class _CustomPythonCodeBlockParser(CodeBlockParser):
     """Code block parser that validates extracted code examples using pylint.
 
     This parser is a modified version of the default Python code block parser

tests_golden/integration/test_cookiecutter_generation/actor/frequenz-actor-test/pyproject.toml

@@ -77,7 +77,7 @@ dev-pylint = [
   "frequenz-actor-test[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-pytest = [
-  "pytest == 7.4.2",
+  "pytest == 8.0.0",
   "frequenz-repo-config[extra-lint-examples] == 0.8.0",
   "pytest-mock == 3.11.1",
   "pytest-asyncio == 0.21.1",

tests_golden/integration/test_cookiecutter_generation/api/frequenz-api-test/pyproject.toml

@@ -76,7 +76,7 @@ dev-pylint = [
   "frequenz-api-test[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-pytest = [
-  "pytest == 7.4.2",
+  "pytest == 8.0.0",
   "frequenz-repo-config[extra-lint-examples] == 0.8.0",
 ]
 dev = [

tests_golden/integration/test_cookiecutter_generation/app/frequenz-app-test/pyproject.toml

@@ -76,7 +76,7 @@ dev-pylint = [
   "frequenz-app-test[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-pytest = [
-  "pytest == 7.4.2",
+  "pytest == 8.0.0",
   "frequenz-repo-config[extra-lint-examples] == 0.8.0",
   "pytest-mock == 3.11.1",
   "pytest-asyncio == 0.21.1",

tests_golden/integration/test_cookiecutter_generation/lib/frequenz-test-python/pyproject.toml

@@ -73,7 +73,7 @@ dev-pylint = [
   "frequenz-test[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-pytest = [
-  "pytest == 7.4.2",
+  "pytest == 8.0.0",
   "frequenz-repo-config[extra-lint-examples] == 0.8.0",
   "pytest-mock == 3.11.1",
   "pytest-asyncio == 0.21.1",

tests_golden/integration/test_cookiecutter_generation/model/frequenz-model-test/pyproject.toml

@@ -77,7 +77,7 @@ dev-pylint = [
   "frequenz-model-test[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-pytest = [
-  "pytest == 7.4.2",
+  "pytest == 8.0.0",
   "frequenz-repo-config[extra-lint-examples] == 0.8.0",
   "pytest-mock == 3.11.1",
   "pytest-asyncio == 0.21.1",