Back to index

plone3  3.1.7
Public Member Functions
GenericSetup.interfaces.IImportStepRegistry Class Reference
Inheritance diagram for GenericSetup.interfaces.IImportStepRegistry:
Inheritance graph
[legend]
Collaboration diagram for GenericSetup.interfaces.IImportStepRegistry:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def sortSteps
def checkComplete
def getStep
def registerStep
def listSteps
def listStepMetadata
def getStepMetadata
def generateXML
def parseXML

Detailed Description

API for import step registry.

Definition at line 220 of file interfaces.py.


Member Function Documentation

Return a sequence of ( node, edge ) tuples for unsatisifed deps.

Definition at line 232 of file interfaces.py.

00232 
00233     def checkComplete():
00234 
00235         """ Return a sequence of ( node, edge ) tuples for unsatisifed deps.
00236         """

Return a round-trippable XML representation of the registry.

o 'handler' values are serialized using their dotted names.

Definition at line 208 of file interfaces.py.

00208 
00209     def generateXML():
00210 
00211         """ Return a round-trippable XML representation of the registry.
00212 
00213         o 'handler' values are serialized using their dotted names.
00214         """

def GenericSetup.interfaces.IImportStepRegistry.getStep (   key,
  default = None 
)
Return the IImportPlugin registered for 'key'.

o Return 'default' if no such step is registered.

Definition at line 237 of file interfaces.py.

00237 
00238     def getStep( key, default=None ):
00239 
00240         """ Return the IImportPlugin registered for 'key'.
00241 
00242         o Return 'default' if no such step is registered.
00243         """

def GenericSetup.interfaces.IStepRegistry.getStepMetadata (   key,
  default = None 
) [inherited]
Return a mapping of metadata for the step identified by 'key'.

o Return 'default' if no such step is registered.

o The 'handler' metadata is available via 'getStep'.

Definition at line 199 of file interfaces.py.

00199 
00200     def getStepMetadata( key, default=None ):
00201 
00202         """ Return a mapping of metadata for the step identified by 'key'.
00203 
00204         o Return 'default' if no such step is registered.
00205 
00206         o The 'handler' metadata is available via 'getStep'.
00207         """

Here is the caller graph for this function:

Return a sequence of mappings describing registered steps.

o Mappings will be ordered alphabetically.

Definition at line 192 of file interfaces.py.

00192 
00193     def listStepMetadata():
00194 
00195         """ Return a sequence of mappings describing registered steps.
00196 
00197         o Mappings will be ordered alphabetically.
00198         """

Base interface for step registries.
Return a sequence of IDs of registered steps.

o Order is not significant.

Definition at line 185 of file interfaces.py.

00185 
00186     def listSteps():
00187 
00188         """ Return a sequence of IDs of registered steps.
00189 
00190         o Order is not significant.
00191         """

Here is the caller graph for this function:

Parse 'text'.

Definition at line 215 of file interfaces.py.

00215 
00216     def parseXML( text ):
00217 
00218         """ Parse 'text'.
00219         """

Here is the caller graph for this function:

def GenericSetup.interfaces.IImportStepRegistry.registerStep (   id,
  version = None,
  handler = None,
  dependencies = (),
  title = None,
  description = None 
)
Register a setup step.

o 'id' is a unique name for this step,

o 'version' is a string for comparing versions, it is preferred to
  be a yyyy/mm/dd-ii formatted string (date plus two-digit
  ordinal).  when comparing two version strings, the version with
  the lower sort order is considered the older version.

  - Newer versions of a step supplant older ones.

  - Attempting to register an older one after a newer one results
    in a KeyError.

  NOTE: The version argument is deprecated.

o 'handler' should implement IImportPlugin.

o 'dependencies' is a tuple of step ids which have to run before
  this step in order to be able to run at all. Registration of
  steps that have unmet dependencies are deferred until the
  dependencies have been registered.

o 'title' is a one-line UI description for this step.
  If None, the first line of the documentation string of the handler
  is used, or the id if no docstring can be found.

o 'description' is a one-line UI description for this step.
  If None, the remaining line of the documentation string of
  the handler is used, or default to ''.

Definition at line 250 of file interfaces.py.

00250 
00251                     ):
00252         """ Register a setup step.
00253 
00254         o 'id' is a unique name for this step,
00255 
00256         o 'version' is a string for comparing versions, it is preferred to
00257           be a yyyy/mm/dd-ii formatted string (date plus two-digit
00258           ordinal).  when comparing two version strings, the version with
00259           the lower sort order is considered the older version.
00260 
00261           - Newer versions of a step supplant older ones.
00262 
00263           - Attempting to register an older one after a newer one results
00264             in a KeyError.
00265 
00266           NOTE: The version argument is deprecated.
00267 
00268         o 'handler' should implement IImportPlugin.
00269 
00270         o 'dependencies' is a tuple of step ids which have to run before
00271           this step in order to be able to run at all. Registration of
00272           steps that have unmet dependencies are deferred until the
00273           dependencies have been registered.
00274 
00275         o 'title' is a one-line UI description for this step.
00276           If None, the first line of the documentation string of the handler
00277           is used, or the id if no docstring can be found.
00278 
00279         o 'description' is a one-line UI description for this step.
00280           If None, the remaining line of the documentation string of
00281           the handler is used, or default to ''.
00282         """

API for import step registry.
Return a sequence of registered step IDs

o Sequence is sorted topologically by dependency, with the dependent
  steps *after* the steps they depend on.

Definition at line 224 of file interfaces.py.

00224 
00225     def sortSteps():
00226 
00227         """ Return a sequence of registered step IDs
00228 
00229         o Sequence is sorted topologically by dependency, with the dependent
00230           steps *after* the steps they depend on.
00231         """


The documentation for this class was generated from the following file: