enumerations ¤

          flowchart TD
          griffe.enumerations.BreakageKind[BreakageKind]

          

          click griffe.enumerations.BreakageKind href "" "griffe.enumerations.BreakageKind"
          

Enumeration of the possible API breakages.

          flowchart TD
          griffe.enumerations.DocstringSectionKind[DocstringSectionKind]

          

          click griffe.enumerations.DocstringSectionKind href "" "griffe.enumerations.DocstringSectionKind"
          

Enumeration of the possible docstring section kinds.

Attributes:

• admonition –

  Admonition block.

• attributes –

  Attributes section.

• classes –

  Classes section.

• deprecated –

  Deprecation section.

• examples –

  Examples section.

• functions –

  Functions section.

• modules –

  Modules section.

• other_parameters –

  Other parameters (keyword arguments) section.

• parameters –

  Parameters section.

• raises –

  Raises (exceptions) section.

• receives –

  Received value(s) (generators) section.

• returns –

  Returned value(s) section.

• text –

  Text section.

• warns –

  Warnings section.

• yields –

  Yielded value(s) (generators) section.

admonition = 'admonition'

attributes = 'attributes'

classes = 'classes'

deprecated = 'deprecated'

examples = 'examples'

functions = 'functions'

modules = 'modules'

other_parameters = 'other parameters'

parameters = 'parameters'

raises = 'raises'

receives = 'receives'

returns = 'returns'

text = 'text'

warns = 'warns'

yields = 'yields'

          flowchart TD
          griffe.enumerations.ExplanationStyle[ExplanationStyle]

          

          click griffe.enumerations.ExplanationStyle href "" "griffe.enumerations.ExplanationStyle"
          

Enumeration of the possible styles for explanations.

Attributes:

• GITHUB (str) –

  Explanation as GitHub workflow commands warnings, adapted to CI.

• MARKDOWN (str) –

  Explanations in Markdown, adapted to changelogs.

• ONE_LINE (str) –

  Explanations on one-line.

• VERBOSE (str) –

  Explanations on multiple lines.

GITHUB: str = 'github'

MARKDOWN: str = 'markdown'

ONE_LINE: str = 'oneline'

VERBOSE: str = 'verbose'

          flowchart TD
          griffe.enumerations.Kind[Kind]

          

          click griffe.enumerations.Kind href "" "griffe.enumerations.Kind"
          

Enumeration of the different object kinds.

Attributes:

• ALIAS (str) –

  Aliases (imported objects).

• ATTRIBUTE (str) –

  Attributes and properties.

• CLASS (str) –

  Classes.

• FUNCTION (str) –

  Functions and methods.

• MODULE (str) –

  Modules.

ALIAS: str = 'alias'

ATTRIBUTE: str = 'attribute'

CLASS: str = 'class'

FUNCTION: str = 'function'

MODULE: str = 'module'

          flowchart TD
          griffe.enumerations.ObjectKind[ObjectKind]

          

          click griffe.enumerations.ObjectKind href "" "griffe.enumerations.ObjectKind"
          

Enumeration of the different runtime object kinds.

Attributes:

• ATTRIBUTE (str) –

  Attributes.

• BUILTIN_FUNCTION (str) –

  Built-in functions.

• BUILTIN_METHOD (str) –

  Built-in ethods.

• CACHED_PROPERTY (str) –

  Cached properties.

• CLASS (str) –

  Classes.

• CLASSMETHOD (str) –

  Class methods.

• COROUTINE (str) –

  Coroutines

• FUNCTION (str) –

  Functions.

• METHOD (str) –

  Methods.

• METHOD_DESCRIPTOR (str) –

  Method descriptors.

• MODULE (str) –

  Modules.

• PROPERTY (str) –

  Properties.

• STATICMETHOD (str) –

  Static methods.

ATTRIBUTE: str = 'attribute'

BUILTIN_FUNCTION: str = 'builtin_function'

BUILTIN_METHOD: str = 'builtin_method'

CACHED_PROPERTY: str = 'cached_property'

CLASS: str = 'class'

CLASSMETHOD: str = 'classmethod'

COROUTINE: str = 'coroutine'

FUNCTION: str = 'function'

METHOD: str = 'method'

METHOD_DESCRIPTOR: str = 'method_descriptor'

MODULE: str = 'module'

PROPERTY: str = 'property'

STATICMETHOD: str = 'staticmethod'

          flowchart TD
          griffe.enumerations.ParameterKind[ParameterKind]

          

          click griffe.enumerations.ParameterKind href "" "griffe.enumerations.ParameterKind"
          

Enumeration of the different parameter kinds.

Attributes:

• keyword_only (str) –

  Keyword-only parameter.

• positional_only (str) –

  Positional-only parameter.

• positional_or_keyword (str) –

  Positional or keyword parameter.

• var_keyword (str) –

  Variadic keyword parameter.

• var_positional (str) –

  Variadic positional parameter.

keyword_only: str = 'keyword-only'

positional_only: str = 'positional-only'

positional_or_keyword: str = 'positional or keyword'

var_keyword: str = 'variadic keyword'

var_positional: str = 'variadic positional'

          flowchart TD
          griffe.enumerations.Parser[Parser]

          

          click griffe.enumerations.Parser href "" "griffe.enumerations.Parser"
          

Enumeration of the different docstring parsers.

Attributes:

• google –

  Google-style docstrings parser.

• numpy –

  Numpydoc-style docstrings parser.

• sphinx –

  Sphinx-style docstrings parser.

google = 'google'

numpy = 'numpy'

sphinx = 'sphinx'

          flowchart TD
          griffe.enumerations.When[When]

          

          click griffe.enumerations.When href "" "griffe.enumerations.When"
          

Enumeration of the different times at which an extension is used.

Attributes:

• after_all (int) –

  For each node, after the visit/inspection.

• after_children (int) –

  For each node, after the children have been visited/inspected, and before finishing the visit/inspection.

• before_all (int) –

  For each node, before the visit/inspection.

• before_children (int) –

  For each node, after the visit has started, and before the children visit/inspection.

after_all: int = 4

after_children: int = 3

before_all: int = 1

before_children: int = 2