Title: Include TagObject in git.types.Tree_ish by EliahKagan · Pull Request #1878 · gitpython-developers/GitPython · GitHub
Open Graph Title: Include TagObject in git.types.Tree_ish by EliahKagan · Pull Request #1878 · gitpython-developers/GitPython
X Title: Include TagObject in git.types.Tree_ish by EliahKagan · Pull Request #1878 · gitpython-developers/GitPython
Description: The Tree_ish union omitted TagObject, whose instances are only sometimes tree-ish, and unlike Commit_ish before #1859, it is not inherently a bug to define Tree_ish this way. However, this Tree_ish type actually has only one use in GitPython (which was also the case before the changes in #1859): as, itself, an alternative in the union used to annotate the rev parameter of the Repo.tree method (whose other alternatives are str and None). A TagObject may be passed, and if it points to a tree or commit then that will be resolved. Just to avoid a mypy error, code doing that would (before this change) have to convert it to str first. That annotation should be improved, and the best way to do it is to keep it written the same way but change the definition of Tree_ish in git.types to include TagObject. The reason is that doing so alleviates a major unintuitive aspect of the relationship between the Commit_ish and Tree_ish types: Commit_ish was broader than everything commit-ish, while Tree_ish was narrower than everything tree-ish. I had not considered making this change in #1859 because I didn't want to modify Tree_ish unnecessarily, and its definition was not inherently a bug. However, the change to Commit_ish is sufficiently large (though it only affects static typing) that a change to Tree_ish to make them coherent and intuitive may be justified. This pull request changes Tree_ish so that, in addition to its Commit and Tree alternatives, it also includes TagObject. This also updates and simplifies its docstring accordingly, bringing it in line with that of Commit_ish which is already defined with the same kind of breadth, and further revises both docstrings to more explicitly clarify when tags are tree-ish or commit-ish and when they are not. Notes This is related to #1859 (comment). This does not change the separate nonpublic Treeish type defined in git.index.base (and named with no underscore), which omits TagObject but includes bytes and str, and which is used to annotate parameters of the IndexFile.from_tree and IndexFile.merge_tree methods. Changes there may be valuable, but the goal here is just to build narrowly on #1859 to address a shortcoming of the revisions to git.types.
Open Graph Description: The Tree_ish union omitted TagObject, whose instances are only sometimes tree-ish, and unlike Commit_ish before #1859, it is not inherently a bug to define Tree_ish this way. However, this Tree_ish...
X Description: The Tree_ish union omitted TagObject, whose instances are only sometimes tree-ish, and unlike Commit_ish before #1859, it is not inherently a bug to define Tree_ish this way. However, this Tree_ish...
Opengraph URL: https://github.com/gitpython-developers/GitPython/pull/1878
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:dc31c446-dc2c-1b0b-742d-a438797bcef7 |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | 9DA0:218E79:266619:359B9D:6968D6DE |
| html-safe-nonce | 70677c0fe32b47bec3d157fe9f84f49fd1fb17ee0a427f0ffd2832045b9cf85b |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5REEwOjIxOEU3OToyNjY2MTk6MzU5QjlEOjY5NjhENkRFIiwidmlzaXRvcl9pZCI6IjU4OTIzMDc3MjU4MzAzNzkyMzAiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 3c411b41a07fb8f411ec78b1f9ec58688182466df0795d2d93aebc88dc9cac0c |
| hovercard-subject-tag | pull_request:1773291104 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/gitpython-developers/GitPython/pull/1878/files |
| twitter:image | https://avatars.githubusercontent.com/u/1771172?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/1771172?s=400&v=4 |
| og:image:alt | The Tree_ish union omitted TagObject, whose instances are only sometimes tree-ish, and unlike Commit_ish before #1859, it is not inherently a bug to define Tree_ish this way. However, this Tree_ish... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | 3c4e9f2fc1db52c609205138be6a397cfde4574cb54d53015014de30dd49f27e |
| turbo-cache-control | no-preview |
| diff-view | unified |
| go-import | github.com/gitpython-developers/GitPython git https://github.com/gitpython-developers/GitPython.git |
| octolytics-dimension-user_id | 503709 |
| octolytics-dimension-user_login | gitpython-developers |
| octolytics-dimension-repository_id | 1126087 |
| octolytics-dimension-repository_nwo | gitpython-developers/GitPython |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 1126087 |
| octolytics-dimension-repository_network_root_nwo | gitpython-developers/GitPython |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 1fb1ea11f8c37dd4dd50347cca70d89824e93788 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width