Source code for malcolm.modules.builtin.parts.helppart

from annotypes import Anno

from malcolm.core import APartName, Part, PartRegistrar, StringMeta, Widget

from ..util import set_tags

with Anno("The URL that gives some help documentation for this Block"):
    AHelpUrl = str
with Anno("The description of what the help documentation is about"):
    ADesc = str


# Pull re-used annotypes into our namespace in case we are subclassed
APartName = APartName


class HelpPart(Part):
    """Part representing a link to some help documentation for the GUI"""

    def __init__(
        self,
        help_url: AHelpUrl,
        name: APartName = "help",
        description: ADesc = "Help documentation for the Block",
    ) -> None:
        super().__init__(name)
        meta = StringMeta(description)
        set_tags(meta, widget=Widget.HELP)
        self.attr = meta.create_attribute_model(help_url)

    def setup(self, registrar: PartRegistrar) -> None:
        registrar.add_attribute_model(self.name, self.attr)