docs: Flesh out the core dump tutorial

The example I originally suggested for the core dump tutorial is a bit too trivial to make an interesting example. Instead, Pablo helped me come up with an example of a known way to crash the interpreter where the root cause is not so obvious, which makes a far more engaging example for readers to dig into and try to make sense of. Signed-off-by: Matt Wozniski <[email protected]>
bloomberg · Aug 1, 2024 · 760ecf3 · 760ecf3
1 parent dfa7c89
commit 760ecf3
Show file tree

Hide file tree

Showing 5 changed files with 308 additions and 180 deletions.
diff --git a/docs/assert.py b/docs/assert.py
diff --git a/docs/core_tutorial.rst b/docs/core_tutorial.rst
diff --git a/docs/overview.rst b/docs/overview.rst
@@ -54,6 +54,7 @@ Contents
 
    tutorials/deadlock
    tutorials/random_prime_number
+   tutorials/core_tutorial
 
 .. toctree::
   :caption: Project Information

diff --git a/docs/tutorials/core_tutorial.py b/docs/tutorials/core_tutorial.py
@@ -0,0 +1,20 @@
+import gc
+
+
+def types_found_in_tuples():
+    elem_types = set()
+
+    for obj in gc.get_objects():
+        if isinstance(obj, tuple):
+            elem_types.update(map(type, obj))
+
+    for elem_type in elem_types:
+        yield elem_type
+
+
+print("Printing with multiple calls to print():")
+for t in types_found_in_tuples():
+    print(t)
+
+print("Printing with one call to print():")
+print(*types_found_in_tuples(), sep="\n")