lsst::cpputils::python::PySharedPtr< T > Class Template Reference

A shared pointer that tracks both a C++ object and its associated PyObject. More...

#include <PySharedPtr.h>

Public Types
using	element_type = T
using	element_type = T

Public Member Functions
	PySharedPtr (T *const ptr)
	Create a pointer that counts as an extra reference in the Python environment. More...
	PySharedPtr (PySharedPtr const &) noexcept=default
	PySharedPtr (PySharedPtr &&) noexcept=default
PySharedPtr &	operator= (PySharedPtr const &) noexcept=default
PySharedPtr &	operator= (PySharedPtr &&) noexcept=default
	~PySharedPtr () noexcept=default
	PySharedPtr (std::shared_ptr< T > r) noexcept
	operator std::shared_ptr< T > () noexcept
T *	get () const noexcept
	PySharedPtr (T *const ptr)
	Create a pointer that counts as an extra reference in the Python environment. More...
	PySharedPtr (PySharedPtr const &) noexcept=default
	PySharedPtr (PySharedPtr &&) noexcept=default
PySharedPtr &	operator= (PySharedPtr const &) noexcept=default
PySharedPtr &	operator= (PySharedPtr &&) noexcept=default
	~PySharedPtr () noexcept=default
	PySharedPtr (std::shared_ptr< T > r) noexcept
	operator std::shared_ptr< T > () noexcept
T *	get () const noexcept

Detailed Description

template<typename T>
class lsst::cpputils::python::PySharedPtr< T >

A shared pointer that tracks both a C++ object and its associated PyObject.

Each group of PySharedPtr for a given object collectively counts as one reference to that object for the purpose of Python garbage collection.

A PySharedPtr is implicitly convertible to and from a std::shared_ptr to minimize API impact. Any shared_ptr created this way will (I think) keep the Python reference alive, as described above.

Definition at line 49 of file PySharedPtr.h.

Member Typedef Documentation

element_type [1/2]

template<typename T >

using lsst::cpputils::python::PySharedPtr< T >::element_type = T

Definition at line 51 of file PySharedPtr.h.

element_type [2/2]

template<typename T >

using lsst::cpputils::python::PySharedPtr< T >::element_type = T

Definition at line 51 of file PySharedPtr.h.

Constructor & Destructor Documentation

PySharedPtr() [1/8]

template<typename T >

lsst::cpputils::python::PySharedPtr< T >::PySharedPtr ( T *const  ptr )

inlineexplicit

Create a pointer that counts as an extra reference in the Python environment.

Parameters

ptr	a pointer to a pybind11-managed object.

Definition at line 59 of file PySharedPtr.h.

                                       : _impl() {
        if (ptr != nullptr) {
            // `cast` returns new PyObject only if `*ptr` not yet associated with one
            PyObject* pyObj = pybind11::cast(ptr).ptr();
            Py_INCREF(pyObj);
            // if any operation with shared_ptr fails, pyObj will get decremented correctly
            std::shared_ptr<PyObject> manager(pyObj, [](PyObject* const obj) noexcept {
                if (obj != nullptr) Py_DECREF(obj);
            });
            _impl = std::shared_ptr<T>(manager, ptr);
        }
    }

PySharedPtr() [2/8]

template<typename T >

lsst::cpputils::python::PySharedPtr< T >::PySharedPtr ( PySharedPtr< T > const &  )

defaultnoexcept

PySharedPtr() [3/8]

template<typename T >

lsst::cpputils::python::PySharedPtr< T >::PySharedPtr ( PySharedPtr< T > &&  )

defaultnoexcept

~PySharedPtr() [1/2]

template<typename T >

lsst::cpputils::python::PySharedPtr< T >::~PySharedPtr ( )

defaultnoexcept

PySharedPtr() [4/8]

template<typename T >

lsst::cpputils::python::PySharedPtr< T >::PySharedPtr ( std::shared_ptr< T >  r )

inlinenoexcept

Definition at line 78 of file PySharedPtr.h.

: _impl(std::move(r)) {}

PySharedPtr() [5/8]

template<typename T >

lsst::cpputils::python::PySharedPtr< T >::PySharedPtr ( T *const  ptr )

inlineexplicit

Create a pointer that counts as an extra reference in the Python environment.

Parameters

ptr	a pointer to a pybind11-managed object.

Definition at line 59 of file PySharedPtr.h.

                                       : _impl() {
        if (ptr != nullptr) {
            // `cast` returns new PyObject only if `*ptr` not yet associated with one
            PyObject* pyObj = pybind11::cast(ptr).ptr();
            Py_INCREF(pyObj);
            // if any operation with shared_ptr fails, pyObj will get decremented correctly
            std::shared_ptr<PyObject> manager(pyObj, [](PyObject* const obj) noexcept {
                if (obj != nullptr) Py_DECREF(obj);
            });
            _impl = std::shared_ptr<T>(manager, ptr);
        }
    }

PySharedPtr() [6/8]

template<typename T >

lsst::cpputils::python::PySharedPtr< T >::PySharedPtr ( PySharedPtr< T > const &  )

defaultnoexcept

PySharedPtr() [7/8]

template<typename T >

lsst::cpputils::python::PySharedPtr< T >::PySharedPtr ( PySharedPtr< T > &&  )

defaultnoexcept

~PySharedPtr() [2/2]

template<typename T >

lsst::cpputils::python::PySharedPtr< T >::~PySharedPtr ( )

defaultnoexcept

PySharedPtr() [8/8]

template<typename T >

lsst::cpputils::python::PySharedPtr< T >::PySharedPtr ( std::shared_ptr< T >  r )

inlinenoexcept

Definition at line 78 of file PySharedPtr.h.

: _impl(std::move(r)) {}

Member Function Documentation

get() [1/2]

template<typename T >

T* lsst::cpputils::python::PySharedPtr< T >::get ( ) const

inlinenoexcept

Definition at line 81 of file PySharedPtr.h.

{ return _impl.get(); }

get() [2/2]

template<typename T >

T* lsst::cpputils::python::PySharedPtr< T >::get ( ) const

inlinenoexcept

Definition at line 81 of file PySharedPtr.h.

{ return _impl.get(); }

operator std::shared_ptr< T >() [1/2]

template<typename T >

lsst::cpputils::python::PySharedPtr< T >::operator std::shared_ptr< T > ( )

inlinenoexcept

Definition at line 79 of file PySharedPtr.h.

{ return _impl; }

operator std::shared_ptr< T >() [2/2]

template<typename T >

lsst::cpputils::python::PySharedPtr< T >::operator std::shared_ptr< T > ( )

inlinenoexcept

Definition at line 79 of file PySharedPtr.h.

{ return _impl; }

operator=() [1/4]

template<typename T >

PySharedPtr& lsst::cpputils::python::PySharedPtr< T >::operator= ( PySharedPtr< T > &&  )

defaultnoexcept

operator=() [2/4]

template<typename T >

PySharedPtr& lsst::cpputils::python::PySharedPtr< T >::operator= ( PySharedPtr< T > &&  )

defaultnoexcept

operator=() [3/4]

template<typename T >

PySharedPtr& lsst::cpputils::python::PySharedPtr< T >::operator= ( PySharedPtr< T > const &  )

defaultnoexcept

operator=() [4/4]

template<typename T >

PySharedPtr& lsst::cpputils::python::PySharedPtr< T >::operator= ( PySharedPtr< T > const &  )

defaultnoexcept

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/cpputils/master-g6e05de7fdc+c1283a92b8/include/lsst/cpputils/python/PySharedPtr.h