|
3 | 3 | # |
4 | 4 | # This module is part of GitPython and is released under |
5 | 5 | # the BSD License: http://www.opensource.org/licenses/bsd-license.php |
| 6 | +import os |
6 | 7 |
|
7 | 8 | class LazyMixin(object): |
8 | 9 | lazy_properties = [] |
9 | | - |
| 10 | + |
| 11 | + __slots__ = "__baked__" |
| 12 | + |
10 | 13 | def __init__(self): |
11 | 14 | self.__baked__ = False |
12 | 15 |
|
@@ -38,17 +41,19 @@ class Object(LazyMixin): |
38 | 41 | """ |
39 | 42 | TYPES = ("blob", "tree", "commit", "tag") |
40 | 43 | __slots__ = ("repo", "id", "size") |
41 | | - type = None # to be set by subclass |
| 44 | + type = None # to be set by subclass |
42 | 45 |
|
43 | 46 | def __init__(self, repo, id, size=None): |
44 | 47 | """ |
45 | 48 | Initialize an object by identifying it by its id. All keyword arguments |
46 | 49 | will be set on demand if None. |
47 | 50 | |
48 | 51 | ``repo`` |
49 | | - repository this object is located in |
| 52 | + repository this object is located in |
| 53 | + |
50 | 54 | ``id`` |
51 | 55 | SHA1 or ref suitable for git-rev-parse |
| 56 | + |
52 | 57 | ``size`` |
53 | 58 | Size of the object's data in bytes |
54 | 59 | """ |
@@ -97,3 +102,153 @@ def __repr__(self): |
97 | 102 | string with pythonic representation of our object |
98 | 103 | """ |
99 | 104 | return '<git.%s "%s">' % (self.__class__.__name__, self.id) |
| 105 | + |
| 106 | + @classmethod |
| 107 | + def get_type_by_name(cls, object_type_name): |
| 108 | + """ |
| 109 | + Returns |
| 110 | + type suitable to handle the given object type name. |
| 111 | + Use the type to create new instances. |
| 112 | + |
| 113 | + ``object_type_name`` |
| 114 | + Member of TYPES |
| 115 | + |
| 116 | + Raises |
| 117 | + ValueError: In case object_type_name is unknown |
| 118 | + """ |
| 119 | + if object_type_name == "commit": |
| 120 | + import commit |
| 121 | + return commit.Commit |
| 122 | + elif object_type_name == "tag": |
| 123 | + import tag |
| 124 | + return tag.TagObject |
| 125 | + elif object_type_name == "blob": |
| 126 | + import blob |
| 127 | + return blob.Blob |
| 128 | + elif object_type_name == "tree": |
| 129 | + import tree |
| 130 | + return tree.Tree |
| 131 | + else: |
| 132 | + raise ValueError("Cannot handle unknown object type: %s" % object_type_name) |
| 133 | + |
| 134 | + |
| 135 | +class Ref(object): |
| 136 | + """ |
| 137 | + Represents a named reference to any object |
| 138 | + """ |
| 139 | + __slots__ = ("path", "object") |
| 140 | + |
| 141 | + def __init__(self, path, object = None): |
| 142 | + """ |
| 143 | + Initialize this instance |
| 144 | + |
| 145 | + ``path`` |
| 146 | + Path relative to the .git/ directory pointing to the ref in question, i.e. |
| 147 | + refs/heads/master |
| 148 | + |
| 149 | + ``object`` |
| 150 | + Object instance, will be retrieved on demand if None |
| 151 | + """ |
| 152 | + self.path = path |
| 153 | + self.object = object |
| 154 | + |
| 155 | + def __str__(self): |
| 156 | + return self.name() |
| 157 | + |
| 158 | + def __repr__(self): |
| 159 | + return '<git.%s "%s">' % (self.__class__.__name__, self.path) |
| 160 | + |
| 161 | + def __eq__(self, other): |
| 162 | + return self.path == other.path and self.object == other.object |
| 163 | + |
| 164 | + def __ne__(self, other): |
| 165 | + return not ( self == other ) |
| 166 | + |
| 167 | + def __hash__(self): |
| 168 | + return hash(self.path) |
| 169 | + |
| 170 | + @property |
| 171 | + def name(self): |
| 172 | + """ |
| 173 | + Returns |
| 174 | + Name of this reference |
| 175 | + """ |
| 176 | + return os.path.basename(self.path) |
| 177 | + |
| 178 | + @classmethod |
| 179 | + def find_all(cls, repo, common_path = "refs", **kwargs): |
| 180 | + """ |
| 181 | + Find all refs in the repository |
| 182 | +
|
| 183 | + ``repo`` |
| 184 | + is the Repo |
| 185 | +
|
| 186 | + ``common_path`` |
| 187 | + Optional keyword argument to the path which is to be shared by all |
| 188 | + returned Ref objects |
| 189 | +
|
| 190 | + ``kwargs`` |
| 191 | + Additional options given as keyword arguments, will be passed |
| 192 | + to git-for-each-ref |
| 193 | +
|
| 194 | + Returns |
| 195 | + git.Ref[] |
| 196 | + |
| 197 | + List is sorted by committerdate |
| 198 | + The returned objects are compatible to the Ref base, but represent the |
| 199 | + actual type, such as Head or Tag |
| 200 | + """ |
| 201 | + |
| 202 | + options = {'sort': "committerdate", |
| 203 | + 'format': "%(refname)%00%(objectname)%00%(objecttype)%00%(objectsize)"} |
| 204 | + |
| 205 | + options.update(kwargs) |
| 206 | + |
| 207 | + output = repo.git.for_each_ref(common_path, **options) |
| 208 | + return cls.list_from_string(repo, output) |
| 209 | + |
| 210 | + @classmethod |
| 211 | + def list_from_string(cls, repo, text): |
| 212 | + """ |
| 213 | + Parse out ref information into a list of Ref compatible objects |
| 214 | +
|
| 215 | + ``repo`` |
| 216 | + is the Repo |
| 217 | + ``text`` |
| 218 | + is the text output from the git-for-each-ref command |
| 219 | +
|
| 220 | + Returns |
| 221 | + git.Ref[] |
| 222 | + |
| 223 | + list of Ref objects |
| 224 | + """ |
| 225 | + heads = [] |
| 226 | + |
| 227 | + for line in text.splitlines(): |
| 228 | + heads.append(cls.from_string(repo, line)) |
| 229 | + |
| 230 | + return heads |
| 231 | + |
| 232 | + @classmethod |
| 233 | + def from_string(cls, repo, line): |
| 234 | + """ |
| 235 | + Create a new Ref instance from the given string. |
| 236 | +
|
| 237 | + ``repo`` |
| 238 | + is the Repo |
| 239 | +
|
| 240 | + ``line`` |
| 241 | + is the formatted ref information |
| 242 | +
|
| 243 | + Format:: |
| 244 | + |
| 245 | + name: [a-zA-Z_/]+ |
| 246 | + <null byte> |
| 247 | + id: [0-9A-Fa-f]{40} |
| 248 | +
|
| 249 | + Returns |
| 250 | + git.Head |
| 251 | + """ |
| 252 | + full_path, hexsha, type_name, object_size = line.split("\x00") |
| 253 | + obj = Object.get_type_by_name(type_name)(repo, hexsha, object_size) |
| 254 | + return cls(full_path, obj) |
0 commit comments