]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.14] gh-141004: Document `PyClassMethod*` and `PyStaticMethod*` APIs (GH-141296...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Sun, 9 Nov 2025 18:09:39 +0000 (19:09 +0100)
committerGitHub <noreply@github.com>
Sun, 9 Nov 2025 18:09:39 +0000 (18:09 +0000)
gh-141004: Document `PyClassMethod*` and `PyStaticMethod*` APIs (GH-141296)
(cherry picked from commit 807db68ddd8572cfa825373bc13461b02691f4d9)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Doc/c-api/descriptor.rst

index ff0df575279d9642d13482f3e2a5bd8359bce16b..9a4093a7708a7c3b02eeca2f1c515be1ade9549d 100644 (file)
@@ -38,3 +38,39 @@ found in the dictionary of type objects.
 
 
 .. c:function:: PyObject* PyWrapper_New(PyObject *, PyObject *)
+
+
+Built-in descriptors
+^^^^^^^^^^^^^^^^^^^^
+
+.. c:var:: PyTypeObject PyClassMethod_Type
+
+   The type of class method objects. This is the same object as
+   :class:`classmethod` in the Python layer.
+
+
+.. c:function:: PyObject *PyClassMethod_New(PyObject *callable)
+
+   Create a new :class:`classmethod` object wrapping *callable*.
+   *callable* must be a callable object and must not be ``NULL``.
+
+   On success, this function returns a :term:`strong reference` to a new class
+   method descriptor. On failure, this function returns ``NULL`` with an
+   exception set.
+
+
+.. c:var:: PyTypeObject PyStaticMethod_Type
+
+   The type of static method objects. This is the same object as
+   :class:`staticmethod` in the Python layer.
+
+
+.. c:function:: PyObject *PyStaticMethod_New(PyObject *callable)
+
+   Create a new :class:`staticmethod` object wrapping *callable*.
+   *callable* must be a callable object and must not be ``NULL``.
+
+   On success, this function returns a :term:`strong reference` to a new static
+   method descriptor. On failure, this function returns ``NULL`` with an
+   exception set.
+