Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32k
gh-99767: update PyTypeObject docs for type watchers#99928
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
Uh oh!
There was an error while loading.Please reload this page.
Conversation
| @@ -2090,6 +2092,15 @@ and :c:type:`PyType_Type` effectively act as defaults.) | |||
| .. versionadded:: 3.9 (the field exists since 3.8 but it's only used since 3.9) | |||
| .. c:member:: char PyTypeObject.tp_watched | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I would rather the docs say "Internal. Do not use."
TBH, I would like the whole of the type struct to be "do not use", but let's not make things any worse.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Are you wanting the existing text removed and replaced so it saysonly "Internal, do not use"? Or do you want to add "Internal, do not use" but also keep the description of what it is?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Pushed a version that removes the existing text, but I can easily re-add it.
* main: (103 commits)pythongh-100248: Add missing `ssl_shutdown_timeout` parameter in `asyncio` docs (python#100249) Assorted minor fixes for specialization stats. (pythonGH-100219)pythongh-100176: venv: Remove redundant compat code for Python <= 3.2 (python#100177)pythonGH-100222: Redefine _Py_CODEUNIT as a union to clarify structure of code unit. (pythonGH-100223)pythongh-99955: undef ERROR and SUCCESS before redefining (fixes sanitizer warning) (python#100215)pythonGH-100206: use versionadded for the addition of sysconfig.get_default_scheme (python#100207)pythongh-81057: Move _Py_RefTotal to the "Ignored Globals" List (pythongh-100203)pythongh-81057: Move Signal-Related Globals to _PyRuntimeState (pythongh-100085)pythongh-81057: Move faulthandler Globals to _PyRuntimeState (pythongh-100152)pythongh-81057: Move tracemalloc Globals to _PyRuntimeState (pythongh-100151)pythonGH-100143: Improve collecting pystats for parts of runs (pythonGH-100144)pythongh-99955: standardize return values of functions in compiler's code-gen (python#100010)pythongh-79218: Define `MS_WIN64` macro for Mingw-w64 64bit on Windows (pythonGH-100137) Fix: typo (Indention) (pythonGH-99904)pythongh-96715 Remove redundant NULL check in `profile_trampoline` function (python#96716)pythongh-100176: remove incorrect version compatibility check from argument clinic (python#100190) clarify the 4300-digit limit on int-str conversion (python#100175)pythongh-70393: Clarify mention of "middle" scope (python#98839)pythongh-99688: Fix outdated tests in test_unary (python#99712)pythongh-100174: [Enum] Correct PowersOfThree example. (pythonGH-100178) ...
netlifybot commentedDec 14, 2022 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
✅ Deploy Preview forpython-cpython-preview ready!
To edit notification comments on pull requests, go to yourNetlify site settings. |
That looks good. Better to document it as "do not use", than have folks try to figure out how to (mis)use it. |
| @@ -147,6 +147,8 @@ Quick Reference | |||
| +------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+ | |||
| | :c:member:`~PyTypeObject.tp_vectorcall` | :c:type:`vectorcallfunc` | | | | | | | |||
| +------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+ | |||
| | :c:member:`~PyTypeObject.tp_watched` | char | | | | | | | |||
| +------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+ | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
If this slot is internal, it should be in square brackets liketp_version_tag
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Thanks, sorry I missed this. Added in#100271
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Thanks
* main: Improve stats presentation for calls. (pythonGH-100274) Better stats for `LOAD_ATTR` and `STORE_ATTR` (pythonGH-100295)pythongh-81057: Move the Cached Parser Dummy Name to _PyRuntimeState (python#100277) Document that zipfile's pwd parameter is a `bytes` object (python#100209)pythongh-99767: mark `PyTypeObject.tp_watched` as internal use only in table (python#100271) Fix typo in introduction.rst (python#100266)pythongh-78997: AttributeError if loading fails in LibraryLoader.__getattr__pythonGH-100234: Set a default value for random.expovariate() (pythonGH-100235) Remove uninformative itertools recipe (pythonGH-100253)pythonGH-99767: update PyTypeObject docs for type watchers (pythonGH-99928) Move stats for the method cache into the `Py_STAT` machinery (pythonGH-100255)pythonGH-100222: fix typo _py_set_opocde -> _py_set_opcode (pythonGH-100259)pythonGH-100000: Cleanup and polish various watchers code (pythonGH-99998)pythongh-90111: Minor Cleanup for Runtime-Global Objects (pythongh-100254)
Uh oh!
There was an error while loading.Please reload this page.