bpo-4260: Document that ctypes.xFUNCTYPE are decorators #7924

andresdelfino · 2018-06-26T02:15:07Z

https://bugs.python.org/issue4260

berkerpeksag · 2018-07-11T11:48:41Z

Doc/library/ctypes.rst

@@ -1582,7 +1599,7 @@ type and the argument types of the function.

 .. function:: CFUNCTYPE(restype, *argtypes, use_errno=False, use_last_error=False)

-   The returned function prototype creates functions that use the standard C
+   Returns a function prototype which creates functions that use the standard C


Please don't make changes irrelevant to bpo-4260.

berkerpeksag · 2018-07-11T11:48:51Z

Doc/library/ctypes.rst

@@ -1592,7 +1609,7 @@ type and the argument types of the function.

 .. function:: WINFUNCTYPE(restype, *argtypes, use_errno=False, use_last_error=False)

-   Windows only: The returned function prototype creates functions that use the
+   Windows only: Returns a function prototype which creates functions that use the


Please don't make changes irrelevant to bpo-4260.

berkerpeksag · 2018-07-11T11:49:04Z

Doc/library/ctypes.rst

@@ -1601,9 +1618,12 @@ type and the argument types of the function.

 .. function:: PYFUNCTYPE(restype, *argtypes)

-   The returned function prototype creates functions that use the Python calling
+   Returns a function prototype which creates functions that use the Python calling


Please don't make changes irrelevant to bpo-4260.

berkerpeksag · 2018-07-11T11:53:54Z

Doc/library/ctypes.rst

   convention.  The function will *not* release the GIL during the call.

+These factory functions can be used as decorator factories, and as such, be applied


I think we can move this information to the first paragraph of the "Function prototypes" section to make it more discoverable.

Also, we can add a link to the examples from that paragraph.

berkerpeksag · 2018-07-11T12:03:42Z

Doc/library/ctypes.rst

+write::
+
+   >>> @CFUNCTYPE(c_int, POINTER(c_int), POINTER(c_int))
+   ... def py_cmp_func(*args):


Why didn't you reuse the py_cmp_func function in line 1008? IMO, the following snippet should work:

@CFUNCTYPE(c_int, POINTER(c_int), POINTER(c_int)) def py_cmp_func(a, b): print("py_cmp_func", a[0], b[0]) return a[0] - b[0]

There is even a test for that same function:

cpython/Lib/ctypes/test/test_callbacks.py

Lines 186 to 188 in b91a3a0

@CFUNCTYPE(c_int, POINTER(c_int), POINTER(c_int))

def cmp_func(a, b):

return a[0] - b[0]

I followed the proposal from David W. Lambert in the issue, but you are right, I tested the decorator with the function from line 1008 and works as well.

bedevere-bot · 2018-07-11T12:17:41Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

andresdelfino · 2018-07-11T12:54:54Z

I have made the requested changes; please review again 🐍🐍🐍

bedevere-bot · 2018-07-11T12:54:57Z

Thanks for making the requested changes!

@berkerpeksag: please review the changes made to this pull request.

berkerpeksag · 2018-07-11T12:58:57Z

Doc/library/ctypes.rst

+type and the argument types of the function, and can be used as decorator
+factories, and as such, be applied to functions through the ``@wrapper`` syntax.
+See :ref:`ctypes-callback-functions` for examples.
+


Style nit: We can drop this extra newline.

berkerpeksag · 2018-07-11T13:01:13Z

This looks pretty good to me, thank you! I will wait for a day or two to let others comment on the PR. Please ping me again if I don't merge this by Friday.

miss-islington · 2018-07-13T12:50:23Z

Thanks @andresdelfino for the PR, and @berkerpeksag for merging it 🌮🎉.. I'm working now to backport this PR to: 3.6, 3.7.
🐍🍒⛏🤖

berkerpeksag · 2018-07-13T12:50:45Z

@andresdelfino thanks!

bedevere-bot · 2018-07-13T12:50:48Z

GH-8272 is a backport of this pull request to the 3.7 branch.

(cherry picked from commit 379e9d6) Co-authored-by: Andrés Delfino <adelfino@gmail.com>

bedevere-bot · 2018-07-13T12:51:35Z

GH-8273 is a backport of this pull request to the 3.6 branch.

(cherry picked from commit 379e9d6) Co-authored-by: Andrés Delfino <adelfino@gmail.com>

* master: (2633 commits) bpo-34087: Fix buffer overflow in int(s) and similar functions (pythonGH-8274) bpo-34108: Fix double carriage return in 2to3 on Windows (python#8271) bpo-4260: Document that ctypes.xFUNCTYPE are decorators (pythonGH-7924) bpo-33723: Fix test_time.test_thread_time() (pythonGH-8267) bpo-33967: Remove use of deprecated assertRaisesRegexp() (pythonGH-8261) bpo-34080: Fix a memory leak in the compiler. (pythonGH-8222) Enable GUI testing on Travis Linux builds via Xvfb (pythonGH-7887) bpo-23927: Make getargs.c skipitem() skipping 'w*'. (pythonGH-8192) bpo-33648: Remove PY_WARN_ON_C_LOCALE (pythonGH-7114) bpo-34092, test_logging: increase SMTPHandlerTest timeout (pythonGH-8245) Simplify __all__ in multiprocessing (pythonGH-6856) bpo-34083: Update dict order in Functional HOWTO (pythonGH-8230) Doc: Point to Simple statements section instead of PEP (pythonGH-8238) bpo-29442: Replace optparse with argparse in setup.py (pythonGH-139) bpo-33597: Add What's New for PyGC_Head (pythonGH-8236) Dataclasses: Fix example on 30.6.8, add method should receive a list rather than an integer. (pythonGH-8038) Fix documentation for input and output tutorial (pythonGH-8231) bpo-34009: Expand on platform support changes (pythonGH-8022) Factor-out two substantially identical code blocks. (pythonGH-8219) bpo-34031: fix incorrect usage of self.fail in two tests (pythonGH-8091) ...

* master: (1159 commits) bpo-34087: Fix buffer overflow in int(s) and similar functions (pythonGH-8274) bpo-34108: Fix double carriage return in 2to3 on Windows (python#8271) bpo-4260: Document that ctypes.xFUNCTYPE are decorators (pythonGH-7924) bpo-33723: Fix test_time.test_thread_time() (pythonGH-8267) bpo-33967: Remove use of deprecated assertRaisesRegexp() (pythonGH-8261) bpo-34080: Fix a memory leak in the compiler. (pythonGH-8222) Enable GUI testing on Travis Linux builds via Xvfb (pythonGH-7887) bpo-23927: Make getargs.c skipitem() skipping 'w*'. (pythonGH-8192) bpo-33648: Remove PY_WARN_ON_C_LOCALE (pythonGH-7114) bpo-34092, test_logging: increase SMTPHandlerTest timeout (pythonGH-8245) Simplify __all__ in multiprocessing (pythonGH-6856) bpo-34083: Update dict order in Functional HOWTO (pythonGH-8230) Doc: Point to Simple statements section instead of PEP (pythonGH-8238) bpo-29442: Replace optparse with argparse in setup.py (pythonGH-139) bpo-33597: Add What's New for PyGC_Head (pythonGH-8236) Dataclasses: Fix example on 30.6.8, add method should receive a list rather than an integer. (pythonGH-8038) Fix documentation for input and output tutorial (pythonGH-8231) bpo-34009: Expand on platform support changes (pythonGH-8022) Factor-out two substantially identical code blocks. (pythonGH-8219) bpo-34031: fix incorrect usage of self.fail in two tests (pythonGH-8091) ...

…ssue-33014 * 'master' of github.com:CuriousLearner/cpython: (722 commits) bpo-34087: Fix buffer overflow in int(s) and similar functions (pythonGH-8274) bpo-34108: Fix double carriage return in 2to3 on Windows (python#8271) bpo-4260: Document that ctypes.xFUNCTYPE are decorators (pythonGH-7924) bpo-33723: Fix test_time.test_thread_time() (pythonGH-8267) bpo-33967: Remove use of deprecated assertRaisesRegexp() (pythonGH-8261) bpo-34080: Fix a memory leak in the compiler. (pythonGH-8222) Enable GUI testing on Travis Linux builds via Xvfb (pythonGH-7887) bpo-23927: Make getargs.c skipitem() skipping 'w*'. (pythonGH-8192) bpo-33648: Remove PY_WARN_ON_C_LOCALE (pythonGH-7114) bpo-34092, test_logging: increase SMTPHandlerTest timeout (pythonGH-8245) Simplify __all__ in multiprocessing (pythonGH-6856) bpo-34083: Update dict order in Functional HOWTO (pythonGH-8230) Doc: Point to Simple statements section instead of PEP (pythonGH-8238) bpo-29442: Replace optparse with argparse in setup.py (pythonGH-139) bpo-33597: Add What's New for PyGC_Head (pythonGH-8236) Dataclasses: Fix example on 30.6.8, add method should receive a list rather than an integer. (pythonGH-8038) Fix documentation for input and output tutorial (pythonGH-8231) bpo-34009: Expand on platform support changes (pythonGH-8022) Factor-out two substantially identical code blocks. (pythonGH-8219) bpo-34031: fix incorrect usage of self.fail in two tests (pythonGH-8091) ...

bpo-4260: Document that ctypes.xFUNCTYPE are decorators

c58c398

the-knights-who-say-ni added the CLA signed label Jun 26, 2018

bedevere-bot added the awaiting review label Jun 26, 2018

Fix indentation

9a35dce

berkerpeksag requested changes Jul 11, 2018

View reviewed changes

bedevere-bot added awaiting changes and removed awaiting review labels Jul 11, 2018

berkerpeksag added skip news needs backport to 3.7 labels Jul 11, 2018

Address Berker comments

4b297e9

bedevere-bot added awaiting change review and removed awaiting changes labels Jul 11, 2018

berkerpeksag approved these changes Jul 11, 2018

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting change review labels Jul 11, 2018

Remove extra newline

c0e6de1

berkerpeksag merged commit 379e9d6 into python:master Jul 13, 2018

bedevere-bot removed the awaiting merge label Jul 13, 2018

bedevere-bot removed the needs backport to 3.7 label Jul 13, 2018

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 13, 2018

bpo-4260: Document that ctypes.xFUNCTYPE are decorators (pythonGH-7924)

3a084af

(cherry picked from commit 379e9d6) Co-authored-by: Andrés Delfino <adelfino@gmail.com>

bedevere-bot removed the needs backport to 3.6 label Jul 13, 2018

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 13, 2018

bpo-4260: Document that ctypes.xFUNCTYPE are decorators (pythonGH-7924)

c032546

(cherry picked from commit 379e9d6) Co-authored-by: Andrés Delfino <adelfino@gmail.com>

andresdelfino deleted the ctypes.xFUNCTYPE branch July 13, 2018 13:29

miss-islington added a commit that referenced this pull request Jul 13, 2018

bpo-4260: Document that ctypes.xFUNCTYPE are decorators (GH-7924)

08c1da7

(cherry picked from commit 379e9d6) Co-authored-by: Andrés Delfino <adelfino@gmail.com>

miss-islington added a commit that referenced this pull request Jul 13, 2018

bpo-4260: Document that ctypes.xFUNCTYPE are decorators (GH-7924)

083a836

(cherry picked from commit 379e9d6) Co-authored-by: Andrés Delfino <adelfino@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

bpo-4260: Document that ctypes.xFUNCTYPE are decorators #7924

bpo-4260: Document that ctypes.xFUNCTYPE are decorators #7924

andresdelfino commented Jun 26, 2018 •

edited by bedevere-bot

Loading

berkerpeksag Jul 11, 2018

berkerpeksag Jul 11, 2018

berkerpeksag Jul 11, 2018

berkerpeksag Jul 11, 2018

berkerpeksag Jul 11, 2018

andresdelfino Jul 11, 2018

bedevere-bot commented Jul 11, 2018

andresdelfino commented Jul 11, 2018

bedevere-bot commented Jul 11, 2018

berkerpeksag Jul 11, 2018

berkerpeksag commented Jul 11, 2018

miss-islington commented Jul 13, 2018

berkerpeksag commented Jul 13, 2018

bedevere-bot commented Jul 13, 2018

bedevere-bot commented Jul 13, 2018

		convention. The function will not release the GIL during the call.

		These factory functions can be used as decorator factories, and as such, be applied

	@CFUNCTYPE(c_int, POINTER(c_int), POINTER(c_int))
	def cmp_func(a, b):
	return a[0] - b[0]

bpo-4260: Document that ctypes.xFUNCTYPE are decorators #7924

bpo-4260: Document that ctypes.xFUNCTYPE are decorators #7924

Conversation

andresdelfino commented Jun 26, 2018 • edited by bedevere-bot Loading

berkerpeksag Jul 11, 2018

Choose a reason for hiding this comment

berkerpeksag Jul 11, 2018

Choose a reason for hiding this comment

berkerpeksag Jul 11, 2018

Choose a reason for hiding this comment

berkerpeksag Jul 11, 2018

Choose a reason for hiding this comment

berkerpeksag Jul 11, 2018

Choose a reason for hiding this comment

andresdelfino Jul 11, 2018

Choose a reason for hiding this comment

bedevere-bot commented Jul 11, 2018

andresdelfino commented Jul 11, 2018

bedevere-bot commented Jul 11, 2018

berkerpeksag Jul 11, 2018

Choose a reason for hiding this comment

berkerpeksag commented Jul 11, 2018

miss-islington commented Jul 13, 2018

berkerpeksag commented Jul 13, 2018

bedevere-bot commented Jul 13, 2018

bedevere-bot commented Jul 13, 2018

andresdelfino commented Jun 26, 2018 •

edited by bedevere-bot

Loading