httk.serve.web.renderers.base
=============================

.. py:module:: httk.serve.web.renderers.base


Classes
-------

.. autoapisummary::

   httk.serve.web.renderers.base.WidgetPlacement
   httk.serve.web.renderers.base.RenderResult
   httk.serve.web.renderers.base.Renderer


Module Contents
---------------

.. py:class:: WidgetPlacement

   A widget invocation replaced by a stable renderer placeholder.


   .. py:attribute:: placeholder
      :type:  str


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: props
      :type:  collections.abc.Mapping[str, object]


   .. py:attribute:: source_path
      :type:  pathlib.Path


   .. py:attribute:: line
      :type:  int


   .. py:attribute:: column
      :type:  int


   .. py:attribute:: snippet
      :type:  str


.. py:class:: RenderResult

   .. py:attribute:: html
      :type:  str


   .. py:attribute:: metadata
      :type:  dict[str, object]


   .. py:attribute:: widgets
      :type:  tuple[WidgetPlacement, Ellipsis]
      :value: ()



.. py:class:: Renderer

   Bases: :py:obj:`Protocol`


   Base class for protocol classes.

   Protocol classes are defined as::

       class Proto(Protocol):
           def meth(self) -> int:
               ...

   Such classes are primarily used with static type checkers that recognize
   structural subtyping (static duck-typing).

   For example::

       class C:
           def meth(self) -> int:
               return 0

       def func(x: Proto) -> int:
           return x.meth()

       func(C())  # Passes static type check

   See PEP 544 for details. Protocol classes decorated with
   @typing.runtime_checkable act as simple-minded runtime protocols that check
   only the presence of given attributes, ignoring their type signatures.
   Protocol classes can be generic, they are defined as::

       class GenProto[T](Protocol):
           def meth(self) -> T:
               ...


   .. py:method:: render(source_path: pathlib.Path) -> RenderResult