Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

gh-104010: Separate and improve docs fortyping.get_origin andtyping.get_args#104013

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.

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

Already on GitHub?Sign in to your account

Merged
JelleZijlstra merged 6 commits intopython:mainfromchgnrdv:typing-separate-and-improve-get_args-get_origin-docs
May 10, 2023
Merged

gh-104010: Separate and improve docs fortyping.get_origin andtyping.get_args#104013

JelleZijlstra merged 6 commits intopython:mainfromchgnrdv:typing-separate-and-improve-get_args-get_origin-docs
May 10, 2023

Conversation

chgnrdv
Copy link
Contributor

@chgnrdvchgnrdv commentedApr 30, 2023
edited by github-actionsbot
Loading

Fixes#104010

  • separate documentation and examples for both functions
  • add examples demonstrating behaviour with unsupported types

📚 Documentation preview 📚:https://cpython-previews--104013.org.readthedocs.build/

* separate documentation and examples for both functions* add examples demonstrating behaviour with unsupported types

Get the unsubscripted version of a type: for a typing object of the form
``X[Y, Z, ...]`` return ``X``. If ``X`` is a generic alias for a builtin or
:mod:`collections` class, it gets normalized to the original class.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Let's add that forParamSpecArgs andKwargs, it returns the underlying ParamSpec.

Copy link
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Done.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Thanks!

@chgnrdv
Copy link
ContributorAuthor

chgnrdv commentedApr 30, 2023
edited
Loading

Shouldn'tget_args andget_origin docs be swapped? Alsoget_args doc uses "objects" to denote unsupported typing objects, but inget_origin doc I wrote "types". Is it critical?

@JelleZijlstra
Copy link
Member

Good points, I do think it makes sense to putget_origin first.

I'd standardize onobjects: these things work on objects that aren't strictly types, likeRequired[]

AlexWaygood and chgnrdv reacted with thumbs up emoji

…f github.com:chgnrdv/cpython into typing-separate-and-improve-get_args-get_origin-docs
@JelleZijlstraJelleZijlstra merged commita7a2dbb intopython:mainMay 10, 2023
@miss-islington
Copy link
Contributor

Thanks@chgnrdv for the PR, and@JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

chgnrdv reacted with hooray emoji

miss-islington pushed a commit to miss-islington/cpython that referenced this pull requestMay 10, 2023
…d `typing.get_args` (pythonGH-104013)* separate documentation and examples for both functions* add examples demonstrating behaviour with unsupported types* document return value of `get_origin` for `ParamSpecArgs` and `ParamSpecKwargs` instances(cherry picked from commita7a2dbb)Co-authored-by: chgnrdv <52372310+chgnrdv@users.noreply.github.com>Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
@bedevere-bot
Copy link

GH-104359 is a backport of this pull request to the3.11 branch.

@bedevere-botbedevere-bot removed the needs backport to 3.11only security fixes labelMay 10, 2023
JelleZijlstra added a commit that referenced this pull requestMay 10, 2023
…nd `typing.get_args` (GH-104013) (#104359)* separate documentation and examples for both functions* add examples demonstrating behaviour with unsupported types* document return value of `get_origin` for `ParamSpecArgs` and `ParamSpecKwargs` instances(cherry picked from commita7a2dbb)Co-authored-by: chgnrdv <52372310+chgnrdv@users.noreply.github.com>Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
carljm added a commit to carljm/cpython that referenced this pull requestMay 10, 2023
* main:pythonGH-102181: Improve specialization stats for SEND (pythonGH-102182)pythongh-103000: Optimise `dataclasses.asdict` for the common case (python#104364)pythongh-103538: Remove unused TK_AQUA code (pythonGH-103539)pythonGH-87695: Fix OSError from `pathlib.Path.glob()` (pythonGH-104292)pythongh-104263: Rely on Py_NAN and introduce Py_INFINITY (pythonGH-104202)pythongh-104010: Separate and improve docs for `typing.get_origin` and `typing.get_args` (python#104013)pythongh-101819: Adapt _io._BufferedIOBase_Type methods to Argument Clinic (python#104355)pythongh-103960: Dark mode: invert image brightness (python#103983)pythongh-104252: Immortalize Py_EMPTY_KEYS (pythongh-104253)pythongh-101819: Clean up _io windows console io afterpythongh-104197 (python#104354)pythongh-101819: Harden _io init (python#104352)pythongh-103247: clear the module cache in a test in test_importlib/extensions/test_loader.py (pythonGH-104226)pythongh-103848: Adds checks to ensure that bracketed hosts found by urlsplit are of IPv6 or IPvFuture format (python#103849)pythongh-74895: adjust tests to work on Solaris (python#104326)pythongh-101819: Refactor _io in preparation for module isolation (python#104334)pythongh-90953: Don't use deprecated AST nodes in clinic.py (python#104322)pythongh-102327: Extend docs for "url" and "headers" parameters to HTTPConnection.request()pythongh-104328: Fix typo in ``typing.Generic`` multiple inheritance error message (python#104335)
carljm added a commit to carljm/cpython that referenced this pull requestMay 11, 2023
* main: (27 commits)pythongh-87849: fix SEND specialization family definition (pythonGH-104268)pythongh-101819: Adapt _io.IOBase.seek and _io.IOBase.truncate to Argument Clinic (python#104384)pythongh-101819: Adapt _io._Buffered* methods to Argument Clinic (python#104367)pythongh-101819: Refactor `_io` futher in preparation for module isolation (python#104369)pythongh-101819: Adapt _io.TextIOBase methods to Argument Clinic (python#104383)pythongh-101117: Improve accuracy of sqlite3.Cursor.rowcount docs (python#104287)pythonGH-92184: Convert os.altsep to '/' in filenames when creating ZipInfo objects (python#92185)pythongh-104357: fix inlined comprehensions that close over iteration var (python#104368)pythonGH-90208: Suppress OSError exceptions from `pathlib.Path.glob()` (pythonGH-104141)pythonGH-102181: Improve specialization stats for SEND (pythonGH-102182)pythongh-103000: Optimise `dataclasses.asdict` for the common case (python#104364)pythongh-103538: Remove unused TK_AQUA code (pythonGH-103539)pythonGH-87695: Fix OSError from `pathlib.Path.glob()` (pythonGH-104292)pythongh-104263: Rely on Py_NAN and introduce Py_INFINITY (pythonGH-104202)pythongh-104010: Separate and improve docs for `typing.get_origin` and `typing.get_args` (python#104013)pythongh-101819: Adapt _io._BufferedIOBase_Type methods to Argument Clinic (python#104355)pythongh-103960: Dark mode: invert image brightness (python#103983)pythongh-104252: Immortalize Py_EMPTY_KEYS (pythongh-104253)pythongh-101819: Clean up _io windows console io afterpythongh-104197 (python#104354)pythongh-101819: Harden _io init (python#104352)  ...
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@JelleZijlstraJelleZijlstraJelleZijlstra approved these changes

@gvanrossumgvanrossumAwaiting requested review from gvanrossum

@Fidget-SpinnerFidget-SpinnerAwaiting requested review from Fidget-Spinner

@AlexWaygoodAlexWaygoodAwaiting requested review from AlexWaygoodAlexWaygood is a code owner

Assignees
No one assigned
Labels
docsDocumentation in the Doc dirskip newstopic-typing
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

typing: Document get_origin and get_args separately
5 participants
@chgnrdv@JelleZijlstra@miss-islington@bedevere-bot@AlexWaygood

[8]ページ先頭

©2009-2025 Movatter.jp