Package libconfix :: Package core :: Package machinery :: Module require :: Class Require
[show private | hide private]
[frames | no frames]

Class Require

Marshallable --+
               |
              Require

Known Subclasses:
Require_String

Method Summary
  __init__(self, urgency)
  get_marshalling_data(self)
Return marshalling data for my attributes.
  id(self)
  set_marshalling_data(self, data)
(To be documented)...
  set_urgency(self, u)
  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.
  urgency(self)
    Inherited from Marshallable
  __getstate__(self)
  __setstate__(self, data)

Class Variable Summary
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.repo.marshalling.Marshallable.get_marshalling_data (inherited documentation)

set_marshalling_data(self, data)

(To be documented)
Overrides:
libconfix.core.repo.marshalling.Marshallable.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.

Class Variable Details

URGENCY_DEFAULT

Type:
int
Value:
0                                                                     

URGENCY_DONTCARE

Type:
int
Value:
0                                                                     

URGENCY_ERROR

Type:
int
Value:
2                                                                     

URGENCY_IGNORE

Type:
int
Value:
0                                                                     

URGENCY_WARN

Type:
int
Value:
1                                                                     

Generated by Epydoc 2.1 on Fri Nov 23 16:56:34 2007 http://epydoc.sf.net