Skip to content

Progress parsing #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion git/cmd.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ class Git(object):
of the command to stdout.
Set its value to 'full' to see details about the returned values.
"""
__slots__ = ("_working_dir", "cat_file_all", "cat_file_header")
__slots__ = ("_working_dir", "cat_file_all", "cat_file_header", "_version_info")

# CONFIGURATION
# The size in bytes read from stdout when copying git's output to another stream
Expand Down Expand Up @@ -205,6 +205,7 @@ def __init__(self, working_dir=None):
.git directory in case of bare repositories."""
super(Git, self).__init__()
self._working_dir = working_dir
self._version_info = self._get_version_as_tuple()

# cached command slots
self.cat_file_header = None
Expand Down Expand Up @@ -513,3 +514,13 @@ def clear_cache(self):
self.cat_file_all = None
self.cat_file_header = None
return self

def _get_version_as_tuple(self):
""" Get and parse git version string. """
version_str = self._call_process('version')
version_numbers = version_str.rpartition(' ')[2]
return tuple(version_numbers.split('.'))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you forgot to convert the strings to integers.
The line should be something like

tuple(int(n) for n in version_numbers.split('.'))

@property
def version_info(self):
return self._version_info
55 changes: 13 additions & 42 deletions git/remote.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,11 @@
TagReference
)

from git.util import join_path
from git.util import (
join_path,
_digest_process_messages,
_finalize_proc
)
from gitdb.util import join

import re
Expand Down Expand Up @@ -432,42 +436,6 @@ def update(self, **kwargs):
self.repo.git.remote("update", self.name)
return self

def _digest_process_messages(self, fh, progress):
"""Read progress messages from file-like object fh, supplying the respective
progress messages to the progress instance.

:return: list(line, ...) list of lines without linebreaks that did
not contain progress information"""
line_so_far = ''
dropped_lines = list()
while True:
char = fh.read(1)
if not char:
break

if char in ('\r', '\n'):
dropped_lines.extend(progress._parse_progress_line(line_so_far))
line_so_far = ''
else:
line_so_far += char
# END process parsed line
# END while file is not done reading
return dropped_lines


def _finalize_proc(self, proc):
"""Wait for the process (fetch, pull or push) and handle its errors accordingly"""
try:
proc.wait()
except GitCommandError,e:
# if a push has rejected items, the command has non-zero return status
# a return status of 128 indicates a connection error - reraise the previous one
if proc.poll() == 128:
raise
pass
# END exception handling


def _get_fetch_info_from_stderr(self, proc, progress):
# skip first line as it is some remote info we are not interested in
output = IterableList('name')
Expand All @@ -477,7 +445,7 @@ def _get_fetch_info_from_stderr(self, proc, progress):
# this also waits for the command to finish
# Skip some progress lines that don't provide relevant information
fetch_info_lines = list()
for line in self._digest_process_messages(proc.stderr, progress):
for line in _digest_process_messages(proc.stderr, progress):
if line.startswith('From') or line.startswith('remote: Total'):
continue
elif line.startswith('warning:'):
Expand All @@ -499,15 +467,15 @@ def _get_fetch_info_from_stderr(self, proc, progress):
output.extend(FetchInfo._from_line(self.repo, err_line, fetch_line)
for err_line,fetch_line in zip(fetch_info_lines, fetch_head_info))

self._finalize_proc(proc)
_finalize_proc(proc)
return output

def _get_push_info(self, proc, progress):
# read progress information from stderr
# we hope stdout can hold all the data, it should ...
# read the lines manually as it will use carriage returns between the messages
# to override the previous one. This is why we read the bytes manually
self._digest_process_messages(proc.stderr, progress)
_digest_process_messages(proc.stderr, progress)

output = IterableList('name')
for line in proc.stdout.readlines():
Expand All @@ -519,7 +487,7 @@ def _get_push_info(self, proc, progress):
# END exception handling
# END for each line

self._finalize_proc(proc)
_finalize_proc(proc)
return output


Expand All @@ -546,6 +514,7 @@ def fetch(self, refspec=None, progress=None, **kwargs):
:note:
As fetch does not provide progress information to non-ttys, we cannot make
it available here unfortunately as in the 'push' method."""
if self.repo.git.version_info >= (1, 7, 0, 0): kwargs['progress'] = True
proc = self.repo.git.fetch(self, refspec, with_extended_output=True, as_process=True, v=True, **kwargs)
return self._get_fetch_info_from_stderr(proc, progress or RemoteProgress())

Expand All @@ -557,6 +526,7 @@ def pull(self, refspec=None, progress=None, **kwargs):
:param progress: see 'push' method
:param kwargs: Additional arguments to be passed to git-pull
:return: Please see 'fetch' method """
if self.repo.git.version_info >= (1, 7, 0, 0): kwargs['progress'] = True
proc = self.repo.git.pull(self, refspec, with_extended_output=True, as_process=True, v=True, **kwargs)
return self._get_fetch_info_from_stderr(proc, progress or RemoteProgress())

Expand All @@ -578,7 +548,8 @@ def push(self, refspec=None, progress=None, **kwargs):
in their flags.
If the operation fails completely, the length of the returned IterableList will
be null."""
proc = self.repo.git.push(self, refspec, porcelain=True, as_process=True, **kwargs)
if self.repo.git.version_info >= (1, 7, 0, 0): kwargs['progress'] = True
proc = self.repo.git.push(self, refspec, porcelain=True, as_process=True, progress=True, v=True, **kwargs)
return self._get_push_info(proc, progress or RemoteProgress())

@property
Expand Down
24 changes: 18 additions & 6 deletions git/repo/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@
)


from git.util import (
_digest_process_messages,
_finalize_proc
)

from gitdb.util import (
join,
isfile,
Expand Down Expand Up @@ -652,7 +657,7 @@ def init(cls, path=None, mkdir=True, **kwargs):
return Repo(path)

@classmethod
def _clone(cls, git, url, path, odb_default_type, **kwargs):
def _clone(cls, git, url, path, odb_default_type, progress, **kwargs):
# special handling for windows for path at which the clone should be
# created.
# tilde '~' will be expanded to the HOME no matter where the ~ occours. Hence
Expand All @@ -679,7 +684,11 @@ def _clone(cls, git, url, path, odb_default_type, **kwargs):
# END windows handling

try:
git.clone(url, path, **kwargs)
if git.version_info >= (1, 7, 0, 0): kwargs['progress'] = True
proc = git.clone(url, path, with_extended_output=True, as_process=True, v=True, **kwargs)
if progress:
_digest_process_messages(proc.stderr, progress)
_finalize_proc(proc)
finally:
if prev_cwd is not None:
os.chdir(prev_cwd)
Expand All @@ -703,28 +712,31 @@ def _clone(cls, git, url, path, odb_default_type, **kwargs):
# END handle remote repo
return repo

def clone(self, path, **kwargs):
def clone(self, path, progress=None, **kwargs):
"""Create a clone from this repository.
:param path:
is the full path of the new repo (traditionally ends with ./<name>.git).

:param progress: See 'git.remote.Remote.push'.

:param kwargs:
odbt = ObjectDatabase Type, allowing to determine the object database
implementation used by the returned Repo instance

All remaining keyword arguments are given to the git-clone command

:return: ``git.Repo`` (the newly cloned repo)"""
return self._clone(self.git, self.git_dir, path, type(self.odb), **kwargs)
return self._clone(self.git, self.git_dir, path, type(self.odb), progress, **kwargs)

@classmethod
def clone_from(cls, url, to_path, **kwargs):
def clone_from(cls, url, to_path, progress=None, **kwargs):
"""Create a clone from the given URL
:param url: valid git url, see http://www.kernel.org/pub/software/scm/git/docs/git-clone.html#URLS
:param to_path: Path to which the repository should be cloned to
:param progress: See 'git.remote.Remote.push'.
:param kwargs: see the ``clone`` method
:return: Repo instance pointing to the cloned directory"""
return cls._clone(Git(os.getcwd()), url, to_path, GitCmdObjectDB, **kwargs)
return cls._clone(Git(os.getcwd()), url, to_path, GitCmdObjectDB, progress, **kwargs)

def archive(self, ostream, treeish=None, prefix=None, **kwargs):
"""Archive the tree at the given revision.
Expand Down
43 changes: 41 additions & 2 deletions git/util.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import time
import tempfile
import platform
from exc import GitCommandError

from gitdb.util import (
make_sha,
Expand Down Expand Up @@ -100,6 +101,40 @@ def get_user_id():
# END get username from login
return "%s@%s" % (username, platform.node())

def _digest_process_messages(fh, progress):
"""Read progress messages from file-like object fh, supplying the respective
progress messages to the progress instance.

:return: list(line, ...) list of lines without linebreaks that did
not contain progress information"""
line_so_far = ''
dropped_lines = list()
while True:
char = fh.read(1)
if not char:
break

if char in ('\r', '\n'):
dropped_lines.extend(progress._parse_progress_line(line_so_far))
line_so_far = ''
else:
line_so_far += char
# END process parsed line
# END while file is not done reading
return dropped_lines

def _finalize_proc(proc):
"""Wait for the process (clone, fetch, pull or push) and handle its errors accordingly"""
try:
proc.wait()
except GitCommandError,e:
# if a push has rejected items, the command has non-zero return status
# a return status of 128 indicates a connection error - reraise the previous one
if proc.poll() == 128:
raise
pass
# END exception handling

#} END utilities

#{ Classes
Expand All @@ -109,8 +144,8 @@ class RemoteProgress(object):
Handler providing an interface to parse progress information emitted by git-push
and git-fetch and to dispatch callbacks allowing subclasses to react to the progress.
"""
_num_op_codes = 5
BEGIN, END, COUNTING, COMPRESSING, WRITING = [1 << x for x in range(_num_op_codes)]
_num_op_codes = 7
BEGIN, END, COUNTING, COMPRESSING, WRITING, RECEIVING, RESOLVING = [1 << x for x in range(_num_op_codes)]
STAGE_MASK = BEGIN|END
OP_MASK = ~STAGE_MASK

Expand Down Expand Up @@ -168,6 +203,10 @@ def _parse_progress_line(self, line):
op_code |= self.COMPRESSING
elif op_name == "Writing objects":
op_code |= self.WRITING
elif op_name == 'Receiving objects':
op_code |= self.RECEIVING
elif op_name == 'Resolving deltas':
op_code |= self.RESOLVING
else:
raise ValueError("Operation name %r unknown" % op_name)

Expand Down