cafcbe3076d2947ca0d1499945980c09d0d301db
[stgit] / stgit / commands / export.py
1 """Export command
2 """
3
4 __copyright__ = """
5 Copyright (C) 2005, Catalin Marinas <catalin.marinas@gmail.com>
6
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License version 2 as
9 published by the Free Software Foundation.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 """
20
21 import sys, os
22 from optparse import OptionParser, make_option
23
24 from stgit.commands.common import *
25 from stgit.utils import *
26 from stgit import stack, git, templates
27
28
29 help = 'exports patches to a directory'
30 usage = """%prog [options] [<patch1>] [<patch2>] [<patch3>..<patch4>]
31
32 Export a range of applied patches to a given directory (defaults to
33 'patches-<branch>') in a standard unified GNU diff format. A template
34 file (defaulting to '.git/patchexport.tmpl' or
35 '~/.stgit/templates/patchexport.tmpl' or
36 '/usr/share/stgit/templates/patchexport.tmpl') can be used for the
37 patch format. The following variables are supported in the template
38 file:
39
40 %(description)s - patch description
41 %(shortdescr)s - the first line of the patch description
42 %(longdescr)s - the rest of the patch description, after the first line
43 %(diffstat)s - the diff statistics
44 %(authname)s - author's name
45 %(authemail)s - author's e-mail
46 %(authdate)s - patch creation date
47 %(commname)s - committer's name
48 %(commemail)s - committer's e-mail
49 """
50
51 options = [make_option('-d', '--dir',
52 help = 'export patches to DIR instead of the default'),
53 make_option('-p', '--patch',
54 help = 'append .patch to the patch names',
55 action = 'store_true'),
56 make_option('-e', '--extension',
57 help = 'append .EXTENSION to the patch names'),
58 make_option('-n', '--numbered',
59 help = 'prefix the patch names with order numbers',
60 action = 'store_true'),
61 make_option('-t', '--template', metavar = 'FILE',
62 help = 'Use FILE as a template'),
63 make_option('-b', '--branch',
64 help = 'use BRANCH instead of the default one'),
65 make_option('--binary',
66 help = 'output a diff even for binary files',
67 action = 'store_true'),
68 make_option('-s', '--stdout',
69 help = 'dump the patches to the standard output',
70 action = 'store_true')]
71
72
73 def func(parser, options, args):
74 """Export a range of patches.
75 """
76 if options.dir:
77 dirname = options.dir
78 else:
79 dirname = 'patches-%s' % crt_series.get_branch()
80
81 if not options.branch and git.local_changes():
82 out.warn('Local changes in the tree;'
83 ' you might want to commit them first')
84
85 if not options.stdout:
86 if not os.path.isdir(dirname):
87 os.makedirs(dirname)
88 series = file(os.path.join(dirname, 'series'), 'w+')
89
90 applied = crt_series.get_applied()
91 if len(args) != 0:
92 patches = parse_patches(args, applied)
93 else:
94 patches = applied
95
96 num = len(patches)
97 if num == 0:
98 raise CmdException, 'No patches applied'
99
100 zpadding = len(str(num))
101 if zpadding < 2:
102 zpadding = 2
103
104 # get the template
105 if options.template:
106 tmpl = file(options.template).read()
107 else:
108 tmpl = templates.get_template('patchexport.tmpl')
109 if not tmpl:
110 tmpl = ''
111
112 # note the base commit for this series
113 if not options.stdout:
114 base_commit = crt_series.get_patch(patches[0]).get_bottom()
115 print >> series, '# This series applies on GIT commit %s' % base_commit
116
117 patch_no = 1;
118 for p in patches:
119 pname = p
120 if options.patch:
121 pname = '%s.patch' % pname
122 elif options.extension:
123 pname = '%s.%s' % (pname, options.extension)
124 if options.numbered:
125 pname = '%s-%s' % (str(patch_no).zfill(zpadding), pname)
126 pfile = os.path.join(dirname, pname)
127 if not options.stdout:
128 print >> series, pname
129
130 # get the patch description
131 patch = crt_series.get_patch(p)
132
133 descr = patch.get_description().strip()
134 descr_lines = descr.split('\n')
135
136 short_descr = descr_lines[0].rstrip()
137 long_descr = reduce(lambda x, y: x + '\n' + y,
138 descr_lines[1:], '').strip()
139
140 tmpl_dict = {'description': patch.get_description().rstrip(),
141 'shortdescr': short_descr,
142 'longdescr': long_descr,
143 'diffstat': git.diffstat(rev1 = patch.get_bottom(),
144 rev2 = patch.get_top()),
145 'authname': patch.get_authname(),
146 'authemail': patch.get_authemail(),
147 'authdate': patch.get_authdate(),
148 'commname': patch.get_commname(),
149 'commemail': patch.get_commemail()}
150 for key in tmpl_dict:
151 if not tmpl_dict[key]:
152 tmpl_dict[key] = ''
153
154 try:
155 descr = tmpl % tmpl_dict
156 except KeyError, err:
157 raise CmdException, 'Unknown patch template variable: %s' \
158 % err
159 except TypeError:
160 raise CmdException, 'Only "%(name)s" variables are ' \
161 'supported in the patch template'
162
163 if options.stdout:
164 f = sys.stdout
165 else:
166 f = open(pfile, 'w+')
167
168 if options.stdout and num > 1:
169 print '-'*79
170 print patch.get_name()
171 print '-'*79
172
173 # write description
174 f.write(descr)
175 # write the diff
176 git.diff(rev1 = patch.get_bottom(),
177 rev2 = patch.get_top(),
178 out_fd = f, binary = options.binary)
179 if not options.stdout:
180 f.close()
181 patch_no += 1
182
183 if not options.stdout:
184 series.close()