[Pygments] Check for missing stubs outside omitted subpackages (#15606)

Author: brianschubert

stubs/Pygments/@tests/stubtest_allowlist.txt

@@ -3,7 +3,34 @@ pygments.lexer.LexerMeta.__new__
 pygments.style.StyleMeta.__new__
 
 # Defined in lexer classes, intended to be used as static method, but doesn't use @staticmethod
-pygments.lexer.LexerMeta.analyse_text
+pygments.lexer.Lexer(Meta)?.analyse_text
 
 # Inheriting from tuple is weird
 pygments.token._TokenType.__init__
+
+# Cannot import in stubtest (SystemExit: 2)
+pygments.__main__
+
+# Class attributes that are typed in the metaclass instead. See comment in stubs.
+pygments.lexer.Lexer.name
+pygments.lexer.Lexer.aliases
+pygments.lexer.Lexer.filenames
+pygments.lexer.Lexer.alias_filenames
+pygments.lexer.Lexer.mimetypes
+pygments.lexer.Lexer.priority
+pygments.lexer.Lexer.url
+pygments.lexer.Lexer.version_added
+pygments.style.Style.background_color
+pygments.style.Style.highlight_color
+pygments.style.Style.line_number_color
+pygments.style.Style.line_number_background_color
+pygments.style.Style.line_number_special_color
+pygments.style.Style.line_number_special_background_color
+pygments.style.Style.styles
+pygments.style.Style.name
+pygments.style.Style.aliases
+pygments.style.Style.web_style_gallery_exclude
+
+# Individual lexers and styles submodules are not stubbed at this time.
+pygments\.lexers\.(?!get_|find_|load_|guess_).*
+pygments\.styles\.(?!get_).*

stubs/Pygments/METADATA.toml

@@ -5,4 +5,3 @@ partial_stub = true
 
 [tool.stubtest]
 stubtest_dependencies = ["sphinx"]
-ignore_missing_stub = true

stubs/Pygments/pygments/formatter.pyi

@@ -1,8 +1,11 @@
+import types
 from _typeshed import Incomplete
-from typing import Generic, TypeVar, overload
+from typing import Any, Generic, TypeVar, overload
 
 _T = TypeVar("_T", str, bytes)
 
+__all__ = ["Formatter"]
+
 class Formatter(Generic[_T]):
     name: Incomplete
     aliases: Incomplete
@@ -19,5 +22,6 @@ class Formatter(Generic[_T]):
     def __init__(self: Formatter[bytes], *, encoding: str, outencoding: None = None, **options) -> None: ...
     @overload
     def __init__(self: Formatter[bytes], *, encoding: None = None, outencoding: str, **options) -> None: ...
+    def __class_getitem__(cls, name: Any) -> types.GenericAlias: ...
     def get_style_defs(self, arg: str = ""): ...
     def format(self, tokensource, outfile): ...

stubs/Pygments/pygments/formatters/__init__.pyi

@@ -3,6 +3,7 @@ from collections.abc import Generator
 
 from ..formatter import Formatter
 from .bbcode import BBCodeFormatter as BBCodeFormatter
+from .groff import GroffFormatter as GroffFormatter
 from .html import HtmlFormatter as HtmlFormatter
 from .img import (
     BmpImageFormatter as BmpImageFormatter,
@@ -19,6 +20,31 @@ from .svg import SvgFormatter as SvgFormatter
 from .terminal import TerminalFormatter as TerminalFormatter
 from .terminal256 import Terminal256Formatter as Terminal256Formatter, TerminalTrueColorFormatter as TerminalTrueColorFormatter
 
+__all__ = [
+    "get_formatter_by_name",
+    "get_formatter_for_filename",
+    "get_all_formatters",
+    "load_formatter_from_file",
+    "BBCodeFormatter",
+    "BmpImageFormatter",
+    "GifImageFormatter",
+    "GroffFormatter",
+    "HtmlFormatter",
+    "IRCFormatter",
+    "ImageFormatter",
+    "JpgImageFormatter",
+    "LatexFormatter",
+    "NullFormatter",
+    "PangoMarkupFormatter",
+    "RawTokenFormatter",
+    "RtfFormatter",
+    "SvgFormatter",
+    "Terminal256Formatter",
+    "TerminalFormatter",
+    "TerminalTrueColorFormatter",
+    "TestcaseFormatter",
+]
+
 def get_all_formatters() -> Generator[type[Formatter[Incomplete]]]: ...
 def get_formatter_by_name(_alias, **options): ...
 def load_formatter_from_file(filename, formattername: str = "CustomFormatter", **options): ...

stubs/Pygments/pygments/formatters/bbcode.pyi

@@ -5,6 +5,8 @@ from pygments.formatter import Formatter
 
 _T = TypeVar("_T", str, bytes)
 
+__all__ = ["BBCodeFormatter"]
+
 class BBCodeFormatter(Formatter[_T]):
     name: str
     aliases: Incomplete

stubs/Pygments/pygments/formatters/groff.pyi

@@ -0,0 +1,18 @@
+from _typeshed import SupportsWrite
+from collections.abc import Iterable
+from typing import TypeVar
+
+from pygments.formatter import Formatter
+from pygments.token import _TokenType
+
+__all__ = ["GroffFormatter"]
+
+_T = TypeVar("_T", str, bytes)
+
+class GroffFormatter(Formatter[_T]):
+    monospaced: bool
+    linenos: bool
+    wrap: int
+    styles: dict[_TokenType, tuple[str, str]]
+    def __init__(self, **options) -> None: ...
+    def format_unencoded(self, tokensource: Iterable[tuple[_TokenType, str]], outfile: SupportsWrite[str]) -> None: ...

stubs/Pygments/pygments/formatters/html.pyi

@@ -5,6 +5,8 @@ from pygments.formatter import Formatter
 
 _T = TypeVar("_T", str, bytes)
 
+__all__ = ["HtmlFormatter"]
+
 class HtmlFormatter(Formatter[_T]):
     name: str
     aliases: Incomplete

stubs/Pygments/pygments/formatters/img.pyi

@@ -5,6 +5,8 @@ from pygments.formatter import Formatter
 
 _T = TypeVar("_T", str, bytes)
 
+__all__ = ["ImageFormatter", "GifImageFormatter", "JpgImageFormatter", "BmpImageFormatter"]
+
 class PilNotAvailable(ImportError): ...
 class FontNotFound(Exception): ...
 

stubs/Pygments/pygments/formatters/irc.pyi

@@ -5,6 +5,8 @@ from pygments.formatter import Formatter
 
 _T = TypeVar("_T", str, bytes)
 
+__all__ = ["IRCFormatter"]
+
 class IRCFormatter(Formatter[_T]):
     name: str
     aliases: Incomplete

stubs/Pygments/pygments/formatters/latex.pyi

@@ -6,6 +6,8 @@ from pygments.lexer import Lexer
 
 _T = TypeVar("_T", str, bytes)
 
+__all__ = ["LatexFormatter"]
+
 class LatexFormatter(Formatter[_T]):
     name: str
     aliases: Incomplete