8000 Consistency is a hobgoblin of a small mind by sigmavirus24 · Pull Request #773 · sigmavirus24/github3.py · GitHub
[go: up one dir, main page]
Skip to content

Consistency is a hobgoblin of a small mind #773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 59 commits into from
Mar 12, 2018
Merged

Consistency is a hobgoblin of a small mind #773

merged 59 commits into from
Mar 12, 2018

Conversation

sigmavirus24
Copy link
Owner

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.

@sigmavirus24 sigmavirus24 mentioned this pull request Jan 27, 2018
Closed
13 tasks
@sigmavirus24
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
@sigmavirus24
Update our notifications module to conform
973435c
@omgjlk
Copy link
Collaborator
omgjlk commented Feb 12, 2018

How goes things here? Anything I could help with?

@sigmavirus24
Update licenses module to better represent differences
f854318 
This splits up the different representations of licenses across the
GitHub API for acccuracy.
@sigmavirus24
Fix up documentation for a passing CI build
9981ea4
@sigmavirus24
Copy link
Owner Author

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
Copy link
Collaborator
omgjlk commented Feb 14, 2018

Okay, I'll take a look through.

@omgjlk
Update events classes for attribute fetching
f64a47e 
Removes the use of _get_attribute and its ilk.

Related-to: #773
@omgjlk
Update github3.auths to remove get_attribute
6f733b1
@omgjlk
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.
@omgjlk
Add py36 to python environments to test in
45103a5
@omgjlk omgjlk mentioned this pull request Feb 15, 2018
Closed
@sigmavirus24
Merge 'develop' into consistency-is-a-hobgoblin
c49af2c
@sigmavirus24
Merge branch 'no-get-attribute-773' of omgjlk
73362a1 
Merging omgjlk's branch into consistency-is-a-hobgoblin
@sigmavirus24
Remove and ignore .DS_Store
2d67ae8
@sigmavirus24
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.
@sigmavirus24
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
@sigmavirus24
Update github3.git API docs
f2b0bdd
@sigmavirus24
Fix line length and docstring
e8e45ea
@omgjlk
Copy link
Collaborator
omgjlk commented Feb 19, 2018

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.

@sigmavirus24
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.
@sigmavirus24
Update github3.repos.commit for consistency
0517bbe
@sigmavirus24
Update github3.repos.comparison for consistency
fca45b0
@sigmavirus24
Update github3.repos.contents for consistency
5aa47f1
@sigmavirus24
Update github3.repos.deployment for consistency
2b4594c
@sigmavirus24
Copy link
Owner Author
sigmavirus24 commented Mar 5, 2018 •
edited
Loading

Remaining modules to update:

  • repos.hook
  • repos.issue_import
  • repos.pages
  • repos.release
  • repos.repo
  • repos.stats
  • repos.status
  • repos.tags
  • github
  • models

If folks want to help out, send PRs to this branch.

@sigmavirus24 sigmavirus24 force-pushed the consistency-is-a-hobgoblin branch from 1e044d4 to 57bbe14 Compare March 9, 2018 22:55
@sigmavirus24
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 sigmavirus24 force-pushed the consistency-is-a-hobgoblin branch from 57bbe14 to b273037 Compare March 9, 2018 23:22
@sigmavirus24 sigmavirus24 force-pushed the consistency-is-a-hobgoblin branch from 6fce842 to 7f32e37 Compare March 10, 2018 23:36
@sigmavirus24 sigmavirus24 force-pushed the consistency-is-a-hobgoblin branch from cbbf492 to b1972fc Compare March 11, 2018 18:03
@sigmavirus24 sigmavirus24 force-pushed the consistency-is-a-hobgoblin branch from b1972fc to 5814c53 Compare March 11, 2018 18:31
@sigmavirus24 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 sigmavirus24 merged commit 508efde into develop Mar 12, 2018
@sigmavirus24 sigmavirus24 deleted the consistency-is-a-hobgoblin branch March 12, 2018 00:15
@mindw
Copy link
Contributor
mindw commented May 20, 2018

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sigmavirus24 @omgjlk @mindw
0