svnmailer.notifier._text.TextNotifier

Package svnmailer :: Package notifier :: Module _text :: Class TextNotifier

[show private | hide private]

Class TextNotifier

  object --+    
           |    
BaseNotifier --+
               |
              TextNotifier

Known Subclasses:: MailNotifier, StdoutNotifier

Base class for plain text notifications

The derived class must implement the run method.

Method Summary
	`__init__(self, settings, groupset)` Initialization
	`_doWritePathList(self, set)` Write the path list of a particular changeset
`str`	`getDate(self, oftime)` Returns the revision date in a human readable format
	`run(self)` Runs the notifier (abstract method)
	`writeContentDiff(self, change, raw)` Writes the content diff for a particular change
`str`	`writeContentDiffAction(self, change)` Writes the content diff action for a particular change
	`writeDiff(self, token, name1, name2, value1, value2, isfile, rec1, rec2, time)` Writes a diff
	`writeDiffList(self)` Writes the commit diffs
	`writeLockData(self)` Writes the locking metadata
	`writeMetaData(self)` Writes the commit metadata output
	`writePathInfo(self, change)` Writes a short info about the kind of change
	`writePathList(self)` Writes the commit path list
	`writePropertyDiff(self, token, name, value1, value2, time, raw)` Writes a property diff
`str`	`writePropertyDiffAction(self, change, name, values, diff_tokens)` Writes the property diff action for a particular change
	`writePropertyDiffs(self, diff_tokens, change, raw)` Writes the property diffs for a particular change
	`writeRevPropData(self, raw)` Writes the revision property change data
Inherited from BaseNotifier
`str`	`_getContentEncoding(self, path, revision)` Returns the encoding for the specified path and revision
`tuple`	`dumpContent(self, change, enc, default)` Dump the two revisions of a particular change
`str`	`getAuthor(self)` Returns the author of the revision
	`getBrowserGenerator(self, config)` Returns the browser generator if any
`unicode`	`getContentDiffAction(self, change)` Returns the content diff action for a particular change
`str`	`getContentDiffUrl(self, config, change)` Returns the content diff url for a particular change
`str`	`getContentEncodingProperty(self, path, revision)` Returns the content encoding property for a path/rev
`tuple`	`getContentEncodings(self, change, default)` Returns the encodings of the change content (base and current rev)
`svnmailer.differ.*`	`getDiffer(self, command, tags)` Returns the initialized differ
`tuple`	`getDiffTokens(self, config)` Returns valid diff tokens and tests
`str`	`getEncodingFromMimeType(self, path, revision)` Returns the encoding extracted from svn:mime-type
`str`	`getLog(self)` Returns the log entry of the revision
`unicode`	`getPropertyDiffAction(self, values)` Returns the property diff action for a particular change
`unicode` or `str`	`getTempDir(self)` Returns the temporary directory
`svnmailer.util.TempFile`	`getTempFile(self)` Returns an open temporary file container object
`int`	`getTime(self)` Returns the time of the revision in seconds since epoch
`str`	`getUrl(self, config)` Returns the revision URL
`bool`	`isBinaryProperty(self, values)` Returns if the supplied property seems to be binary
`bool`	`isOneLineProperty(self, name, value)` Returns if the supplied property value takes just one line
`bool`	`isUTF8Property(self, name)` Returns if the supplied property name represents an UTF-8 property
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
`list`	`changeset`: The list of changes to process
`svnmailer.settings._base.GroupSettingsContainer`	`config`: The group config
`svnmailer.differ.*`	`differ`: The differ object
file like object	`fp`: The file to write to
Inherited from BaseNotifier
`svnmailer.main.GroupSet`	`_groupset`: The groupset to process
`dict`	`_penc_cache`: The (path, rev) -> property encoding cache
`svnmailer.settings._base.BaseSettings`	`_settings`: The settings to use

Class Variable Summary
`list`	`__implements__` = `[<class 'svnmailer.notifier._base.BaseN...`
`str`	`OUTPUT_SEPARATOR`: the separator between headline and diff
`str`	`OUTPUT_SEPARATOR_LIGHT`: the separator between headline and property diff
Inherited from BaseNotifier
`tuple`	`_diffable_tests`: Maps `generate_diffs` list entrys to change methods
`unicode`	`ADD`: "add" token
`unicode`	`COPY`: "copy" token
`unicode`	`DELETE`: "delete" token
`str`	`ENC_CONFIG`: Magic value, meaning that the content encoding should be retrieved from the config
`str`	`ENC_DEFAULT`: Magic value to determine if the default encoding should be displayed
`str`	`ENC_PROPERTY`: The property name, where encodings could be stored
`unicode`	`MODIFY`: "modify" token
`unicode`	`NONE`: "none" token
`unicode`	`PROPCHANGE`: "propchange" token

Method Details

init(self, settings, groupset)
(Constructor)

Initialization

Overrides:: svnmailer.notifier._base.BaseNotifier.__init__

_doWritePathList(self, set)

Write the path list of a particular changeset

Parameters:: set - The changeset to process
(type=list)

getDate(self, oftime=None)

Returns the revision date in a human readable format

Returns:: The date
(type=str)

run(self)

Runs the notifier (abstract method)

Overrides:: svnmailer.notifier._base.BaseNotifier.run

writeContentDiff(self, change, raw=False)

Writes the content diff for a particular change

Parameters:: change - The particular change to process
(type=svnmailer.subversion.VersionedPathDescriptor); raw - Prefer no recoding?
(type=bool)

writeContentDiffAction(self, change)

Writes the content diff action for a particular change

Parameters:: change - The particular change to process
(type=svnmailer.subversion.VersionedPathDescriptor)

Returns:: The diff token (maybe None)
(type=str)

writeDiff(self, token, name1, name2, value1, value2, isfile=False, rec1=None, rec2=None, time=None)

Writes a diff

By default value1 and value2 are strings to diff, but if isfile is set and True, these are treated as names of files to diff.

Parameters:: token - The diff token
(type=unicode); name1 - The (faked) first filename
(type=str); name2 - The (faked) second filename
(type=str); value1 - The first value
(type=str); value2 - The second value
(type=str); isfile - are the values file names?
(type=bool)

writeDiffList(self)

Writes the commit diffs

writeLockData(self)

Writes the locking metadata

writeMetaData(self)

Writes the commit metadata output

writePathInfo(self, change)

Writes a short info about the kind of change

Parameters:: change - The change info
(type=svnmailer.subversion.VersionedPathDescriptor)

writePathList(self)

Writes the commit path list

writePropertyDiff(self, token, name, value1, value2, time=None, raw=False)

Writes a property diff

Parameters:: token - The diff token
(type=unicode); name - The name of the property
(type=str); value1 - The raw old value
(type=str); value2 - The raw new value
(type=str); time - Time to display in the diff description in seconds since epoch
(type=int); raw - Don't recode the properties?
(type=bool)

writePropertyDiffAction(self, change, name, values, diff_tokens)

Writes the property diff action for a particular change

Parameters:: change - The particular change to process
(type=svnmailer.subversion.VersionedPathDescriptor); name - The property name
(type=str); values - The values of the property
(type=tuple); diff_tokens - Valid diff tokens
(type=list)

Returns:: diff token that should be applied
(type=str)

writePropertyDiffs(self, diff_tokens, change, raw=False)

Writes the property diffs for a particular change

Parameters:: diff_tokens - The valid diff tokens
(type=list); change - The particular change to process
(type=svnmailer.subversion.VersionedPathDescriptor); raw - Don't recode the properties?
(type=bool)

writeRevPropData(self, raw=False)

Writes the revision property change data

Parameters:: raw - Don't recode the property?
(type=bool)

Instance Variable Details

changeset

The list of changes to process

Type:: list

config

The group config

Type:: svnmailer.settings._base.GroupSettingsContainer

differ

The differ object

Type:: svnmailer.differ.*

fp

The file to write to

Type:: file like object
Value:: None

Class Variable Details

implements

Type:: list
Value:: [<class 'svnmailer.notifier._base.BaseNotifier'>]

OUTPUT_SEPARATOR

the separator between headline and diff

Type:: str
Value:: '''===================================================================\ =========== '''

OUTPUT_SEPARATOR_LIGHT

the separator between headline and property diff

Type:: str
Value:: '''-------------------------------------------------------------------\ ----------- '''

Generated by Epydoc 2.0 on Sun Sep 25 20:49:16 2005

http://epydoc.sf.net