kiwi.python module documentation

Part of kiwi

Generic python addons

Class ClassInittableMetaType Undocumented
Class ClassInittableObject I am an object which will call a classmethod called __class_init__ when I am created. Subclasses of me will also have __class_init__ called.
Class AttributeForwarder AttributeForwarder is an object which is used to forward certain attributes to another object.
Function namedAny Get a fully named package, module, module-global object, or attribute.
Class Settable No summary
Function qual Convert a class to a string representation, which is the name of the module plut a dot plus the name of the class.
Function clamp No summary
Function slicerange Takes a slice object and returns a range iterator
Function deprecationwarn Prints a deprecation warning
Function disabledeprecationcall Disables all deprecation warnings during the function call to func
Class enum enum is an enumered type implementation in python.
Function all Predict used to check if all items in a seq are True. @returns: True if all items in seq are True
Function any Predict used to check if any item in a seq are True. @returns: True if any item in seq is True
Class _ForwardedProperty Undocumented
def namedAny(name):

Get a fully named package, module, module-global object, or attribute.

Parametersname
Returnsobject, module or attribute
def qual(klass):

Convert a class to a string representation, which is the name of the module plut a dot plus the name of the class.

Returnsfully qualified module and class name
def clamp(x, low, high):

Ensures that x is between the limits set by low and high. For example, * clamp(5, 10, 15) is 10. * clamp(15, 5, 10) is 10. * clamp(20, 15, 25) is 20.

Parametersxthe value to clamp.
lowthe minimum value allowed.
highthe maximum value allowed.
Returnsthe clamped value
def slicerange(slice, limit):

Takes a slice object and returns a range iterator

Parameterssliceslice object
limitmaximum value allowed
Returnsiterator
def deprecationwarn(msg, stacklevel=2):

Prints a deprecation warning

def disabledeprecationcall(func, *args, **kwargs):

Disables all deprecation warnings during the function call to func

def all(seq):

Predict used to check if all items in a seq are True.

ReturnsTrue if all items in seq are True
def any(seq):

Predict used to check if any item in a seq are True.

ReturnsTrue if any item in seq is True
API Documentation for Kiwi, generated by pydoctor at 2015-12-15 11:23:22.