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
|
# remote.py
# Copyright (C) 2008, 2009 Michael Trier (mtrier@gmail.com) and contributors
#
# This module is part of GitPython and is released under
# the BSD License: http://www.opensource.org/licenses/bsd-license.php
"""
Module implementing a remote object allowing easy access to git remotes
"""
from git.utils import LazyMixin, Iterable
from refs import RemoteRef
class _SectionConstraint(object):
"""
Constrains a ConfigParser to only option commands which are constrained to
always use the section we have been initialized with.
It supports all ConfigParser methods that operate on an option
"""
__slots__ = ("_config", "_section_name")
_valid_attrs_ = ("get", "set", "getint", "getfloat", "getboolean", "has_option")
def __init__(self, config, section):
self._config = config
self._section_name = section
def __getattr__(self, attr):
if attr in self._valid_attrs_:
return lambda *args: self._call_config(attr, *args)
return super(_SectionConstraint,self).__getattribute__(attr)
def _call_config(self, method, *args):
"""Call the configuration at the given method which must take a section name
as first argument"""
return getattr(self._config, method)(self._section_name, *args)
class Remote(LazyMixin, Iterable):
"""
Provides easy read and write access to a git remote.
Everything not part of this interface is considered an option for the current
remote, allowing constructs like remote.pushurl to query the pushurl.
NOTE: When querying configuration, the configuration accessor will be cached
to speed up subsequent accesses.
"""
__slots__ = ( "repo", "name", "_config_reader" )
def __init__(self, repo, name):
"""
Initialize a remote instance
``repo``
The repository we are a remote of
``name``
the name of the remote, i.e. 'origin'
"""
self.repo = repo
self.name = name
def __getattr__(self, attr):
"""
Allows to call this instance like
remote.special( *args, **kwargs) to call git-remote special self.name
"""
if attr == "_config_reader":
return super(Remote, self).__getattr__(attr)
return self._config_reader.get(attr)
def _config_section_name(self):
return 'remote "%s"' % self.name
def _set_cache_(self, attr):
if attr == "_config_reader":
self._config_reader = _SectionConstraint(self.repo.config_reader, self._config_section_name())
else:
super(Remote, self)._set_cache_(attr)
def __str__(self):
return self.name
def __repr__(self):
return '<git.%s "%s">' % (self.__class__.__name__, self.name)
def __eq__(self, other):
return self.name == other.name
def __ne__(self, other):
return not ( self == other )
def __hash__(self):
return hash(self.name)
@classmethod
def iter_items(cls, repo):
"""
Returns
Iterator yielding Remote objects of the given repository
"""
# parse them using refs, as their query can be faster as it is
# purely based on the file system
seen_remotes = set()
for ref in RemoteRef.iter_items(repo):
remote_name = ref.remote_name
if remote_name in seen_remotes:
continue
# END if remote done already
seen_remotes.add(remote_name)
yield Remote(repo, remote_name)
# END for each ref
@property
def refs(self):
"""
Returns
List of RemoteRef objects
"""
out_refs = list()
for ref in RemoteRef.list_items(self.repo):
if ref.remote_name == self.name:
out_refs.append(ref)
# END if names match
# END for each ref
assert out_refs, "Remote %s did not have any references" % self.name
return out_refs
@classmethod
def create(cls, repo, name, url, **kwargs):
"""
Create a new remote to the given repository
``repo``
Repository instance that is to receive the new remote
``name``
Desired name of the remote
``url``
URL which corresponds to the remote's name
``**kwargs``
Additional arguments to be passed to the git-remote add command
Returns
New Remote instance
Raise
GitCommandError in case an origin with that name already exists
"""
repo.git.remote( "add", name, url, **kwargs )
return cls(repo, name)
# add is an alias
add = create
@classmethod
def remove(cls, repo, name ):
"""
Remove the remote with the given name
"""
repo.git.remote("rm", name)
# alias
rm = remove
def rename(self, new_name):
"""
Rename self to the given new_name
Returns
self
"""
if self.name == new_name:
return self
self.repo.git.remote("rename", self.name, new_name)
self.name = new_name
del(self._config_reader) # it contains cached values, section names are different now
return self
def update(self, **kwargs):
"""
Fetch all changes for this remote, including new branches
``kwargs``
Additional arguments passed to git-remote update
Returns
self
"""
self.repo.git.remote("update", self.name)
return self
@property
def config_reader(self):
"""
Returns
GitConfigParser compatible object able to read options for only our remote.
Hence you may simple type config.get("pushurl") to obtain the information
"""
return self._config_reader
@property
def config_writer(self):
"""
Return
GitConfigParser compatible object able to write options for this remote.
Note
You can only own one writer at a time - delete it to release the
configuration file and make it useable by others.
To assure consistent results, you should only query options through the
writer. Once you are done writing, you are free to use the config reader
once again.
"""
writer = self.repo.config_writer()
# clear our cache to assure we re-read the possibly changed configuration
del(self._config_reader)
return _SectionConstraint(writer, self._config_section_name())
|
