Support github timeline events (GH-422). #1302

ncb000gt · 2019-11-26T14:16:11Z

Adds support for retrieval of Github timeline events (GH-422).

Usage example:

issue = repo.get_issue(28)
events = issue.get_timeline()
for event in events:
    print(f'Event: {event}')

The class doesn't match the output exactly as shown on the api site because the output from the call/events doesn't. This can be seen in the text file used for testing. This can be verified using the following.

curl -i https://[REPLACE WITH GH TOKEN]@api.github.com/repositories/3544490/issues/28/timeline -H"Accept:application/vnd.github.mockingbird-preview"

Signed-off-by: Nick Campbell nicholas.j.campbell@gmail.com

TravisBuddy · 2019-11-26T14:18:35Z

Hey @ncb000gt,
Your changes look good to me!

View build log

TravisBuddy Request Identifier: a01bd840-1057-11ea-a65a-5f455ab5a299

codecov-io · 2019-11-26T14:18:40Z

Codecov Report

Merging #1302 into master will decrease coverage by 0.03%.
The diff coverage is 94.61%.

@@            Coverage Diff             @@
##           master    #1302      +/-   ##
==========================================
- Coverage   98.17%   98.14%   -0.04%     
==========================================
  Files         186      188       +2     
  Lines       14092    14222     +130     
==========================================
+ Hits        13835    13958     +123     
- Misses        257      264       +7

Impacted Files	Coverage Δ
tests/Issue.py	`100% <100%> (ø)`	⬆️
github/Consts.py	`100% <100%> (ø)`	⬆️
github/Issue.py	`98.61% <100%> (+0.01%)`	⬆️
github/TimelineEventSource.py	`90% <90%> (ø)`
github/TimelineEvent.py	`93.82% <93.82%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update baddb71...d27ea9a. Read the comment docs.

s-t-e-v-e-n-k · 2019-11-28T10:47:05Z

This is looking great! Would you mind adding a test case for TimelineEvent where you fetch one from the API and assert it's parsed correctly? tests/RequiredStatusChecks.py is a small example.

ncb000gt · 2019-12-02T18:59:49Z

@s-t-e-v-e-n-k I'll take a look and post back. Thanks.

ncb000gt · 2019-12-03T04:28:25Z

@s-t-e-v-e-n-k I took a look and the difference between individual timeline events is that they can't be lazily loaded. You either get the full timeline or you don't. I removed the "load if not found" calls since they can't be individually loaded. I added some additional checks to the test that I did add.

What are your thoughts?

TravisBuddy · 2019-12-03T04:28:33Z

Hey @ncb000gt,
Your changes look good to me!

View build log

TravisBuddy Request Identifier: 5c00a040-1585-11ea-81b2-273600e26419

s-t-e-v-e-n-k · 2019-12-03T04:40:45Z

I'm happy with the replay data including the entire timeline even if you only assert the attributes of the first one. You can always selectively edit the replay data to have more brevity.

tests/Issue.py

TravisBuddy · 2019-12-12T15:50:05Z

Hey @ncb000gt,
Your changes look good to me!

View build log

TravisBuddy Request Identifier: 0ec12420-1cf7-11ea-a2fb-51cb67500490

ncb000gt · 2019-12-17T02:06:31Z

@s-t-e-v-e-n-k let me know if you want me to make any additional changes. Thanks!

s-t-e-v-e-n-k

Two more niggling issues now that I've had a close look.

github/TimelineEventSource.py

tests/Issue.py

TravisBuddy · 2019-12-19T02:40:44Z

Hey @ncb000gt,
Your changes look good to me!

View build log

TravisBuddy Request Identifier: f34db3e0-2208-11ea-b76a-c509dfe0ae07

TravisBuddy · 2019-12-19T02:50:23Z

Hey @ncb000gt,
Your changes look good to me!

View build log

TravisBuddy Request Identifier: 4bbb87e0-220a-11ea-b76a-c509dfe0ae07

github/TimelineEvent.py

s-t-e-v-e-n-k · 2019-12-19T13:03:16Z

github/TimelineEvent.py

+import github.TimelineEventSource
+
+
+class TimelineEvent(github.GithubObject.NonCompletableGithubObject):


It is completable! It has a URL and everything.

They don't all have a url. Some do. if you look through the replay data the cross-referenced event does not have a url.

Adds support for retrieval of Github timeline events. Signed-off-by: Nick Campbell <nicholas.j.campbell@gmail.com>

TravisBuddy · 2019-12-19T13:43:05Z

Hey @ncb000gt,
Your changes look good to me!

View build log

TravisBuddy Request Identifier: 7a6f7eb0-2265-11ea-b76a-c509dfe0ae07

ncb000gt force-pushed the master branch from f6f1eda to 6c85666 Compare December 3, 2019 04:26

s-t-e-v-e-n-k reviewed Dec 4, 2019

View reviewed changes

tests/Issue.py Outdated Show resolved Hide resolved

ncb000gt force-pushed the master branch 2 times, most recently from 1c420ab to 4e26c3b Compare December 12, 2019 15:48

s-t-e-v-e-n-k reviewed Dec 19, 2019

View reviewed changes

github/TimelineEventSource.py Outdated Show resolved Hide resolved

tests/Issue.py Outdated Show resolved Hide resolved

ncb000gt force-pushed the master branch from 4e26c3b to bdadc83 Compare December 19, 2019 02:38

ncb000gt force-pushed the master branch from bdadc83 to 6f79f65 Compare December 19, 2019 02:48

s-t-e-v-e-n-k reviewed Dec 19, 2019

View reviewed changes

Support github timeline events.

d27ea9a

Adds support for retrieval of Github timeline events. Signed-off-by: Nick Campbell <nicholas.j.campbell@gmail.com>

ncb000gt force-pushed the master branch from 6f79f65 to d27ea9a Compare December 19, 2019 13:41

s-t-e-v-e-n-k merged commit 732fd26 into PyGithub:master Dec 28, 2019

sfdye mentioned this pull request Apr 15, 2020

Timeline missing #422

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support github timeline events (GH-422). #1302

Support github timeline events (GH-422). #1302

ncb000gt commented Nov 26, 2019 •

edited

TravisBuddy commented Nov 26, 2019

codecov-io commented Nov 26, 2019 •

edited

s-t-e-v-e-n-k commented Nov 28, 2019

ncb000gt commented Dec 2, 2019

ncb000gt commented Dec 3, 2019

TravisBuddy commented Dec 3, 2019

s-t-e-v-e-n-k commented Dec 3, 2019

TravisBuddy commented Dec 12, 2019

ncb000gt commented Dec 17, 2019

s-t-e-v-e-n-k left a comment

TravisBuddy commented Dec 19, 2019

TravisBuddy commented Dec 19, 2019

s-t-e-v-e-n-k Dec 19, 2019

ncb000gt Dec 19, 2019

TravisBuddy commented Dec 19, 2019

		import github.TimelineEventSource


		class TimelineEvent(github.GithubObject.NonCompletableGithubObject):

Support github timeline events (GH-422). #1302

Support github timeline events (GH-422). #1302

Conversation

ncb000gt commented Nov 26, 2019 • edited

TravisBuddy commented Nov 26, 2019

TravisBuddy Request Identifier: a01bd840-1057-11ea-a65a-5f455ab5a299

codecov-io commented Nov 26, 2019 • edited

Codecov Report

s-t-e-v-e-n-k commented Nov 28, 2019

ncb000gt commented Dec 2, 2019

ncb000gt commented Dec 3, 2019

TravisBuddy commented Dec 3, 2019

TravisBuddy Request Identifier: 5c00a040-1585-11ea-81b2-273600e26419

s-t-e-v-e-n-k commented Dec 3, 2019

TravisBuddy commented Dec 12, 2019

TravisBuddy Request Identifier: 0ec12420-1cf7-11ea-a2fb-51cb67500490

ncb000gt commented Dec 17, 2019

s-t-e-v-e-n-k left a comment

Choose a reason for hiding this comment

TravisBuddy commented Dec 19, 2019

TravisBuddy Request Identifier: f34db3e0-2208-11ea-b76a-c509dfe0ae07

TravisBuddy commented Dec 19, 2019

TravisBuddy Request Identifier: 4bbb87e0-220a-11ea-b76a-c509dfe0ae07

s-t-e-v-e-n-k Dec 19, 2019

Choose a reason for hiding this comment

ncb000gt Dec 19, 2019

Choose a reason for hiding this comment

TravisBuddy commented Dec 19, 2019

TravisBuddy Request Identifier: 7a6f7eb0-2265-11ea-b76a-c509dfe0ae07

ncb000gt commented Nov 26, 2019 •

edited

codecov-io commented Nov 26, 2019 •

edited