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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
# Copyright (C) 2008 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""Processor for fast-import commands.
This module provides the skeleton of a fast-import backend.
To import from a fast-import stream to your version-control system:
- derive a class from the abstract ImportProcessor class and
implement the *_helper methods.
- parse a fast-import stream into a sequence of commands, for example
using the helpers from the parser module.
- pass that command sequence to the process method of your processor.
See git-fast-import.1 for the meaning of each command and the
processors package for examples.
"""
import sys
import time
from . import errors
from .helpers import newobject as object
class ImportProcessor(object):
"""Base class for fast-import stream processors.
Subclasses should override the pre_*, post_* and *_handler
methods as appropriate.
"""
known_params = []
def __init__(self, params=None, verbose=False, outf=None):
if outf is None:
self.outf = sys.stdout
else:
self.outf = outf
self.verbose = verbose
if params is None:
self.params = {}
else:
self.params = params
self.validate_parameters()
# Handlers can set this to request exiting cleanly without
# iterating through the remaining commands
self.finished = False
def validate_parameters(self):
"""Validate that the parameters are correctly specified."""
for p in self.params:
if p not in self.known_params:
raise errors.UnknownParameter(p, self.known_params)
def process(self, command_iter):
"""Import data into Bazaar by processing a stream of commands.
:param command_iter: an iterator providing commands
"""
self._process(command_iter)
def _process(self, command_iter):
self.pre_process()
for cmd in command_iter():
try:
name = (cmd.name + b'_handler').decode('utf8')
handler = getattr(self.__class__, name)
except KeyError:
raise errors.MissingHandler(cmd.name)
else:
self.pre_handler(cmd)
handler(self, cmd)
self.post_handler(cmd)
if self.finished:
break
self.post_process()
def warning(self, msg, *args):
"""Output a warning but timestamp it."""
pass
def debug(self, mgs, *args):
"""Output a debug message."""
pass
def _time_of_day(self):
"""Time of day as a string."""
# Note: this is a separate method so tests can patch in a fixed value
return time.strftime("%H:%M:%S")
def pre_process(self):
"""Hook for logic at start of processing."""
pass
def post_process(self):
"""Hook for logic at end of processing."""
pass
def pre_handler(self, cmd):
"""Hook for logic before each handler starts."""
pass
def post_handler(self, cmd):
"""Hook for logic after each handler finishes."""
pass
def progress_handler(self, cmd):
"""Process a ProgressCommand."""
raise NotImplementedError(self.progress_handler)
def blob_handler(self, cmd):
"""Process a BlobCommand."""
raise NotImplementedError(self.blob_handler)
def checkpoint_handler(self, cmd):
"""Process a CheckpointCommand."""
raise NotImplementedError(self.checkpoint_handler)
def commit_handler(self, cmd):
"""Process a CommitCommand."""
raise NotImplementedError(self.commit_handler)
def reset_handler(self, cmd):
"""Process a ResetCommand."""
raise NotImplementedError(self.reset_handler)
def tag_handler(self, cmd):
"""Process a TagCommand."""
raise NotImplementedError(self.tag_handler)
def feature_handler(self, cmd):
"""Process a FeatureCommand."""
raise NotImplementedError(self.feature_handler)
class CommitHandler(object):
"""Base class for commit handling.
Subclasses should override the pre_*, post_* and *_handler
methods as appropriate.
"""
def __init__(self, command):
self.command = command
def process(self):
self.pre_process_files()
for fc in self.command.iter_files():
try:
name = (fc.name[4:] + b'_handler').decode('utf8')
handler = getattr(self.__class__, name)
except KeyError:
raise errors.MissingHandler(fc.name)
else:
handler(self, fc)
self.post_process_files()
def warning(self, msg, *args):
"""Output a warning but add context."""
pass
def pre_process_files(self):
"""Prepare for committing."""
pass
def post_process_files(self):
"""Save the revision."""
pass
def modify_handler(self, filecmd):
"""Handle a filemodify command."""
raise NotImplementedError(self.modify_handler)
def delete_handler(self, filecmd):
"""Handle a filedelete command."""
raise NotImplementedError(self.delete_handler)
def copy_handler(self, filecmd):
"""Handle a filecopy command."""
raise NotImplementedError(self.copy_handler)
def rename_handler(self, filecmd):
"""Handle a filerename command."""
raise NotImplementedError(self.rename_handler)
def deleteall_handler(self, filecmd):
"""Handle a filedeleteall command."""
raise NotImplementedError(self.deleteall_handler)
|
