`textoutpc.nodes` – Node definitions#

class textoutpc.nodes.LinkTarget(value)#

Bases: str, Enum

Target to add to links.

SELF = 'self'#: Whether the target is the current window and tab.

BLANK = 'blank'#

Whether the target is a different window / tab.

In this case, rel="noopener" is also added, in order for the new window / tab to have no access to the current window / tab.

class textoutpc.nodes.NodeHTMLRenderEnvironment(*, link_target: LinkTarget = LinkTarget.BLANK, smiley_url_format: str = 'https://www.planet-casio.com/images/smileys/{name}.gif', calc_url_format: str = 'https://www.planet-casio.com/images/icones/calc/{name}.png', staff_image_url_format: str = 'https://www.planet-casio.com/storage/staff/{path}', user_profile_url_format: str = 'https://www.planet-casio.com/Fr/compte/voir_profil.php?membre={username}', topic_url_format: str = 'https://www.planet-casio.com/Fr/forums/lecture_sujet.php?id={id}', tutorial_url_format: str = 'https://www.planet-casio.com/Fr/programmation/tutoriels.php?id={id}', program_url_format: str = 'https://www.planet-casio.com/Fr/programmes/voir_un_programme_casio.php?showid={id}', email_script_url: str = 'https://www.planet-casio.com/scripts/public/email.php')#

Bases: BaseModel

Node rendering environment.

link_target: LinkTarget#: Link target.

smiley_url_format: str#: URL format for smileys.

calc_url_format: str#: URL format for calculator icons.

staff_image_url_format: str#: URL format for staff images.

user_profile_url_format: str#: URL format for members.

topic_url_format: str#: URL format for topics.

tutorial_url_format: str#: URL format for tutorials.

program_url_format: str#: URL format for programs.

email_script_url: str#: URL to the e-mail display format.

class textoutpc.nodes.Node#

Bases: ABC, BaseModel

Base node in a textoutpc tree.

abstract render_html(env: NodeHTMLRenderEnvironment, /) → str#

Render the node as HTML.

Parameters:: env – Environment with all of the options.
Returns:: Rendered HTML version of the node.

class textoutpc.nodes.TextNode(content: str | None = None)#

Bases: Node

Textual node in a textoutpc tree.

content: str#: Content.

render_html(env: NodeHTMLRenderEnvironment, /) → str#

Render the node as HTML.

Parameters:: env – Environment with all of the options.
Returns:: Rendered HTML version of the node.

class textoutpc.nodes.ContainerNode(children: Iterable[Node] | None = None)#

Bases: Node

Container node in a textoutpc tree.

AUTHORIZED_CHILDREN_TYPES: ClassVar[Sequence[type[Node] | tuple[type[Node], int | range]] | None] = None#

Authorized children types.

This is a sequence of either the type to check, or the authorized count of this type of node. Here’s an example use of this property:

class MyContainerNode(ContainerNode):
    AUTHORIZED_CHILDREN_TYPES = (
        MyFirstNode,
        (MySecondNode, 4),
        (MyThirdNode, range(1, 3)),
    )

This example presents the following constraints:

Children are either instances of MyFirstNode, MySecondNode or MyThirdNode;
There must be exactly 4 MySecondNode instances;
There must be 1 or 2 MyThirdNode instances.

children: tuple[Node, ...]#: Children.

find_children(type_or_types: tuple[type, ...] | type | None = None, /, *, exclude_type: type | None = None, exclude_types: tuple[type, ...] | None = None) → Iterator[Node]#

Find children with the provided filters.

Parameters:

type_or_types – Only count children of the provided type or types.
exclude_type – Exclude the provided type in the count.
exclude_types – Exclude the provided types in the count.

Returns:

Children for the provided filters.

Find a single child with the provided filters.

Parameters:

type_or_types – Only count children of the provided type or types.
exclude_type – Exclude the provided type in the count.
exclude_types – Exclude the provided types in the count.

Returns:

Child for the provided filters.

Raises:

ChildNotFound –
TooManyChildren –

count_children(type_or_types: tuple[type, ...] | type | None = None, /, *, exclude_type: type | None = None, exclude_types: tuple[type, ...] | None = None) → int#

Count children of a provided type.

Parameters:

type_or_types – Only count children of the provided type or types.
exclude_type – Exclude the provided type in the count.
exclude_types – Exclude the provided types in the count.

Returns:

Count of children for the provided filters.

render_children_html(env: NodeHTMLRenderEnvironment, /) → str#

Render the node’s children as HTML.

Parameters:: env – Environment with all of the options.
Returns:: Rendered HTML version of the node’s children.

class textoutpc.nodes.BlockNode#

Bases: Node

Block-level node.

class textoutpc.nodes.BlockContainerNode(children: Iterable[Node] | None = None)#

Bases: ContainerNode, BlockNode

Block-level node that can contain both block and inline nodes.

children: tuple[Node, ...]#: Children.

class textoutpc.nodes.BlockInlineContainerNode(children: Iterable[Node] | None = None)#

Bases: ContainerNode, BlockNode

Block-level node that can contain inline nodes.

children: tuple[Node, ...]#: Children.

class textoutpc.nodes.InlineNode#

Bases: Node

Inline-level node.

class textoutpc.nodes.InlineContainerNode(children: Iterable[Node] | None = None)#

Bases: ContainerNode, InlineNode

Inline-level node that can contain other inline nodes.

children: tuple[Node, ...]#: Children.

class textoutpc.nodes.ParagraphNode(children: Iterable[Node] | None = None, *, align: Literal['center', 'left', 'right', 'justify'] | None = None)#