Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork966
Expand file tree
/
Copy pathtest_quick_doc.py
More file actions
222 lines (169 loc) · 6.93 KB
/
test_quick_doc.py
File metadata and controls
222 lines (169 loc) · 6.93 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
# This module is part of GitPython and is released under the
# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/
importgc
fromtest.libimportTestBase
fromtest.lib.helperimportwith_rw_directory
classQuickDoc(TestBase):
deftearDown(self):
gc.collect()
@with_rw_directory
deftest_init_repo_object(self,path_to_dir):
# [1-test_init_repo_object]
# $ git init <path/to/dir>
fromgitimportRepo
repo=Repo.init(path_to_dir)
# ![1-test_init_repo_object]
# [2-test_init_repo_object]
repo=Repo(path_to_dir)
# ![2-test_init_repo_object]
delrepo# Avoids "assigned to but never used" warning. Doesn't go in the docs.
@with_rw_directory
deftest_cloned_repo_object(self,local_dir):
fromgitimportRepo
# Code to clone from url
# [1-test_cloned_repo_object]
# $ git clone <url> <local_dir>
repo_url="https://github.com/gitpython-developers/QuickStartTutorialFiles.git"
repo=Repo.clone_from(repo_url,local_dir)
# ![1-test_cloned_repo_object]
# Code to add files
# [2-test_cloned_repo_object]
# We must make a change to a file so that we can add the update to git
update_file="dir1/file2.txt"# we'll use local_dir/dir1/file2.txt
withopen(f"{local_dir}/{update_file}","a")asf:
f.write("\nUpdate version 2")
# ![2-test_cloned_repo_object]
# [3-test_cloned_repo_object]
# $ git add <file>
add_file= [update_file]# relative path from git root
repo.index.add(add_file)# notice the add function requires a list of paths
# ![3-test_cloned_repo_object]
# Code to commit - not sure how to test this
# [4-test_cloned_repo_object]
# $ git commit -m <message>
repo.index.commit("Update to file2")
# ![4-test_cloned_repo_object]
# [5-test_cloned_repo_object]
# $ git log <file>
# Relative path from git root
repo.iter_commits(all=True,max_count=10,paths=update_file)# Gets the last 10 commits from all branches.
# Outputs: <generator object Commit._iter_from_process_or_stream at 0x7fb66c186cf0>
# ![5-test_cloned_repo_object]
# [6-test_cloned_repo_object]
commits_for_file_generator=repo.iter_commits(all=True,max_count=10,paths=update_file)
commits_for_file=list(commits_for_file_generator)
commits_for_file
# Outputs: [<git.Commit "SHA1-HEX_HASH-2">,
# <git.Commit "SHA1-HEX-HASH-1">]
# ![6-test_cloned_repo_object]
# Untracked files - create new file
# [7-test_cloned_repo_object]
f=open(f"{local_dir}/untracked.txt","w")# Creates an empty file.
f.close()
# ![7-test_cloned_repo_object]
# [8-test_cloned_repo_object]
repo.untracked_files
# Output: ['untracked.txt']
# ![8-test_cloned_repo_object]
# Modified files
# [9-test_cloned_repo_object]
# Let's modify one of our tracked files.
withopen(f"{local_dir}/Downloads/file3.txt","w")asf:
f.write("file3 version 2")# Overwrite file 3.
# ![9-test_cloned_repo_object]
# [10-test_cloned_repo_object]
repo.index.diff(None)# Compares staging area to working directory.
# Output: [<git.diff.Diff object at 0x7fb66c076e50>,
# <git.diff.Diff object at 0x7fb66c076ca0>]
# ![10-test_cloned_repo_object]
# [11-test_cloned_repo_object]
diffs=repo.index.diff(None)
fordindiffs:
print(d.a_path)
# Output
# Downloads/file3.txt
# ![11-test_cloned_repo_object]
# Compares staging area to head commit
# [11.1-test_cloned_repo_object]
diffs=repo.index.diff(repo.head.commit)
fordindiffs:
print(d.a_path)
# Output
# ![11.1-test_cloned_repo_object]
# [11.2-test_cloned_repo_object]
# Let's add untracked.txt.
repo.index.add(["untracked.txt"])
diffs=repo.index.diff(repo.head.commit)
fordindiffs:
print(d.a_path)
# Output
# untracked.txt
# ![11.2-test_cloned_repo_object]
# Compare commit to commit
# [11.3-test_cloned_repo_object]
first_commit=list(repo.iter_commits(all=True))[-1]
diffs=repo.head.commit.diff(first_commit)
fordindiffs:
print(d.a_path)
# Output
# dir1/file2.txt
# ![11.3-test_cloned_repo_object]
"""Trees and Blobs"""
# Latest commit tree
# [12-test_cloned_repo_object]
tree=repo.head.commit.tree
# ![12-test_cloned_repo_object]
# Previous commit tree
# [13-test_cloned_repo_object]
prev_commits=list(repo.iter_commits(all=True,max_count=10))# Last 10 commits from all branches.
tree=prev_commits[0].tree
# ![13-test_cloned_repo_object]
# Iterating through tree
# [14-test_cloned_repo_object]
files_and_dirs= [(entry,entry.name,entry.type)forentryintree]
files_and_dirs
# Output
# [(< git.Tree "SHA1-HEX_HASH" >, 'Downloads', 'tree'),
# (< git.Tree "SHA1-HEX_HASH" >, 'dir1', 'tree'),
# (< git.Blob "SHA1-HEX_HASH" >, 'file4.txt', 'blob')]
# ![14-test_cloned_repo_object]
# [15-test_cloned_repo_object]
defprint_files_from_git(root,level=0):
forentryinroot:
print(f"{'-'*4*level}|{entry.path},{entry.type}")
ifentry.type=="tree":
print_files_from_git(entry,level+1)
# ![15-test_cloned_repo_object]
# [16-test_cloned_repo_object]
print_files_from_git(tree)
# Output
# | Downloads, tree
# ----| Downloads / file3.txt, blob
# | dir1, tree
# ----| dir1 / file1.txt, blob
# ----| dir1 / file2.txt, blob
# | file4.txt, blob
# # ![16-test_cloned_repo_object]
# Printing text files
# [17-test_cloned_repo_object]
print_file="dir1/file2.txt"
tree[print_file]# The head commit tree.
# Output <git.Blob "SHA1-HEX-HASH">
# ![17-test_cloned_repo_object]
# Print latest file
# [18-test_cloned_repo_object]
blob=tree[print_file]
print(blob.data_stream.read().decode())
# Output
# File 2 version 1
# Update version 2
# ![18-test_cloned_repo_object]
# Print previous tree
# [18.1-test_cloned_repo_object]
commits_for_file=list(repo.iter_commits(all=True,paths=print_file))
tree=commits_for_file[-1].tree# Gets the first commit tree.
blob=tree[print_file]
print(blob.data_stream.read().decode())
# Output
# File 2 version 1
# ![18.1-test_cloned_repo_object]