Consistency is a hobgoblin of a small mind #773

sigmavirus24 · 2018-01-24T22:45:54Z

This pull request unifies the way objects work in github3.py. We use direct access of the keys in the dictionary instead of calling .get() this will provide a more consistent interface and set of expectations for users.

Re-record GitHub.add_email_addreses test for correctness

Add a Contributor object for the Repository.contributors method and update usage and tests.

Also update our class documentation to be better.

Also improve our documentation

…obgoblin

This also introduces consistency in the orgs module in how we set-up attributes for the *Team and *Organization classes. It also rewrites the docstrings to be consistent with the rest of the library

omgjlk · 2018-02-12T22:01:48Z

How goes things here? Anything I could help with?

This splits up the different representations of licenses across the GitHub API for acccuracy.

sigmavirus24 · 2018-02-14T12:14:48Z

How goes things here? Anything I could help with?

Sorry, I missed this entirely.

One of the things I'd like to be able to do is completely get rid of the _*_attribute methods by eliminating their usage in the modules. If you want to tackle some of the submodules I haven't made my way to yet (I'm working backwards alphabetically and ignoring issues, gists, search, and repos for now). That would be awesome. Keep an eye out as you do this for any objects that need further splitting up. I've found several already.

omgjlk · 2018-02-14T15:40:42Z

Okay, I'll take a look through.

Removes the use of _get_attribute and its ilk. Related-to: #773

This also created a CommitTree object as the tree is different via the git object API vs the repository object API. New example data is added to account for this difference as well.

Merging omgjlk's branch into consistency-is-a-hobgoblin

Let's try to mainly import modules instead of functions or members. Let's update the class documentation and add otherwise missing attributes.

Add better documentation around the objects there and what they represent. Also add a new Commit-like object for RepoCommits

omgjlk · 2018-02-19T22:24:06Z

It looks like github3/model.py is the last module that has calls to _get_attribute and the like, outside of issues, gists, search, and repos. Digging into model.py would break things inside of those, so some strategy is necessary there I think.

This adds the ShortComment class to represent comments without text and html bodies. This also removes the BaseAccount, BaseComment, and BaseCommit classes as they're no longer used or necessary.

sigmavirus24 · 2018-03-05T02:53:42Z

GitHub is inconsistent in the timestamps it returns for the issue import API. strptime has a way of handling UTC offsets a format like -0600 but not -06:00. There's no good way to handle that with the standard library, so here we must add dateutil.

mindw · 2018-05-20T12:31:06Z

Better late than never - only 1.5 years. Finally I can stop using my ancient fork for correct timestamp parsing :)

sigmavirus24 added 9 commits January 7, 2018 08:19

Update Email class for attributes and docs

90d737a

Re-record GitHub.add_email_addreses test for correctness

Re-organize attribute documentation for *User objects

ea9c834

Add a Contributor object for the Repository.contributors method and update usage and tests.

Fix-up docstrings and add GitHubException

9722e2c

Update github3.users.Key to access attributes

8e38d15

Also update our class documentation to be better.

Migrate Plan to accessing values directly

0ae0f25

Update github3.pulls to access attributes directly

331f56c

Also improve our documentation

Merge remote-tracking branch 'origin/develop' into consistency-is-a-h…

e73bb36

…obgoblin

Fix up tests from recent pull request changes

a91c04d

Fix-up projects documentation

c68d0b3

sigmavirus24 mentioned this pull request Jan 27, 2018

[RFC] [Meta] Design Reconsiderations #670

Closed

13 tasks

sigmavirus24 added 2 commits February 4, 2018 09:16

Split out ShortTeam from Team

e65d27b

This also introduces consistency in the orgs module in how we set-up attributes for the *Team and *Organization classes. It also rewrites the docstrings to be consistent with the rest of the library

Update our notifications module to conform

973435c

sigmavirus24 added 2 commits February 13, 2018 19:00

Update licenses module to better represent differences

f854318

This splits up the different representations of licenses across the GitHub API for acccuracy.

Fix up documentation for a passing CI build

9981ea4

omgjlk added 4 commits February 14, 2018 20:59

Update events classes for attribute fetching

f64a47e

Removes the use of _get_attribute and its ilk. Related-to: #773

Update github3.auths to remove get_attribute

6f733b1

Update github3.git to remove get_attribute

f7ad5a5

This also created a CommitTree object as the tree is different via the git object API vs the repository object API. New example data is added to account for this difference as well.

Add py36 to python environments to test in

45103a5

omgjlk mentioned this pull request Feb 15, 2018

Remove more get_attribute and similar calls #782

Closed

sigmavirus24 added 7 commits February 17, 2018 07:35

Merge 'develop' into consistency-is-a-hobgoblin

c49af2c

Merge branch 'no-get-attribute-773' of omgjlk

73362a1

Merging omgjlk's branch into consistency-is-a-hobgoblin

Remove and ignore .DS_Store

2d67ae8

Further update github3.git for consistency

112caa6

Let's try to mainly import modules instead of functions or members. Let's update the class documentation and add otherwise missing attributes.

Bring github3.git into a consistent state

929c131

Add better documentation around the objects there and what they represent. Also add a new Commit-like object for RepoCommits

Update github3.git API docs

f2b0bdd

Fix line length and docstring

e8e45ea

sigmavirus24 added 5 commits March 3, 2018 10:24

Update RepoComment for consistency

0b1e5cd

This adds the ShortComment class to represent comments without text and html bodies. This also removes the BaseAccount, BaseComment, and BaseCommit classes as they're no longer used or necessary.

Update github3.repos.commit for consistency

0517bbe

Update github3.repos.comparison for consistency

fca45b0

Update github3.repos.contents for consistency

5aa47f1

Update github3.repos.deployment for consistency

2b4594c

sigmavirus24 added 2 commits March 5, 2018 17:46

Finish updating github3.repos.deployment

f7748b6

Update github3.repos.hook for consistency

232cff2

sigmavirus24 force-pushed the consistency-is-a-hobgoblin branch from 1e044d4 to 57bbe14 Compare March 9, 2018 22:55

Add dateutil to parse timestamps

b273037

GitHub is inconsistent in the timestamps it returns for the issue import API. strptime has a way of handling UTC offsets a format like -0600 but not -06:00. There's no good way to handle that with the standard library, so here we must add dateutil.

sigmavirus24 force-pushed the consistency-is-a-hobgoblin branch from 57bbe14 to b273037 Compare March 9, 2018 23:22

sigmavirus24 added 4 commits March 9, 2018 18:36

Update github3.repos.issue_import for consistency

adf165d

Update github3.repos.pages for consistency

f38845b

Update github3.repos.release for consistency

f93ca04

Update github3.repos.stats for consistency

7f32e37

sigmavirus24 force-pushed the consistency-is-a-hobgoblin branch from 6fce842 to 7f32e37 Compare March 10, 2018 23:36

sigmavirus24 added 6 commits March 11, 2018 07:45

Update github3.repos.status for consistency

dcace1d

Update github3.repos.tag for consistency

ad56d5a

Update github3.search.user for consistency

ac8c1b6

Remove final few stragglers of _get_attribute

e0ec86d

Remove _class_attribute and missed _strptime_attribute

10d9ac6

Clean-up github3.models and remove BaseCommit

81e6047

sigmavirus24 force-pushed the consistency-is-a-hobgoblin branch from cbbf492 to b1972fc Compare March 11, 2018 18:03

Clean-up github3.github for consistency

9E88

5814c53

sigmavirus24 force-pushed the consistency-is-a-hobgoblin branch from b1972fc to 5814c53 Compare March 11, 2018 18:31

Update github3.repos.repo for consistency

7e5a00b

sigmavirus24 changed the title ~~WIP: Consistency is a hobgoblin of a small mind~~ Consistency is a hobgoblin of a small mind Mar 11, 2018

sigmavirus24 merged commit 508efde into develop Mar 12, 2018

sigmavirus24 deleted the consistency-is-a-hobgoblin branch March 12, 2018 00:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Consistency is a hobgoblin of a small mind #773

Consistency is a hobgoblin of a small mind #773

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Consistency is a hobgoblin of a small mind #773

Consistency is a hobgoblin of a small mind #773

Uh oh!

Conversation

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!