Mailman 3 May 2021 - Python-checkins

bpo-42085: [docs] Add versionadded for am_send in type object documentation (GH-25465)
by iritkatriel May 29, 2021

May 29, 2021

https://github.com/python/cpython/commit/0b11c429c7f1721d9ffb9ae19e3e8e2e7b… commit: 0b11c429c7f1721d9ffb9ae19e3e8e2e7bd6444d branch: main author: Martmists <mail(a)martmists.com> committer: iritkatriel <1055913+iritkatriel(a)users.noreply.github.com> date: 2021-05-29T21:30:27+01:00 summary: bpo-42085: [docs] Add versionadded for am_send in type object documentation (GH-25465) files: M Doc/c-api/typeobj.rst diff --git a/Doc/c-api/typeobj.rst b/Doc/c-api/typeobj.rst index 82f2ab5345116..ea811158fa873 100644 --- a/Doc/c-api/typeobj.rst +++ b/Doc/c-api/typeobj.rst @@ -2453,6 +2453,8 @@ Async Object Structures See :c:func:`PyIter_Send` for details. This slot may be set to ``NULL``. + .. versionadded:: 3.10 + .. _slot-typedefs:

1 0

bpo-44263: Mention PyType_Ready in the gc protocol warning (GH-26445) (#26446)
by pablogsal May 29, 2021

May 29, 2021

https://github.com/python/cpython/commit/d8ce746e7c5193757c8d316105870b0dc5… commit: d8ce746e7c5193757c8d316105870b0dc5d6fa53 branch: 3.10 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: pablogsal <Pablogsal(a)gmail.com> date: 2021-05-29T18:49:16+01:00 summary: bpo-44263: Mention PyType_Ready in the gc protocol warning (GH-26445) (#26446) (cherry picked from commit 43cf7c864a2941b3f8f823e5928721dd286b7778) Co-authored-by: Pablo Galindo <Pablogsal(a)gmail.com> Co-authored-by: Pablo Galindo <Pablogsal(a)gmail.com> files: M Doc/c-api/gcsupport.rst M Doc/c-api/type.rst diff --git a/Doc/c-api/gcsupport.rst b/Doc/c-api/gcsupport.rst index 338365b6657ef..4bd2fb3837a1a 100644 --- a/Doc/c-api/gcsupport.rst +++ b/Doc/c-api/gcsupport.rst @@ -38,8 +38,9 @@ Constructors for container types must conform to two rules: a :c:member:`~PyTypeObject.tp_traverse` handler or explicitly use one from its subclass or subclasses. - Some APIs like :c:func:`PyType_FromSpecWithBases` or - :c:func:`PyType_FromSpec` will automatically populate the + When calling :c:func:`PyType_Ready` or some of the APIs that indirectly + call it like :c:func:`PyType_FromSpecWithBases` or + :c:func:`PyType_FromSpec` the interpreter will automatically populate the :c:member:`~PyTypeObject.tp_flags`, :c:member:`~PyTypeObject.tp_traverse` and :c:member:`~PyTypeObject.tp_clear` fields if the type inherits from a class that implements the garbage collector protocol and the child class diff --git a/Doc/c-api/type.rst b/Doc/c-api/type.rst index 9d24f39803f21..7a677593d073d 100644 --- a/Doc/c-api/type.rst +++ b/Doc/c-api/type.rst @@ -97,6 +97,15 @@ Type Objects from a type's base class. Return ``0`` on success, or return ``-1`` and sets an exception on error. + .. note:: + If some of the base classes implements the GC protocol and the provided + type does not include the :const:`Py_TPFLAGS_HAVE_GC` in its flags, then + the GC protocol will be automatically implemented from its parents. On + the contrary, if the type being created does include + :const:`Py_TPFLAGS_HAVE_GC` in its flags then it **must** implement the + GC protocol itself by at least implementing the + :c:member:`~PyTypeObject.tp_traverse` handle. + .. c:function:: void* PyType_GetSlot(PyTypeObject *type, int slot) Return the function pointer stored in the given slot. If the @@ -169,13 +178,6 @@ The following functions and structs are used to create The associated module is not inherited by subclasses; it must be specified for each class individually. - If some of the bases in *bases* implements the GC protocol and the type being - created does not include the :const:`Py_TPFLAGS_HAVE_GC` in the flags included in - *spec*, then the GC protocol will be automatically implemented from its parents. On - the contrary, if the type being created does include :const:`Py_TPFLAGS_HAVE_GC` in - its flags then it *must* implement the GC protocol itself by at least including a slot - for :c:member:`~PyTypeObject.tp_traverse` in *spec*. - This function calls :c:func:`PyType_Ready` on the new type. .. versionadded:: 3.9

1 0

bpo-44254: On Mac, remove disfunctional colors from turtledemo buttons (GH-26448)
by terryjreedy May 29, 2021

May 29, 2021

https://github.com/python/cpython/commit/9bcb76c24f6d3f01e596a439c1521f9099… commit: 9bcb76c24f6d3f01e596a439c1521f9099e3fe80 branch: 3.9 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: terryjreedy <tjreedy(a)udel.edu> date: 2021-05-29T04:16:34-04:00 summary: bpo-44254: On Mac, remove disfunctional colors from turtledemo buttons (GH-26448) On macOS, tk defers to system setting for button background when in normal state. Give turtledemo button text a color that works on either light or dark background. (cherry picked from commit af5a324843de395cecc562cb0c757b3768f2077f) Co-authored-by: Terry Jan Reedy <tjreedy(a)udel.edu> files: A Misc/NEWS.d/next/Library/2021-05-29-01-05-43.bpo-44254.f06xDm.rst M Lib/turtledemo/__main__.py diff --git a/Lib/turtledemo/__main__.py b/Lib/turtledemo/__main__.py index 12be5098dad274..caea022da4a688 100755 --- a/Lib/turtledemo/__main__.py +++ b/Lib/turtledemo/__main__.py @@ -124,7 +124,6 @@ def getExampleEntries(): ) - class DemoWindow(object): def __init__(self, filename=None): @@ -171,15 +170,23 @@ def __init__(self, filename=None): self.output_lbl = Label(root, height= 1, text=" --- ", bg="#ddf", font=("Arial", 16, 'normal'), borderwidth=2, relief=RIDGE) - self.start_btn = Button(root, text=" START ", font=btnfont, - fg="white", disabledforeground = "#fed", - command=self.startDemo) - self.stop_btn = Button(root, text=" STOP ", font=btnfont, - fg="white", disabledforeground = "#fed", - command=self.stopIt) - self.clear_btn = Button(root, text=" CLEAR ", font=btnfont, - fg="white", disabledforeground="#fed", - command = self.clearCanvas) + if darwin: # Leave Mac button colors alone - #44254. + self.start_btn = Button(root, text=" START ", font=btnfont, + fg='#00cc22', command=self.startDemo) + self.stop_btn = Button(root, text=" STOP ", font=btnfont, + fg='#00cc22', command=self.stopIt) + self.clear_btn = Button(root, text=" CLEAR ", font=btnfont, + fg='#00cc22', command = self.clearCanvas) + else: + self.start_btn = Button(root, text=" START ", font=btnfont, + fg="white", disabledforeground = "#fed", + command=self.startDemo) + self.stop_btn = Button(root, text=" STOP ", font=btnfont, + fg="white", disabledforeground = "#fed", + command=self.stopIt) + self.clear_btn = Button(root, text=" CLEAR ", font=btnfont, + fg="white", disabledforeground="#fed", + command = self.clearCanvas) self.output_lbl.grid(row=1, column=0, sticky='news', padx=(0,5)) self.start_btn.grid(row=1, column=1, sticky='ew') self.stop_btn.grid(row=1, column=2, sticky='ew') @@ -267,12 +274,17 @@ def update_mousewheel(self, event): return self.increase_size() def configGUI(self, start, stop, clear, txt="", color="blue"): - self.start_btn.config(state=start, - bg="#d00" if start == NORMAL else "#fca") - self.stop_btn.config(state=stop, - bg="#d00" if stop == NORMAL else "#fca") - self.clear_btn.config(state=clear, - bg="#d00" if clear == NORMAL else "#fca") + if darwin: # Leave Mac button colors alone - #44254. + self.start_btn.config(state=start) + self.stop_btn.config(state=stop) + self.clear_btn.config(state=clear) + else: + self.start_btn.config(state=start, + bg="#d00" if start == NORMAL else "#fca") + self.stop_btn.config(state=stop, + bg="#d00" if stop == NORMAL else "#fca") + self.clear_btn.config(state=clear, + bg="#d00" if clear == NORMAL else "#fca") self.output_lbl.config(text=txt, fg=color) def makeLoadDemoMenu(self, master): diff --git a/Misc/NEWS.d/next/Library/2021-05-29-01-05-43.bpo-44254.f06xDm.rst b/Misc/NEWS.d/next/Library/2021-05-29-01-05-43.bpo-44254.f06xDm.rst new file mode 100644 index 00000000000000..7438d5ce044b87 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2021-05-29-01-05-43.bpo-44254.f06xDm.rst @@ -0,0 +1,2 @@ +On Mac, give turtledemo button text a color that works on both light +or dark background. Programmers cannot control the latter.

1 0

bpo-44254: On Mac, remove disfunctional colors from turtledemo buttons (GH-26448)
by terryjreedy May 29, 2021

May 29, 2021

https://github.com/python/cpython/commit/addd32986f703e692463828ac0014023a9… commit: addd32986f703e692463828ac0014023a901010f branch: 3.10 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: terryjreedy <tjreedy(a)udel.edu> date: 2021-05-29T03:34:57-04:00 summary: bpo-44254: On Mac, remove disfunctional colors from turtledemo buttons (GH-26448) On macOS, tk defers to system setting for button background when in normal state. Give turtledemo button text a color that works on either light or dark background. (cherry picked from commit af5a324843de395cecc562cb0c757b3768f2077f) Co-authored-by: Terry Jan Reedy <tjreedy(a)udel.edu> files: A Misc/NEWS.d/next/Library/2021-05-29-01-05-43.bpo-44254.f06xDm.rst M Lib/turtledemo/__main__.py diff --git a/Lib/turtledemo/__main__.py b/Lib/turtledemo/__main__.py index 12be5098dad274..caea022da4a688 100755 --- a/Lib/turtledemo/__main__.py +++ b/Lib/turtledemo/__main__.py @@ -124,7 +124,6 @@ def getExampleEntries(): ) - class DemoWindow(object): def __init__(self, filename=None): @@ -171,15 +170,23 @@ def __init__(self, filename=None): self.output_lbl = Label(root, height= 1, text=" --- ", bg="#ddf", font=("Arial", 16, 'normal'), borderwidth=2, relief=RIDGE) - self.start_btn = Button(root, text=" START ", font=btnfont, - fg="white", disabledforeground = "#fed", - command=self.startDemo) - self.stop_btn = Button(root, text=" STOP ", font=btnfont, - fg="white", disabledforeground = "#fed", - command=self.stopIt) - self.clear_btn = Button(root, text=" CLEAR ", font=btnfont, - fg="white", disabledforeground="#fed", - command = self.clearCanvas) + if darwin: # Leave Mac button colors alone - #44254. + self.start_btn = Button(root, text=" START ", font=btnfont, + fg='#00cc22', command=self.startDemo) + self.stop_btn = Button(root, text=" STOP ", font=btnfont, + fg='#00cc22', command=self.stopIt) + self.clear_btn = Button(root, text=" CLEAR ", font=btnfont, + fg='#00cc22', command = self.clearCanvas) + else: + self.start_btn = Button(root, text=" START ", font=btnfont, + fg="white", disabledforeground = "#fed", + command=self.startDemo) + self.stop_btn = Button(root, text=" STOP ", font=btnfont, + fg="white", disabledforeground = "#fed", + command=self.stopIt) + self.clear_btn = Button(root, text=" CLEAR ", font=btnfont, + fg="white", disabledforeground="#fed", + command = self.clearCanvas) self.output_lbl.grid(row=1, column=0, sticky='news', padx=(0,5)) self.start_btn.grid(row=1, column=1, sticky='ew') self.stop_btn.grid(row=1, column=2, sticky='ew') @@ -267,12 +274,17 @@ def update_mousewheel(self, event): return self.increase_size() def configGUI(self, start, stop, clear, txt="", color="blue"): - self.start_btn.config(state=start, - bg="#d00" if start == NORMAL else "#fca") - self.stop_btn.config(state=stop, - bg="#d00" if stop == NORMAL else "#fca") - self.clear_btn.config(state=clear, - bg="#d00" if clear == NORMAL else "#fca") + if darwin: # Leave Mac button colors alone - #44254. + self.start_btn.config(state=start) + self.stop_btn.config(state=stop) + self.clear_btn.config(state=clear) + else: + self.start_btn.config(state=start, + bg="#d00" if start == NORMAL else "#fca") + self.stop_btn.config(state=stop, + bg="#d00" if stop == NORMAL else "#fca") + self.clear_btn.config(state=clear, + bg="#d00" if clear == NORMAL else "#fca") self.output_lbl.config(text=txt, fg=color) def makeLoadDemoMenu(self, master): diff --git a/Misc/NEWS.d/next/Library/2021-05-29-01-05-43.bpo-44254.f06xDm.rst b/Misc/NEWS.d/next/Library/2021-05-29-01-05-43.bpo-44254.f06xDm.rst new file mode 100644 index 00000000000000..7438d5ce044b87 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2021-05-29-01-05-43.bpo-44254.f06xDm.rst @@ -0,0 +1,2 @@ +On Mac, give turtledemo button text a color that works on both light +or dark background. Programmers cannot control the latter.

1 0

bpo-44254: On Mac, remove disfunctional colors from turtledemo buttons (GH-26448)
by terryjreedy May 29, 2021

May 29, 2021

https://github.com/python/cpython/commit/af5a324843de395cecc562cb0c757b3768… commit: af5a324843de395cecc562cb0c757b3768f2077f branch: main author: Terry Jan Reedy <tjreedy(a)udel.edu> committer: terryjreedy <tjreedy(a)udel.edu> date: 2021-05-29T03:19:50-04:00 summary: bpo-44254: On Mac, remove disfunctional colors from turtledemo buttons (GH-26448) On macOS, tk defers to system setting for button background when in normal state. Give turtledemo button text a color that works on either light or dark background. files: A Misc/NEWS.d/next/Library/2021-05-29-01-05-43.bpo-44254.f06xDm.rst M Lib/turtledemo/__main__.py diff --git a/Lib/turtledemo/__main__.py b/Lib/turtledemo/__main__.py index 12be5098dad274..caea022da4a688 100755 --- a/Lib/turtledemo/__main__.py +++ b/Lib/turtledemo/__main__.py @@ -124,7 +124,6 @@ def getExampleEntries(): ) - class DemoWindow(object): def __init__(self, filename=None): @@ -171,15 +170,23 @@ def __init__(self, filename=None): self.output_lbl = Label(root, height= 1, text=" --- ", bg="#ddf", font=("Arial", 16, 'normal'), borderwidth=2, relief=RIDGE) - self.start_btn = Button(root, text=" START ", font=btnfont, - fg="white", disabledforeground = "#fed", - command=self.startDemo) - self.stop_btn = Button(root, text=" STOP ", font=btnfont, - fg="white", disabledforeground = "#fed", - command=self.stopIt) - self.clear_btn = Button(root, text=" CLEAR ", font=btnfont, - fg="white", disabledforeground="#fed", - command = self.clearCanvas) + if darwin: # Leave Mac button colors alone - #44254. + self.start_btn = Button(root, text=" START ", font=btnfont, + fg='#00cc22', command=self.startDemo) + self.stop_btn = Button(root, text=" STOP ", font=btnfont, + fg='#00cc22', command=self.stopIt) + self.clear_btn = Button(root, text=" CLEAR ", font=btnfont, + fg='#00cc22', command = self.clearCanvas) + else: + self.start_btn = Button(root, text=" START ", font=btnfont, + fg="white", disabledforeground = "#fed", + command=self.startDemo) + self.stop_btn = Button(root, text=" STOP ", font=btnfont, + fg="white", disabledforeground = "#fed", + command=self.stopIt) + self.clear_btn = Button(root, text=" CLEAR ", font=btnfont, + fg="white", disabledforeground="#fed", + command = self.clearCanvas) self.output_lbl.grid(row=1, column=0, sticky='news', padx=(0,5)) self.start_btn.grid(row=1, column=1, sticky='ew') self.stop_btn.grid(row=1, column=2, sticky='ew') @@ -267,12 +274,17 @@ def update_mousewheel(self, event): return self.increase_size() def configGUI(self, start, stop, clear, txt="", color="blue"): - self.start_btn.config(state=start, - bg="#d00" if start == NORMAL else "#fca") - self.stop_btn.config(state=stop, - bg="#d00" if stop == NORMAL else "#fca") - self.clear_btn.config(state=clear, - bg="#d00" if clear == NORMAL else "#fca") + if darwin: # Leave Mac button colors alone - #44254. + self.start_btn.config(state=start) + self.stop_btn.config(state=stop) + self.clear_btn.config(state=clear) + else: + self.start_btn.config(state=start, + bg="#d00" if start == NORMAL else "#fca") + self.stop_btn.config(state=stop, + bg="#d00" if stop == NORMAL else "#fca") + self.clear_btn.config(state=clear, + bg="#d00" if clear == NORMAL else "#fca") self.output_lbl.config(text=txt, fg=color) def makeLoadDemoMenu(self, master): diff --git a/Misc/NEWS.d/next/Library/2021-05-29-01-05-43.bpo-44254.f06xDm.rst b/Misc/NEWS.d/next/Library/2021-05-29-01-05-43.bpo-44254.f06xDm.rst new file mode 100644 index 00000000000000..7438d5ce044b87 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2021-05-29-01-05-43.bpo-44254.f06xDm.rst @@ -0,0 +1,2 @@ +On Mac, give turtledemo button text a color that works on both light +or dark background. Programmers cannot control the latter.

1 0

bpo-44263: Mention PyType_Ready in the gc protocol warning (GH-26445)
by miss-islington May 29, 2021

May 29, 2021

https://github.com/python/cpython/commit/7bd1304d49a110700b3f079e4b2dd1052a… commit: 7bd1304d49a110700b3f079e4b2dd1052a23bde4 branch: 3.9 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: miss-islington <31488909+miss-islington(a)users.noreply.github.com> date: 2021-05-28T20:53:40-07:00 summary: bpo-44263: Mention PyType_Ready in the gc protocol warning (GH-26445) (cherry picked from commit 43cf7c864a2941b3f8f823e5928721dd286b7778) Co-authored-by: Pablo Galindo <Pablogsal(a)gmail.com> files: M Doc/c-api/gcsupport.rst M Doc/c-api/type.rst diff --git a/Doc/c-api/gcsupport.rst b/Doc/c-api/gcsupport.rst index 76f9ab53b4f31..f821b45090c47 100644 --- a/Doc/c-api/gcsupport.rst +++ b/Doc/c-api/gcsupport.rst @@ -38,8 +38,9 @@ Constructors for container types must conform to two rules: a :c:member:`~PyTypeObject.tp_traverse` handler or explicitly use one from its subclass or subclasses. - Some APIs like :c:func:`PyType_FromSpecWithBases` or - :c:func:`PyType_FromSpec` will automatically populate the + When calling :c:func:`PyType_Ready` or some of the APIs that indirectly + call it like :c:func:`PyType_FromSpecWithBases` or + :c:func:`PyType_FromSpec` the interpreter will automatically populate the :c:member:`~PyTypeObject.tp_flags`, :c:member:`~PyTypeObject.tp_traverse` and :c:member:`~PyTypeObject.tp_clear` fields if the type inherits from a class that implements the garbage collector protocol and the child class diff --git a/Doc/c-api/type.rst b/Doc/c-api/type.rst index d694b8caf1799..d7f4bd67def13 100644 --- a/Doc/c-api/type.rst +++ b/Doc/c-api/type.rst @@ -97,6 +97,15 @@ Type Objects from a type's base class. Return ``0`` on success, or return ``-1`` and sets an exception on error. + .. note:: + If some of the base classes implements the GC protocol and the provided + type does not include the :const:`Py_TPFLAGS_HAVE_GC` in its flags, then + the GC protocol will be automatically implemented from its parents. On + the contrary, if the type being created does include + :const:`Py_TPFLAGS_HAVE_GC` in its flags then it **must** implement the + GC protocol itself by at least implementing the + :c:member:`~PyTypeObject.tp_traverse` handle. + .. c:function:: void* PyType_GetSlot(PyTypeObject *type, int slot) Return the function pointer stored in the given slot. If the @@ -168,13 +177,6 @@ The following functions and structs are used to create The associated module is not inherited by subclasses; it must be specified for each class individually. - If some of the bases in *bases* implements the GC protocol and the type being - created does not include the :const:`Py_TPFLAGS_HAVE_GC` in the flags included in - *spec*, then the GC protocol will be automatically implemented from its parents. On - the contrary, if the type being created does include :const:`Py_TPFLAGS_HAVE_GC` in - its flags then it *must* implement the GC protocol itself by at least including a slot - for :c:member:`~PyTypeObject.tp_traverse` in *spec*. - This function calls :c:func:`PyType_Ready` on the new type. .. versionadded:: 3.9

1 0

bpo-44263: Mention PyType_Ready in the gc protocol warning (GH-26445)
by pablogsal May 29, 2021

May 29, 2021

https://github.com/python/cpython/commit/43cf7c864a2941b3f8f823e5928721dd28… commit: 43cf7c864a2941b3f8f823e5928721dd286b7778 branch: main author: Pablo Galindo <Pablogsal(a)gmail.com> committer: pablogsal <Pablogsal(a)gmail.com> date: 2021-05-29T04:32:42+01:00 summary: bpo-44263: Mention PyType_Ready in the gc protocol warning (GH-26445) files: M Doc/c-api/gcsupport.rst M Doc/c-api/type.rst diff --git a/Doc/c-api/gcsupport.rst b/Doc/c-api/gcsupport.rst index 338365b6657ef..4bd2fb3837a1a 100644 --- a/Doc/c-api/gcsupport.rst +++ b/Doc/c-api/gcsupport.rst @@ -38,8 +38,9 @@ Constructors for container types must conform to two rules: a :c:member:`~PyTypeObject.tp_traverse` handler or explicitly use one from its subclass or subclasses. - Some APIs like :c:func:`PyType_FromSpecWithBases` or - :c:func:`PyType_FromSpec` will automatically populate the + When calling :c:func:`PyType_Ready` or some of the APIs that indirectly + call it like :c:func:`PyType_FromSpecWithBases` or + :c:func:`PyType_FromSpec` the interpreter will automatically populate the :c:member:`~PyTypeObject.tp_flags`, :c:member:`~PyTypeObject.tp_traverse` and :c:member:`~PyTypeObject.tp_clear` fields if the type inherits from a class that implements the garbage collector protocol and the child class diff --git a/Doc/c-api/type.rst b/Doc/c-api/type.rst index 9d24f39803f21..7a677593d073d 100644 --- a/Doc/c-api/type.rst +++ b/Doc/c-api/type.rst @@ -97,6 +97,15 @@ Type Objects from a type's base class. Return ``0`` on success, or return ``-1`` and sets an exception on error. + .. note:: + If some of the base classes implements the GC protocol and the provided + type does not include the :const:`Py_TPFLAGS_HAVE_GC` in its flags, then + the GC protocol will be automatically implemented from its parents. On + the contrary, if the type being created does include + :const:`Py_TPFLAGS_HAVE_GC` in its flags then it **must** implement the + GC protocol itself by at least implementing the + :c:member:`~PyTypeObject.tp_traverse` handle. + .. c:function:: void* PyType_GetSlot(PyTypeObject *type, int slot) Return the function pointer stored in the given slot. If the @@ -169,13 +178,6 @@ The following functions and structs are used to create The associated module is not inherited by subclasses; it must be specified for each class individually. - If some of the bases in *bases* implements the GC protocol and the type being - created does not include the :const:`Py_TPFLAGS_HAVE_GC` in the flags included in - *spec*, then the GC protocol will be automatically implemented from its parents. On - the contrary, if the type being created does include :const:`Py_TPFLAGS_HAVE_GC` in - its flags then it *must* implement the GC protocol itself by at least including a slot - for :c:member:`~PyTypeObject.tp_traverse` in *spec*. - This function calls :c:func:`PyType_Ready` on the new type. .. versionadded:: 3.9

1 0

bpo-44263: Better explain the GC contract for PyType_FromSpecWithBases (GH-26442) (GH-26443)
by pablogsal May 29, 2021

May 29, 2021

https://github.com/python/cpython/commit/11049bece15b6fa08fa6d74aea8eb6bc2e… commit: 11049bece15b6fa08fa6d74aea8eb6bc2ebadfe5 branch: 3.10 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: pablogsal <Pablogsal(a)gmail.com> date: 2021-05-29T04:21:26+01:00 summary: bpo-44263: Better explain the GC contract for PyType_FromSpecWithBases (GH-26442) (GH-26443) (cherry picked from commit 8b55bc3f93a655bc803bff79725d5fe3f124e2f0) Co-authored-by: Pablo Galindo <Pablogsal(a)gmail.com> Co-authored-by: Pablo Galindo <Pablogsal(a)gmail.com> files: M Doc/c-api/gcsupport.rst M Doc/c-api/type.rst diff --git a/Doc/c-api/gcsupport.rst b/Doc/c-api/gcsupport.rst index 55ed9d4f7fad48..338365b6657efe 100644 --- a/Doc/c-api/gcsupport.rst +++ b/Doc/c-api/gcsupport.rst @@ -33,6 +33,17 @@ Constructors for container types must conform to two rules: #. Once all the fields which may contain references to other containers are initialized, it must call :c:func:`PyObject_GC_Track`. + .. warning:: + If a type adds the Py_TPFLAGS_HAVE_GC, then it *must* implement at least + a :c:member:`~PyTypeObject.tp_traverse` handler or explicitly use one + from its subclass or subclasses. + + Some APIs like :c:func:`PyType_FromSpecWithBases` or + :c:func:`PyType_FromSpec` will automatically populate the + :c:member:`~PyTypeObject.tp_flags`, :c:member:`~PyTypeObject.tp_traverse` + and :c:member:`~PyTypeObject.tp_clear` fields if the type inherits from a + class that implements the garbage collector protocol and the child class + does *not* include the :const:`Py_TPFLAGS_HAVE_GC` flag. .. c:function:: TYPE* PyObject_GC_New(TYPE, PyTypeObject *type) diff --git a/Doc/c-api/type.rst b/Doc/c-api/type.rst index bdb636dff326f2..9d24f39803f21d 100644 --- a/Doc/c-api/type.rst +++ b/Doc/c-api/type.rst @@ -169,6 +169,13 @@ The following functions and structs are used to create The associated module is not inherited by subclasses; it must be specified for each class individually. + If some of the bases in *bases* implements the GC protocol and the type being + created does not include the :const:`Py_TPFLAGS_HAVE_GC` in the flags included in + *spec*, then the GC protocol will be automatically implemented from its parents. On + the contrary, if the type being created does include :const:`Py_TPFLAGS_HAVE_GC` in + its flags then it *must* implement the GC protocol itself by at least including a slot + for :c:member:`~PyTypeObject.tp_traverse` in *spec*. + This function calls :c:func:`PyType_Ready` on the new type. .. versionadded:: 3.9

1 0

bpo-44263: Better explain the GC contract for PyType_FromSpecWithBases (GH-26442)
by miss-islington May 29, 2021

May 29, 2021

https://github.com/python/cpython/commit/a30cbaee84262cdd4597f3204861ccdd86… commit: a30cbaee84262cdd4597f3204861ccdd86bbf533 branch: 3.9 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: miss-islington <31488909+miss-islington(a)users.noreply.github.com> date: 2021-05-28T20:20:54-07:00 summary: bpo-44263: Better explain the GC contract for PyType_FromSpecWithBases (GH-26442) (cherry picked from commit 8b55bc3f93a655bc803bff79725d5fe3f124e2f0) Co-authored-by: Pablo Galindo <Pablogsal(a)gmail.com> files: M Doc/c-api/gcsupport.rst M Doc/c-api/type.rst diff --git a/Doc/c-api/gcsupport.rst b/Doc/c-api/gcsupport.rst index eee114c19d5904..76f9ab53b4f31a 100644 --- a/Doc/c-api/gcsupport.rst +++ b/Doc/c-api/gcsupport.rst @@ -33,6 +33,17 @@ Constructors for container types must conform to two rules: #. Once all the fields which may contain references to other containers are initialized, it must call :c:func:`PyObject_GC_Track`. + .. warning:: + If a type adds the Py_TPFLAGS_HAVE_GC, then it *must* implement at least + a :c:member:`~PyTypeObject.tp_traverse` handler or explicitly use one + from its subclass or subclasses. + + Some APIs like :c:func:`PyType_FromSpecWithBases` or + :c:func:`PyType_FromSpec` will automatically populate the + :c:member:`~PyTypeObject.tp_flags`, :c:member:`~PyTypeObject.tp_traverse` + and :c:member:`~PyTypeObject.tp_clear` fields if the type inherits from a + class that implements the garbage collector protocol and the child class + does *not* include the :const:`Py_TPFLAGS_HAVE_GC` flag. .. c:function:: TYPE* PyObject_GC_New(TYPE, PyTypeObject *type) diff --git a/Doc/c-api/type.rst b/Doc/c-api/type.rst index ee76f52289387f..d694b8caf17996 100644 --- a/Doc/c-api/type.rst +++ b/Doc/c-api/type.rst @@ -168,6 +168,13 @@ The following functions and structs are used to create The associated module is not inherited by subclasses; it must be specified for each class individually. + If some of the bases in *bases* implements the GC protocol and the type being + created does not include the :const:`Py_TPFLAGS_HAVE_GC` in the flags included in + *spec*, then the GC protocol will be automatically implemented from its parents. On + the contrary, if the type being created does include :const:`Py_TPFLAGS_HAVE_GC` in + its flags then it *must* implement the GC protocol itself by at least including a slot + for :c:member:`~PyTypeObject.tp_traverse` in *spec*. + This function calls :c:func:`PyType_Ready` on the new type. .. versionadded:: 3.9

1 0

bpo-44263: Better explain the GC contract for PyType_FromSpecWithBases (GH-26442)
by pablogsal May 29, 2021

May 29, 2021

https://github.com/python/cpython/commit/8b55bc3f93a655bc803bff79725d5fe3f1… commit: 8b55bc3f93a655bc803bff79725d5fe3f124e2f0 branch: main author: Pablo Galindo <Pablogsal(a)gmail.com> committer: pablogsal <Pablogsal(a)gmail.com> date: 2021-05-29T03:57:39+01:00 summary: bpo-44263: Better explain the GC contract for PyType_FromSpecWithBases (GH-26442) files: M Doc/c-api/gcsupport.rst M Doc/c-api/type.rst diff --git a/Doc/c-api/gcsupport.rst b/Doc/c-api/gcsupport.rst index 55ed9d4f7fad48..338365b6657efe 100644 --- a/Doc/c-api/gcsupport.rst +++ b/Doc/c-api/gcsupport.rst @@ -33,6 +33,17 @@ Constructors for container types must conform to two rules: #. Once all the fields which may contain references to other containers are initialized, it must call :c:func:`PyObject_GC_Track`. + .. warning:: + If a type adds the Py_TPFLAGS_HAVE_GC, then it *must* implement at least + a :c:member:`~PyTypeObject.tp_traverse` handler or explicitly use one + from its subclass or subclasses. + + Some APIs like :c:func:`PyType_FromSpecWithBases` or + :c:func:`PyType_FromSpec` will automatically populate the + :c:member:`~PyTypeObject.tp_flags`, :c:member:`~PyTypeObject.tp_traverse` + and :c:member:`~PyTypeObject.tp_clear` fields if the type inherits from a + class that implements the garbage collector protocol and the child class + does *not* include the :const:`Py_TPFLAGS_HAVE_GC` flag. .. c:function:: TYPE* PyObject_GC_New(TYPE, PyTypeObject *type) diff --git a/Doc/c-api/type.rst b/Doc/c-api/type.rst index bdb636dff326f2..9d24f39803f21d 100644 --- a/Doc/c-api/type.rst +++ b/Doc/c-api/type.rst @@ -169,6 +169,13 @@ The following functions and structs are used to create The associated module is not inherited by subclasses; it must be specified for each class individually. + If some of the bases in *bases* implements the GC protocol and the type being + created does not include the :const:`Py_TPFLAGS_HAVE_GC` in the flags included in + *spec*, then the GC protocol will be automatically implemented from its parents. On + the contrary, if the type being created does include :const:`Py_TPFLAGS_HAVE_GC` in + its flags then it *must* implement the GC protocol itself by at least including a slot + for :c:member:`~PyTypeObject.tp_traverse` in *spec*. + This function calls :c:func:`PyType_Ready` on the new type. .. versionadded:: 3.9

1 0