Package pybaz :: Class Patchlog
[frames | no frames]

Type Patchlog

object --+
         |
        Patchlog


Log entry associated to a revision.

May be produced by Revision.patchlog or ArchSourceTree.iter_logs(). It provides an extensive summary of the associated changeset, a natural language description of the changes, and any number of user-defined extension headers.

Patchlogs are formatted according to RFC-822, and are parsed using the standard email-handling facilities.

Note that the patchlog text is not actually parsed before it is needed. That deferred evaluation feature is implemented in the _parse method.

The fundamental accessors are __getitem__, which give the text of a named patchlog header, and the description property which gives the text of the patchlog body, that is anything after the headers.

Additional properties provide appropriate standard conversion of the standard headers.


Method Summary
  __init__(self, revision, tree, fromlib)
Patchlog associated to the given revision.

str, None

__getitem__(self, header)
Text of a patchlog header by name.
  __repr__(self)

Revision, None.

get_continuation(self)
Deprecated.

str

get_creator(self)
Deprecated.

local time tuple

get_date(self)
Deprecated.

str

get_description(self)
Deprecated.

iterable of Revision

get_merged_patches(self)
Deprecated.

iterable of FileName

get_modified_files(self)
Deprecated.

iterable of FileName

get_new_files(self)
Deprecated.

iterable of Revision

get_new_patches(self)
Deprecated.

iterable of FileName

get_removed_files(self)
Deprecated.

dict

get_renamed_files(self)
Deprecated.

Revision

get_revision(self)
Deprecated.

str

get_summary(self)
Deprecated.

list of 2-tuple of str

items(self)
List of 2-tuples containing all headers and values.
    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
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Property Summary

Revision, None.

continuation: Deprecated.

Revision, None.

continuation_of: Ancestor of tag revisions.

str

creator: User id of the the creator of the associated revision.

local time tuple

date: Time of the associated revision.

str

description: Patchlog body, a long natural language description.
  fromlib

iterable of Revision

merged_patches: Revisions merged in this revision.

iterable of FileName

modified_files: Names of source files modified in the associated revision.

iterable of FileName

new_files: Source files added in the associated revision.

iterable of Revision

new_patches: New-patches header as an iterable of Revision.

iterable of FileName

removed_files: Names of source files removed in the associated revision.

dict

renamed_files: Source files renames in the associated revision.

Revision

revision: Revision associated to this patchlog.

str

summary: Patchlog summary, a one-line natural language description.
  tree

Method Details

__init__(self, revision, tree=None, fromlib=False)
(Constructor)

Patchlog associated to the given revision.

The patchlog may be retrieved from the provided tree, from the revision library if fromlib is set, or from the archive.

Parameters:
tree -

source tree to retrieve the patchlog from.


           (type=

ArchSourceTree, None

)
fromlib -

retrieve the patchlog from the revision library.


           (type=

bool

)
Raises:
ValueError -

tree and fromlib are both set.

Overrides:
__builtin__.object.__init__

__getitem__(self, header)
(Indexing operator)

Text of a patchlog header by name.

Parameters:
header -

name of a patchlog header.


           (type=

str

)
Returns:

text of the header, or None if the header is not present.


           (type=

str, None

)

get_continuation(self)

Deprecated.

Ancestor of tag revisions. None for commit and import revisions.

Returns:

Revision, None.

See Also:

Patchlog.continuation_of

get_creator(self)

Deprecated.

User id of the the creator of the associated revision.

Returns:

str

See Also:

Patchlog.creator

get_date(self)

Deprecated.

For the description of the local time tuple, see the documentation of the time module.

Returns:

local time tuple

See Also:

Patchlog.date

get_description(self)

Deprecated.

Patchlog body, a long natural language description.

Returns:

str

See Also:

Patchlog.description

get_merged_patches(self)

Deprecated.

Revisions merged in this revision. That is the revisions listed in the New-patches header except the revision of the patchlog.

Returns:

iterable of Revision

See Also:

Patchlog.merged_patches

get_modified_files(self)

Deprecated.

Names of source files modified in the associated revision.

Returns:

iterable of FileName

get_new_files(self)

Deprecated.

Source files added in the associated revision.

Returns:

iterable of FileName

See Also:

Patchlog.new_files

get_new_patches(self)

Deprecated.

New-patches header as an iterable of Revision.

Returns:

iterable of Revision

See Also:

Patchlog.new_patches

get_removed_files(self)

Deprecated.

Names of source files removed in the associated revision.

Returns:

iterable of FileName

get_renamed_files(self)

Deprecated.

Source files renames in the associated revision.

Dictionnary whose keys are old names and whose values are the corresponding new names. Explicit file ids are listed in addition to their associated source file.

Returns:

dict

get_revision(self)

Deprecated.

Revision associated to this patchlog.

Returns:

Revision

See Also:

Patchlog.revision

get_summary(self)

Deprecated.

Patchlog summary, a one-line natural language description.

Returns:

str

See Also:

Patchlog.summary

items(self)

List of 2-tuples containing all headers and values.

Returns:

list of 2-tuple of str


Property Details

continuation

Deprecated.

Ancestor of tag revisions. None for commit and import revisions.

continuation_of

Ancestor of tag revisions. None for commit and import revisions.

creator

User id of the the creator of the associated revision.

date

Time of the associated revision.

For the description of the local time tuple, see the documentation of the time module.

description

Patchlog body, a long natural language description.

merged_patches

Revisions merged in this revision.

That is the revisions listed in the New-patches header except the revision of the patchlog.

modified_files

Names of source files modified in the associated revision.

new_files

Source files added in the associated revision.

new_patches

New-patches header as an iterable of Revision.

Patchlogs added in this revision.

removed_files

Names of source files removed in the associated revision.

renamed_files

Source files renames in the associated revision.

Dictionnary whose keys are old names and whose values are the corresponding new names. Explicit file ids are listed in addition to their associated source file.

revision

Revision associated to this patchlog.

summary

Patchlog summary, a one-line natural language description.


Generated by Epydoc 2.1 on Fri Jul 7 17:05:35 2006 http://epydoc.sf.net