rendering.TypeAliasRenderer
The presentation of a PEP 695 type alias, with its type parameters and value
Usage
rendering.TypeAliasRenderer(
node,
level=1,
contained=False,
page_path=None,
display_name_format="doc",
signature_name_format="doc",
*,
renderers=_default_renderers(),
extension=_default_extension(),
context_page_path=None,
_purpose=_RenderingPurpose.OBJECT,
)The description shows the subject, then the declaration in source form, without a Usage row. A generic alias renders its Type Parameters section even though it is not callable.
Parameter Attributes
node: (
APIReference
| content.DocClass
| content.DocFunction
| content.DocAttribute
| content.DocTypeAlias
| content.DocModule
| content.Page
| content.Section
)-
The node being documented
level: int = 1-
The heading depth of this appearance
contained: bool = False-
Whether this object is documented inside another object’s documentation
A contained member’s summary row links to its heading on the same page, and its context reports the containing page.
page_path: str | None = None-
The page that this object’s summary row links to
API pages supply a path relative to the reference directory.
Nonelinks within the current page, and contained members always link to a local anchor. For the containing page relative to the output directory, usecontext.page_path. display_name_format: DisplayNameFormat = "doc"-
Format for the display name
signature_name_format: DisplayNameFormat = "doc"-
Format for the signature name
renderers: Renderers = _default_renderers()-
Renderer choices shared with nested objects, pages and summaries
extension: Extension = _default_extension()-
The extension that supplies settings and project directories
A standalone renderer uses default settings and has no project directories.
context_page_path: str | None = None-
The containing page’s path relative to the output directory, apart from summary links
_purpose: _RenderingPurpose = _RenderingPurpose.OBJECT
Methods
| Name | Description |
|---|---|
| __post_init__() | Narrow doc and obj to type alias documentation |
| render_description() | Render the subject followed by the alias declaration, without a Usage row |
| render_signature() | Render the alias in its source form, e.g. type Pair[T] = tuple[T, T] |
| render_type_parameters_section() | Render a Type Parameters section for a generic alias |
__post_init__()
Narrow doc and obj to type alias documentation
Usage
__post_init__()render_description()
Render the subject followed by the alias declaration, without a Usage row
Usage
render_description()Returns
BlockContent- The subject and the declaration.
render_signature()
Render the alias in its source form, e.g. type Pair[T] = tuple[T, T]
Usage
render_signature()Returns
BlockContent-
The declaration in a
doc-signaturedivision.
render_type_parameters_section()
Render a Type Parameters section for a generic alias
Usage
render_type_parameters_section(el)Parameters
el: gf.DocstringSectionTypeParameters-
The
Type Parameterssection.
Returns
BlockContent-
The definitions as a definition list, or
Nonewhen the section has no items.