Package svnmailer :: Module main :: Class Main
[show private | hide private]
[frames | no frames]

Class Main

object --+
         |
        Main


main svnmailer logic
Method Summary
  __init__(self, options)
Initialization
  run(self)
Dispatches the work to be done
  _closeRepository(self)
Closes the repository
list _getChanges(self)
Returns the list of changes for the requested revision
dict _getDefaultSubst(self, group, repos_path, path)
Returns the default substitution dict
list _getGroupsByChange(self, change)
Returns the matching groups for a particular change
list of list _getGroupSets(self)
Returns the list of groupsets (grouped groups...) to notify
list of svnmailer.notifier.* _getNotifiers(self)
Returns the notifiers to use for a particular groupset
svnmailer.config.ConfigFileSettings _getSettings(self, options)
Returns the settings object
  _openRepository(self)
Opens the repository
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name...
  __getattribute__(...)
x.__getattribute__('name') <==> x.name...
  __hash__(x)
x.__hash__() <==> hash(x)...
  __reduce__(...)
helper for pickle...
  __reduce_ex__(...)
helper for pickle...
  __repr__(x)
x.__repr__() <==> repr(x)...
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value...
  __str__(x)
x.__str__() <==> str(x)...
    Inherited from type
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T...

Instance Variable Summary
svnmailer.settings.Settings _settings: The settings to use

Method Details

__init__(self, options)
(Constructor)

Initialization
Parameters:
options - Command line options
           (type=optparse.OptionParser)
Overrides:
__builtin__.object.__init__

run(self)

Dispatches the work to be done

_closeRepository(self)

Closes the repository

_getChanges(self)

Returns the list of changes for the requested revision
Returns:
The list of changes
           (type=list)

_getDefaultSubst(self, group, repos_path, path)

Returns the default substitution dict
Parameters:
group - The group to consider
           (type=

svnmailer.settings._GroupSettingsContainer)

repos_path - The repository path
           (type=unicode)
path - The change path
           (type=unicode)
Returns:
The initialized dictionary
           (type=dict)

_getGroupsByChange(self, change)

Returns the matching groups for a particular change
Parameters:
change - The change to select
           (type=

svnmailer.subversion._PathChangeDescriptor)

Returns:
The group list
           (type=list)

_getGroupSets(self)

Returns the list of groupsets (grouped groups...) to notify
Returns:
The list (maybe empty). The list elements are two element-lists. The first item is a list of the groups that should be notified for the changeset that is represented by the second item (also a list). Example:
   groupset = [
       [ [group1, group2], [changeA, changeB] ], # a groupset
       [ [group3],         [changeX] ],    # another groupset
   ]

           (type=list of list)

_getNotifiers(self)

Returns the notifiers to use for a particular groupset
Returns:
The notifiers
           (type=list of svnmailer.notifier.*)

Note: Currently this returns just one notifier, but its so designed, that multiple notifiers could be supported in the future. For example, one that sends a mail to a commits mailing list and another that notifies http://cia.navi.cx/.

_getSettings(self, options)

Returns the settings object
Parameters:
options - Command line options
           (type=optparse.OptionParser)
Returns:
The settings object
           (type=svnmailer.config.ConfigFileSettings)
Raises:
ConfigError - configuration error

_openRepository(self)

Opens the repository

Instance Variable Details

_settings

The settings to use
Type:
svnmailer.settings.Settings

Generated by Epydoc 2.0 on Mon Feb 14 16:49:18 2005 http://epydoc.sf.net