yasmin.blackboard.Blackboard Class Reference

Inheritance diagram for yasmin.blackboard.Blackboard:

Collaboration diagram for yasmin.blackboard.Blackboard:

Public Member Functions
None	__init__ (self, Dict[str, Any] init=None)
Any	__getitem__ (self, str key)
None	__setitem__ (self, str key, Any value)
None	__delitem__ (self, str key)
bool	__contains__ (self, str key)
int	__len__ (self)
str	__repr__ (self)
Dict[str, str]	remapings (self)
None	remappings (self, Dict[str, str] remapping)

Protected Attributes
dict	_data = {}
	A dictionary holding the data stored in the blackboard.

Private Member Functions
str	__remap (self, str key)

Private Attributes
Lock	__lock = Lock()
	A threading lock to ensure thread-safe access to the _data attribute.
dict	__remapping = {}
	A dictionary containing all remappings.

Detailed Description

A thread-safe blackboard for storing key-value pairs.

The Blackboard class provides a mechanism to store data in a dictionary-like format,
allowing for concurrent access and modification through thread-safe operations.

Attributes:
    _data (Dict[str, Any]): A dictionary holding the data stored in the blackboard.
    __lock (Lock): A threading lock to ensure thread-safe access to the _data attribute.

Methods:
    __getitem__(key): Retrieve a value associated with the given key.
    __setitem__(key, value): Set a value for the given key.
    __delitem__(key): Remove the value associated with the given key.
    __contains__(key): Check if a key exists in the blackboard.
    __len__(): Return the number of items in the blackboard.
    __repr__(): Return a string representation of the blackboard's data.

Constructor & Destructor Documentation

__init__()

None yasmin.blackboard.Blackboard.__init__	(		self,
		Dict[str, Any]	init = None )

Initializes the Blackboard with an optional initial dictionary.

Args:
    init (Dict[str, Any], optional): A dictionary to initialize the blackboard with.
        If None, the blackboard starts empty.

Raises:
    None

Member Function Documentation

__contains__()

bool yasmin.blackboard.Blackboard.__contains__	(		self,
		str	key )

Checks if a specified key exists in the blackboard.

Args:
    key (str): The key to check for existence.

Returns:
    bool: True if the key exists, False otherwise.

Raises:
    None

__delitem__()

None yasmin.blackboard.Blackboard.__delitem__	(		self,
		str	key )

Removes the value associated with the specified key from the blackboard.

Args:
    key (str): The key to be removed.

Returns:
    None

Raises:
    KeyError: If the key is not found in the blackboard.

__getitem__()

Any yasmin.blackboard.Blackboard.__getitem__	(		self,
		str	key )

Retrieves a value from the blackboard associated with the specified key.

Args:
    key (str): The key whose value needs to be retrieved.

Returns:
    Any: The value associated with the key.

Raises:
    KeyError: If the key is not found in the blackboard.

__len__()

int yasmin.blackboard.Blackboard.__len__

(

self

)

Returns the number of items stored in the blackboard.

Returns:
    int: The count of items in the blackboard.

Raises:
    None

__remap()

str yasmin.blackboard.Blackboard.__remap ( self, str key )

private

internal method that acquires the maped key. In the case the key is not remaped, retruns the arg key.

Args:
    key (str): The key to be remaped.
Returns:
    str: The remaped key or if is not remaped, the own key.
Raises:
    None

__repr__()

str yasmin.blackboard.Blackboard.__repr__

(

self

)

Returns a string representation of the blackboard's data.

Returns:
    str: A string representation of the current state of the blackboard.

Raises:
    None

__setitem__()

None yasmin.blackboard.Blackboard.__setitem__	(		self,
		str	key,
		Any	value )

Sets a value in the blackboard for the specified key.

Args:
    key (str): The key to associate with the value.
    value (Any): The value to be stored in the blackboard.

Returns:
    None

Raises:
    None

remapings()

Dict[str, str] yasmin.blackboard.Blackboard.remapings

(

self

)

Property getter of a dict of remappings of the blackboard keys.

Return:
    Dict: A dict with the current key remappings of the blackboard.

Raises:
    None

remappings()

None yasmin.blackboard.Blackboard.remappings	(		self,
		Dict[str, str]	remapping )

Property setter of the remapping of the blackboard keys.

Args:
    remapping (Dict): The new remap of the blackboard.

Returns:
    None

Raises:
    None

Member Data Documentation

__lock

Lock yasmin.blackboard.Blackboard.__lock = Lock()

private

A threading lock to ensure thread-safe access to the _data attribute.

__remapping

dict yasmin.blackboard.Blackboard.__remapping = {}

private

A dictionary containing all remappings.

_data

yasmin.blackboard.Blackboard._data = {}

protected

A dictionary holding the data stored in the blackboard.

---

The documentation for this class was generated from the following file:

• yasmin/yasmin/blackboard.py