LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Types | Public Member Functions | List of all members
lsst::cpputils::python::PySharedPtr< T > Class Template Referencefinal

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
 
PySharedPtroperator= (PySharedPtr const &) noexcept=default
 
PySharedPtroperator= (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
 
PySharedPtroperator= (PySharedPtr const &) noexcept=default
 
PySharedPtroperator= (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
ptra pointer to a pybind11-managed object.

Definition at line 59 of file PySharedPtr.h.

59  : _impl() {
60  if (ptr != nullptr) {
61  // `cast` returns new PyObject only if `*ptr` not yet associated with one
62  PyObject* pyObj = pybind11::cast(ptr).ptr();
63  Py_INCREF(pyObj);
64  // if any operation with shared_ptr fails, pyObj will get decremented correctly
65  std::shared_ptr<PyObject> manager(pyObj, [](PyObject* const obj) noexcept {
66  if (obj != nullptr) Py_DECREF(obj);
67  });
68  _impl = std::shared_ptr<T>(manager, ptr);
69  }
70  }
uint64_t * ptr
Definition: RangeSet.cc:88

◆ 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.

78 : _impl(std::move(r)) {}
T move(T... args)

◆ 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
ptra pointer to a pybind11-managed object.

Definition at line 59 of file PySharedPtr.h.

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

◆ 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.

78 : _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.

81 { 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.

81 { 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.

79 { 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.

79 { 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: