duck.html.components.core.props

Module containing dictionaries for containing HTML props/style.

Module Contents

Classes

PropertyStore	A dictionary subclass to store properties for HTML components, with certain restrictions.
StyleStore	PropertyStore dictionary for component styling.

API

class duck.html.components.core.props.PropertyStore(initdict: Optional[Dict[Any, Any]] = None, on_set_item: Optional[Callable] = None, on_delete_item: Optional[Callable] = None)

Bases: dict

A dictionary subclass to store properties for HTML components, with certain restrictions.

Keys and values must both be strings. Certain methods (pop, popitem, update, setdefault, etc.) are overridden to ensure they utilize the custom setitem and delitem logic, including event hooks for set and delete operations.

Args:

• *args: Arguments to initialize the dictionary.

• **kwargs: Keyword arguments to initialize the dictionary.

Initialization

Initialize self. See help(type(self)) for accurate signature.

__delitem__(key: str, call_on_delete_item_handler: bool = True) → None

Deletes a key from the property store.

Parameters:

• key – The key to delete. Must be a string.

• call_on_delete_item_handler – Whether to call on_delete_item after the actual __delitem__.

__repr__() → str

Returns a string representation of PropertyStore.

Returns:

String representation of the PropertyStore.

Return type:

str

__setitem__(key: str, value: str, call_on_set_item_handler: bool = True) → None

Sets the value for the given key if the key is allowed.

Parameters:

• key – The key to set the value for. Must be a string.

• value – The value to set. Must be a string.

• call_on_set_item_handler – Whether to call on_set_item after the actual __setitem__.

Raises:

AssertionError – If the key or value is not a string.

__slots__

(‘__version’, ‘_on_set_item_func’, ‘_on_delete_item_func’)

_on_delete_item(k)

_on_set_item(k, v)

property _version: int

on_delete_item(key: str) → None

Called after __delitem__.

Parameters:

key – The key deleted.

on_set_item(key: str, value: Any) → None

Called after __setitem__.

Parameters:

• key – The key set.

• value – The value set.

pop(key: str, default: Any = None) → Any

Removes the specified key and returns its value. If key is not found, default is returned if provided, otherwise KeyError is raised.

Parameters:

• key – The key to remove.

• default – The value to return if key is not found.

Returns:

The value associated with the key, or default.

Return type:

Any

Raises:

KeyError – If key is not found and default is not provided.

popitem() → Tuple[str, str]

Removes and returns a (key, value) pair from the dictionary. Pairs are returned in LIFO order.

Returns:

The removed (key, value) pair.

Return type:

Tuple[str, str]

Raises:

KeyError – If the dictionary is empty.

setdefault(key: str, default: Optional[str] = None, call_on_set_item_handler: bool = True) → str

Inserts key with a value of default if key is not in the dictionary.

Parameters:

• key – The key to check.

• default – The default value to set if key is missing.

• call_on_set_item_handler – Whether to call on_set_item if setting.

Returns:

The value for the key.

Return type:

str

setdefaults(data: Dict[str, str]) → None

Calls setdefault on multiple items.

Parameters:

data – The key-value pairs to set as defaults.

update(data: Any = None, call_on_set_item_handler: bool = True, *args, **kwargs) → None

Updates the PropertyStore with the key/value pairs from data, ensuring setitem logic.

Parameters:

• data – Mapping or iterable to update from.

• call_on_set_item_handler – Whether to call on_set_item for each item.

• *args – Additional data.

• **kwargs – Additional data.

class duck.html.components.core.props.StyleStore(initdict: Optional[Dict[Any, Any]] = None, on_set_item: Optional[Callable] = None, on_delete_item: Optional[Callable] = None)

Bases: duck.html.components.core.props.PropertyStore

PropertyStore dictionary for component styling.

Initialization

Initialize self. See help(type(self)) for accurate signature.