Merge branch 'main' into tests

Resolve conflicts and run new versions of linters.

Author: real-yfprojects

.pre-commit-config.yaml

@@ -55,7 +55,7 @@ repos:
 
   # Lint python code with ruff (also sorts imports)
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "5bd2636577fce68326b4fa0bea1769f02d7025bf" # frozen: v0.0.272
+    rev: "bbaf495f2dc6ce2853c91dc0b2c75d3b8249c15c" # frozen: v0.1.15
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]

docs/poly.py

@@ -35,7 +35,7 @@
         GitRef("dev", "", "", GitRefType.BRANCH, datetime.fromtimestamp(4)),
         GitRef("some-feature", "", "", GitRefType.BRANCH, datetime.fromtimestamp(5)),
     ],
-    "current": GitRef("local", "", "", GitRefType.BRANCH, datetime.fromtimestamp(6)),
+    "current": GitRef("local", "", "", GitRefType.TAG, datetime.fromtimestamp(6)),
 }
 MOCK = False
 

docs/sphinx/conf.py

@@ -166,6 +166,7 @@ def linkcode_resolve(domain, info):
     .. seealso::
 
         https://www.sphinx-doc.org/en/master/usage/extensions/linkcode.html#confval-linkcode_resolve
+
     """
     if domain != "py":
         return None

poetry.lock

@@ -37,10 +37,9 @@ jinja      = ["jinja2"]
 sphinx-polyversion = "sphinx_polyversion.main:main"
 
 [tool.poetry.group.lint.dependencies]
-mypy  = "^1.3.0"
-ruff  = "^0.0.272"
-black = "^23.3.0"
-
+mypy  = "^1.7.1"
+ruff  = "^0.1.6"
+black = "^23.11.0"
 
 [tool.poetry.group.test.dependencies]
 pytest         = "^7.4.4"

pyproject.toml

@@ -6,6 +6,7 @@
 logger: Logger
     The root logger used by this package.
 
+
 """
 from logging import DEBUG, NullHandler, getLogger
 

sphinx_polyversion/__init__.py

@@ -39,6 +39,7 @@ def load(namespace: dict[str, Any] | None = None) -> Any:
     ------
     LoadError
         The environment variable isn't set.
+
     """
     namespace = namespace or {}
 
@@ -72,6 +73,7 @@ def apply_overrides(namespace: dict[str, Any]) -> dict[str, Any]:
     -------
     dict[str, Any]
         The values that were applied to the namespace.
+
     """
     args = get_parser(expect_config=False).parse_args()
     overrides: dict[str, Any] = args.override

sphinx_polyversion/api.py

@@ -43,5 +43,6 @@ async def build(self, environment: ENV, output_dir: Path, data: JSONable) -> R:
         Any
             Arbitrary data that results from building.
             This data can be used by custom :class:`Driver` implementations.
+
         """
         ...

sphinx_polyversion/builder.py

@@ -74,6 +74,7 @@ class Driver(Generic[RT, ENV], metaclass=ABCMeta):
     -------
     run()
         Build all revisions.
+
     """
 
     #: The version provider used by the driver e.g. to determine build targets.
@@ -103,6 +104,7 @@ def __init__(
             The directory where to place the built docs.
         mock : MockData[RT] | None | Literal[False], optional
             Only build from local files and mock building all docs using the data provided.
+
         """
         self.root = root
         self.output_dir = output_dir
@@ -123,6 +125,7 @@ def name_for_rev(self, rev: RT) -> str:
         -------
         str
             The name
+
         """
 
     @abstractmethod
@@ -136,6 +139,7 @@ async def init_vcs(self) -> VersionProvider[RT]:
         Returns
         -------
         VersionProvider
+
         """
 
     @abstractmethod
@@ -154,6 +158,7 @@ async def init_builder(self, rev: RT) -> Builder[ENV, Any]:
         Returns
         -------
         Builder
+
         """
 
     @abstractmethod
@@ -174,6 +179,7 @@ async def init_environment(self, path: Path, rev: RT) -> ENV:
         Returns
         -------
         Environment
+
         """
 
     @abstractmethod
@@ -192,6 +198,7 @@ async def init_data(self, rev: RT, env: ENV) -> JSONable:
         -------
         JSONable
             The metadata to pass to the builder.
+
         """
 
     @abstractmethod
@@ -212,6 +219,7 @@ def tmp_dir(self, rev: RT) -> AsyncContextManager[Path]:
         -------
         AsyncContextManager[Path]
             A context manager creating and cleaning up the temp dir.
+
         """
 
     @abstractmethod
@@ -227,6 +235,7 @@ def build_failed(self, rev: RT, exc_info: EXC_INFO) -> None:
             The revision that failed to build.
         exc_info : EXC_INFO
             The exception raised by the build steps.
+
         """
 
     def build_succeeded(self, rev: RT, data: Any) -> None:
@@ -242,6 +251,7 @@ def build_succeeded(self, rev: RT, data: Any) -> None:
             The revision that was build.
         data : Any
             The data returned by the builder.
+
         """
         self.builds.append(rev)
 
@@ -257,6 +267,7 @@ async def build_revision(self, rev: RT) -> None:
         ----------
         rev : Any
             The revision to build.
+
         """
         builder = await self.init_builder(rev)
 
@@ -303,6 +314,7 @@ async def build_local(self) -> None:
         ------
         ValueError
             `self.mock` isn't set.
+
         """
         if not self.mock:
             raise ValueError("Missing mock data.")
@@ -407,6 +419,7 @@ class DefaultDriver(Driver[JRT, ENV], Generic[JRT, ENV, S]):
         The source directory for root level templates.
     mock : MockData[RT] | None | Literal[False], optional
         Only build from local files and mock building all docs using the data provided.
+
     """
 
     def __init__(
@@ -461,6 +474,7 @@ def __init__(
             The source directory for root level templates.
         mock : MockData[RT] | None | Literal[False], optional
             Only build from local files and mock building all docs using the data provided.
+
         """
         super().__init__(Path(root), Path(output_dir), mock=mock)
         self.static_dir = Path(static_dir) if static_dir is not None else static_dir
@@ -494,6 +508,7 @@ def name_for_rev(self, rev: JRT) -> str:
         -------
         str
             The name
+
         """
         return self.namer(rev) if self.namer else self.vcs.name(rev)
 
@@ -516,6 +531,7 @@ async def init_builder(self, rev: JRT) -> Builder[ENV, Any]:
         Returns
         -------
         Builder
+
         """
         if isinstance(self.builder, Mapping):
             r = self.selector(rev, self.builder.keys())  # type: ignore[misc]
@@ -541,6 +557,7 @@ async def init_environment(self, path: Path, rev: JRT) -> ENV:
         Returns
         -------
         Environment
+
         """
         if isinstance(self.env_factory, Mapping):
             r = self.selector(rev, self.env_factory.keys())  # type: ignore[misc]
@@ -573,6 +590,7 @@ async def init_data(self, rev: JRT, env: ENV) -> JSONable:
         -------
         JSONable
             The metadata to pass to the builder.
+
         """
         if not self.data_factory:
             return {"revisions": tuple(self.targets), "current": rev}
@@ -603,6 +621,7 @@ async def tmp_dir(self, rev: JRT) -> AsyncGenerator[Path, None]:
         -------
         AsyncContextManager[Path]
             A context manager creating and cleaning up the temp dir.
+
         """
         with tempfile.TemporaryDirectory() as tmp:
             yield Path(tmp)
@@ -619,6 +638,7 @@ def build_failed(self, rev: JRT, exc_info: EXC_INFO) -> None:
             The revision that failed to build.
         exc_info : EXC_INFO
             The exception raised by the build steps.
+
         """
         logger.error("Building %s failed", self.name_for_rev(rev), exc_info=exc_info)
 

sphinx_polyversion/driver.py

@@ -41,6 +41,7 @@ class Environment:
     -------
     run(*cmd: str, decode: bool = True, **kwargs: Any)
         Run a OS process in the environment.
+
     """
 
     path: Path
@@ -55,6 +56,7 @@ def __init__(self, path: Path, name: str):
             The location of the current revision.
         name : str
             The name of the environment (usually the name of the current revision).
+
         """
         self.path = path.resolve()
         self.logger = ContextAdapter(getLogger(__name__), {"context": name})
@@ -84,6 +86,7 @@ async def run(
             The error output of the command
         returncode : int | None
             The returncode of the command
+
         """
         process = await asyncio.create_subprocess_exec(*cmd, **kwargs)
         out, err = await process.communicate()
@@ -111,6 +114,7 @@ def factory(cls: Type[ENV], **kwargs: Any) -> Callable[[Path, str], ENV]:
         -------
         Callable[[Path, str], ENV]
             The factory function.
+
         """
         return partial(cls, **kwargs)