◐ Shell
reader mode source ↗
Skip to content

gh-104010: Separate and improve docs for typing.get_origin and typing.get_args#104013

Merged
JelleZijlstra merged 6 commits into
python:mainfrom
chgnrdv:typing-separate-and-improve-get_args-get_origin-docs
May 10, 2023
Merged

gh-104010: Separate and improve docs for typing.get_origin and typing.get_args#104013
JelleZijlstra merged 6 commits into
python:mainfrom
chgnrdv:typing-separate-and-improve-get_args-get_origin-docs

Conversation

@chgnrdv

@chgnrdv chgnrdv commented Apr 30, 2023 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Contributor

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/

@chgnrdv
typing: separate and improve docs for get_origin and get_args …
f6a2736 
* separate documentation and examples for both functions
* add examples demonstrating behaviour with unsupported types
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir skip news labels Apr 30, 2023
@bedevere-bot bedevere-bot mentioned this pull request Apr 30, 2023
Closed
@JelleZijlstra JelleZijlstra added the needs backport to 3.11 only security fixes label Apr 30, 2023
@chgnrdv

chgnrdv commented Apr 30, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Shouldn't get_args and get_origin docs be swapped? Also get_args doc uses "objects" to denote unsupported typing objects, but in get_origin doc I wrote "types". Is it critical?

@JelleZijlstra

JelleZijlstra commented Apr 30, 2023

Copy link
Copy Markdown
Member

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

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

chgnrdv added 2 commits April 30, 2023 18:23
@chgnrdv
Merge branch 'typing-separate-and-improve-get_args-get_origin-docs' o… …
e733947 
…f github.com:chgnrdv/cpython into typing-separate-and-improve-get_args-get_origin-docs
@chgnrdv
swapped get_args and get_origin docs, changed "objects" to "types… …
d53b595 
…" in `get_origin` doc
@JelleZijlstra JelleZijlstra merged commit a7a2dbb into python:main May 10, 2023
@miss-islington

miss-islington commented May 10, 2023

Copy link
Copy Markdown
Contributor

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 10, 2023
@chgnrdv @JelleZijlstra @miss-islington
pythongh-104010: Separate and improve docs for typing.get_origin an… …
8555c1a 
…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 commit a7a2dbb)

Co-authored-by: chgnrdv <52372310+chgnrdv@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
@bedevere-bot

bedevere-bot commented May 10, 2023

Copy link
Copy Markdown

GH-104359 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label May 10, 2023
JelleZijlstra added a commit that referenced this pull request May 10, 2023
@miss-islington @chgnrdv @JelleZijlstra
[3.11] gh-104010: Separate and improve docs for typing.get_origin a… …
a8e902d 
…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 commit a7a2dbb)

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 request May 10, 2023
@carljm
Merge branch 'main' into fixloadsuperspec …
5976df9 
* 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 after pythongh-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 request May 11, 2023
@carljm
Merge branch 'main' into supermon …
19b3d9e 
* 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 after pythongh-104197 (python#104354)
  pythongh-101819: Harden _io init (python#104352)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@JelleZijlstra JelleZijlstra JelleZijlstra approved these changes

@gvanrossum gvanrossum Awaiting requested review from gvanrossum

@Fidget-Spinner Fidget-Spinner Awaiting requested review from Fidget-Spinner

@AlexWaygood AlexWaygood Awaiting requested review from AlexWaygood AlexWaygood is a code owner

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news topic-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