Function use_scope

pywebio/output.py:2099–2138

use_scope(name=None, clear=False) Open or enter a scope. Can be used as context manager and decorator. See :ref:`User manual - use_scope() ` :param str name: Scope name. If it is None, a globally unique scope name is generated. (When used as context manager, the con

(name: str = None, clear: bool = False, **kwargs)

def use_scope(name: str = None, clear: bool = False, **kwargs):
    """use_scope(name=None, clear=False)

    Open or enter a scope. Can be used as context manager and decorator.

    See :ref:`User manual - use_scope() <use_scope>`

    :param str name: Scope name. If it is None, a globally unique scope name is generated.
        (When used as context manager, the context manager will return the scope name)
    :param bool clear: Whether to clear the contents of the scope before entering the scope.

    :Usage:

    ::

        with use_scope(...) as scope_name:
            put_xxx()

        @use_scope(...)
        def app():
            put_xxx()

    """
    # For backward compatible
    #     :param bool create_scope: Whether to create scope when scope does not exist.
    #     :param scope_params: Extra parameters passed to `set_scope()` when need to create scope.
    #         Only available when ``create_scope=True``.
    create_scope = kwargs.pop('create_scope', True)
    scope_params = kwargs

    if name is None:
        name = random_str(10)
    check_dom_name_value(name, 'scope name')

    def before_enter():
        if create_scope:
            if_exist = 'blank' if clear else None
            set_scope(name, if_exist=if_exist, **scope_params)  # lock the height of the scope and clear its content

    return use_scope_(name=name, before_enter=before_enter)


class use_scope_: