| | |
- ListOf(rlist)
-
- Callables
- listof_Arguments
- Propertied(object)
-
- Argument
- Callable
class Argument(Propertied) |
| |
Representation of a single argument on a callable object
|
| |
- Method resolution order:
- Argument
- Propertied
- object
Methods defined here:
- __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, name, default=[], baseType=[], **named)
- Initialize the Callable object
name -- the argument name
default -- if provided, will provide the default value
for the argument
baseType -- if provided, will allow for type checking
and coercion of arguments before calling the callable
object.
- __repr__ = __str__(self)
- __str__(self)
- Create a friendly string representation
Class methods defined here:
- 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 cls instance
Accepted forms:
("name",)
("name",default)
("name",default,baseType)
"name"
{ ** } # passed to the initialiser
Data and other attributes defined here:
- baseType = <BasicProperty 'baseType'>
- Base data-type for the argument, may be NULL/unavailable
- default = <BasicProperty 'default'>
- Default-value for the argument, may be NULL/unavailable
- name = <StringLocaleProperty 'name'>
- The argument's name, as a simple string
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 0x01A309F0>
- dictionary for instance variables (if defined)
- __weakref__ = <attribute '__weakref__' of 'Propertied' objects>
- list of weak references to the object (if defined)
|
class Callable(Propertied) |
| |
Modelling of a callable Python object
|
| |
- Method resolution order:
- Callable
- Propertied
- object
Methods defined here:
- __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 defined here:
- 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 defined here:
- 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 0x01A30F90>
- dictionary for instance variables (if defined)
- __weakref__ = <attribute '__weakref__' of 'Propertied' objects>
- list of weak references to the object (if defined)
|
class Callables(ListOf) |
| | |
- Method resolution order:
- Callables
- ListOf
- rlist
- list
- object
Data and other attributes defined here:
- dataType = 'list.Callables'
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 0x01A30F70>
- 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
|
class listof_Arguments(ListOf) |
| | |
- Method resolution order:
- listof_Arguments
- ListOf
- rlist
- list
- object
Data and other attributes defined here:
- dataType = 'list.Arguments'
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 0x01A30E90>
- 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
| |