g_docformatter.tokens

Contains token definitions.

class g_docformatter.tokens.SubclassedTokenEnumMeta(clsname, bases, attrs: _EnumDict)

Bases: EnumType

Metaclass for token enums that aggregate members from their subclasses.

This metaclass enables a base enum class to provide iteration and membership checking across all its subclasses. It overrides __iter__ and __members__ to aggregate members from all subclasses.

class g_docformatter.tokens.BaseTokenEnum(new_class_name, /, names, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Base class for all token enums.

g_docformatter.tokens.get_tokenizer_regex(*token_enums: type[BaseTokenEnum]) str

Get the regex pattern for tokenizing from the provided token enums.

class g_docformatter.tokens.DocstringSyntaxTokens(*values)

Bases: BaseTokenEnum

Docstring syntax tokens.

class g_docformatter.tokens.REPLCodeTokens(*values)

Bases: BaseTokenEnum

REPL code tokens.

class g_docformatter.tokens.AllSectionTokens(new_class_name, /, names, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: BaseTokenEnum

Base class for any type of section start token.

class g_docformatter.tokens.StandardSectionTokens(*values)

Bases: AllSectionTokens

Standard section tokens.

class g_docformatter.tokens.ListSectionTokens(*values)

Bases: AllSectionTokens

List section tokens.

class g_docformatter.tokens.SphinxSectionTokens(*values)

Bases: BaseTokenEnum

Sphinx section tokens.