svndump.file.SvnDumpFile

Package svndump :: Module file :: Class SvnDumpFile

[show private | hide private]

Class SvnDumpFile

A class for reading and writing svn dump files.

Method Summary
	`__init__(self)`
	`add_node(self, node)` Add a node to the current revision.
	`add_rev(self, revProps)` Add a new revision to this dump file.
	`add_rev_from_dump(self, dump)` Add the current revision of the specified SvnDumpFile to this one.
	`close(self)` Close this svn dump file.
	`create_with_rev_0(self, filename, uuid, rev0date)` Create a new dump file starting with revision 0.
	`create_with_rev_n(self, filename, uuid, firstRevNr)` Create a new dump file.
SvnDumpNode	`get_node(self, index)` Returns the node at the given index.
integer	`get_node_count(self)` Returns the count of nodes of the current revision.
string	`get_rev_author(self)` Returns the author of the current revision.
list( integer )	`get_rev_date(self)` Returns the date of the current revision as [ time_t, micros ].
string	`get_rev_date_str(self)` Returns the date of the current revision as string.
string	`get_rev_log(self)` Returns the log message of the current revision.
integer	`get_rev_nr(self)` Returns the current revision number.
list( string )	`get_rev_prop_names(self)` Returns a list of revision property names of the current revision.
string	`get_rev_prop_value(self, name)` Returns the value of the revision property with the specified name.
dict( string -> string )	`get_rev_props(self)` Returns a dict containing the revision properties.
string	`get_uuid(self)` Returns the UUID of this dump file.
bool	`has_rev_prop(self, name)` Returns true if the revision has a property with the specified name.
bool	`has_revision(self)` Returns false when EOF occured.
	`open(self, filename)` Open a dump file for reading and read the header.
	`read_next_rev(self)` Read the next revision.
string	`__create_prop_string(self, properties)` Create a string from a dict containing properties.
dict( string -> string )	`__get_prop_list(self)` Get a list of properties.
list( string )	`__get_tag(self, raiseEof)` Read a Tag line (name: value).
dict( string -> string )	`__get_tag_list(self)` Get a list of tags, end is an empty line.
string	`__read_bin(self, length)` Read some bytes.
integer, string	`__read_line(self, raiseEof)` Read one line from teh dump file.
string	`__set_rev_date(self, dateStr)` Check a date string, set and return a valid one.
	`__skip_bin(self, length)` Skip some bytes.
	`__skip_empty_line(self)` Read one line from the dump file and check that it is empty.

Method Details

add_node(self, node)

Add a node to the current revision.

This method uses SvnDumpNode.write_text_to_file().

Parameters:: node - The node to add.
(type=SvnDumpNode)

add_rev(self, revProps)

Add a new revision to this dump file.

Parameters:: revProps - A dict with revision properties.
(type=dict( string -> string ))

add_rev_from_dump(self, dump)

Add the current revision of the specified SvnDumpFile to this one.

Parameters:: dump - A dump file.
(type=SvnDumpFile)

close(self)

Close this svn dump file.

create_with_rev_0(self, filename, uuid, rev0date)

Create a new dump file starting with revision 0.

Parameters:: filename - Name of the new dump file.
(type=string); uuid - UUID of the new dump file.
(type=string); rev0date - Svn date string for revision 0.
(type=string)

create_with_rev_n(self, filename, uuid, firstRevNr)

Create a new dump file.

Parameters:: filename - Name of the new dump file.
(type=string); uuid - UUID of the new dump file.
(type=string); firstRevNr - First revision number (>0).
(type=integer)

get_node(self, index)

Returns the node at the given index.

Parameters:: index - Index of the node to return.
(type=integer)

Returns:: The node at the given index.
(type=SvnDumpNode)

get_node_count(self)

Returns the count of nodes of the current revision.

Returns:: Node count of the curent revision.
(type=integer)

get_rev_author(self)

Returns the author of the current revision.

Returns:: Author of the current revision.
(type=string)

get_rev_date(self)

Returns the date of the current revision as [ time_t, micros ].

Returns:: The revision date.
(type=list( integer ))

get_rev_date_str(self)

Returns the date of the current revision as string.

Returns:: The revision date.
(type=string)

get_rev_log(self)

Returns the log message of the current revision.

Returns:: The log message.
(type=string)

get_rev_nr(self)

Returns the current revision number.

Returns:: The current revision number.
(type=integer)

get_rev_prop_names(self)

Returns a list of revision property names of the current revision.

Returns:: A list of revision property names.
(type=list( string ))

get_rev_prop_value(self, name)

Returns the value of the revision property with the specified name.

Parameters:: name - Name of the property.
(type=string)

Returns:: The value of the revision property.
(type=string)

get_rev_props(self)

Returns a dict containing the revision properties.

Returns:: The revision properties.
(type=dict( string -> string ))

get_uuid(self)

Returns the UUID of this dump file.

Returns:: UUID of this dump file.
(type=string)

has_rev_prop(self, name)

Returns true if the revision has a property with the specified name.

Returns:: True if the revision has that property.
(type=bool)

has_revision(self)

Returns false when EOF occured.

Returns:: False if EOF occured.
(type=bool)

open(self, filename)

Open a dump file for reading and read the header.

Parameters:: filename - Name of an existing dump file.
(type=string)

read_next_rev(self)

Read the next revision.

__create_prop_string(self, properties)

Create a string from a dict containing properties.

Parameters:: properties - A dict containing the properties.
(type=dict( string -> string ))

Returns:: A string containing the properties.
(type=string)

__get_prop_list(self)

Get a list of properties.

Returns:: A dict containing the properties.
(type=dict( string -> string ))

__get_tag(self, raiseEof)

Read a Tag line (name: value).

Parameters:: raiseEof - Raise SvnDumpException when true and EOF occured.
(type=integer (+++should be bool!))

Returns:: A list containing the tag name and value.
(type=list( string ))

__get_tag_list(self)

Get a list of tags, end is an empty line.

Returns:: A dict containing the tags.
(type=dict( string -> string ))

__read_bin(self, length)

Read some bytes.

Parameters:: length - Count of bytes to read.
(type=integer)

Returns:: The data read.
(type=string)

__read_line(self, raiseEof)

Read one line from teh dump file.

Parameters:: raiseEof - Raise SvnDumpException when true and EOF occured.
(type=integer (+++should be bool!))

Returns:: (eof, line), line without LF.
(type=integer, string)

__set_rev_date(self, dateStr)

Check a date string, set and return a valid one.

If the date is less or equal the previous revision date the current revision date will be set to the previous plus one micro second.

Parameters:: dateStr - A svn date string.
(type=string)

Returns:: A svn date string.
(type=string)

__skip_bin(self, length)

Skip some bytes.

Parameters:: length - Count of bytes to skip.
(type=integer)

__skip_empty_line(self)

Read one line from the dump file and check that it is empty.

Generated by Epydoc 2.1 on Mon Mar 14 01:16:35 2005

http://epydoc.sf.net