svnmailer.notifier.stdout.StdoutNotifier

Package svnmailer :: Package notifier :: Module stdout :: Class StdoutNotifier

[show private | hide private]

Type StdoutNotifier

  object --+        
           |        
BaseNotifier --+    
               |    
    TextNotifier --+
                   |
                  StdoutNotifier

Writes all stuff to sys.stdout

Method Summary
`str`	`_getOutputEnc(self, fp)` Returns the "proper" output encoding
	`_writeNotification(self)` Writes the whole diff notification body
	`_writePreamble(self, groups)` Writes the stdout preamble for the selected groups
	`run(self)` Print the notification to stdout
Inherited from TextNotifier
	`__init__(self, settings, groupset)` Initialization
	`_doWritePathList(self, cset)` Write the path list of a particular changeset
`str`	`getDate(self, oftime)` Returns the revision date in a human readable format
	`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
`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` of `str`	`getContentEncodings(self, change, default)` Returns the encodings of the change content (base and current rev)
`svnmailer.differ.*`	`getDiffer(self, command)` 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)...
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T...
	`__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)...

Instance Variable Summary
file like object	`_fp`: alternate file like object (for testing purposes)
Inherited from TextNotifier
`list`	`changeset`: The list of changes to process
`svnmailer.settings.GroupSettingsContainer`	`config`: The group config
`svnmailer.differ.*`	`differ`: The differ object
file like object	`fp`: The file to write to
Inherited from BaseNotifier
`list`	`_groupset`: The groupset to process
`dict`	`_penc_cache`: The (path, rev) -> property encoding cache
`svnmailer.settings.Settings`	`_settings`: The settings to use

Class Variable Summary
`list`	`__implements__` = `[<class 'svnmailer.notifier._text.TextN...`
	`_fp`: `None`
Inherited from TextNotifier
`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`: Map `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` = `'show default encoding'`
`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

_getOutputEnc(self, fp)

Returns the "proper" output encoding

If the output goes to a terminal, the method tries to get the current locale encoding. UTF-8 is default and fallback if anything fails.

Parameters:: fp - The file object written to
(type=file like object)

Returns:: The chosen encoding
(type=str)

_writeNotification(self)

Writes the whole diff notification body

_writePreamble(self, groups)

Writes the stdout preamble for the selected groups

Parameters:: groups - The groups that are notified
(type=list)

run(self)

Print the notification to stdout

Overrides:: svnmailer.notifier._text.TextNotifier.run

Instance Variable Details

_fp

alternate file like object (for testing purposes)

Type:: file like object
Value:: None

Class Variable Details

implements

Type:: list
Value:: [<class 'svnmailer.notifier._text.TextNotifier'>]

_fp

None

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

http://epydoc.sf.net