basictypes.factory
index
p:\properties\basictypes\factory.py

(preliminary) Model of a Factory Callable object

 
Modules
       
basicproperty.basic
basictypes.callable
basicproperty.common
basictypes.list_types
basicproperty.propertied

 
Classes
       
Callable(Propertied)
Factory
ListOf(rlist)
listof_Factories

 
class Factory(Callable)
    An object intended to create instances of a type
 
The factory allows you to create instances of a type
through the GUI.  Most factories will allow for
entirely-default calling (i.e. Factory() creates a
new, valid instance).  Others may require interactive
definition of certain parameters.
 
 
Method resolution order:
Factory
Callable
Propertied
object

Methods inherited from Callable:
__call__(self, *arguments, **named)
Do the actual calling of the callable object
__eq__(self, other)
Determine whether other is our equivalent
 
returns true if other is of the same class, with
the same primary attributes
__init__(self, implementation, name=[], arguments=[], shortHelp=[], longHelp=[], **named)
Initialize the Callable object
 
implementation -- a callable python object
name -- if provided, will override the given name
arguments -- if provided, will override calculated arguments
shortHelp -- short help-string, first line of __doc__ if not given
longHelp -- long help-string, entire __doc__ string if not given
__str__(self)
Return a friendly string representation
getArgument(self, name)
Retieve an argument by name

Class methods inherited from Callable:
check(cls, value) from type
Strict check to see if value is an instance of cls
coerce(cls, value) from type
Coerce value to a Callable-object

Data and other attributes inherited from Callable:
arguments = <ListProperty 'arguments'>
Argument-list for the callable object
implementation = <BasicProperty 'implementation'>
The underlying implementation (callable Python object)
longHelp = <StringProperty 'longHelp'>
Longer help-string suitable for context-sensitive help
name = <StringProperty 'name'>
The callable object's-name (may be different from underlying object)
shortHelp = <StringProperty 'shortHelp'>
Short help-string suitable for tooltips/status-bars

Methods inherited from Propertied:
clone(self, **newValues)
Clone this object, with optional new property values
 
This method calls the __init__ method of your class with
the current property values of your class.  Providing newValues
(a dictionary) overrides property settings with new values.
getCloneProperties(self)
Get properties dictionary (key:value) for use in cloning of the instance
 
By default you get getProperties()' values, with an
attempt made to use the property's name, then the property's
direct "__get__" method.
toString(self, indentation='', alreadyDone=None, indentString=' ')
Get a nicely formatted representation of this object
 
This version assumes that getProperties returns
the list of properties which should be presented,
it recursively calls it's children with greater
indents to get their representations.
 
indentation -- current string indentation level
alreadyDone -- set of object ids which are already finished
 
XXX Needs a far better API, likely a stand-alone class
        without the automatic inheritance problems here :(

Class methods inherited from Propertied:
getProperties(cls) from type
Get the BasicProperty properties for a particular object's class

Data and other attributes inherited from Propertied:
__dict__ = <dictproxy object at 0x02749EF0>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'Propertied' objects>
list of weak references to the object (if defined)

 
class listof_Factories(ListOf)
    
Method resolution order:
listof_Factories
ListOf
rlist
list
object

Data and other attributes defined here:
dataType = 'list.Factories'

Methods inherited from ListOf:
beforeAdd(self, value)
Called before all attempts to add an item

Methods inherited from rlist:
__iadd__ = extend(self, value)
extend with value checking
__init__(self, value=None)
Initialize the restricted list object
__setitem__(self, index, value)
__setitem__ with value checking
__setslice__(self, start, stop, value)
__setslice__ with value checking
append(self, value)
append with value checking
beforeMultipleAdd(self, value)
Called before attempts to add more than one item (beforeAdd has already be called for each item)
extend(self, value)
extend with value checking
insert(self, index, value)
insert with value checking

Data and other attributes inherited from rlist:
__dict__ = <dictproxy object at 0x02749550>
dictionary for instance variables (if defined)
__weakref__ = <attribute '__weakref__' of 'rlist' objects>
list of weak references to the object (if defined)

Methods inherited from list:
__add__(...)
x.__add__(y) <==> x+y
__contains__(...)
x.__contains__(y) <==> y in x
__delitem__(...)
x.__delitem__(y) <==> del x[y]
__delslice__(...)
x.__delslice__(i, j) <==> del x[i:j]
 
Use of negative indices is not supported.
__eq__(...)
x.__eq__(y) <==> x==y
__ge__(...)
x.__ge__(y) <==> x>=y
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__gt__(...)
x.__gt__(y) <==> x>y
__hash__(...)
x.__hash__() <==> hash(x)
__imul__(...)
x.__imul__(y) <==> x*=y
__iter__(...)
x.__iter__() <==> iter(x)
__le__(...)
x.__le__(y) <==> x<=y
__len__(...)
x.__len__() <==> len(x)
__lt__(...)
x.__lt__(y) <==> x<y
__mul__(...)
x.__mul__(n) <==> x*n
__ne__(...)
x.__ne__(y) <==> x!=y
__repr__(...)
x.__repr__() <==> repr(x)
__rmul__(...)
x.__rmul__(n) <==> n*x
count(...)
L.count(value) -> integer -- return number of occurrences of value
index(...)
L.index(value, [start, [stop]]) -> integer -- return first index of value
pop(...)
L.pop([index]) -> item -- remove and return item at index (default last)
remove(...)
L.remove(value) -- remove first occurrence of value
reverse(...)
L.reverse() -- reverse *IN PLACE*
sort(...)
L.sort(cmpfunc=None) -- stable sort *IN PLACE*; cmpfunc(x, y) -> -1, 0, 1

Data and other attributes inherited from list:
__new__ = <built-in method __new__ of type object at 0x1E0C3C78>
T.__new__(S, ...) -> a new object with type S, a subtype of T