chore: Use YORE comments (experiment)

Author: pawamoy

scripts/gen_credits.py

@@ -15,7 +15,7 @@
 from jinja2.sandbox import SandboxedEnvironment
 from packaging.requirements import Requirement
 
-# TODO: Remove once support for Python 3.10 is dropped.
+# YORE: EOL 3.10: Replace block with line 2.
 if sys.version_info >= (3, 11):
     import tomllib
 else:

src/griffe/agents/nodes/_runtime.py

@@ -21,7 +21,7 @@
 
 
 def _same_components(a: str, b: str, /) -> bool:
-    # TODO: Use `removeprefix` when we drop Python 3.8.
+    # YORE: EOL 3.8: Replace `lstrip` with `removeprefix` within line.
     return [cpn.lstrip("_") for cpn in a.split(".")] == [cpn.lstrip("_") for cpn in b.split(".")]
 
 

src/griffe/agents/nodes/_values.py

@@ -8,7 +8,7 @@
 
 from griffe.logger import get_logger
 
-# TODO: Remove once support for Python 3.8 is dropped.
+# YORE: EOL 3.8: Replace block with line 4.
 if sys.version_info < (3, 9):
     from astunparse import unparse
 else:

src/griffe/dataclasses.py

@@ -152,7 +152,7 @@ def as_dict(
         Returns:
             A dictionary.
         """
-        # TODO: Remove at some point.
+        # YORE: Bump 1.0.0: Remove block.
         if docstring_parser is not None:
             warnings.warn("Parameter `docstring_parser` is deprecated and has no effect.", stacklevel=1)
 
@@ -527,6 +527,7 @@ def is_namespace_subpackage(self) -> bool:
         """Whether this object is a namespace subpackage."""
         return False
 
+    # YORE: Bump 1.0.0: Replace ` | set[str]` with `` within line.
     def has_labels(self, *labels: str | set[str]) -> bool:
         """Tell if this object has all the given labels.
 
@@ -536,7 +537,7 @@ def has_labels(self, *labels: str | set[str]) -> bool:
         Returns:
             True or False.
         """
-        # TODO: Remove at some point.
+        # YORE: Bump 1.0.0: Remove block.
         all_labels = set()
         for label in labels:
             if isinstance(label, str):
@@ -548,6 +549,8 @@ def has_labels(self, *labels: str | set[str]) -> bool:
                     stacklevel=2,
                 )
                 all_labels.update(label)
+
+        # YORE: Bump 1.0.0: Replace `all_labels` with `set(labels)` within line.
         return all_labels.issubset(self.labels)
 
     def filter_members(self, *predicates: Callable[[Object | Alias], bool]) -> dict[str, Object | Alias]:

src/griffe/encoders.py

@@ -88,7 +88,7 @@ def __init__(
         super().__init__(*args, **kwargs)
         self.full: bool = full
 
-        # TODO: Remove at some point.
+        # YORE: Bump 1.0.0: Remove block.
         self.docstring_parser: Parser | None = docstring_parser
         self.docstring_options: dict[str, Any] = docstring_options or {}
         if docstring_parser is not None:

src/griffe/expressions.py

@@ -73,7 +73,7 @@ def _expr_as_dict(expression: Expr, **kwargs: Any) -> dict[str, Any]:
     return fields
 
 
-# TODO: Merge in decorators once Python 3.9 is dropped.
+# YORE: EOL 3.9: Remove block.
 dataclass_opts: dict[str, bool] = {}
 if sys.version_info >= (3, 10):
     dataclass_opts["slots"] = True
@@ -171,6 +171,7 @@ def is_generator(self) -> bool:
         return isinstance(self, ExprSubscript) and self.canonical_name == "Generator"
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprAttribute(Expr):
     """Attributes like `a.b`."""
@@ -214,6 +215,7 @@ def canonical_path(self) -> str:
         return self.last.canonical_path
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprBinOp(Expr):
     """Binary operations like `a + b`."""
@@ -231,6 +233,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
         yield from _yield(self.right, flat=flat)
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprBoolOp(Expr):
     """Boolean operations like `a or b`."""
@@ -244,6 +247,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
         yield from _join(self.values, f" {self.operator} ", flat=flat)
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprCall(Expr):
     """Calls like `f()`."""
@@ -265,6 +269,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
         yield ")"
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprCompare(Expr):
     """Comparisons like `a > b`."""
@@ -282,6 +287,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
         yield from _join(zip_longest(self.operators, [], self.comparators, fillvalue=" "), " ", flat=flat)
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprComprehension(Expr):
     """Comprehensions like `a for b in c if d`."""
@@ -307,6 +313,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
             yield from _join(self.conditions, " if ", flat=flat)
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprConstant(Expr):
     """Constants like `"a"` or `1`."""
@@ -318,6 +325,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: ARG002
         yield self.value
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprDict(Expr):
     """Dictionaries like `{"a": 0}`."""
@@ -337,6 +345,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
         yield "}"
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprDictComp(Expr):
     """Dict comprehensions like `{k: v for k, v in a}`."""
@@ -357,6 +366,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
         yield "}"
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprExtSlice(Expr):
     """Extended slice like `a[x:y, z]`."""
@@ -368,6 +378,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
         yield from _join(self.dims, ", ", flat=flat)
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprFormatted(Expr):
     """Formatted string like `{1 + 1}`."""
@@ -381,6 +392,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
         yield "}"
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprGeneratorExp(Expr):
     """Generator expressions like `a for b in c for d in e`."""
@@ -396,6 +408,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
         yield from _join(self.generators, " ", flat=flat)
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprIfExp(Expr):
     """Conditions like `a if b else c`."""
@@ -415,6 +428,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
         yield from _yield(self.orelse, flat=flat)
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprJoinedStr(Expr):
     """Joined strings like `f"a {b} c"`."""
@@ -428,6 +442,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
         yield "'"
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprKeyword(Expr):
     """Keyword arguments like `a=b`."""
@@ -468,6 +483,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
         yield from _yield(self.value, flat=flat)
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprVarPositional(Expr):
     """Variadic positional parameters like `*args`."""
@@ -480,6 +496,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
         yield from _yield(self.value, flat=flat)
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprVarKeyword(Expr):
     """Variadic keyword parameters like `**kwargs`."""
@@ -492,6 +509,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
         yield from _yield(self.value, flat=flat)
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprLambda(Expr):
     """Lambda expressions like `lambda a: a.b`."""
@@ -534,6 +552,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
         yield from _yield(self.body, flat=flat)
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprList(Expr):
     """Lists like `[0, 1, 2]`."""
@@ -547,6 +566,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
         yield "]"
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprListComp(Expr):
     """List comprehensions like `[a for b in c]`."""
@@ -564,6 +584,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
         yield "]"
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=False, **dataclass_opts)
 class ExprName(Expr):
     """This class represents a Python object identified by a name in a given scope."""
@@ -643,6 +664,7 @@ def is_enum_value(self) -> bool:
             return False
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprNamedExpr(Expr):
     """Named/assignment expressions like `a := b`."""
@@ -660,6 +682,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
         yield ")"
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprParameter(Expr):
     """Parameters in function signatures like `a: int = 0`."""
@@ -674,6 +697,7 @@ class ExprParameter(Expr):
     """Parameter default."""
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprSet(Expr):
     """Sets like `{0, 1, 2}`."""
@@ -687,6 +711,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
         yield "}"
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprSetComp(Expr):
     """Set comprehensions like `{a for b in c}`."""
@@ -704,6 +729,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
         yield "}"
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprSlice(Expr):
     """Slices like `[a:b:c]`."""
@@ -726,6 +752,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
             yield from _yield(self.step, flat=flat)
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprSubscript(Expr):
     """Subscripts like `a[b]`."""
@@ -756,6 +783,7 @@ def canonical_path(self) -> str:
         return self.left.canonical_path
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprTuple(Expr):
     """Tuples like `(0, 1, 2)`."""
@@ -773,6 +801,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
             yield ")"
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprUnaryOp(Expr):
     """Unary operations like `-1`."""
@@ -787,6 +816,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
         yield from _yield(self.value, flat=flat)
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprYield(Expr):
     """Yield statements like `yield a`."""
@@ -801,6 +831,7 @@ def iterate(self, *, flat: bool = True) -> Iterator[str | Expr]:  # noqa: D102
             yield from _yield(self.value, flat=flat)
 
 
+# YORE: EOL 3.9: Replace `**dataclass_opts` with `slots=True` within line.
 @dataclass(eq=True, **dataclass_opts)
 class ExprYieldFrom(Expr):
     """Yield statements like `yield from a`."""
@@ -1135,7 +1166,7 @@ def _build_yield_from(node: ast.YieldFrom, parent: Module | Class, **kwargs: Any
     ast.YieldFrom: _build_yield_from,
 }
 
-# TODO: remove once Python 3.8 support is dropped
+# YORE: EOL 3.8: Remove block.
 if sys.version_info < (3, 9):
 
     def _build_extslice(node: ast.ExtSlice, parent: Module | Class, **kwargs: Any) -> Expr:

src/griffe/extensions/base.py

@@ -461,20 +461,20 @@ def _load_extension(
 
 
 def load_extensions(
-    # TODO: Only accept LoadableExtension at some point.
+    # YORE: Bump 1.0.0: Replace ` | Sequence[LoadableExtension],` with `` within line.
     *exts: LoadableExtension | Sequence[LoadableExtension],
 ) -> Extensions:
     """Load configured extensions.
 
     Parameters:
-        exts: A sequence of extension, with potential configuration options.
+        exts: Extensions with potential configuration options.
 
     Returns:
         An extensions container.
     """
     extensions = Extensions()
 
-    # TODO: Remove at some point.
+    # YORE: Bump 1.0.0: Remove block.
     all_exts: list[LoadableExtension] = []
     for ext in exts:
         if isinstance(ext, (list, tuple)):
@@ -488,6 +488,7 @@ def load_extensions(
         else:
             all_exts.append(ext)  # type: ignore[arg-type]
 
+    # YORE: Bump 1.0.0: Replace `all_exts` with `exts` within line.
     for extension in all_exts:
         ext = _load_extension(extension)
         if isinstance(ext, list):

src/griffe/git.py

@@ -16,7 +16,7 @@
 WORKTREE_PREFIX = "griffe-worktree-"
 
 
-# TODO: Remove at some point.
+# YORE: Bump 1.0.0: Remove block.
 def __getattr__(name: str) -> Any:
     if name == "load_git":
         warnings.warn(