Skip to content

Isurwars/Correlation / .agents/skills/pybind11

pybind11

Verified

Direct high-performance Python bindings creation, zero-copy NumPy buffer transfers, GIL management, and C++/Python memory safety. Use when editing or reviewing Python bindings in src/bindings/.

FileKindSize
SKILL.mdskill md2.4 KB
---
name: pybind11
description: Direct high-performance Python bindings creation, zero-copy NumPy buffer transfers, GIL management, and C++/Python memory safety. Use when editing or reviewing Python bindings in src/bindings/.
---

# Pybind11 Python Interoperability

This skill governs the implementation, optimization, and maintenance of Python C++ extension bindings located in `src/bindings/`.

## 1. Zero-Copy NumPy Buffer Integration

1. **Direct Pointer Passing:** Prefer `py::array_t<T, py::array::c_style | py::array::forcecast>` to receive or export multi-dimensional array data without copying underlying memory.
2. **Buffer Protocol Interface:** Map C++ `Cell` and `Trajectory` coordinate buffers directly to Python using `py::buffer_info`.

```cpp
// GOOD: True zero-copy NumPy array exposure via std::span view
m.def("compute_distances", [](py::array_t<double, py::array::c_style> coords) {
    if (coords.ndim() != 2 || coords.shape(1) != 3) {
        throw std::invalid_argument("Input array must have shape (N, 3)");
    }
    
    // Zero-copy non-owning view over contiguous buffer memory
    const auto* ptr = coords.data();
    const auto total_doubles = static_cast<size_t>(coords.size());
    std::span<const double> raw_span(ptr, total_doubles);
    
    return DistanceCalculator::compute_from_flat_span(raw_span);
});
```

---

## 2. Global Interpreter Lock (GIL) Management

1. **Release GIL During Heavy Computations:** Always instantiate `py::gil_scoped_release` before calling CPU-intensive OpenMP, TBB, or SYCL GPU calculations in C++.
2. **Re-acquire GIL on Callback:** If C++ code invokes a Python progress callback or logger, re-acquire the GIL using `py::gil_scoped_acquire`.

```cpp
// GOOD: Releasing GIL during compute phase
m.def("calculate_rdf", [](Trajectory& traj, const RDFNormalizationParams& params) {
    py::gil_scoped_release release;
    RDFCalculator calc;
    return calc.calculate(traj, params); // Multi-threaded TBB compute loop
});
```

---

## 3. Class Exposure & Memory Ownership

1. **Holders & Shared Pointers:** Use `std::shared_ptr<T>` as the holder type (`py::class_<T, std::shared_ptr<T>>`) when instances are co-owned by Python and C++ runtimes.
2. **Implicit Conversions & Type Safety:** Keep bindings strictly type-checked and raise informative Python exceptions (`std::invalid_argument` -> `ValueError`, `std::out_of_range` -> `IndexError`).
receiving-code-reviewobra/superpowersUse when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative agreement or blind implementationStars: 322kUpdated Claude CodeCodexVerifiedInstall
requesting-code-reviewobra/superpowersUse when completing tasks, implementing major features, or before merging to verify work meets requirementsStars: 322kUpdated Claude CodeCodexVerifiedInstall
using-git-worktreesobra/superpowersUse when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallbackStars: 322kUpdated Claude CodeCodexVerifiedInstall
verification-before-completionobra/superpowersUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions alwaysStars: 322kUpdated Claude CodeCodexVerifiedInstall