s.properties : module documentation

Part of subvertpy

Handling of Subversion properties.
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.
ParameterspropProperty name
ReturnsWhether prop is a valid property name
def time_to_cstring(timestamp):
Determine string representation of a time.
ParameterstimestampTimestamp
Returnsstring with date
def time_from_cstring(text):
Parse a time from a cstring.
ParameterstextParse text
Returnstimestamp
def parse_externals_description(base_url, val):
Parse an svn:externals property value.
Parametersbase_urlURL on which the property is set. Used for relative externals.
Returnsdictionary 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.
ParameterstextProperty contents
def generate_mergeinfo_property(merges):
Generate the contents of the svn:mergeinfo property
Parametersmergesdictionary mapping paths to lists of ranges
ReturnsProperty contents
def range_includes_revnum(ranges, revnum):
Check if the specified range contains the mentioned revision number.
Parametersrangeslist of ranges
revnumrevision number
ReturnsWhether or not the revision number is included
def range_add_revnum(ranges, revnum, inheritable=True):
Add revision number to a list of ranges
ParametersrangesList of ranges
revnumRevision number to add
inheritableTODO
ReturnsNew list of ranges
def mergeinfo_includes_revision(merges, path, revnum):
Check if the specified mergeinfo contains a path in revnum.
ParametersmergesDictionary with merges
pathMerged path
revnumRevision number
ReturnsWhether the revision is included
def mergeinfo_add_revision(mergeinfo, path, revnum):
Add a revision to a mergeinfo dictionary
ParametersmergeinfoMerginfo dictionary
pathMerged path to add
revnumMerged revision to add
ReturnsUpdated dictionary
def diff(current, previous):
Find the differences between two property dictionaries.
ParameterscurrentDictionary with current (new) properties
previousDictionary with previous (old) properties
ReturnsDictionary that contains an entry for each property that was changed. Value is a tuple with the old and the new property value.
API Documentation for subvertpy, generated by pydoctor at 2014-07-06 00:35:58.