1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
"""
Utility functions.
"""
from __future__ import print_function
import csv
import io
import os
import subprocess
import sys
import click
from tabulate import tabulate
def ensure_str(s):
if s is None:
s = ''
elif isinstance(s, bytes):
s = s.decode('utf-8', 'strict')
elif not isinstance(s, str):
s = str(s)
return s
def trim(string, length=70): # type: (str, int) -> str
"""Trim a string to the given length."""
return (string[:length - 1] + '...') if len(string) > length else string
def git_config(value):
"""Parse config from ``git-config`` cache.
Returns:
Matching setting for ``key`` if available, else None.
"""
try:
output = subprocess.check_output(['git', 'config', value])
except subprocess.CalledProcessError:
output = b''
return output.decode('utf-8').strip()
def git_am(mbox, args):
"""Execute git-am on a given mbox file."""
cmd = ['git', 'am']
if args:
cmd.extend(args)
else:
cmd.append('-3')
cmd.append(mbox)
try:
output = subprocess.check_output(cmd, stderr=subprocess.STDOUT)
except subprocess.CalledProcessError as exc:
print(exc.output.decode('utf-8'))
sys.exit(exc.returncode)
else:
print(output.decode('utf-8'), end='')
def _tabulate(output, headers, fmt):
fmt = fmt or git_config('pw.format') or 'table'
if fmt == 'table':
return tabulate(output, headers, tablefmt='psql')
elif fmt == 'simple':
return tabulate(output, headers, tablefmt='simple')
elif fmt == 'csv':
result = io.StringIO()
writer = csv.writer(
result, quoting=csv.QUOTE_ALL, lineterminator=os.linesep)
writer.writerow([ensure_str(h) for h in headers])
for item in output:
writer.writerow([ensure_str(i) for i in item])
return result.getvalue()
print('pw.format must be one of: table, simple, csv')
sys.exit(1)
def _echo_via_pager(pager, output):
env = dict(os.environ)
# When the LESS environment variable is unset, Git sets it to FRX (if
# LESS environment variable is set, Git does not change it at all).
if 'LESS' not in env:
env['LESS'] = 'FRX'
pager = subprocess.Popen(pager.split(), stdin=subprocess.PIPE, env=env)
# TODO(stephenfin): This is potential hangover from Python 2 days
if not isinstance(output, bytes):
output = output.encode('utf-8', 'strict')
try:
pager.communicate(input=output)
except (IOError, KeyboardInterrupt):
pass
else:
pager.stdin.close()
while True:
try:
pager.wait()
except KeyboardInterrupt:
pass
else:
break
def echo_via_pager(output, headers, fmt):
"""Echo using git's default pager.
Wrap ``click.echo_via_pager``, setting some environment variables in the
processs to mimic the pager settings used by Git:
The order of preference is the ``$GIT_PAGER`` environment variable,
then ``core.pager`` configuration, then ``$PAGER``, and then the
default chosen at compile time (usually ``less``).
"""
output = _tabulate(output, headers, fmt)
pager = os.environ.get('GIT_PAGER', None)
if pager:
_echo_via_pager(pager, output)
return
pager = git_config('core.parser')
if pager:
_echo_via_pager(pager, output)
return
pager = os.environ.get('PAGER', None)
if pager:
_echo_via_pager(pager, output)
return
_echo_via_pager('less', output)
def echo(output, headers, fmt):
click.echo(_tabulate(output, headers, fmt))
def pagination_options(sort_fields, default_sort):
"""Shared pagination options."""
def _pagination_options(f):
f = click.option('--limit', metavar='LIMIT', type=click.INT,
help='Maximum number of items to show.')(f)
f = click.option('--page', metavar='PAGE', type=click.INT,
help='Page to retrieve items from. This is '
'influenced by the size of LIMIT.')(f)
f = click.option('--sort', metavar='FIELD', default=default_sort,
type=click.Choice(sort_fields),
help='Sort output on given field.')(f)
return f
return _pagination_options
def format_options(original_function=None, headers=None):
"""Shared output format options."""
def _format_options(f):
f = click.option('--format', '-f', 'fmt', default=None,
type=click.Choice(['simple', 'table', 'csv']),
help="Output format. Defaults to the value of "
"'git config pw.format' else 'table'.")(f)
if headers:
f = click.option('--column', '-c', 'headers', metavar='COLUMN',
multiple=True, default=headers,
type=click.Choice(headers),
help='Columns to be included in output.')(f)
return f
if original_function:
return _format_options(original_function)
return _format_options
|
