libconfix.core.machinery.require_string.Require

Package libconfix :: Package core :: Package machinery :: Module require_string :: Class Require_String

[show private | hide private]

Class Require_String

Marshallable --+    
               |    
         Require --+
                   |
                  Require_String

Known Subclasses:: Require_Callable, Require_CInclude, Require_IDL, Require_Symbol, RequireRelocatedHeader

Method Summary
	`__init__(self, string, found_in, urgency)`
	`found_in(self)`
	`get_marshalling_data(self)` Return marshalling data for my attributes.
	`is_equal(self, other)`
	`set_marshalling_data(self, data)` (To be documented)...
	`string(self)`
	`update(self, r)` When multiple equivalent Require objects are added to the same module, this adds unnecessary (and sometimes considerable) overhead to the resolving process.
Inherited from Require
	`id(self)`
	`set_urgency(self, u)`
	`urgency(self)`
Inherited from Marshallable
	`__getstate__(self)`
	`__setstate__(self, data)`

Class Variable Summary
Inherited from Require
`int`	`URGENCY_DEFAULT` = 0
`int`	`URGENCY_DONTCARE` = 0
`int`	`URGENCY_ERROR` = 2
`int`	`URGENCY_IGNORE` = 0
`int`	`URGENCY_WARN` = 1
Inherited from Marshallable
`str`	`ATTRIBUTES` = `'attributes'`
`str`	`GENERATING_CLASS` = `'generating_class'`
`str`	`VERSIONS` = `'versions'`

Method Details

get_marshalling_data(self)

Return marshalling data for my attributes.

To be implemented by derived classes.

The returned marshalling data is a dictionary object that
contains relatively anonymous data which represents the object
to be marshalled. The dictionary is composed by derived
classes and must look as follows:

::

   {
      'generating_class': <class object of generating object>,
      'versions': <versions of contributions>,
      'attributes': <dictionary with direct attributes key/value pairs>,
   }

Called indirectly by `__getstate__`.

Overrides:: libconfix.core.machinery.require.Require.get_marshalling_data (inherited documentation)

set_marshalling_data(self, data)

(To be documented)

Overrides:: libconfix.core.machinery.require.Require.set_marshalling_data (inherited documentation)

update(self, r)

When multiple equivalent Require objects are added to the
same module, this adds unnecessary (and sometimes
considerable) overhead to the resolving process. This method
is an attempt to collapse r with self.

@rtype: boolean

@return: A boolean that indicates whether the objects could be
collapsed.

Overrides:: libconfix.core.machinery.require.Require.update (inherited documentation)

Generated by Epydoc 2.1 on Fri Nov 23 16:56:35 2007

http://epydoc.sf.net