forked from vmware-archive/ml-conversational-analytic-tool
-
Notifications
You must be signed in to change notification settings - Fork 0
/
githubDataExtraction.html
808 lines (737 loc) · 43.9 KB
/
githubDataExtraction.html
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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>mcat.githubDataExtraction API documentation</title>
<meta name="description" content="" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>mcat.githubDataExtraction</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python"># Copyright 2021 VMware, Inc.
# SPDX-License-Identifier: Apache-2.0
import argparse
import datetime
import os
import time
import pandas as pd
import requests
from mcat import utils
class GithubDataExtractor:
def __init__(self, access_token, organization):
"""
Constructor requires an access token to start a Github session, and specifies instance variables
"""
self.reaction_flag = False
self.organization = organization
self.query_repos = self.load_query('repos.graphql')
self.query_pull_requests_without_reactions = self.load_query('pull_requests_without_reactions.graphql')
self.query_pull_requests_with_reactions = self.load_query('pull_requests_with_reactions.graphql')
self.headers = {'Authorization': 'bearer ' + access_token}
def get_all_repos(self):
"""
Method to get all repos of an organization
Parameters: None
Returns: A list of repository names
"""
queries_and_variables = {
'query': self.query_repos,
'variables': {'owner': self.organization}
}
repository_list = self.run_queries(query=queries_and_variables)
repositories = [repository.get('name') for repository in repository_list]
return repositories
def get_all_pull_requests(self, repo, reaction_flag=False):
"""
Method to get all pull requests from a repo
Parameters:
repo - string
reaction_flag - boolean
Returns: dataframe containing rows of pull requests
"""
self.reaction_flag = reaction_flag
if self.reaction_flag:
query = self.query_pull_requests_with_reactions
else:
query = self.query_pull_requests_without_reactions
queries_and_variables = {
'query': query,
'variables': {'owner': self.organization, 'repo': repo}
}
pull_request_list = self.run_queries(query=queries_and_variables)
pull_data = (self.get_pull_features(pr) for pr in pull_request_list)
pull_request_df = pd.DataFrame(pull_data)
try:
# sort by the first column: Pull request number
return pull_request_df.sort_values(by=pull_request_df.columns[0])
except IndexError:
return pull_request_df
def load_query(self, file_name, directory='queries'):
"""
Method to load graphql queries
Parameters: file_name - name of the graphql query file
Returns: string
"""
directory_path = os.path.dirname(os.path.realpath(__file__))
query_path = os.path.join(directory_path, directory, file_name)
with open(query_path) as file:
return file.read()
def run_queries(self, query):
"""
Method to run graphql queries
Parameters: query - dict of graphql query and variables
Returns: json string
"""
has_next_page = True
data = []
while has_next_page:
# wait one second to avoid the secondary rate limits
time.sleep(1)
print('retrieving data...')
try:
response = requests.post(url='https://api.github.com/graphql', json=query, headers=self.headers)
response_json = response.json()
response_reason = response.reason
status_code = response.status_code
if status_code == 200:
# GitHub graphql has a bug that returns status 200 for exceeding the rate limit
# When a rate limit has exceeded, retries after waiting until rate limit has reset
# The wait time is calculated using returned header X-RateLimit-Reset
rate_limit_remaining = response.headers.get('X-RateLimit-Remaining')
if rate_limit_remaining == "0":
rate_limit_reset = response.headers.get('X-RateLimit-Reset')
rate_limit_reset_time = datetime.datetime.fromtimestamp(int(rate_limit_reset))
current_time = datetime.datetime.now()
wait_time_seconds = (rate_limit_reset_time - current_time).total_seconds()
print('rate limit exceeded, retrying after {} seconds'.format(wait_time_seconds))
time.sleep(wait_time_seconds)
else:
if query['query'] == self.query_repos:
org_repos = response_json['data']['organization']['repositories']
page_info = org_repos['pageInfo']
nodes = org_repos['nodes']
else:
repo_pull_requests = response_json['data']['repository']['pullRequests']
page_info = repo_pull_requests['pageInfo']
nodes = repo_pull_requests['nodes']
end_cursor = page_info['endCursor']
has_next_page = page_info['hasNextPage']
variables = query['variables']
variables['cursor'] = end_cursor
query = {'query': query['query'], 'variables': variables}
data += nodes
elif status_code in (502, 503, 403, 413, 429):
print('retrying due to {} {} {}'.format(status_code, response_reason, response_json))
else:
raise requests.HTTPError('{}: {} {}'.format(status_code, response_reason, response_json))
except requests.exceptions.ChunkedEncodingError as error:
# Broken connection, exception is not thrown to allow retry
print('retrying due to {}'.format(error))
pass
return data
def list_of_comments(self, comments):
"""
Method to form a list of json strings representing comments, reviews, or issue.
Parameters: comments - list of comments
Returns: List of json strings
"""
list_comments = []
# Iterate over each comment
for comment in comments:
comment_user = comment.get("author").get("login", None) if comment.get("author") is not None else None
# Record reactions if Flag is True
if self.reaction_flag:
reactions = []
raw_reactions = comment.get("reactions").get("nodes", None) if comment.get(
"reactions") is not None else []
for reaction in raw_reactions:
reaction_user = reaction.get("user").get("login", None) if reaction.get(
"user") is not None else None
# Extract information regarding each reaction
reactions.append({"Content": reaction.get("content", None),
"Created_At": reaction.get("createdAt", None),
"User": reaction_user})
# Extract information regarding each comment
list_comments.append({"Created_At": comment.get("createdAt", None),
"User": comment_user,
"Body": comment.get("body", None),
"Updated_At": comment.get("updatedAt", None),
"Reactions": reactions})
else:
list_comments.append({"Created_At": comment.get("createdAt", None),
"User": comment_user,
"Body": comment.get("body", None),
"Updated_At": comment.get("updatedAt", None)})
return list_comments
def get_pull_features(self, pull):
"""
Method to get all data for a particular pull. Parameters: pull - object representing a pull
Returns: dictionary containing all data of a pull
"""
comments = pull.get('comments').get('nodes', None) if 'comments' in pull else None
reviews = pull.get("reviews").get("nodes", None) if "reviews" in pull else None
return {
'Number': pull.get('number', None),
'Title': pull.get('title', None),
'User': pull.get('author').get('login', None) if pull.get('author') is not None else None,
'URL': pull.get('url', None),
'State': pull.get('state', None),
'Body': pull.get('body', None),
'Additions': pull.get('additions', None),
'Deletions': pull.get('deletions', None),
'Comments_Num': pull.get('comments').get('totalCount', None) if pull.get('comments') is not None else None,
'Commits_Num': pull.get('comments').get('totalCount', None) if pull.get('commits') is not None else None,
'Created_At': pull.get('createdAt', None),
'Closed_At': pull.get('closedAt', None),
'Merged': pull.get('merged', None),
'Merged_At': pull.get('mergedAt', None),
'Merged_By': pull.get('mergedBy').get('login', None) if pull.get('mergedBy') is not None else None,
'Review_Comments_Num': pull.get('reviews').get('totalCount', None) if pull.get(
'reviews') is not None else None,
'Updated_At': pull.get('updatedAt'),
'Comments': self.list_of_comments(comments) if comments is not None else [],
"Review_Comments": self.list_of_comments(reviews) if reviews is not None else []
}
def retrieve_and_export_pull_request_data(self, repo, reactions_flag, name, organization):
df = self.get_all_pull_requests(repo, reactions_flag)
file_name = utils.construct_file_name(name, organization, repo)
utils.export_to_cvs(df, file_name)
if __name__ == "__main__":
parser = argparse.ArgumentParser(description='Create CSV/s for all pulls in repo/s')
parser.add_argument('organization', help='Organization the repo belongs to.')
parser.add_argument('-R', '--repo', help='Name of repo.')
parser.add_argument('--reactions', action='store_true', default=False, help='Flag to extract reactions')
parser.add_argument('-n', "--name",
help='Output file name. If not specified, the name is constructed like this: <organization>_<repo>.csv')
args = parser.parse_args()
ACCESS_TOKEN = os.environ["GH_TOKEN"] # Access Github token from environment for security purposes
extractor = GithubDataExtractor(ACCESS_TOKEN, args.organization)
if args.repo is None:
# Extract data for all repositories in organization
repos = extractor.get_all_repos()
for repo in repos:
extractor.retrieve_and_export_pull_request_data(repo=repo, reactions_flag=args.reactions, name=None,
organization=args.organization)
else:
# Extract data for an individual repository
extractor.retrieve_and_export_pull_request_data(repo=args.repo, reactions_flag=args.reactions, name=args.name,
organization=args.organization)</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="mcat.githubDataExtraction.GithubDataExtractor"><code class="flex name class">
<span>class <span class="ident">GithubDataExtractor</span></span>
<span>(</span><span>access_token, organization)</span>
</code></dt>
<dd>
<div class="desc"><p>Constructor requires an access token to start a Github session, and specifies instance variables</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class GithubDataExtractor:
def __init__(self, access_token, organization):
"""
Constructor requires an access token to start a Github session, and specifies instance variables
"""
self.reaction_flag = False
self.organization = organization
self.query_repos = self.load_query('repos.graphql')
self.query_pull_requests_without_reactions = self.load_query('pull_requests_without_reactions.graphql')
self.query_pull_requests_with_reactions = self.load_query('pull_requests_with_reactions.graphql')
self.headers = {'Authorization': 'bearer ' + access_token}
def get_all_repos(self):
"""
Method to get all repos of an organization
Parameters: None
Returns: A list of repository names
"""
queries_and_variables = {
'query': self.query_repos,
'variables': {'owner': self.organization}
}
repository_list = self.run_queries(query=queries_and_variables)
repositories = [repository.get('name') for repository in repository_list]
return repositories
def get_all_pull_requests(self, repo, reaction_flag=False):
"""
Method to get all pull requests from a repo
Parameters:
repo - string
reaction_flag - boolean
Returns: dataframe containing rows of pull requests
"""
self.reaction_flag = reaction_flag
if self.reaction_flag:
query = self.query_pull_requests_with_reactions
else:
query = self.query_pull_requests_without_reactions
queries_and_variables = {
'query': query,
'variables': {'owner': self.organization, 'repo': repo}
}
pull_request_list = self.run_queries(query=queries_and_variables)
pull_data = (self.get_pull_features(pr) for pr in pull_request_list)
pull_request_df = pd.DataFrame(pull_data)
try:
# sort by the first column: Pull request number
return pull_request_df.sort_values(by=pull_request_df.columns[0])
except IndexError:
return pull_request_df
def load_query(self, file_name, directory='queries'):
"""
Method to load graphql queries
Parameters: file_name - name of the graphql query file
Returns: string
"""
directory_path = os.path.dirname(os.path.realpath(__file__))
query_path = os.path.join(directory_path, directory, file_name)
with open(query_path) as file:
return file.read()
def run_queries(self, query):
"""
Method to run graphql queries
Parameters: query - dict of graphql query and variables
Returns: json string
"""
has_next_page = True
data = []
while has_next_page:
# wait one second to avoid the secondary rate limits
time.sleep(1)
print('retrieving data...')
try:
response = requests.post(url='https://api.github.com/graphql', json=query, headers=self.headers)
response_json = response.json()
response_reason = response.reason
status_code = response.status_code
if status_code == 200:
# GitHub graphql has a bug that returns status 200 for exceeding the rate limit
# When a rate limit has exceeded, retries after waiting until rate limit has reset
# The wait time is calculated using returned header X-RateLimit-Reset
rate_limit_remaining = response.headers.get('X-RateLimit-Remaining')
if rate_limit_remaining == "0":
rate_limit_reset = response.headers.get('X-RateLimit-Reset')
rate_limit_reset_time = datetime.datetime.fromtimestamp(int(rate_limit_reset))
current_time = datetime.datetime.now()
wait_time_seconds = (rate_limit_reset_time - current_time).total_seconds()
print('rate limit exceeded, retrying after {} seconds'.format(wait_time_seconds))
time.sleep(wait_time_seconds)
else:
if query['query'] == self.query_repos:
org_repos = response_json['data']['organization']['repositories']
page_info = org_repos['pageInfo']
nodes = org_repos['nodes']
else:
repo_pull_requests = response_json['data']['repository']['pullRequests']
page_info = repo_pull_requests['pageInfo']
nodes = repo_pull_requests['nodes']
end_cursor = page_info['endCursor']
has_next_page = page_info['hasNextPage']
variables = query['variables']
variables['cursor'] = end_cursor
query = {'query': query['query'], 'variables': variables}
data += nodes
elif status_code in (502, 503, 403, 413, 429):
print('retrying due to {} {} {}'.format(status_code, response_reason, response_json))
else:
raise requests.HTTPError('{}: {} {}'.format(status_code, response_reason, response_json))
except requests.exceptions.ChunkedEncodingError as error:
# Broken connection, exception is not thrown to allow retry
print('retrying due to {}'.format(error))
pass
return data
def list_of_comments(self, comments):
"""
Method to form a list of json strings representing comments, reviews, or issue.
Parameters: comments - list of comments
Returns: List of json strings
"""
list_comments = []
# Iterate over each comment
for comment in comments:
comment_user = comment.get("author").get("login", None) if comment.get("author") is not None else None
# Record reactions if Flag is True
if self.reaction_flag:
reactions = []
raw_reactions = comment.get("reactions").get("nodes", None) if comment.get(
"reactions") is not None else []
for reaction in raw_reactions:
reaction_user = reaction.get("user").get("login", None) if reaction.get(
"user") is not None else None
# Extract information regarding each reaction
reactions.append({"Content": reaction.get("content", None),
"Created_At": reaction.get("createdAt", None),
"User": reaction_user})
# Extract information regarding each comment
list_comments.append({"Created_At": comment.get("createdAt", None),
"User": comment_user,
"Body": comment.get("body", None),
"Updated_At": comment.get("updatedAt", None),
"Reactions": reactions})
else:
list_comments.append({"Created_At": comment.get("createdAt", None),
"User": comment_user,
"Body": comment.get("body", None),
"Updated_At": comment.get("updatedAt", None)})
return list_comments
def get_pull_features(self, pull):
"""
Method to get all data for a particular pull. Parameters: pull - object representing a pull
Returns: dictionary containing all data of a pull
"""
comments = pull.get('comments').get('nodes', None) if 'comments' in pull else None
reviews = pull.get("reviews").get("nodes", None) if "reviews" in pull else None
return {
'Number': pull.get('number', None),
'Title': pull.get('title', None),
'User': pull.get('author').get('login', None) if pull.get('author') is not None else None,
'URL': pull.get('url', None),
'State': pull.get('state', None),
'Body': pull.get('body', None),
'Additions': pull.get('additions', None),
'Deletions': pull.get('deletions', None),
'Comments_Num': pull.get('comments').get('totalCount', None) if pull.get('comments') is not None else None,
'Commits_Num': pull.get('comments').get('totalCount', None) if pull.get('commits') is not None else None,
'Created_At': pull.get('createdAt', None),
'Closed_At': pull.get('closedAt', None),
'Merged': pull.get('merged', None),
'Merged_At': pull.get('mergedAt', None),
'Merged_By': pull.get('mergedBy').get('login', None) if pull.get('mergedBy') is not None else None,
'Review_Comments_Num': pull.get('reviews').get('totalCount', None) if pull.get(
'reviews') is not None else None,
'Updated_At': pull.get('updatedAt'),
'Comments': self.list_of_comments(comments) if comments is not None else [],
"Review_Comments": self.list_of_comments(reviews) if reviews is not None else []
}
def retrieve_and_export_pull_request_data(self, repo, reactions_flag, name, organization):
df = self.get_all_pull_requests(repo, reactions_flag)
file_name = utils.construct_file_name(name, organization, repo)
utils.export_to_cvs(df, file_name)</code></pre>
</details>
<h3>Methods</h3>
<dl>
<dt id="mcat.githubDataExtraction.GithubDataExtractor.get_all_pull_requests"><code class="name flex">
<span>def <span class="ident">get_all_pull_requests</span></span>(<span>self, repo, reaction_flag=False)</span>
</code></dt>
<dd>
<div class="desc"><p>Method to get all pull requests from a repo</p>
<h2 id="parameters">Parameters</h2>
<p>repo - string
reaction_flag - boolean
Returns: dataframe containing rows of pull requests</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_all_pull_requests(self, repo, reaction_flag=False):
"""
Method to get all pull requests from a repo
Parameters:
repo - string
reaction_flag - boolean
Returns: dataframe containing rows of pull requests
"""
self.reaction_flag = reaction_flag
if self.reaction_flag:
query = self.query_pull_requests_with_reactions
else:
query = self.query_pull_requests_without_reactions
queries_and_variables = {
'query': query,
'variables': {'owner': self.organization, 'repo': repo}
}
pull_request_list = self.run_queries(query=queries_and_variables)
pull_data = (self.get_pull_features(pr) for pr in pull_request_list)
pull_request_df = pd.DataFrame(pull_data)
try:
# sort by the first column: Pull request number
return pull_request_df.sort_values(by=pull_request_df.columns[0])
except IndexError:
return pull_request_df</code></pre>
</details>
</dd>
<dt id="mcat.githubDataExtraction.GithubDataExtractor.get_all_repos"><code class="name flex">
<span>def <span class="ident">get_all_repos</span></span>(<span>self)</span>
</code></dt>
<dd>
<div class="desc"><p>Method to get all repos of an organization
Parameters: None
Returns: A list of repository names</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_all_repos(self):
"""
Method to get all repos of an organization
Parameters: None
Returns: A list of repository names
"""
queries_and_variables = {
'query': self.query_repos,
'variables': {'owner': self.organization}
}
repository_list = self.run_queries(query=queries_and_variables)
repositories = [repository.get('name') for repository in repository_list]
return repositories</code></pre>
</details>
</dd>
<dt id="mcat.githubDataExtraction.GithubDataExtractor.get_pull_features"><code class="name flex">
<span>def <span class="ident">get_pull_features</span></span>(<span>self, pull)</span>
</code></dt>
<dd>
<div class="desc"><p>Method to get all data for a particular pull. Parameters: pull - object representing a pull
Returns: dictionary containing all data of a pull</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def get_pull_features(self, pull):
"""
Method to get all data for a particular pull. Parameters: pull - object representing a pull
Returns: dictionary containing all data of a pull
"""
comments = pull.get('comments').get('nodes', None) if 'comments' in pull else None
reviews = pull.get("reviews").get("nodes", None) if "reviews" in pull else None
return {
'Number': pull.get('number', None),
'Title': pull.get('title', None),
'User': pull.get('author').get('login', None) if pull.get('author') is not None else None,
'URL': pull.get('url', None),
'State': pull.get('state', None),
'Body': pull.get('body', None),
'Additions': pull.get('additions', None),
'Deletions': pull.get('deletions', None),
'Comments_Num': pull.get('comments').get('totalCount', None) if pull.get('comments') is not None else None,
'Commits_Num': pull.get('comments').get('totalCount', None) if pull.get('commits') is not None else None,
'Created_At': pull.get('createdAt', None),
'Closed_At': pull.get('closedAt', None),
'Merged': pull.get('merged', None),
'Merged_At': pull.get('mergedAt', None),
'Merged_By': pull.get('mergedBy').get('login', None) if pull.get('mergedBy') is not None else None,
'Review_Comments_Num': pull.get('reviews').get('totalCount', None) if pull.get(
'reviews') is not None else None,
'Updated_At': pull.get('updatedAt'),
'Comments': self.list_of_comments(comments) if comments is not None else [],
"Review_Comments": self.list_of_comments(reviews) if reviews is not None else []
}</code></pre>
</details>
</dd>
<dt id="mcat.githubDataExtraction.GithubDataExtractor.list_of_comments"><code class="name flex">
<span>def <span class="ident">list_of_comments</span></span>(<span>self, comments)</span>
</code></dt>
<dd>
<div class="desc"><p>Method to form a list of json strings representing comments, reviews, or issue.
Parameters: comments - list of comments
Returns: List of json strings</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def list_of_comments(self, comments):
"""
Method to form a list of json strings representing comments, reviews, or issue.
Parameters: comments - list of comments
Returns: List of json strings
"""
list_comments = []
# Iterate over each comment
for comment in comments:
comment_user = comment.get("author").get("login", None) if comment.get("author") is not None else None
# Record reactions if Flag is True
if self.reaction_flag:
reactions = []
raw_reactions = comment.get("reactions").get("nodes", None) if comment.get(
"reactions") is not None else []
for reaction in raw_reactions:
reaction_user = reaction.get("user").get("login", None) if reaction.get(
"user") is not None else None
# Extract information regarding each reaction
reactions.append({"Content": reaction.get("content", None),
"Created_At": reaction.get("createdAt", None),
"User": reaction_user})
# Extract information regarding each comment
list_comments.append({"Created_At": comment.get("createdAt", None),
"User": comment_user,
"Body": comment.get("body", None),
"Updated_At": comment.get("updatedAt", None),
"Reactions": reactions})
else:
list_comments.append({"Created_At": comment.get("createdAt", None),
"User": comment_user,
"Body": comment.get("body", None),
"Updated_At": comment.get("updatedAt", None)})
return list_comments</code></pre>
</details>
</dd>
<dt id="mcat.githubDataExtraction.GithubDataExtractor.load_query"><code class="name flex">
<span>def <span class="ident">load_query</span></span>(<span>self, file_name, directory='queries')</span>
</code></dt>
<dd>
<div class="desc"><p>Method to load graphql queries
Parameters: file_name - name of the graphql query file
Returns: string</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def load_query(self, file_name, directory='queries'):
"""
Method to load graphql queries
Parameters: file_name - name of the graphql query file
Returns: string
"""
directory_path = os.path.dirname(os.path.realpath(__file__))
query_path = os.path.join(directory_path, directory, file_name)
with open(query_path) as file:
return file.read()</code></pre>
</details>
</dd>
<dt id="mcat.githubDataExtraction.GithubDataExtractor.retrieve_and_export_pull_request_data"><code class="name flex">
<span>def <span class="ident">retrieve_and_export_pull_request_data</span></span>(<span>self, repo, reactions_flag, name, organization)</span>
</code></dt>
<dd>
<div class="desc"></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def retrieve_and_export_pull_request_data(self, repo, reactions_flag, name, organization):
df = self.get_all_pull_requests(repo, reactions_flag)
file_name = utils.construct_file_name(name, organization, repo)
utils.export_to_cvs(df, file_name)</code></pre>
</details>
</dd>
<dt id="mcat.githubDataExtraction.GithubDataExtractor.run_queries"><code class="name flex">
<span>def <span class="ident">run_queries</span></span>(<span>self, query)</span>
</code></dt>
<dd>
<div class="desc"><p>Method to run graphql queries
Parameters: query - dict of graphql query and variables
Returns: json string</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def run_queries(self, query):
"""
Method to run graphql queries
Parameters: query - dict of graphql query and variables
Returns: json string
"""
has_next_page = True
data = []
while has_next_page:
# wait one second to avoid the secondary rate limits
time.sleep(1)
print('retrieving data...')
try:
response = requests.post(url='https://api.github.com/graphql', json=query, headers=self.headers)
response_json = response.json()
response_reason = response.reason
status_code = response.status_code
if status_code == 200:
# GitHub graphql has a bug that returns status 200 for exceeding the rate limit
# When a rate limit has exceeded, retries after waiting until rate limit has reset
# The wait time is calculated using returned header X-RateLimit-Reset
rate_limit_remaining = response.headers.get('X-RateLimit-Remaining')
if rate_limit_remaining == "0":
rate_limit_reset = response.headers.get('X-RateLimit-Reset')
rate_limit_reset_time = datetime.datetime.fromtimestamp(int(rate_limit_reset))
current_time = datetime.datetime.now()
wait_time_seconds = (rate_limit_reset_time - current_time).total_seconds()
print('rate limit exceeded, retrying after {} seconds'.format(wait_time_seconds))
time.sleep(wait_time_seconds)
else:
if query['query'] == self.query_repos:
org_repos = response_json['data']['organization']['repositories']
page_info = org_repos['pageInfo']
nodes = org_repos['nodes']
else:
repo_pull_requests = response_json['data']['repository']['pullRequests']
page_info = repo_pull_requests['pageInfo']
nodes = repo_pull_requests['nodes']
end_cursor = page_info['endCursor']
has_next_page = page_info['hasNextPage']
variables = query['variables']
variables['cursor'] = end_cursor
query = {'query': query['query'], 'variables': variables}
data += nodes
elif status_code in (502, 503, 403, 413, 429):
print('retrying due to {} {} {}'.format(status_code, response_reason, response_json))
else:
raise requests.HTTPError('{}: {} {}'.format(status_code, response_reason, response_json))
except requests.exceptions.ChunkedEncodingError as error:
# Broken connection, exception is not thrown to allow retry
print('retrying due to {}'.format(error))
pass
return data</code></pre>
</details>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="mcat" href="index.html">mcat</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="mcat.githubDataExtraction.GithubDataExtractor" href="#mcat.githubDataExtraction.GithubDataExtractor">GithubDataExtractor</a></code></h4>
<ul class="">
<li><code><a title="mcat.githubDataExtraction.GithubDataExtractor.get_all_pull_requests" href="#mcat.githubDataExtraction.GithubDataExtractor.get_all_pull_requests">get_all_pull_requests</a></code></li>
<li><code><a title="mcat.githubDataExtraction.GithubDataExtractor.get_all_repos" href="#mcat.githubDataExtraction.GithubDataExtractor.get_all_repos">get_all_repos</a></code></li>
<li><code><a title="mcat.githubDataExtraction.GithubDataExtractor.get_pull_features" href="#mcat.githubDataExtraction.GithubDataExtractor.get_pull_features">get_pull_features</a></code></li>
<li><code><a title="mcat.githubDataExtraction.GithubDataExtractor.list_of_comments" href="#mcat.githubDataExtraction.GithubDataExtractor.list_of_comments">list_of_comments</a></code></li>
<li><code><a title="mcat.githubDataExtraction.GithubDataExtractor.load_query" href="#mcat.githubDataExtraction.GithubDataExtractor.load_query">load_query</a></code></li>
<li><code><a title="mcat.githubDataExtraction.GithubDataExtractor.retrieve_and_export_pull_request_data" href="#mcat.githubDataExtraction.GithubDataExtractor.retrieve_and_export_pull_request_data">retrieve_and_export_pull_request_data</a></code></li>
<li><code><a title="mcat.githubDataExtraction.GithubDataExtractor.run_queries" href="#mcat.githubDataExtraction.GithubDataExtractor.run_queries">run_queries</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>