Module osbot_utils.helpers.html.Tag__Style

Expand source code
from osbot_utils.helpers.html.Dict_To_Css import Dict_To_Css
from osbot_utils.helpers.html.Tag__Base import Tag__Base, INDENT_SIZE


class Tag__Style(Tag__Base):
    tag_name    : str = 'style'
    dict_to_css : Dict_To_Css

    def add_css_entry(self, selector, data):
        self.dict_to_css.add_css_entry(selector,data)
        return self

    def css(self):
        return self.dict_to_css.css

    def render(self):
        if self.dict_to_css.css:
            css_indent          = self.indent +1
            css_indent_text     = " " * css_indent * INDENT_SIZE
            element_indent_text = " " * self.indent * INDENT_SIZE
            self.inner_html = '\n' + self.dict_to_css.convert(indent=css_indent_text) + '\n' + element_indent_text
        return super().render()

    def set_css(self, css):
        self.dict_to_css.css = css

Classes

class Tag__Style (**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__Style(Tag__Base):
    tag_name    : str = 'style'
    dict_to_css : Dict_To_Css

    def add_css_entry(self, selector, data):
        self.dict_to_css.add_css_entry(selector,data)
        return self

    def css(self):
        return self.dict_to_css.css

    def render(self):
        if self.dict_to_css.css:
            css_indent          = self.indent +1
            css_indent_text     = " " * css_indent * INDENT_SIZE
            element_indent_text = " " * self.indent * INDENT_SIZE
            self.inner_html = '\n' + self.dict_to_css.convert(indent=css_indent_text) + '\n' + element_indent_text
        return super().render()

    def set_css(self, css):
        self.dict_to_css.css = css

Ancestors

Class variables

var dict_to_cssDict_To_Css
var tag_name : str

Methods

def add_css_entry(self, selector, data)
Expand source code
def add_css_entry(self, selector, data):
    self.dict_to_css.add_css_entry(selector,data)
    return self
def css(self)
Expand source code
def css(self):
    return self.dict_to_css.css
def render(self)
Expand source code
def render(self):
    if self.dict_to_css.css:
        css_indent          = self.indent +1
        css_indent_text     = " " * css_indent * INDENT_SIZE
        element_indent_text = " " * self.indent * INDENT_SIZE
        self.inner_html = '\n' + self.dict_to_css.convert(indent=css_indent_text) + '\n' + element_indent_text
    return super().render()
def set_css(self, css)
Expand source code
def set_css(self, css):
    self.dict_to_css.css = css

Inherited members