Package gbp :: Package deb :: Module changelog :: Class ChangeLog
[hide private]
[frames] | no frames]

Class ChangeLog

object --+
         |
        ChangeLog

A Debian changelog

Instance Methods [hide private]
 
__init__(self, contents=None, filename=None)
x.__init__(...) initializes x; see help(type(x)) for signature
 
_parse(self)
Parse a changelog based on the already read contents.
 
_read(self)
 
__getitem__(self, item)
 
__setitem__(self, item, value)
bool
has_epoch(self)
Whether the version has an epoch
 
add_entry(self, msg, author=None, email=None, dch_options=[])
Add a single changelog entry
 
add_section(self, msg, distribution, author=None, email=None, version={}, dch_options=[])
Add a new section to the changelog

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods [hide private]
 
spawn_dch(msg=[], author=None, email=None, newversion=False, version=None, release=False, distribution=None, dch_options=[])
Spawn dch
Properties [hide private]
  filename
The filename (path) of the changelog
  name
The packges name
  version
The full version string
  upstream_version
The upstream version
  debian_version
The Debian part of the version number
  epoch
The package's epoch
  noepoch
The version string without the epoch
  author
The author of the last modification
  email
The author's email
  date
The date of the last modification as rfc822 date
  sections_iter
Iterate over sections in the changelog
  sections
Get sections in the changelog

Inherited from object: __class__

Method Details [hide private]

__init__(self, contents=None, filename=None)
(Constructor)

 

x.__init__(...) initializes x; see help(type(x)) for signature

Parameters:
  • contents (str) - the contents of the changelog
  • filename - the filename of the changelog
  • filename - str
Overrides: object.__init__

has_epoch(self)

 

Whether the version has an epoch

Returns: bool
True if the version has an epoch, False otherwise

spawn_dch(msg=[], author=None, email=None, newversion=False, version=None, release=False, distribution=None, dch_options=[])
Static Method

 

Spawn dch

Parameters:
  • author (str) - committers name
  • email (str) - committers email
  • newversion (bool) - start a new version
  • version (str) - the verion to use
  • release (bool) - finalize changelog for releaze
  • distribution (str) - distribution to use
  • dch_options (list) - options passed verbatim to dch

add_entry(self, msg, author=None, email=None, dch_options=[])

 

Add a single changelog entry

Parameters:
  • msg (str) - log message to add
  • author (str) - name of the author of the log message
  • email (str) - email of the author of the log message
  • dch_options (list) - options passed verbatim to dch

add_section(self, msg, distribution, author=None, email=None, version={}, dch_options=[])

 

Add a new section to the changelog

Parameters:
  • msg (str) - log message to add
  • distribution (str) - distribution to set for the new changelog entry
  • author (str) - name of the author of the log message
  • email (str) - email of the author of the log message
  • version - version to set for the new changelog entry
  • version - dict
  • dch_options (list) - options passed verbatim to dch

Property Details [hide private]

filename

The filename (path) of the changelog

Get Method:
unreachable.filename(self) - The filename (path) of the changelog

name

The packges name

Get Method:
unreachable.name(self) - The packges name

version

The full version string

Get Method:
unreachable.version(self) - The full version string

upstream_version

The upstream version

Get Method:
unreachable.upstream_version(self) - The upstream version

debian_version

The Debian part of the version number

Get Method:
unreachable.debian_version(self) - The Debian part of the version number

epoch

The package's epoch

Get Method:
unreachable.epoch(self) - The package's epoch

noepoch

The version string without the epoch

Get Method:
unreachable.noepoch(self) - The version string without the epoch

author

The author of the last modification

Get Method:
unreachable.author(self) - The author of the last modification

email

The author's email

Get Method:
unreachable.email(self) - The author's email

date

The date of the last modification as rfc822 date

Get Method:
unreachable.date(self) - The date of the last modification as rfc822 date

sections_iter

Iterate over sections in the changelog

Get Method:
unreachable.sections_iter(self) - Iterate over sections in the changelog

sections

Get sections in the changelog

Get Method:
unreachable.sections(self) - Get sections in the changelog