kiwi.component module documentation

Part of kiwi
No module docstring
Class Interface Undocumented
Class Attribute Undocumented
Function implements Undocumented
Class AlreadyImplementedError Called when a utility already exists.
Function provide_utility Set the utility for the named interface. If the utility is already set, an {AlreadyImplementedError} is raised.
Function get_utility Get the utility for the named interface. If the utility is not available (has not been set) a {NotImplementedError} is raised unless default is set.
Function remove_utility Remove the utility provided for an interface If the utility is not available (has not been set) {NotImplementedError} is raised.
Class _UtilityHandler Undocumented
def implements(iface):
Undocumented
def provide_utility(iface, utility, replace=False):

Set the utility for the named interface. If the utility is already set, an {AlreadyImplementedError} is raised.

Parametersifaceinterface to set the utility for.
utilityutility providing the interface.
def get_utility(iface, default=ValueUnset):

Get the utility for the named interface. If the utility is not available (has not been set) a {NotImplementedError} is raised unless default is set.

Parametersifacean interface
defaultoptional, if set return if a utility is not found
Returnsthe utility
def remove_utility(iface):

Remove the utility provided for an interface If the utility is not available (has not been set) {NotImplementedError} is raised.

Parametersifacethe interface
Returnsthe removed utility
API Documentation for Kiwi, generated by pydoctor at 2015-12-15 02:02:17.