Package moap :: Package command :: Module cl :: Class ChangeLogFile
[hide private]
[frames] | no frames]

Class ChangeLogFile

source code

extern.log.log.Loggable --+
                          |
                         ChangeLogFile

I represent a standard ChangeLog file.

Create me, then call parse() on me to parse the file into entries.

Instance Methods [hide private]
 
__init__(self, path) source code
 
parse(self, allEntries=True)
Parse the ChangeLog file into entries.
source code
 
__blocks(self) source code
 
getEntry(self, num)
Get the nth entry from the ChangeLog, starting from 0 for the most recent one.
source code
 
getReleaseIndex(self, release) source code
 
find(self, needles, caseSensitive=False)
Find and return all entries whose text matches all of the given strings.
source code

Inherited from extern.log.log.Loggable: debug, doLog, error, info, log, logFunction, logObjectName, warning, warningFailure, writeMarker

Class Variables [hide private]
  logCategory = 'ChangeLog'
Implementors can provide a category to log their messages under.
Method Details [hide private]

parse(self, allEntries=True)

source code 

Parse the ChangeLog file into entries.

Parameters:
  • allEntries (bool) - whether to parse all, or stop on the first.

getEntry(self, num)

source code 

Get the nth entry from the ChangeLog, starting from 0 for the most recent one.

Raises:
  • IndexError - If no entry could be found

find(self, needles, caseSensitive=False)

source code 

Find and return all entries whose text matches all of the given strings.

Parameters:
  • needles (list of str) - the strings to look for
  • caseSensitive (bool) - whether to do case sensitive searching