forked from libgit2/pygit2
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathremote.py
More file actions
408 lines (311 loc) · 13.2 KB
/
remote.py
File metadata and controls
408 lines (311 loc) · 13.2 KB
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
# Copyright 2010-2021 The pygit2 contributors
#
# This file is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License, version 2,
# as published by the Free Software Foundation.
#
# In addition to the permissions in the GNU General Public License,
# the authors give you unlimited permission to link the compiled
# version of this file into combinations with other programs,
# and to distribute those combinations without any restriction
# coming from the use of this file. (The General Public License
# restrictions do apply in other respects; for example, they cover
# modification of the file, and distribution when not linked into
# a combined executable.)
#
# This file 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; see the file COPYING. If not, write to
# the Free Software Foundation, 51 Franklin Street, Fifth Floor,
# Boston, MA 02110-1301, USA.
# Import from pygit2
from ._pygit2 import Oid
from .callbacks import git_fetch_options, git_push_options, git_remote_callbacks
from .errors import check_error
from .ffi import ffi, C
from .refspec import Refspec
from .utils import maybe_string, to_bytes, strarray_to_strings, StrArray
class TransferProgress:
"""Progress downloading and indexing data during a fetch.
"""
def __init__(self, tp):
self.total_objects = tp.total_objects
"""Total number of objects to download"""
self.indexed_objects = tp.indexed_objects
"""Objects which have been indexed"""
self.received_objects = tp.received_objects
"""Objects which have been received up to now"""
self.local_objects = tp.local_objects
"""Local objects which were used to fix the thin pack"""
self.total_deltas = tp.total_deltas
"""Total number of deltas in the pack"""
self.indexed_deltas = tp.indexed_deltas
"""Deltas which have been indexed"""
self.received_bytes = tp.received_bytes
""""Number of bytes received up to now"""
class Remote:
def __init__(self, repo, ptr):
"""The constructor is for internal use only.
"""
self._repo = repo
self._remote = ptr
self._stored_exception = None
def __del__(self):
C.git_remote_free(self._remote)
@property
def name(self):
"""Name of the remote"""
return maybe_string(C.git_remote_name(self._remote))
@property
def url(self):
"""Url of the remote"""
return maybe_string(C.git_remote_url(self._remote))
@property
def push_url(self):
"""Push url of the remote"""
return maybe_string(C.git_remote_pushurl(self._remote))
def connect(self, callbacks=None, direction=C.GIT_DIRECTION_FETCH, proxy=None):
"""Connect to the remote.
Parameters:
proxy : None or True or str
Proxy configuration. Can be one of:
* `None` (the default) to disable proxy usage
* `True` to enable automatic proxy detection
* an url to a proxy (`http://proxy.example.org:3128/`)
"""
proxy_opts = ffi.new('git_proxy_options *')
C.git_proxy_init_options(proxy_opts, C.GIT_PROXY_OPTIONS_VERSION)
self.__set_proxy(proxy_opts, proxy)
with git_remote_callbacks(callbacks) as payload:
err = C.git_remote_connect(self._remote, direction,
payload.remote_callbacks, proxy_opts,
ffi.NULL)
payload.check_error(err)
def save(self):
"""Save a remote to its repository's configuration.
"""
err = C.git_remote_save(self._remote)
check_error(err)
def fetch(self, refspecs=None, message=None, callbacks=None, prune=C.GIT_FETCH_PRUNE_UNSPECIFIED, proxy=None):
"""Perform a fetch against this remote. Returns a <TransferProgress>
object.
Parameters:
prune : enum
Either <GIT_FETCH_PRUNE_UNSPECIFIED>, <GIT_FETCH_PRUNE>, or
<GIT_FETCH_NO_PRUNE>. The first uses the configuration from the
repo, the second will remove any remote branch in the local
repository that does not exist in the remote and the last will
always keep the remote branches
proxy : None or True or str
Proxy configuration. Can be one of:
* `None` (the default) to disable proxy usage
* `True` to enable automatic proxy detection
* an url to a proxy (`http://proxy.example.org:3128/`)
"""
with git_fetch_options(callbacks) as payload:
opts = payload.fetch_options
opts.prune = prune
self.__set_proxy(opts.proxy_opts, proxy)
with StrArray(refspecs) as arr:
err = C.git_remote_fetch(self._remote, arr, opts, to_bytes(message))
payload.check_error(err)
return TransferProgress(C.git_remote_stats(self._remote))
def ls_remotes(self, callbacks=None, proxy=None):
"""
Return a list of dicts that maps to `git_remote_head` from a
`ls_remotes` call.
Parameters:
callbacks : Passed to connect()
proxy : Passed to connect()
"""
self.connect(callbacks=callbacks, proxy=proxy)
refs = ffi.new('git_remote_head ***')
refs_len = ffi.new('size_t *')
err = C.git_remote_ls(refs, refs_len, self._remote)
check_error(err)
results = []
for i in range(int(refs_len[0])):
ref = refs[0][i]
local = bool(ref.local)
if local:
loid = Oid(raw=bytes(ffi.buffer(ref.loid.id)[:]))
else:
loid = None
remote = {
"local": local,
"loid": loid,
"name": maybe_string(ref.name),
"symref_target": maybe_string(ref.symref_target),
"oid": Oid(raw=bytes(ffi.buffer(ref.oid.id)[:])),
}
results.append(remote)
return results
def prune(self, callbacks=None):
"""Perform a prune against this remote.
"""
with git_remote_callbacks(callbacks) as payload:
err = C.git_remote_prune(self._remote, payload.remote_callbacks)
payload.check_error(err)
@property
def refspec_count(self):
"""Total number of refspecs in this remote"""
return C.git_remote_refspec_count(self._remote)
def get_refspec(self, n):
"""Return the <Refspec> object at the given position."""
spec = C.git_remote_get_refspec(self._remote, n)
return Refspec(self, spec)
@property
def fetch_refspecs(self):
"""Refspecs that will be used for fetching"""
specs = ffi.new('git_strarray *')
err = C.git_remote_get_fetch_refspecs(specs, self._remote)
check_error(err)
return strarray_to_strings(specs)
@property
def push_refspecs(self):
"""Refspecs that will be used for pushing"""
specs = ffi.new('git_strarray *')
err = C.git_remote_get_push_refspecs(specs, self._remote)
check_error(err)
return strarray_to_strings(specs)
def push(self, specs, callbacks=None, proxy=None):
"""
Push the given refspec to the remote. Raises ``GitError`` on protocol
error or unpack failure.
When the remote has a githook installed, that denies the reference this
function will return successfully. Thus it is strongly recommended to
install a callback, that implements
:py:meth:`RemoteCallbacks.push_update_reference` and check the passed
parameters for successfull operations.
Parameters:
specs : [str]
Push refspecs to use.
proxy : None or True or str
Proxy configuration. Can be one of:
* `None` (the default) to disable proxy usage
* `True` to enable automatic proxy detection
* an url to a proxy (`http://proxy.example.org:3128/`)
"""
with git_push_options(callbacks) as payload:
opts = payload.push_options
self.__set_proxy(opts.proxy_opts, proxy)
with StrArray(specs) as refspecs:
err = C.git_remote_push(self._remote, refspecs, opts)
payload.check_error(err)
def __set_proxy(self, proxy_opts, proxy):
if proxy is None:
proxy_opts.type = C.GIT_PROXY_NONE
elif proxy is True:
proxy_opts.type = C.GIT_PROXY_AUTO
elif type(proxy) is str:
proxy_opts.type = C.GIT_PROXY_SPECIFIED
# Keep url in memory, otherwise memory is freed and bad things happen
self.__url = ffi.new('char[]', to_bytes(proxy))
proxy_opts.url = self.__url
else:
raise TypeError("Proxy must be None, True, or a string")
class RemoteCollection:
"""Collection of configured remotes
You can use this class to look up and manage the remotes configured
in a repository. You can access repositories using index
access. E.g. to look up the "origin" remote, you can use
>>> repo.remotes["origin"]
"""
def __init__(self, repo):
self._repo = repo;
def __len__(self):
names = ffi.new('git_strarray *')
try:
err = C.git_remote_list(names, self._repo._repo)
check_error(err)
return names.count
finally:
C.git_strarray_free(names)
def __iter__(self):
cremote = ffi.new('git_remote **')
for name in self._ffi_names():
err = C.git_remote_lookup(cremote, self._repo._repo, name)
check_error(err)
yield Remote(self._repo, cremote[0])
def __getitem__(self, name):
if isinstance(name, int):
return list(self)[name]
cremote = ffi.new('git_remote **')
err = C.git_remote_lookup(cremote, self._repo._repo, to_bytes(name))
check_error(err)
return Remote(self._repo, cremote[0])
def _ffi_names(self):
names = ffi.new('git_strarray *')
try:
err = C.git_remote_list(names, self._repo._repo)
check_error(err)
for i in range(names.count):
yield names.strings[i]
finally:
C.git_strarray_free(names)
def names(self):
"""An iterator over the names of the available remotes."""
for name in self._ffi_names():
yield maybe_string(name)
def create(self, name, url, fetch=None):
"""Create a new remote with the given name and url. Returns a <Remote>
object.
If 'fetch' is provided, this fetch refspec will be used instead of the
default.
"""
cremote = ffi.new('git_remote **')
name = to_bytes(name)
url = to_bytes(url)
if fetch:
fetch = to_bytes(fetch)
err = C.git_remote_create_with_fetchspec(cremote, self._repo._repo, name, url, fetch)
else:
err = C.git_remote_create(cremote, self._repo._repo, name, url)
check_error(err)
return Remote(self._repo, cremote[0])
def rename(self, name, new_name):
"""Rename a remote in the configuration. The refspecs in standard
format will be renamed.
Returns a list of fetch refspecs (list of strings) which were not in
the standard format and thus could not be remapped.
"""
if not new_name:
raise ValueError("Current remote name must be a non-empty string")
if not new_name:
raise ValueError("New remote name must be a non-empty string")
problems = ffi.new('git_strarray *')
err = C.git_remote_rename(problems, self._repo._repo, to_bytes(name), to_bytes(new_name))
check_error(err)
ret = strarray_to_strings(problems)
C.git_strarray_free(problems)
return ret
def delete(self, name):
"""Remove a remote from the configuration
All remote-tracking branches and configuration settings for the remote will be removed.
"""
err = C.git_remote_delete(self._repo._repo, to_bytes(name))
check_error(err)
def set_url(self, name, url):
""" Set the URL for a remote
"""
err = C.git_remote_set_url(self._repo._repo, to_bytes(name), to_bytes(url))
check_error(err)
def set_push_url(self, name, url):
"""Set the push-URL for a remote
"""
err = C.git_remote_set_pushurl(self._repo._repo, to_bytes(name), to_bytes(url))
check_error(err)
def add_fetch(self, name, refspec):
"""Add a fetch refspec (str) to the remote
"""
err = C.git_remote_add_fetch(self._repo._repo, to_bytes(name), to_bytes(refspec))
check_error(err)
def add_push(self, name, refspec):
"""Add a push refspec (str) to the remote
"""
err = C.git_remote_add_push(self._repo._repo, to_bytes(name), to_bytes(refspec))
check_error(err)