Submodules¶

pyrpo.pyrpo module¶

class pyrpo.pyrpo.BzrRepository(fpath)[source]¶

Bases: pyrpo.pyrpo.Repository

Bzr Repository subclass

label¶

str

vcs name (e.g. “hg”)

prefix¶

str

vcs folder name (e.g. ”.hg”)

preparse¶

callable

pre-processing function for vcs log output

fsep¶

str

field separator / record delimiter

lsep¶

str

log output record separator / delimiter

fields¶

list of tuples

(colname, vcs formatter, postprocess_callable)

clone_cmd¶

str

name of commandline clone command (e.g. “clone”)

field_trans¶

dict

mapping between bzr field outputs and tuple fields

logrgx¶

rgx

compiled regex for parsing log message fields

branch[source]¶

Determine the branch name of the working directory of this Repository

Returns:	branch nick (bzr nick)
Return type:	str

clone_cmd = 'branch'

current_id[source]¶

Determine the current revision identifier for the working directory of this Repository

Returns:	bazaar revision identifier (bzr version-info --custom --template='{revision_id}')
Return type:	str

diff()[source]¶

Run the repository diff command to compare working directory with ‘tip’

Returns:	stdout output of bzr diff
Return type:	str

field_trans = {'timestamp': 'datestr', 'message': 'desc', 'revno': 'noderev', 'branch nick': 'branchnick', 'committer': 'author'}

fields = (('datestr', None, <function parse at 0x7fa48012d410>), ('noderev', None, None), ('author', None, None), ('tags', None, None), ('branchnick', None, None), ('desc', None, None))

fsep = '\n'

label = 'bzr'

log(n=None, template=None)[source]¶

Run the repository log command

Returns:	output of log command (bzr log -l <n>)
Return type:	str

logrgx = <_sre.SRE_Pattern object at 0x2662790>

lsep = '------------------------------------------------------------'

prefix = '.bzr'

remote_url[source]¶

Determine the primary remote url for this Repository

Returns:	primary remote url for this Repository (bzr info | egrep '^ parent branch:` | awk '{ print $3 }')
Return type:	str

status[source]¶

Run the repository status command and return stdout

Returns:	stdout output of bzr status command
Return type:	str

template = None¶

unique_id¶

Determine a “unique id” for this repository

Returns:	fpath of this repository
Return type:	str

class pyrpo.pyrpo.GitRepository(fpath)[source]¶

Bases: pyrpo.pyrpo.Repository

Git Repository subclass

label¶

str

vcs name (e.g. “hg”)

prefix¶

str

vcs folder name (e.g. ”.hg”)

preparse¶

callable

pre-processing function for vcs log output

fsep¶

str

field separator / record delimiter

lsep¶

str

log output record separator / delimiter

fields¶

list of tuples

(colname, vcs formatter, postprocess_callable)

clone_cmd¶

str

name of commandline clone command (e.g. “clone”)

template¶

str

concatenated log output template

branch[source]¶

Determine the branch name of the working directory of this Repository

Returns:	branch name (git branch)
Return type:	str

cfg_file¶

checkout_branch_cmd = 'checkout'¶

checkout_branch_hard_cmd = 'checkout -C'¶

checkout_rev_cmd = 'checkout -r'¶

clone_cmd = 'clone'

current_id[source]¶

diff()[source]¶

Run the repository diff command to compare working directory with ‘tip’

Returns:	stdout output of git diff
Return type:	str

fields = (('datestr', '%ai', None, <function parse at 0x7fa48012d410>), ('noderev', '%h', None), ('author', '%an', None), ('tags', '%d', <function <lambda> at 0x7fa48013f9b0>), ('desc', '%s ', None))

incoming_cmd = 'incoming'¶

label = 'git'

last_commit[source]¶

Get and parse the most recent Repository revision

Returns:	Repository log tuple
Return type:	tuple

log(n=None, **kwargs)[source]¶

Run the repository log command

Returns:	output of log command (git log -n <n> <--kwarg=value>)
Return type:	str

loggraph()[source]¶

Show the log annotated an with ASCII revlog graph

Returns:	stdout output from git log --graph
Return type:	str

new_branch_cmd = 'checkout -b'¶

outgoing_cmd = 'outgoing'¶

prefix = '.git'

pull_cmd = 'pull'¶

push_cmd = 'push'¶

remote_url[source]¶

Determine the primary remote url for this Repository

Returns:	primary remote url for this Repository (git config remote.origin.url)
Return type:	str

remote_urls[source]¶

Get all configured remote urls for this Repository

Returns:	primary remote url for this Repository (git config -l | grep "url")
Return type:	str

repo_abspath_cmd = '-C'¶

serve()[source]¶

Run the git serve command

status[source]¶

Run the repository status command and return stdout

Returns:	stdout output of hg status command
Return type:	str

template = '%ai ||| %h ||| %an ||| %d ||| %s |..|'

unique_id¶

Determine a “unique id” for this repository

Returns:	fpath of this repository
Return type:	str

unpushed()[source]¶

Returns:	stdout output from git log master --not --remotes='*/master'.
Return type:	str

class pyrpo.pyrpo.MercurialRepository(fpath)[source]¶

Bases: pyrpo.pyrpo.Repository

Mercurial Repository subclass

label¶

str

vcs name (e.g. “hg”)

prefix¶

str

vcs folder name (e.g. ”.hg”)

preparse¶

callable

pre-processing function for vcs log output

fsep¶

str

field separator / record delimiter

lsep¶

str

log output record separator / delimiter

fields¶

list of tuples

(colname, vcs formatter, postprocess_callable)

clone_cmd¶

str

name of commandline clone command (e.g. “clone”)

template¶

str

concatenated log output template

branch[source]¶

Determine the branch name of the working directory of this Repository

Returns:	branch name (hg branch)
Return type:	str

cfg_file¶

checkout_branch_cmd = 'checkout'¶

checkout_branch_hard_cmd = 'checkout -C'¶

checkout_rev_cmd = 'checkout -r'¶

clone_cmd = 'clone'

current_id[source]¶

Determine the current revision identifier for the working directory of this Repository

Returns:	revision identifier (hg id -i)
Return type:	str

diff[source]¶

Run the repository diff command to compare working directory with ‘tip’

Returns:	stdout output of hg diff -g
Return type:	str

fields = (('datestr', '{date|isodatesec}', <function parse at 0x7fa48012d410>), ('noderev', '{node|short}', None), ('author', '{author|firstline}', None), ('tags', '{tags}', <function <lambda> at 0x7fa48013f140>), ('desc', '{desc}', None))

incoming_cmd = 'incoming'¶

label = 'hg'

log(n=None, **kwargs)[source]¶

Run the repository log command

Returns:	output of log command (hg log -l <n> <--kwarg=value>)
Return type:	str

loggraph()[source]¶

Show the log annotated an with ASCII revlog graph

Returns:	stdout output from hg log --graph
Return type:	str

new_branch_cmd = 'branch'¶

outgoing_cmd = 'outgoing'¶

overwrite_hg_paths(text)[source]¶

prefix = '.hg'

pull_cmd = 'pull'¶

push_cmd = 'push'¶

remote_url[source]¶

Determine the primary remote url for this Repository

Returns:	primary remote url for this Repository (hg showconfig paths.default)
Return type:	str

remote_urls[source]¶

Get all configured remote urls for this Repository

Returns:	primary remote url for this Repository (hg showconfig paths.default)
Return type:	str

repo_abspath_cmd = '-R'¶

serve()[source]¶

Run the hg serve command

sh(*args, **kwargs)[source]¶

status[source]¶

Run the repository status command and return stdout

Returns:	stdout output of hg status command
Return type:	str

template = '{date|isodatesec} ||| {node|short} ||| {author|firstline} ||| {tags} ||| {desc} |..|'

classmethod to_hg_scheme_url(url)[source]¶

Convert a URL to local mercurial URL schemes

Parameters:	url (str) – URL to map to local mercurial URL schemes

example

# schemes.gh = git://github.com/ >> remote_url = git://github.com/westurner/dotfiles’ >> to_hg_scheme_url(remote_url) << gh://westurner/dotfiles

classmethod to_normal_url(url)[source]¶

convert a URL from local mercurial URL schemes to “normal” URLS

example

# schemes.gh = git://github.com/ # remote_url = “gh://westurner/dotfiles” >> to_normal_url(remote_url) << ‘git://github.com/westurner/dotfiles’

unique_id¶

Determine a “unique id” for this repository

Returns:	fpath of this repository
Return type:	str

unpushed()[source]¶

Show outgoing changesets

Raises:	NotImplementedError – always

class pyrpo.pyrpo.Repository(fpath)[source]¶

Bases: object

Abstract Repository class from which VCS-specific implementations derive

label¶

str

vcs name (e.g. “hg”)

prefix¶

str

vcs folder name (e.g. ”.hg”)

preparse¶

callable

pre-processing function for vcs log output

fsep¶

str

field separator / record delimiter

lsep¶

str

log output record separator / delimiter

fields¶

list of tuples

(colname, vcs formatter, postprocess_callable)

clone_cmd¶

str

name of commandline clone command (e.g. “clone”)

__str__()[source]¶

Returns:	//fpath``
Return type:	str: ``label

__unicode__()[source]¶

Returns:	//fpath``
Return type:	str: ``label

branch()[source]¶

Determine the branch name of the working directory of this Repository

Returns:	branch name
Return type:	str

cfg_file¶

checkout_branch_cmd = 'checkout'¶

checkout_rev_cmd = 'checkout -r'¶

clone_cmd = 'clone'

ctime[source]¶

Returns:	strftime-formatted ctime (creation time) of fpath
Return type:	str

current_id()[source]¶

Determine the current revision identifier for the working directory of this Repository

Returns:	revision identifier
Return type:	str

diff()[source]¶

Run the repository diff command to compare working directory with ‘tip’

Returns:	stdout output of Repository diff command
Return type:	str

eggname[source]¶

Returns:	basename of repository path (e.g. for pip_report)
Return type:	str

fields = []

find_symlinks[source]¶

Find symlinks within fpath

Returns:	path -> link
Return type:	str

fsep = ' ||| '

full_report()[source]¶

Show origin, last_commit, status, and parsed complete log history for this repository

Yields:	str – report lines

gitmodule_report()[source]¶

Yields:	str – .gitmodules configuration lines for this repository

hgsub_report()[source]¶

Yields:	str – .hgsubs line for this repository

incoming_cmd = 'incoming'¶

itersplit_to_fields(_str)[source]¶

Split (or parse) repository log output into fields

Returns:	self._tuple(*values)
Return type:	tuple

json_report()[source]¶

label = None

last_commit[source]¶

Get and parse the most recent Repository revision

Returns:	Repository log tuple
Return type:	tuple

lately(count=15)[source]¶

Show count most-recently modified files by mtime

Yields:	tuple – (strftime-formatted mtime, self.fpath-relative file path)

log(n=None, **kwargs)[source]¶

Run the repository log command

Returns:	output of log command
Return type:	str

log_iter(maxentries=None, template=None, **kwargs)[source]¶

Run the repository log command, parse, and yield log tuples

Yields:	tuple – self._tuple

lsep = ' |..|'

mtime[source]¶

Returns:	strftime-formatted mtime (modification time) of fpath
Return type:	str

new_branch_cmd = 'branch'¶

origin_report()[source]¶

Yields:	str: label -- //fpath = remote_url

outgoing_cmd = 'outgoing'¶

pip_report()[source]¶

Show editable pip-requirements line necessary to clone this repository

Yields:	str – pip-requirements line necessary to clone this repository

prefix = None

preparse = None

pull_cmd = 'pull'¶

push_cmd = 'push'¶

read_cfg_file()[source]¶

recreate_remotes_shellcmd()[source]¶

Yields:	str – shell command blocks to recreate repo config

relpath¶

Determine the relative path to this repository

Returns:	relative path to this repository
Return type:	str

remote_url()[source]¶

Determine the primary remote url for this Repository

Returns:	primary remote url for this Repository
Return type:	str

repo_abspath_cmd = '--repo-path'¶

sh(cmd, ignore_error=False, cwd=None, *args, **kwargs)[source]¶

Run a command with the current working directory set to self.fpath

Returns:	stdout output of wrapped call to sh (subprocess.Popen)
Return type:	str

sh_report(full=True, latest=False)[source]¶

Show shell command necessary to clone this repository

If there is no primary remote url, prefix-comment the command

Keyword Arguments:
	full (bool) – also include commands to recreate branches and remotes latest (bool) – checkout repo.branch instead of repo.current_id
Yields:	str – shell command necessary to clone this repository

status()[source]¶

Run the repository status command and return stdout

Returns:	stdout output of Repository status command
Return type:	str

status_report()[source]¶

Yields:	str – sh_report, last_commit, and repository status output

str_report()[source]¶

Yields:	str – pretty-formatted representation of self.to_dict

to_dict()[source]¶

Cast this Repository to a dict

Returns:	this Repository as a dict
Return type:	dict

to_json()[source]¶

to_json_dict()[source]¶

classmethod to_normal_url(url)[source]¶

Parameters:	url (str) – repository URL (potentially with hg schemes)
Returns:	normal repository URL (un-hg-schemes-ed repository URL)
Return type:	str

unique_id()[source]¶

Determine a “unique id” for this repository

Returns:	a “unique id” for this repository
Return type:	str

class pyrpo.pyrpo.SvnRepository(fpath)[source]¶

Bases: pyrpo.pyrpo.Repository

SVN Repository subclass

label¶

str

vcs name (e.g. “hg”)

prefix¶

str

vcs folder name (e.g. ”.hg”)

preparse¶

callable

pre-processing function for vcs log output

fsep¶

str

field separator / record delimiter

lsep¶

str

log output record separator / delimiter

fields¶

list of tuples

(colname, vcs formatter, postprocess_callable)

clone_cmd¶

str

name of commandline clone command (e.g. “clone”)

current_id()[source]¶

Determine the current revision identifier for the working directory of this Repository

Returns:	revision identifier (svn info | grep "^Revision: ")
Return type:	str

diff()[source]¶

Run the repository diff command to compare working directory with ‘tip’

Returns:	stdout output of svn diff
Return type:	str

fields = (('noderev', None, None), ('author', None, None), ('datestr', None, None), ('changecount', None, None), ('desc', None, None))

fsep = ' | '

label = 'svn'

last_commit[source]¶

Get and parse the most recent Repository revision

Returns:	Repository log tuple
Return type:	tuple

log(n=None, template=None, **kwargs)[source]¶

Run the repository log command

Returns:	output of log command (svn log -l <n> <--kwarg=value>)
Return type:	str

lsep = '------------------------------------------------------------------------\n'

prefix = '.svn'

remote_url[source]¶

Determine the primary remote url for this Repository

Returns:	primary remote url for this Repository (svn info | grep "^Repository Root:")
Return type:	str

search_upwards(fpath=None, repodirname='.svn', upwards={})[source]¶

Traverse filesystem upwards, searching for .svn directories with matching UUIDs (Recursive)

Parameters:	fpath (str) – file path to search upwards from repodirname (str) – directory name to search for (.svn) upwards (dict) – dict of already-searched directories

example

repo/.svn repo/dir1/.svn repo/dir1/dir2/.svn

>> search_upwards(‘repo/’) << ‘repo/’ >> search_upwards(‘repo/dir1’) << ‘repo/’ >> search_upwards(‘repo/dir1/dir2’) << ‘repo/’

repo/.svn repo/dirA/ repo/dirA/dirB/.svn

>> search_upwards(‘repo/dirA’) << ‘repo/’ >> search_upwards(‘repo/dirA/dirB’) >> ‘repo/dirB’)

status[source]¶

Run the repository status command and return stdout

Returns:	stdout output of svn status command
Return type:	str

template = None¶

unique_id[source]¶

Determine a “unique id” for this repository

Returns:	Repository UUID of this repository
Return type:	str

class pyrpo.pyrpo.cached_property(func, name=None, doc=None)[source]¶

Bases: object

Decorator that converts a function into a lazy property. The function wrapped is called the first time to retrieve the result and then that calculated result is used the next time you access the value:

class Foo(object):

    @cached_property
    def foo(self):
        # calculate something important here
        return 42

The class must have a __dict__ (e.g. be a subclass of object)

Copyright:	BSD

see: https://github.com/mitsuhiko/werkzeug/blob/master/werkzeug/utils.py

pyrpo.pyrpo.do_repo_report(repos, report='full', output=<open file '<stdout>', mode 'w'>, *args, **kwargs)[source]¶

Do a repository report: call the report function for each Repository

Parameters:	repos (iterable) – iterable of Repository instances report (string) – report name output (writeable) – output stream to print to
Yields:	Repository subclass

pyrpo.pyrpo.do_tortoisehg_report(repos, output)[source]¶

Generate a thg-reporegistry.xml file from a list of repos and print to output

Parameters:	repos (iterable) – iterable of Repository subclass instances output (writeable) – output stream to which THG XML will be printed

pyrpo.pyrpo.dtformat(time)[source]¶

pyrpo.pyrpo.find_find_repos(where, ignore_error=True)[source]¶

Search for repositories with GNU find

Parameters:	where (str) – path to search from ignore_error (bool) – if False, raise Exception when the returncode is not zero.
Yields:	Repository subclass instance

pyrpo.pyrpo.find_unique_repos(where)[source]¶

Search for repositories and deduplicate based on repo.fpath

Parameters:	where (str) – path to search from
Yields:	Repository subclass

pyrpo.pyrpo.get_option_parser()[source]¶

Build an optparse.OptionParser for pyrpo commandline use

pyrpo.pyrpo.itersplit(s, sep=None)[source]¶

Split a string by sep and yield chunks

Parameters:	s (str-type) – string to split sep (str-type) – delimiter to split by
Yields:	generator of strings – chunks of string s

pyrpo.pyrpo.itersplit_to_fields(str_, fsep=' ||| ', revtuple=None, fields=[], preparse=None)[source]¶

Itersplit a string into a (named, if specified) tuple.

Parameters:	str (str) – string to split fsep (str) – field separator (delimiter to split by) revtuple (object) – namedtuple (or class with a ._fields attr) (optional) fields (list of str) – field names (if revtuple is not specified) preparse (callable) – function to parse str with before itersplitting
Returns:	fields as a tuple or revtuple, if specified
Return type:	tuple or revtuple

pyrpo.pyrpo.listdir_find_repos(where)[source]¶

Search for repositories with a stack and os.listdir

Parameters:	where (str) – path to search from
Yields:	Repository subclass instance

pyrpo.pyrpo.main()[source]¶

pyrpo.main: parse commandline options with optparse and run specified reports

pyrpo.pyrpo.sh(cmd, ignore_error=False, cwd=None, *args, **kwargs)[source]¶

Execute a command with subprocess.Popen and block until output

Parameters:	cmd (tuple or str) – same as subprocess.Popen args ignore_error (bool) – if False, raise an Exception if p.returncode is not 0 cwd (str) – path to current working directory
Returns:	command execution stdout
Return type:	str
Raises:	Exception – if ignore_error is true and returncode is not zero

Note

this executes commands with shell=True: careful with shell-escaping.

Module contents¶