API

pyhtml.create_tag

create_tag(name: str, base: type[Tag] = Tag) -> type[Tag]

Create a new PyHTML tag definition.

PyHTML already provides definitions for all standard HTML tags, so you don't need to use this unless you are using a JavaScript library that defines custom HTML elements.

Parameters:

Name	Type	Description	Default
`name`	`str`	the name of the tag. This is used during rendering, as `<{name}> ... </{name}>`.	required
`base`	`type[Tag]`	the base class to use for the custom tag. The new tag will inherit from this base class.	`Tag`

Returns:

Type	Description
`type[Tag]`	type[Tag]: a new tag definition.

pyhtml.Tag

Base tag class

children `instance-attribute`

children = flattened

Children of this tag

attributes `instance-attribute`

attributes = filter_attributes(attributes)

Attributes of this tag

_get_tag_name

_get_tag_name() -> str

Returns the name of the tag

_get_default_attributes

_get_default_attributes(
    given: dict[str, AttributeType],
) -> dict[str, AttributeType]

Returns the default attributes for the tag given the specified attributes.

This is overridden by child classes to return a dictionary of default attributes that are applied to the class.

_get_default_render_options

_get_default_render_options() -> RenderOptions

Returns the default rendering options for this tag.

This can be used to control how the element is rendered by default. For example a <p> element can specify spacing="" so that its child elements are not spaced out (thereby reducing anger from Tom7).

When the user provides their own options, they will be merged with the element's default options using the Options.union method.

_get_tag_pre_content

_get_tag_pre_content() -> str | None

Return "pre-content" for the tag.

This is used by the <html> tag to add a <!DOCTYPE html> before the tag.

_escape_children

_escape_children() -> bool

Returns whether the contents of the element should be escaped, or rendered plainly.

By default, all string content should be escaped to prevent security vulnerabilities such as XSS, but this is disabled for certain tags such as <script>.

_render

_render(
    indent: str,
    options: FullRenderOptions,
    skip_indent: bool = False,
) -> list[str]

Renders tag and its children to a list of strings where each string is a single line of output.

Parameters

indent : str string to use for indentation options : FullOptions rendering options skip_indent : bool whether to skip indentation for this element

Returns

list[str] list of lines of output

pyhtml.SelfClosingTag

Bases: Tag

Self-closing tags don't contain child elements

pyhtml.WhitespaceSensitiveTag

Bases: Tag

Whitespace-sensitive tags are tags where whitespace needs to be respected.

pyhtml.RenderOptions `dataclass`

PyHTML rendering options.

indent `class-attribute` `instance-attribute`

indent: str | None | EllipsisType = ...

String to add to indentation for non-inline child elements. For example, to indent using a tab, you could use '\t'. Setting the indent to None means that the output will not be indented at all, meaning that indentation from parent elements is discarded.

Defaults to 2 spaces (' ').

spacing `class-attribute` `instance-attribute`

spacing: str | EllipsisType = ...

String to use for spacing between child elements. When this is set to '\n', each child element will be placed on its own line, and indentation will be applied. Otherwise, each child element will be separated using the given string.

Defaults to a new-line ('\n').

union

union(
    other: RenderOptions | FullRenderOptions,
) -> RenderOptions

Union this set of options with the other options, returning a new Options object as the result.

Any non-ellipsis options in other will overwrite the original values.

API