PyObject Reference Ownership: Borrowed vs New References is part of Native integration and runtime diagnosis. This lesson focuses on the exact problem it solves, the behavior you can observe, and the limits to understand before applying it in your own project.
New references require release, borrowed references are only valid while their owner keeps the object alive, and stolen references transfer responsibility.
What You Will Learn
- Identify the purpose of PyObject Reference Ownership: Borrowed vs New References and when it is useful.
- Understand the worked example and what happens to each input.
- Recognize the relevant compatibility, safety or correctness limitation.
- Apply the technique to a small exercise and verify the result.
Before You Start
You can run the Python-only portion in a local interpreter. Before adapting the example for real files, the operating system or production data, make a disposable test environment and record the Python version.
How It Works
New references require release, borrowed references are only valid while their owner keeps the object alive, and stolen references transfer responsibility.
Focus on the public contract first: what goes in, what comes out, what may fail, and which state changes. Internal implementation details are useful only when they explain a measured behavior or guide a safe design decision.
Step-by-Step Example
The following self-contained example is intentionally small enough to read line by line. Comments containing another programming language or a terminal command are illustrative and must not be executed as Python source.
# C ownership example:
# PyObject *item = PyList_GetItem(list, 0); // borrowed reference
# PyObject *copy = Py_NewRef(item); // new owned reference
# Py_DECREF(copy); // release owned reference
print('Borrowed references must not be decref-ed as owned references.')Understanding the Example
- The print call exposes the result or a specific property of the operation. Compare it with your prediction rather than memorizing the line.
- Read the code from top to bottom and track how the input becomes a result; any exception is part of the documented contract.
- The important rule is: New references require release, borrowed references are only valid while their owner keeps the object alive, and stolen references transfer responsibility.
Expected behavior: New references require release, borrowed references are only valid while their owner keeps the object alive, and stolen references transfer responsibility. Exact timing values, platform paths, interpreter internals and native library availability may differ between machines.
Practical Use and Design Choices
Before integrating a native library, write down the ABI, ownership of every pointer, calling convention, input sizes and cleanup path. Test failures in an isolated process and keep native build artifacts compatible with the target interpreter.
Choose a pure-Python alternative when it solves the actual problem. Adding a C boundary increases deployment and memory-safety responsibilities even if a short example appears simple.
A Second Scenario to Consider
Imagine using the same technique with an unavailable feature, an unexpected input or a larger workload. Before editing the code, identify which assumption of the first example no longer holds. Decide whether to reject the input, choose a safe fallback or change the design.
For this specific lesson: Classify the ownership of three C API functions before using them.
Important Limitations
Double-decrementing or keeping a borrowed pointer after invalidation can corrupt memory.
Practice Exercise
- Classify the ownership of three C API functions before using them.
- Write down the expected result before running a changed case.
- Add a test for one normal case and one invalid or boundary case. Record the observed result and explain any difference.
Common Beginner Mistakes
- Double-decrementing or keeping a borrowed pointer after invalidation can corrupt memory.
- Double-decrementing or keeping a borrowed pointer after invalidation can corrupt memory.
- Applying PyObject Reference Ownership: Borrowed vs New References without checking input types, resource ownership, side effects or version support.
Key Takeaways
- New references require release, borrowed references are only valid while their owner keeps the object alive, and stolen references transfer responsibility.
- The worked example demonstrates the central behavior of PyObject Reference Ownership: Borrowed vs New References using visible results and bounded input.
- A useful next step is: Classify the ownership of three C API functions before using them.