Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 3 additions & 16 deletions docs/api-reference/pydom/context/context/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,6 @@ pydom.context.context
.. py:module:: pydom.context.context


Attributes
----------

.. autoapisummary::

pydom.context.context.T
pydom.context.context.P


Classes
-------

Expand All @@ -33,21 +24,17 @@ Functions
Module Contents
---------------

.. py:data:: T

.. py:data:: P

.. py:class:: Context

.. py:attribute:: injector
:type: pydom.utils.injector.Injector


.. py:method:: add_prop_transformer(transformer: pydom.context.transformers.PropertyTransformer, /, *, before: Optional[List[Type[pydom.context.transformers.PropertyTransformer]]] = None, after: Optional[List[Type[pydom.context.transformers.PropertyTransformer]]] = None) -> None
add_prop_transformer(matcher: pydom.context.transformers.PropertyMatcherFunction, transformer: pydom.context.transformers.PropertyTransformerFunction, /, *, before: Optional[List[Type[pydom.context.transformers.PropertyTransformer]]] = None, after: Optional[List[Type[pydom.context.transformers.PropertyTransformer]]] = None) -> None
.. py:method:: add_prop_transformer(transformer: pydom.rendering.transformers.PropertyTransformer, /, *, before: Optional[List[Type[pydom.rendering.transformers.PropertyTransformer]]] = None, after: Optional[List[Type[pydom.rendering.transformers.PropertyTransformer]]] = None) -> None
add_prop_transformer(matcher: pydom.rendering.transformers.property_transformer.PropertyMatcherFunction, transformer: pydom.rendering.transformers.property_transformer.PropertyTransformerFunction, /, *, before: Optional[List[Type[pydom.rendering.transformers.PropertyTransformer]]] = None, after: Optional[List[Type[pydom.rendering.transformers.PropertyTransformer]]] = None) -> None


.. py:method:: add_post_render_transformer(transformer: Union[pydom.context.transformers.PostRenderTransformerFunction, pydom.context.transformers.PostRenderTransformer], /, *, before: Optional[List[Type[pydom.context.transformers.PostRenderTransformer]]] = None, after: Optional[List[Type[pydom.context.transformers.PostRenderTransformer]]] = None)
.. py:method:: add_post_render_transformer(transformer: Union[pydom.rendering.transformers.post_render_transformer.PostRenderTransformerFunction, pydom.rendering.transformers.PostRenderTransformer], /, *, before: Optional[List[Type[pydom.rendering.transformers.PostRenderTransformer]]] = None, after: Optional[List[Type[pydom.rendering.transformers.PostRenderTransformer]]] = None)


.. py:property:: prop_transformers
Expand Down
8 changes: 3 additions & 5 deletions docs/api-reference/pydom/context/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@ Submodules
:maxdepth: 1

/api-reference/pydom/context/context/index
/api-reference/pydom/context/feature/index
/api-reference/pydom/context/standard/index
/api-reference/pydom/context/transformers/index


Classes
Expand Down Expand Up @@ -41,11 +39,11 @@ Package Contents
:type: pydom.utils.injector.Injector


.. py:method:: add_prop_transformer(transformer: pydom.context.transformers.PropertyTransformer, /, *, before: Optional[List[Type[pydom.context.transformers.PropertyTransformer]]] = None, after: Optional[List[Type[pydom.context.transformers.PropertyTransformer]]] = None) -> None
add_prop_transformer(matcher: pydom.context.transformers.PropertyMatcherFunction, transformer: pydom.context.transformers.PropertyTransformerFunction, /, *, before: Optional[List[Type[pydom.context.transformers.PropertyTransformer]]] = None, after: Optional[List[Type[pydom.context.transformers.PropertyTransformer]]] = None) -> None
.. py:method:: add_prop_transformer(transformer: pydom.rendering.transformers.PropertyTransformer, /, *, before: Optional[List[Type[pydom.rendering.transformers.PropertyTransformer]]] = None, after: Optional[List[Type[pydom.rendering.transformers.PropertyTransformer]]] = None) -> None
add_prop_transformer(matcher: pydom.rendering.transformers.property_transformer.PropertyMatcherFunction, transformer: pydom.rendering.transformers.property_transformer.PropertyTransformerFunction, /, *, before: Optional[List[Type[pydom.rendering.transformers.PropertyTransformer]]] = None, after: Optional[List[Type[pydom.rendering.transformers.PropertyTransformer]]] = None) -> None


.. py:method:: add_post_render_transformer(transformer: Union[pydom.context.transformers.PostRenderTransformerFunction, pydom.context.transformers.PostRenderTransformer], /, *, before: Optional[List[Type[pydom.context.transformers.PostRenderTransformer]]] = None, after: Optional[List[Type[pydom.context.transformers.PostRenderTransformer]]] = None)
.. py:method:: add_post_render_transformer(transformer: Union[pydom.rendering.transformers.post_render_transformer.PostRenderTransformerFunction, pydom.rendering.transformers.PostRenderTransformer], /, *, before: Optional[List[Type[pydom.rendering.transformers.PostRenderTransformer]]] = None, after: Optional[List[Type[pydom.rendering.transformers.PostRenderTransformer]]] = None)


.. py:property:: prop_transformers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,7 @@ Module Contents

.. py:class:: ClassTransformer(prop_name='classes')

Bases: :py:obj:`pydom.context.transformers.PropertyTransformer`


Helper class that provides a standard way to create an ABC using
inheritance.
Bases: :py:obj:`pydom.rendering.transformers.PropertyTransformer`


.. py:attribute:: prop_name
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,7 @@ Module Contents

.. py:class:: DashTransformer

Bases: :py:obj:`pydom.context.transformers.PropertyTransformer`


Helper class that provides a standard way to create an ABC using
inheritance.
Bases: :py:obj:`pydom.rendering.transformers.PropertyTransformer`


.. py:method:: match(prop_name, _) -> bool
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,7 @@ Module Contents

.. py:class:: FalsyTransformer

Bases: :py:obj:`pydom.context.transformers.PropertyTransformer`


Helper class that provides a standard way to create an ABC using
inheritance.
Bases: :py:obj:`pydom.rendering.transformers.PropertyTransformer`


.. py:method:: match(_, prop_value) -> bool
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,7 @@ Module Contents

.. py:class:: HTMLEventsTransformer

Bases: :py:obj:`pydom.context.transformers.PropertyTransformer`


Helper class that provides a standard way to create an ABC using
inheritance.
Bases: :py:obj:`pydom.rendering.transformers.PropertyTransformer`


.. py:method:: match(prop_name, prop_value) -> bool
Expand Down
42 changes: 7 additions & 35 deletions docs/api-reference/pydom/context/standard/transformers/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,7 @@ Package Contents

.. py:class:: ClassTransformer(prop_name='classes')

Bases: :py:obj:`pydom.context.transformers.PropertyTransformer`


Helper class that provides a standard way to create an ABC using
inheritance.
Bases: :py:obj:`pydom.rendering.transformers.PropertyTransformer`


.. py:attribute:: prop_name
Expand All @@ -58,11 +54,7 @@ Package Contents

.. py:class:: DashTransformer

Bases: :py:obj:`pydom.context.transformers.PropertyTransformer`


Helper class that provides a standard way to create an ABC using
inheritance.
Bases: :py:obj:`pydom.rendering.transformers.PropertyTransformer`


.. py:method:: match(prop_name, _) -> bool
Expand All @@ -73,11 +65,7 @@ Package Contents

.. py:class:: FalsyTransformer

Bases: :py:obj:`pydom.context.transformers.PropertyTransformer`


Helper class that provides a standard way to create an ABC using
inheritance.
Bases: :py:obj:`pydom.rendering.transformers.PropertyTransformer`


.. py:method:: match(_, prop_value) -> bool
Expand All @@ -88,11 +76,7 @@ Package Contents

.. py:class:: HTMLEventsTransformer

Bases: :py:obj:`pydom.context.transformers.PropertyTransformer`


Helper class that provides a standard way to create an ABC using
inheritance.
Bases: :py:obj:`pydom.rendering.transformers.PropertyTransformer`


.. py:method:: match(prop_name, prop_value) -> bool
Expand All @@ -103,11 +87,7 @@ Package Contents

.. py:class:: InnerHTMLTransformer

Bases: :py:obj:`pydom.context.transformers.PropertyTransformer`


Helper class that provides a standard way to create an ABC using
inheritance.
Bases: :py:obj:`pydom.rendering.transformers.PropertyTransformer`


.. py:method:: match(prop_name: str, _) -> bool
Expand All @@ -118,11 +98,7 @@ Package Contents

.. py:class:: SimpleTransformer

Bases: :py:obj:`pydom.context.transformers.PropertyTransformer`


Helper class that provides a standard way to create an ABC using
inheritance.
Bases: :py:obj:`pydom.rendering.transformers.PropertyTransformer`


.. py:method:: match(prop_name, _) -> bool
Expand All @@ -133,11 +109,7 @@ Package Contents

.. py:class:: StyleTransformer

Bases: :py:obj:`pydom.context.transformers.PropertyTransformer`


Helper class that provides a standard way to create an ABC using
inheritance.
Bases: :py:obj:`pydom.rendering.transformers.PropertyTransformer`


.. py:method:: match(_, value)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,7 @@ Module Contents

.. py:class:: InnerHTMLTransformer

Bases: :py:obj:`pydom.context.transformers.PropertyTransformer`


Helper class that provides a standard way to create an ABC using
inheritance.
Bases: :py:obj:`pydom.rendering.transformers.PropertyTransformer`


.. py:method:: match(prop_name: str, _) -> bool
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,7 @@ Module Contents

.. py:class:: SimpleTransformer

Bases: :py:obj:`pydom.context.transformers.PropertyTransformer`


Helper class that provides a standard way to create an ABC using
inheritance.
Bases: :py:obj:`pydom.rendering.transformers.PropertyTransformer`


.. py:method:: match(prop_name, _) -> bool
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,7 @@ Module Contents

.. py:class:: StyleTransformer

Bases: :py:obj:`pydom.context.transformers.PropertyTransformer`


Helper class that provides a standard way to create an ABC using
inheritance.
Bases: :py:obj:`pydom.rendering.transformers.PropertyTransformer`


.. py:method:: match(_, value)
Expand Down
6 changes: 3 additions & 3 deletions docs/api-reference/pydom/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -215,11 +215,11 @@ Package Contents
:type: pydom.utils.injector.Injector


.. py:method:: add_prop_transformer(transformer: pydom.context.transformers.PropertyTransformer, /, *, before: Optional[List[Type[pydom.context.transformers.PropertyTransformer]]] = None, after: Optional[List[Type[pydom.context.transformers.PropertyTransformer]]] = None) -> None
add_prop_transformer(matcher: pydom.context.transformers.PropertyMatcherFunction, transformer: pydom.context.transformers.PropertyTransformerFunction, /, *, before: Optional[List[Type[pydom.context.transformers.PropertyTransformer]]] = None, after: Optional[List[Type[pydom.context.transformers.PropertyTransformer]]] = None) -> None
.. py:method:: add_prop_transformer(transformer: pydom.rendering.transformers.PropertyTransformer, /, *, before: Optional[List[Type[pydom.rendering.transformers.PropertyTransformer]]] = None, after: Optional[List[Type[pydom.rendering.transformers.PropertyTransformer]]] = None) -> None
add_prop_transformer(matcher: pydom.rendering.transformers.property_transformer.PropertyMatcherFunction, transformer: pydom.rendering.transformers.property_transformer.PropertyTransformerFunction, /, *, before: Optional[List[Type[pydom.rendering.transformers.PropertyTransformer]]] = None, after: Optional[List[Type[pydom.rendering.transformers.PropertyTransformer]]] = None) -> None


.. py:method:: add_post_render_transformer(transformer: Union[pydom.context.transformers.PostRenderTransformerFunction, pydom.context.transformers.PostRenderTransformer], /, *, before: Optional[List[Type[pydom.context.transformers.PostRenderTransformer]]] = None, after: Optional[List[Type[pydom.context.transformers.PostRenderTransformer]]] = None)
.. py:method:: add_post_render_transformer(transformer: Union[pydom.rendering.transformers.post_render_transformer.PostRenderTransformerFunction, pydom.rendering.transformers.PostRenderTransformer], /, *, before: Optional[List[Type[pydom.rendering.transformers.PostRenderTransformer]]] = None, after: Optional[List[Type[pydom.rendering.transformers.PostRenderTransformer]]] = None)


.. py:property:: prop_transformers
Expand Down
46 changes: 44 additions & 2 deletions docs/api-reference/pydom/rendering/transformers/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,15 @@ Submodules
/api-reference/pydom/rendering/transformers/property_transformer/index


Classes
-------

.. autoapisummary::

pydom.rendering.transformers.PostRenderTransformer
pydom.rendering.transformers.PropertyTransformer


Functions
---------

Expand All @@ -26,7 +35,7 @@ Functions
Package Contents
----------------

.. py:function:: post_render_transformer(*, context: Union[pydom.context.context.Context, None] = None, before: Optional[List[Type[pydom.context.transformers.PostRenderTransformer]]] = None, after: Optional[List[Type[pydom.context.transformers.PostRenderTransformer]]] = None)
.. py:function:: post_render_transformer(*, context: Union[pydom.context.Context, None] = None, before: Optional[List[Type[PostRenderTransformer]]] = None, after: Optional[List[Type[PostRenderTransformer]]] = None)

A decorator to register a function as a post-render transformer.

Expand All @@ -48,7 +57,21 @@ Package Contents



.. py:function:: property_transformer(matcher: Union[Callable[[str, Any], bool], str], *, context: Optional[pydom.context.context.Context] = None, before: Optional[List[Type[pydom.context.transformers.PropertyTransformer]]] = None, after: Optional[List[Type[pydom.context.transformers.PropertyTransformer]]] = None)
.. py:class:: PostRenderTransformer

Bases: :py:obj:`abc.ABC`


Helper class that provides a standard way to create an ABC using
inheritance.


.. py:method:: transform(element: pydom.rendering.tree.nodes.ContextNode)
:abstractmethod:



.. py:function:: property_transformer(matcher: Union[Callable[[str, Any], bool], str], *, context: Optional[pydom.context.Context] = None, before: Optional[List[Type[PropertyTransformer]]] = None, after: Optional[List[Type[PropertyTransformer]]] = None)

A decorator to register a function as a property transformer.

Expand All @@ -71,3 +94,22 @@ Package Contents



.. py:class:: PropertyTransformer

Bases: :py:obj:`abc.ABC`, :py:obj:`Tuple`\ [\ :py:obj:`PropertyMatcherFunction`\ , :py:obj:`PropertyTransformerFunction`\ ]


Helper class that provides a standard way to create an ABC using
inheritance.


.. py:method:: match(prop_name: str, prop_value, /) -> bool
:abstractmethod:



.. py:method:: transform(prop_name: str, prop_value, element: pydom.rendering.tree.nodes.ContextNode, /)
:abstractmethod:



Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,23 @@ pydom.rendering.transformers.post_render_transformer
.. py:module:: pydom.rendering.transformers.post_render_transformer


Attributes
----------

.. autoapisummary::

pydom.rendering.transformers.post_render_transformer.P
pydom.rendering.transformers.post_render_transformer.PostRenderTransformerFunction


Classes
-------

.. autoapisummary::

pydom.rendering.transformers.post_render_transformer.PostRenderTransformer


Functions
---------

Expand All @@ -15,7 +32,26 @@ Functions
Module Contents
---------------

.. py:function:: post_render_transformer(*, context: Union[pydom.context.context.Context, None] = None, before: Optional[List[Type[pydom.context.transformers.PostRenderTransformer]]] = None, after: Optional[List[Type[pydom.context.transformers.PostRenderTransformer]]] = None)
.. py:data:: P

.. py:data:: PostRenderTransformerFunction
:type: typing_extensions.TypeAlias

.. py:class:: PostRenderTransformer

Bases: :py:obj:`abc.ABC`


Helper class that provides a standard way to create an ABC using
inheritance.


.. py:method:: transform(element: pydom.rendering.tree.nodes.ContextNode)
:abstractmethod:



.. py:function:: post_render_transformer(*, context: Union[pydom.context.Context, None] = None, before: Optional[List[Type[PostRenderTransformer]]] = None, after: Optional[List[Type[PostRenderTransformer]]] = None)

A decorator to register a function as a post-render transformer.

Expand Down
Loading