Add `GithubObject.last_modified_datetime` to have `last_modified` as a `datetime` #2772

chouetz · 2023-09-29T16:23:46Z

As nearly all dates are returned as datetime.datetime, it would be convenient to have last_modified as a datetime.datetime as well.
As discussed below, let's introduce last_modified_datetime new argument to cover this need.

codecov-commenter · 2023-10-03T07:35:42Z

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (c8b4fcb) 96.74% compared to head (16ff649) 96.74%.

Files	Patch %	Lines
github/GithubObject.py	66.66%	1 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2772      +/-   ##
==========================================
- Coverage   96.74%   96.74%   -0.01%     
==========================================
  Files         142      142              
  Lines       14361    14364       +3     
==========================================
+ Hits        13894    13896       +2     
- Misses        467      468       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

EnricoMi · 2023-10-03T15:56:52Z

This would be a breaking change, and last_modified could rightly be considered a header attribute of type string,

I'd prefer to introduce a separate property last_modified_datetime: Optional[datetime]. Using _makeDatetimeAttribute would also help to support more than just a single hard-coded format.

And here should be some asserts on this property in tests.

chouetz · 2023-10-04T15:42:14Z

This would be a breaking change, and last_modified could rightly be considered a header attribute of type string,

I'd prefer to introduce a separate property last_modified_datetime: Optional[datetime]. Using _makeDatetimeAttribute would also help to support more than just a single hard-coded format.

And here should be some asserts on this property in tests.

Many thanks for your comment, I'll update the PR this way and let you know when it's ready

chouetz · 2023-10-10T07:18:41Z

Probably needs #2783 for the failing job, @EnricoMi can you check the PR content again please?
Many thanks in advance

github/GithubObject.py

Co-authored-by: Enrico Minack <github@enrico.minack.dev>

github/GithubObject.py

chouetz · 2023-10-10T11:50:10Z

Thanks for your time @EnricoMi

chouetz · 2023-10-18T13:41:07Z

OK for review @EnricoMi, many thanks in advance

EnricoMi

LGTM!

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [PyGithub](https://togithub.com/pygithub/pygithub) | `==2.1.1` -> `==2.2.0` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/PyGithub/2.2.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/PyGithub/2.2.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/PyGithub/2.1.1/2.2.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/PyGithub/2.1.1/2.2.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>pygithub/pygithub (PyGithub)</summary> ### [`v2.2.0`](https://togithub.com/PyGithub/PyGithub/releases/tag/v2.2.0) [Compare Source](https://togithub.com/pygithub/pygithub/compare/v2.1.1...v2.2.0) #### Breaking Changes The `github.Comparison.Comparison` instance returned by `Repository.compare` provides a `commits` property that used to return a `list[github.Commit.Commit]`, which has now been changed to `PaginatedList[github.Commit.Commit]`. This breaks user code that assumes a `list`: ```python commits = repo.compare("v0.6", "v0.7").commits no_of_commits = len(commits) # will raise a TypeError ``` This will raise a `TypeError: object of type 'PaginatedList' has no len()`, as the returned `PaginatedList` does not support the `len()` method. Use the `totalCount` property instead: ```python commits = repo.compare("v0.6", "v0.7").commits no_of_commits = commits.totalCount ``` #### New features - Add support to call GraphQL API #### Improvements - Add parent_team_id, maintainers and notification_setting for creating and updating teams. by [@Cheshirez](https://togithub.com/Cheshirez) in [PyGithub/PyGithub#2863 - Add support for issue reactions summary by [@smuzaffar](https://togithub.com/smuzaffar) in [PyGithub/PyGithub#2866 - Support for DependabotAlert APIs by [@coopernetes](https://togithub.com/coopernetes) in [PyGithub/PyGithub#2879 - Derive GraphQL URL from base_url by [@EnricoMi](https://togithub.com/EnricoMi) in [PyGithub/PyGithub#2880 - Make `Repository.compare().commits` return paginated list by [@EnricoMi](https://togithub.com/EnricoMi) in [PyGithub/PyGithub#2882 - Add missing branch protection fields by [@treee111](https://togithub.com/treee111) in [PyGithub/PyGithub#2873 - Add `include_all_branches` to `create_repo_from_template` of `AuthenticatedUser` and `Organization` by [@janssonoskar](https://togithub.com/janssonoskar) in [PyGithub/PyGithub#2871 - Add and update organisation dependabot secrets by [@mohy01](https://togithub.com/mohy01) in [PyGithub/PyGithub#2316 - Add missing params to `Organization.create_repo` by [@tekumara](https://togithub.com/tekumara) in [PyGithub/PyGithub#2700 - Update allowed values for `Repository` collaborator permissions by [@flying-sheep](https://togithub.com/flying-sheep) in [PyGithub/PyGithub#1996 - Support editing PullRequestReview by [@ColasGael](https://togithub.com/ColasGael) in [PyGithub/PyGithub#2851 - Update attributes after calling `PullRequestReview.dismiss` by [@ColasGael](https://togithub.com/ColasGael) in [PyGithub/PyGithub#2854 - Add `request_cve` on `RepositoryAdvisories` by [@JLLeitschuh](https://togithub.com/JLLeitschuh) in [PyGithub/PyGithub#2855 - Filter collaborators of a repository by permissions by [@notmicaelfilipe](https://togithub.com/notmicaelfilipe) in [PyGithub/PyGithub#2792 - Set pull request to auto merge via GraphQL API by [@heitorpolidoro](https://togithub.com/heitorpolidoro) in [PyGithub/PyGithub#2816 - Support Environment Variables and Secrets by [@AndrewJDawes](https://togithub.com/AndrewJDawes) in [PyGithub/PyGithub#2848 - Update workflow.get_runs & pullrequest.add_to_assignees function signature by [@sd-kialo](https://togithub.com/sd-kialo) in [PyGithub/PyGithub#2799 - Add `GithubObject.last_modified_datetime` to have `last_modified` as a `datetime` by [@chouetz](https://togithub.com/chouetz) in [PyGithub/PyGithub#2772 - Add support for global advisories and unify some shared logic with repository advisories by [@crimsonknave](https://togithub.com/crimsonknave) in [PyGithub/PyGithub#2702 - Add `internal` as valid Repository visibility value by [@AndrewJDawes](https://togithub.com/AndrewJDawes) in [PyGithub/PyGithub#2806 - Add support for issue comments reactions summary by [@smuzaffar](https://togithub.com/smuzaffar) in [PyGithub/PyGithub#2813 #### Bug Fixes - Add a bunch of missing urllib.parse.quote calls by [@ExplodingCabbage](https://togithub.com/ExplodingCabbage) in [PyGithub/PyGithub#1976 - Fix Variable and Secret url bugs by [@AndrewJDawes](https://togithub.com/AndrewJDawes) in [PyGithub/PyGithub#2835 #### Maintenance - Update the class name for NetrcAuth in the examples by [@vinnybod](https://togithub.com/vinnybod) in [PyGithub/PyGithub#2860 - Move build to PEP517 by [@trim21](https://togithub.com/trim21) in [PyGithub/PyGithub#2800 - Use new type assert functions in `Repository` by [@trim21](https://togithub.com/trim21) in [PyGithub/PyGithub#2798 - PyTest: Move config to pyproject.toml by [@Borda](https://togithub.com/Borda) in [PyGithub/PyGithub#2859 - codespell: ignore-words-list by [@Borda](https://togithub.com/Borda) in [PyGithub/PyGithub#2858 - Improve fix-headers.py script by [@EnricoMi](https://togithub.com/EnricoMi) in [PyGithub/PyGithub#2728 - Remove dependency on python-dateutil by [@lazka](https://togithub.com/lazka) in [PyGithub/PyGithub#2804 - CI: update precommit & apply by [@Borda](https://togithub.com/Borda) in [PyGithub/PyGithub#2600 - Docs: Fix parameter order according to Version 2.1.0 by [@nad182](https://togithub.com/nad182) in [PyGithub/PyGithub#2786 - Add missing GitHub classes to docs by [@EnricoMi](https://togithub.com/EnricoMi) in [PyGithub/PyGithub#2783 - CI: Fix mypy error by ignoring override by [@EnricoMi](https://togithub.com/EnricoMi) in [PyGithub/PyGithub#2779 **Full Changelog**: PyGithub/PyGithub@v2.1.1...v2.2.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/lettuce-financial/github-bot-signed-commit).

chouetz force-pushed the nschweitzer/last_modified branch 4 times, most recently from 68d3145 to 38db32b Compare October 3, 2023 07:33

chouetz force-pushed the nschweitzer/last_modified branch 3 times, most recently from 50f96cc to 314457d Compare October 5, 2023 07:55

EnricoMi and others added 2 commits October 6, 2023 10:50

Fix mypy error

c167009

Cast last_modified as a date

96ef639

chouetz force-pushed the nschweitzer/last_modified branch from 314457d to 96ef639 Compare October 6, 2023 08:53

chouetz changed the title ~~Cast last_modified as a date~~ New property last_modified_datetime to have last_modified as a datetime Oct 10, 2023

EnricoMi requested changes Oct 10, 2023

View reviewed changes

github/GithubObject.py Outdated Show resolved Hide resolved

EnricoMi changed the title ~~New property last_modified_datetime to have last_modified as a datetime~~ Add GithubObject.last_modified_datetime to have last_modified as a datetime Oct 10, 2023

Apply suggestions from code review

62b859c

Co-authored-by: Enrico Minack <github@enrico.minack.dev>

chouetz commented Oct 10, 2023

View reviewed changes

github/GithubObject.py Outdated Show resolved Hide resolved

chouetz added 2 commits October 10, 2023 13:45

Return the Attribute value

c0e4fa2

Merge branch 'main' into nschweitzer/last_modified

89d5248

Merge branch 'main' into nschweitzer/last_modified

50fdbf3

EnricoMi mentioned this pull request Nov 20, 2023

Remove dependency on python-dateutil #2804

Merged

Merge branch 'main' into nschweitzer/last_modified

16ff649

EnricoMi approved these changes Nov 26, 2023

View reviewed changes

EnricoMi merged commit e7ce818 into PyGithub:main Nov 26, 2023
15 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `GithubObject.last_modified_datetime` to have `last_modified` as a `datetime` #2772

Add `GithubObject.last_modified_datetime` to have `last_modified` as a `datetime` #2772

chouetz commented Sep 29, 2023 •

edited

codecov-commenter commented Oct 3, 2023 •

edited

EnricoMi commented Oct 3, 2023 •

edited

chouetz commented Oct 4, 2023

chouetz commented Oct 10, 2023

chouetz commented Oct 10, 2023

chouetz commented Oct 18, 2023

EnricoMi left a comment

Add GithubObject.last_modified_datetime to have last_modified as a datetime #2772

Add GithubObject.last_modified_datetime to have last_modified as a datetime #2772

Conversation

chouetz commented Sep 29, 2023 • edited

codecov-commenter commented Oct 3, 2023 • edited

Codecov Report

EnricoMi commented Oct 3, 2023 • edited

chouetz commented Oct 4, 2023

chouetz commented Oct 10, 2023

chouetz commented Oct 10, 2023

chouetz commented Oct 18, 2023

EnricoMi left a comment

Choose a reason for hiding this comment

Add `GithubObject.last_modified_datetime` to have `last_modified` as a `datetime` #2772

Add `GithubObject.last_modified_datetime` to have `last_modified` as a `datetime` #2772

chouetz commented Sep 29, 2023 •

edited

codecov-commenter commented Oct 3, 2023 •

edited

EnricoMi commented Oct 3, 2023 •

edited