gbp.deb.changelog.ChangeLog

class documentation

class ChangeLog(object):

A Debian changelog

Class Method	`create`	Create a new, empty changelog
Static Method	`spawn_dch`	Spawn dch
Method	`__getitem__`	Undocumented
Method	`__init__`	No summary
Method	`__setitem__`	Undocumented
Method	`add_entry`	Add a single changelog entry
Method	`add_section`	Add a new section to the changelog
Method	`get_changes`	Undocumented
Method	`has_epoch`	Whether the version has an epoch
Property	`author`	The author of the last modification
Property	`date`	The date of the last modification as rfc822 date
Property	`debian_version`	The Debian part of the version number
Property	`distribution`	Undocumented
Property	`email`	The author's email
Property	`epoch`	The package's epoch
Property	`filename`	The filename (path) of the changelog
Property	`name`	The packages name
Property	`noepoch`	The version string without the epoch
Property	`sections`	Get sections in the changelog
Property	`sections_iter`	Iterate over sections in the changelog
Property	`upstream_version`	The upstream version
Property	`version`	The full version string
Static Method	`_parse_maint`	Parse maintainer
Method	`_parse`	Parse a changelog based on the already read contents.
Method	`_read`	Undocumented
Method	`_run_parsechangelog`	Undocumented
Instance Variable	`_contents`	Undocumented
Instance Variable	`_cp`	Undocumented
Instance Variable	`_filename`	Undocumented

@classmethod
def create(cls, package=None, version=None): ¶

Create a new, empty changelog

@staticmethod
def spawn_dch(msg=[], author=None, email=None, newversion=False, version=None, release=False, distribution=None, dch_options=None): ¶

Spawn dch

Parameters
msg	Undocumented
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

def __getitem__(self, item): ¶

Undocumented

def __init__(self, contents=None, filename=None): ¶

Parameters
contents:`str`	the contents of the changelog
filename	`str`

def __setitem__(self, item, value): ¶

Undocumented

def 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

def 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	`dict`
dch_options:`list`	options passed verbatim to dch

def get_changes(self, since='0~'): ¶

Undocumented

def has_epoch(self): ¶

Whether the version has an epoch

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

@property
author = ¶

The author of the last modification

@property
date = ¶

The date of the last modification as rfc822 date

@property
debian_version = ¶

The Debian part of the version number

@property
distribution = ¶

Undocumented

@property
email = ¶

The author's email

@property
epoch = ¶

The package's epoch

@property
filename = ¶

The filename (path) of the changelog

@property
name = ¶

The packages name

@property
noepoch = ¶

The version string without the epoch

@property
sections = ¶

Get sections in the changelog

@property
sections_iter = ¶

Iterate over sections in the changelog

@property
upstream_version = ¶

The upstream version

@property
version = ¶

The full version string

@staticmethod
def _parse_maint(maintainer): ¶

Parse maintainer

Mostly rfc822 but we allow for commas

def _parse(self): ¶

Parse a changelog based on the already read contents.

def _read(self): ¶

Undocumented

def _run_parsechangelog(self, options=None): ¶

Undocumented

_contents = ¶

Undocumented

_cp = ¶

Undocumented

_filename = ¶

Undocumented