Method item

src/pymgrid/modules/module_container.py:420–437

Get the value of a singleton list. Returns ------- module : BaseMicrogridModule Item in a singleton list. Raises ------ ValueError : If there is more than one item in the list.

(self)

class ModuleList(UserList):
    def item(self):
        """
        Get the value of a singleton list.

        Returns
        -------
        module : BaseMicrogridModule
            Item in a singleton list.

        Raises
        ------
        ValueError :
            If there is more than one item in the list.

        """
        if len(self) != 1:
            raise ValueError("Can only convert a ModuleList of length one to a scalar")
        return self[0]

    def to_list(self):
        """