Module `osbot_utils.helpers.html.Tag__Html`

Expand source code

from osbot_utils.helpers.html.Tag__Base import Tag__Base
from osbot_utils.helpers.html.Tag__Body import Tag__Body
from osbot_utils.helpers.html.Tag__Head import Tag__Head
from osbot_utils.utils.Misc import str_to_bytes

ATTRIBUTES_NAMES__LINK = ['lang']


class Tag__Html(Tag__Base):
    doc_type: bool = True
    body    : Tag__Body
    head    : Tag__Head
    lang    : str

    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        self.head.indent = self.indent + 1
        self.body.indent = self.indent + 1
        self.tag_name    = 'html'

    def render(self):
        self.elements = [self.head, self.body]
        self.attributes = self.attributes_values(*ATTRIBUTES_NAMES__LINK)
        if self.doc_type:
            html = "<!DOCTYPE html>\n"
        else:
            html = ""
        attributes = {}
        if self.lang:
            attributes['lang'] = self.lang

        html += self.render_element()
        return html

    def render_to_bytes(self):
        return str_to_bytes(self.render())

    def set_inner_html(self, value):
        self.body.inner_html = value
        return self

Classes

class Tag__Html (**kwargs)

A mixin class to strictly assign keyword arguments to pre-defined instance attributes during initialization.

This base class provides an init method that assigns values from keyword arguments to instance attributes. If an attribute with the same name as a key from the kwargs is defined in the class, it will be set to the value from kwargs. If the key does not match any predefined attribute names, an exception is raised.

This behavior enforces strict control over the attributes of instances, ensuring that only predefined attributes can be set at the time of instantiation and avoids silent attribute creation which can lead to bugs in the code.

Usage

class MyConfigurableClass(Kwargs_To_Self): attribute1 = 'default_value' attribute2 = True attribute3 : str attribute4 : list attribute4 : int = 42

# Other methods can be added here

Correctly override default values by passing keyword arguments

instance = MyConfigurableClass(attribute1='new_value', attribute2=False)

This will raise an exception as 'attribute3' is not predefined

instance = MyConfigurableClass(attribute3='invalid_attribute')

this will also assign the default value to any variable that has a type defined. In the example above the default values (mapped by default__kwargs and locals) will be: attribute1 = 'default_value' attribute2 = True attribute3 = '' # default value of str attribute4 = [] # default value of list attribute4 = 42 # defined value in the class

Note

It is important that all attributes which may be set at instantiation are predefined in the class. Failure to do so will result in an exception being raised.

Methods

init(**kwargs): The initializer that handles the assignment of keyword arguments to instance attributes. It enforces strict attribute assignment rules, only allowing attributes that are already defined in the class to be set.

Initialize an instance of the derived class, strictly assigning provided keyword arguments to corresponding instance attributes.

Parameters

**kwargs: Variable length keyword arguments.

Raises

Exception: If a key from kwargs does not correspond to any attribute pre-defined in the class, an exception is raised to prevent setting an undefined attribute.

Expand source code

class Tag__Html(Tag__Base):
    doc_type: bool = True
    body    : Tag__Body
    head    : Tag__Head
    lang    : str

    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        self.head.indent = self.indent + 1
        self.body.indent = self.indent + 1
        self.tag_name    = 'html'

    def render(self):
        self.elements = [self.head, self.body]
        self.attributes = self.attributes_values(*ATTRIBUTES_NAMES__LINK)
        if self.doc_type:
            html = "<!DOCTYPE html>\n"
        else:
            html = ""
        attributes = {}
        if self.lang:
            attributes['lang'] = self.lang

        html += self.render_element()
        return html

    def render_to_bytes(self):
        return str_to_bytes(self.render())

    def set_inner_html(self, value):
        self.body.inner_html = value
        return self

Ancestors

Class variables

var body : Tag__Body
var doc_type : bool
var head : Tag__Head
var lang : str

Methods

def render(self)

Expand source code

def render(self):
    self.elements = [self.head, self.body]
    self.attributes = self.attributes_values(*ATTRIBUTES_NAMES__LINK)
    if self.doc_type:
        html = "<!DOCTYPE html>\n"
    else:
        html = ""
    attributes = {}
    if self.lang:
        attributes['lang'] = self.lang

    html += self.render_element()
    return html

def render_to_bytes(self)

Expand source code

def render_to_bytes(self):
    return str_to_bytes(self.render())

def set_inner_html(self, value)

Expand source code

def set_inner_html(self, value):
    self.body.inner_html = value
    return self

Inherited members

Tag__Base:
- update_from_kwargs