Skip to content
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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

DOC: tp_watch was added to PyTypeObject but is not documented #99767

Closed
mattip opened this issue Nov 25, 2022 · 3 comments
Closed

DOC: tp_watch was added to PyTypeObject but is not documented #99767

mattip opened this issue Nov 25, 2022 · 3 comments
Labels
docs Documentation in the Doc dir

Comments

@mattip
Copy link
Contributor

mattip commented Nov 25, 2022 •
edited by bedevere-bot
Loading

Documentation

PR #97875 extended the PyTypeObject structure with a new tp_watch field. It should be documented in the tp slots section, the PyTypeObject struct definition, and the PyTypeObject slots sections of typeobject.rst

Linked PRs
@mattip mattip added the docs Documentation in the Doc dir label Nov 25, 2022
@mattip
Copy link
Contributor Author

mattip commented Nov 25, 2022

xref @carljm as the author of #97875

@carljm
Copy link
Member

carljm commented Dec 1, 2022

Thanks! I'll work on a PR with these doc updates.

carljm added a commit to carljm/cpython that referenced this issue Dec 1, 2022
@carljm
pythongh-99767: update PyTypeObject docs for type watchers
970b03e
@bedevere-bot bedevere-bot mentioned this issue Dec 1, 2022
Merged
markshannon pushed a commit that referenced this issue Dec 15, 2022
@carljm
GH-99767: update PyTypeObject docs for type watchers (GH-99928)
b7e4f1d
@mattip
Copy link
Contributor Author

mattip commented Dec 15, 2022

Thanks. Documenting it makes it easier for things like cython to know what to do.

carljm added a commit to carljm/cpython that referenced this issue Dec 15, 2022
@carljm
pythongh-99767: mark PyTypeObject.tp_watched as internal use only in …
610d558 
…table
@bedevere-bot bedevere-bot mentioned this issue Dec 15, 2022
Merged
kumaraditya303 pushed a commit that referenced this issue Dec 16, 2022
@carljm
gh-99767: mark PyTypeObject.tp_watched as internal use only in table (
e00266f 
#100271)
carljm added a commit to carljm/cpython that referenced this issue Dec 16, 2022
@carljm
Merge branch 'main' into fastmock
2260a54 
* 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)
shihai1991 added a commit to shihai1991/cpython that referenced this issue Dec 18, 2022
@shihai1991
Merge remote-tracking branch 'origin/main' into bpo_34697
2878571 
* origin/main: (1306 commits)
  Correct CVE-2020-10735 documentation (python#100306)
  pythongh-100272: Fix JSON serialization of OrderedDict (pythonGH-100273)
  pythongh-93649: Split tracemalloc tests from _testcapimodule.c (python#99551)
  Docs: Use `PY_VERSION_HEX` for version comparison (python#100179)
  pythongh-97909: Fix markup for `PyMethodDef` members (python#100089)
  pythongh-99240: Reset pointer to NULL when the pointed memory is freed in argument parsing (python#99890)
  pythongh-99240: Reset pointer to NULL when the pointed memory is freed in argument parsing (python#99890)
  pythonGH-98831: Add DECREF_INPUTS(), expanding to DECREF() each stack input (python#100205)
  pythongh-78707: deprecate passing >1 argument to `PurePath.[is_]relative_to()` (pythonGH-94469)
  pythongh-99540: Constant hash for _PyNone_Type to aid reproducibility (pythonGH-99541)
  pythongh-100039: enhance __signature__ to work with str and callables (pythonGH-100168)
  pythongh-99830: asyncio: Document returns of remove_{reader,writer} (python#100302)
  "Compound statement" docs: Fix with-statement step indexing (python#100286)
  pythonGH-90043: Handle NaNs in COMPARE_OP_FLOAT_JUMP (pythonGH-100278)
  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)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@carljm @mattip @markshannon