subvertpy.properties : API documentation

Class	InvalidExternalsDescription	Undocumented
Function	is_valid_property_name	Check the validity of a property name.
Function	time_to_cstring	Determine string representation of a time.
Function	time_from_cstring	Parse a time from a cstring.
Function	parse_externals_description	Parse an svn:externals property value.
Function	parse_mergeinfo_property	Parse a mergeinfo property.
Function	generate_mergeinfo_property	Generate the contents of the svn:mergeinfo property
Function	range_includes_revnum	Check if the specified range contains the mentioned revision number.
Function	range_add_revnum	Add revision number to a list of ranges
Function	mergeinfo_includes_revision	Check if the specified mergeinfo contains a path in revnum.
Function	mergeinfo_add_revision	Add a revision to a mergeinfo dictionary
Function	diff	Find the differences between two property dictionaries.

def is_valid_property_name(prop):

Check the validity of a property name.

:param prop: Property name :return: Whether prop is a valid property name

def time_to_cstring(timestamp):

Determine string representation of a time.

:param timestamp: Timestamp :return: string with date

def time_from_cstring(text):

Parse a time from a cstring.

:param text: Parse text :return: timestamp

def parse_externals_description(base_url, val):

Parse an svn:externals property value.

:param base_url: URL on which the property is set. Used for 
    relative externals.

:returns: dictionary with local names as keys, (revnum, url)
          as value. revnum is the revision number and is 
          set to None if not applicable.

def parse_mergeinfo_property(text):

Parse a mergeinfo property.

:param text: Property contents

def generate_mergeinfo_property(merges):

Generate the contents of the svn:mergeinfo property

:param merges: dictionary mapping paths to lists of ranges :return: Property contents

def range_includes_revnum(ranges, revnum):

Check if the specified range contains the mentioned revision number.

:param ranges: list of ranges :param revnum: revision number :return: Whether or not the revision number is included

def range_add_revnum(ranges, revnum, inheritable=True):

Add revision number to a list of ranges

:param ranges: List of ranges :param revnum: Revision number to add :param inheritable: TODO :return: New list of ranges

def mergeinfo_includes_revision(merges, path, revnum):

Check if the specified mergeinfo contains a path in revnum.

:param merges: Dictionary with merges :param path: Merged path :param revnum: Revision number :return: Whether the revision is included

def mergeinfo_add_revision(mergeinfo, path, revnum):

Add a revision to a mergeinfo dictionary

:param mergeinfo: Merginfo dictionary :param path: Merged path to add :param revnum: Merged revision to add :return: Updated dictionary

def diff(current, previous):

Find the differences between two property dictionaries.

:param current: Dictionary with current (new) properties
:param previous: Dictionary with previous (old) properties
:return: Dictionary that contains an entry for 
         each property that was changed. Value is a tuple 
         with the old and the new property value.

s.properties : module documentation