Skip to content

Commit

Permalink
docutils: Use ClassVar for Directive class variables (#11550)
Browse files Browse the repository at this point in the history
These are intended to be set as class variables, in subclasses of Directive, rather
than instance variables.

See also:
- https://docutils.sourceforge.io/docs/howto/rst-directives.html#the-directive-class
- https://docutils.sourceforge.io/docs/howto/rst-directives.html#admonitions
  • Loading branch information
tony authored Mar 9, 2024
1 parent 4d8ae17 commit 96e62dd
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 17 deletions.
16 changes: 4 additions & 12 deletions stubs/Pygments/pygments/sphinxext.pyi
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
from typing import Any

from docutils.parsers.rst import Directive

MODULEDOC: str
Expand All @@ -8,15 +6,9 @@ FMTERDOC: str
FILTERDOC: str

class PygmentsDoc(Directive):
has_content: bool
required_arguments: int
optional_arguments: int
final_argument_whitespace: bool
option_spec: Any
filenames: Any
def run(self): ...
def document_lexers(self): ...
def document_formatters(self): ...
def document_filters(self): ...
filenames: set[str]
def document_lexers(self) -> str: ...
def document_formatters(self) -> str: ...
def document_filters(self) -> str: ...

def setup(app) -> None: ...
10 changes: 5 additions & 5 deletions stubs/docutils/docutils/parsers/rst/__init__.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ class DirectiveError(Exception):
def __init__(self, level: int, message: str) -> None: ...

class Directive:
required_arguments: int
optional_arguments: int
final_argument_whitespace: bool
option_spec: dict[str, Callable[[str], Any]] | None
has_content: bool
required_arguments: ClassVar[int]
optional_arguments: ClassVar[int]
final_argument_whitespace: ClassVar[bool]
option_spec: ClassVar[dict[str, Callable[[str], Any]] | None]
has_content: ClassVar[bool]
name: str
arguments: list[str]
options: dict[str, Any]
Expand Down

0 comments on commit 96e62dd

Please sign in to comment.