Module and Class Hierarchies

[show private | hide private]

[frames | no frames]

Module Hierarchy

svnmailer: This is the core svnmailer package.
- browser: Respository Browser URL construction
- cli: The svnmailer provides two different command line interfaces.
- config: Configfile parsing
- differ: Differ classes
- main: This module is the central core of the svnmailer.
- notifier: Package svnmailer.notifier
  - cia_xmlrpc: This notifier delivers a notification message in XML format to a CIA server.
  - mail: Text based email notifiers (either piped to a program or via SMTP)
  - news: Text based news notifier (via NNTP)
  - selector: notifier selector module
  - stdout: Stdout notifier - mostly for debugging purposes
  - _base: Base notifier class
  - _mail: Email notifier base module
  - _multimail: email notifier
  - _text: Plain text notifier base
  - _textmail: text based email notifier
  - _textnews: Text based news notifier
- settings: This module defines one public class, called Settings.
- stream: svnmailer stream objects
- struct_accessors: This module exactly describes the struct member definitions used by the svnmailer.
- subversion: Access to the subversion respository
- typedstruct: This module provides helpers for creating typed data structures.
- util: This module contains some utility functions and classes used in several places of the svnmailer.

Class Hierarchy

__builtin__.object: The most base type...
- __builtin__.basestring: Type basestring cannot be instantiated; it is the base for str and unicode.
  - __builtin__.str: str(object) -> string Return a nice string representation of the object.
    - svnmailer.struct_accessors._QuotedString: Holds a quoted string
- __builtin__.dict: dict() -> new empty dictionary.
  - svnmailer.util.ReadOnlyDict: Read only dictionary
  - svnmailer.util.SafeDict: A dict, which returns '' on unknown keys or false values
- svnmailer.differ.ExternalDiffer: Differ which calls an external program (e.g.
- svnmailer.differ.InternalDiffer: Differ without an external program call (uses difflib)
- svnmailer.main.Main: main svnmailer logic
- svnmailer.typedstruct.MemberDescriptor: Base class for members descriptors
  - svnmailer.struct_accessors.BaseDescriptor: Base class for svnmailer descriptors
    - svnmailer.struct_accessors.BasePostmapDescriptor: Base class for postmap only descriptors
      - svnmailer.struct_accessors.TokenlistDescriptor: (Unicode) Tokenlist storage
      - svnmailer.struct_accessors.UnicodeDescriptor: Unicode object storage
    - svnmailer.struct_accessors.BasePremapDescriptor: Base class for premap only descriptors
      - svnmailer.struct_accessors.CommandlineDescriptor: Commandline storage
      - svnmailer.struct_accessors.FilenameDescriptor: Filename storage
      - svnmailer.struct_accessors.MailactionDescriptor: Mail action parsing and storage
      - svnmailer.struct_accessors.QuotedstringDescriptor: Quoted string storage
      - svnmailer.struct_accessors.RegexDescriptor: Regex storage
      - svnmailer.struct_accessors.TokenDescriptor: Unicode token storage
    - svnmailer.struct_accessors.BooleanDescriptor: Boolean storage
    - svnmailer.struct_accessors.HumanBooleanDescriptor: Boolean storage with translater from human readable booleans
    - svnmailer.struct_accessors.IntegerDescriptor: Integer storage
    - svnmailer.struct_accessors.StdinDescriptor: Stdin storage
    - svnmailer.struct_accessors.StringDescriptor: String storage
- svnmailer.subversion.Repository: Access to the subversion repository
- svnmailer.notifier.selector.Selector: Notifier selector class
- svnmailer.settings.Settings: Settings management
  - svnmailer.config.ConfigFileSettings: Provide settings from config
- svnmailer.typedstruct.Struct: General structure stub
  - svnmailer.settings.GeneralSettingsContainer: Container for general settings
  - svnmailer.settings.GroupSettingsContainer: Container for group settings
  - svnmailer.settings.RuntimeSettingsContainer: Container for runtime settings
- svnmailer.util.TempFile: Tempfile container class
- __builtin__.type: type(object) -> the object's type...
- svnmailer.stream._BaseStream: Base stream wrapper
  - svnmailer.stream.BinaryOrUnicodeStream: Stream wrapper, which accepts unicode or binary data
  - svnmailer.stream.CountStream: Dummy stream, which throws away all data
  - svnmailer.stream.CuckooStream: Stream wrapper, which provides a method to replace the stream
  - svnmailer.stream.DevNullStream: Dummy stream, which throws away all data
  - svnmailer.stream.SplittingStream: Stream wrapper, which provides the ability to split the stream
  - svnmailer.stream.TruncatingStream: stream wrapper, which truncates after a limit
    - svnmailer.stream.TruncatingFileStream: Truncating stream, which writes the truncating note on close
  - svnmailer.stream.UnicodeStream: Stream wrapper, which accepts unicode and a specified charset
- svnmailer.util._DummyPopen3: Dummy Popen3 class for platforms which don't provide one in popen2
- svnmailer.util._DummyPopen4: Dummy Popen4 class for platforms which don't provide one in popen2
- svnmailer.util._LocaleFile: Transform filenames according to locale
- svnmailer.struct_accessors._MailAction: Mailaction container
- svnmailer.settings._Tokens: Generic token container
- svnmailer.subversion._Version: SVN version container class
- svnmailer.notifier._base.BaseNotifier: Base class for notifiers
  - svnmailer.notifier.cia_xmlrpc.CIAXMLRPCNotifier: The CIA XML-RPC Notifier class
  - svnmailer.notifier._text.TextNotifier: Base class for plain text notifications
    - svnmailer.notifier._mail.MailNotifier: Bases class for mail (like) notifiers
      - svnmailer.notifier._multimail.MultiMailNotifier: Bases class for mail notifiers using attachments for the diffs
      - svnmailer.notifier._textmail.TextMailNotifier: Bases class for textual mail notifiers
        
        svnmailer.notifier._textnews.TextNewsNotifier: Bases class for news notifiers
    - svnmailer.notifier.stdout.StdoutNotifier: Writes all stuff to sys.stdout
- svnmailer.subversion.Collector: svn 1.[01] collector
  - svnmailer.subversion._RevisionChangeCollector: Collect all changes between two particular revisions
- svnmailer.notifier._multimail.DiffDescriptor: Container class to describe a dumped diff
- svnmailer.main.GroupSet: Container object for a single groupset
- svnmailer.notifier.news.NNTPSubmitter: Use NNTP to submit the notification as news article
- svnmailer.browser.ParsedUrl: Container for URL parsing and modification
- svnmailer.subversion.PathDescriptor: Describes the basic information of a particular path
  - svnmailer.subversion.LockedPathDescriptor: Describes the lock status of a particular path
  - svnmailer.subversion.VersionedPathDescriptor: Describes the changes of a particular path
- svnmailer.notifier.mail.SendmailSubmitter: Pipe all stuff to a mailer
- svnmailer.notifier.mail.SMTPSubmitter: Use SMTP to submit the mail
- svnmailer.notifier._multimail.SplittingDecorator: Splits the content between diffs if it gets too long
- svnmailer.notifier._textmail.SplittingDecorator: Splits the content between diffs, if it gets loo long
- svnmailer.notifier._multimail.SplittingTruncatingDecorator: split/truncate decorator
- svnmailer.typedstruct.StructDescriptor: Base class for struct descriptors
  - svnmailer.typedstruct.StructDictDescriptor: _dict_ descriptor
  - svnmailer.typedstruct.StructMembersDescriptor: _members_ descriptor
  - svnmailer.typedstruct.StructSetDescriptor: _set_ descriptor
  - svnmailer.typedstruct.StructSubDescriptor: _sub_ descriptor
- svnmailer.typedstruct.StructPrivate: Private container class for Struct internals
- svnmailer.notifier._multimail.TruncatingDecorator: Truncates the mail body after n bytes
- svnmailer.notifier._textmail.TruncatingDecorator: Truncates the mail body after n bytes
- svnmailer.notifier._multimail.URLDecorator: Shows only the urls, if the mail gets too long
- svnmailer.notifier._textmail.URLDecorator: Shows only the urls, if the mail gets too long
- svnmailer.notifier._multimail.URLTruncatingDecorator: Truncates url-only mails
- svnmailer.notifier._textmail.URLTruncatingDecorator: Truncates the mail body after n bytes
- svnmailer.browser.ViewcvsGenerator: viewcvs generator
- svnmailer.browser.WebsvnGenerator: websvn generator
email.Message.Message: Basic message object.
- email.MIMEBase.MIMEBase: Base class for MIME specializations.
  - email.MIMEMultipart.MIMEMultipart: Base class for MIME multipart/* type messages.
    - svnmailer.notifier._multimail._MultiMail: A multimail class
  - email.MIMENonMultipart.MIMENonMultipart: Base class for MIME multipart/* type messages.
    - svnmailer.notifier._multimail._SinglePart: A single part of a multipart mail
    - svnmailer.notifier._textmail._TextMail: A text mail class (email.MIMEText produces undesired results)
exceptions.Exception: Common base class for all exceptions.
- svnmailer.config.Error: Base exception for this module
  - svnmailer.config.ConfigInvalidError: Config file has errors
    - svnmailer.config.ConfigMappingSectionNotFoundError: Config mapping section was not found
    - svnmailer.config.ConfigMappingSpecInvalidError: Config mapping spec was not recognized
    - svnmailer.config.ConfigOptionUnknownError: An unknown option was parsed
    - svnmailer.config.ConfigSectionNotFoundError: Specified config section was not found
  - svnmailer.config.ConfigNotFoundError: Config file not found
    - svnmailer.config.ConfigMissingError: Config not specified and not found on default locations
- svnmailer.main.Error: Base exception for this module
  - svnmailer.main.ConfigError: Configuration error occurred
  - svnmailer.main.NotifierError: An Notifier error occured
- svnmailer.subversion.RepositoryError: A repository error occured
- exceptions.StandardError: Base class for all standard Python exceptions.
  - exceptions.RuntimeError: Unspecified run-time error.
    - exceptions.NotImplementedError: Method or function hasn't been implemented yet.
      - svnmailer.struct_accessors.NotSupportedError: This method is not supported
- svnmailer.browser.Error: Base exception for this module
  - svnmailer.browser.InvalidBaseUrlError: Invalid URL was configured
- svnmailer.cli.Error: Base exception for this module
  - svnmailer.cli.CommandlineError: Error in commandline
- svnmailer.notifier._mail.Error: Base exception for this module
  - svnmailer.notifier._mail.NoRecipientsError: No recipients found
- svnmailer.notifier._multimail.Error: Base exception for this module
  - svnmailer.notifier._multimail.InvalidMailOption: Invalid Multipart mail option
optparse.OptionContainer: Abstract base class.
- optparse.OptionParser: Class attributes: standard_option_list : [Option] list of standard options that will be accepted by all instances of this parser class (intended to be overridden by subclasses).
  - svnmailer.cli.SvnmailerOptionParser: Fully initialized option parser
svn.repos.RevisionChangeCollector
- svnmailer.subversion.Collector: svn 1.[01] collector
  - svnmailer.subversion._RevisionChangeCollector: Collect all changes between two particular revisions

Generated by Epydoc 2.1 on Mon Apr 17 12:39:12 2006

http://epydoc.sf.net