Skip to content

gh-134160: Start "Extending and embedding" with a Diataxis-style tutorial #142314

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

Merged
encukou merged 25 commits into from
Dec 19, 2025
Merged

gh-134160: Start "Extending and embedding" with a Diataxis-style tutorial #142314

Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
4d31b9a
New first chapter of a C API tutorial
encukou Nov 28, 2025
4c2b982
Reword more
encukou Dec 1, 2025
1525795
Start from the beginning
encukou Dec 3, 2025
dc844dd
TMP
encukou Dec 3, 2025
32ae620
Full draft
encukou Dec 4, 2025
13d5efa
Ruthlessly miminise explanation
encukou Dec 4, 2025
7f1014e
Re-add some reference tragets
encukou Dec 5, 2025
4c61bf4
Typo fix
encukou Dec 5, 2025
0d91185
Apply suggestions from code review
encukou Dec 10, 2025
2902a8b
Address more review comments
encukou Dec 10, 2025
276d8cd
tart with the headers
encukou Dec 10, 2025
2306fcd
str->bytes is *encoding*
encukou Dec 10, 2025
a312862
Merge in the main branch
encukou Dec 12, 2025
ae85969
Link to the list of recommended tools in the Python Packaging User Guide
encukou Dec 12, 2025
27af529
Fix line highlight
encukou Dec 12, 2025
7069412
Move signature check up
encukou Dec 12, 2025
54e2999
Use meson-python
encukou Dec 12, 2025
f92562c
Use 'sampleproject' for the project name
encukou Dec 12, 2025
a17458a
Apply suggestions from code review
encukou Dec 16, 2025
638d2a0
Address more review
encukou Dec 16, 2025
2fc1511
Use :c:func:`system`, not ``system``
encukou Dec 16, 2025
24c6eaa
Expand the explanation of Py_RETURN_NONE
encukou Dec 16, 2025
8e622ac
Merge in the main branch
encukou Dec 17, 2025
772152c
Add a comment for <stdlib.h>
encukou Dec 17, 2025
72fd39f
Apply suggestions from code review
encukou Dec 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Move signature check up
  • Loading branch information
@encukou
encukou committed Dec 12, 2025
commit 7069412a13258857ba552c42d76b180cb67d614e
15 changes: 10 additions & 5 deletions Doc/extending/first-extension-module.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,6 +334,16 @@ You should now be able to call the function:
Note that our ``spam.system`` does not yet run the ``whoami`` command;
Comment thread
ZeroIntensity marked this conversation as resolved.
it only returns ``None``.

Check that the function accepts exactly one argument, as specified by
the :c:data:`METH_O` flag:

.. code-block:: pycon

>>> print(spam.system('too', 'many', 'arguments'))
Comment thread
ZeroIntensity marked this conversation as resolved.
Traceback (most recent call last):
...
TypeError: spam.system() takes exactly one argument (3 given)


Returning an integer
====================
Expand Down Expand Up @@ -495,11 +505,6 @@ You might also want to test error cases:
...
TypeError: bad argument type for built-in operation

>>> print(spam.system('too', 'many', 'arguments'))
Traceback (most recent call last):
...
TypeError: spam.system() takes exactly one argument (3 given)


The result
==========
Expand Down
Loading