Class object

include/lbann/utils/python.hpp:116–166

@brief Wrapper around a Python object pointer. * * Manages the reference count for a @c PyObject pointer and is * implicitly convertible to the pointer. This is especially * convenient for interacting with Python C API functions that @a * borrow references and return @a new references (this is the most * common kind). * * This class is @a not thread-safe. However, it's best practice

 *  for an explanation of reference counts.
 */
class object
{
public:
  /** @brief Take ownership of a Python object pointer.
   *  @details @a Steals the reference.
   */
  object(PyObject* ptr);

  /** @brief Create a Python string. */
  object(const std::string& val);
  /** @brief Create a Python integer. */
  object(long val);
  /** @brief Create a Python floating point number. */
  object(double val);

  object() {}
  /** @details @a Borrows the reference. */
  object(const object& other);
  /** @details @a Borrows the reference. */
  object& operator=(const object& other);
  /** @details @a Steals the reference. */
  object(object&& other) noexcept;
  /** @details @a Steals the reference. */
  object& operator=(object&& other);
  ~object();

  /** @returns @a Borrowed reference. */
  inline PyObject* get() noexcept { return m_ptr; }
  /** @returns @a Borrowed reference. */
  inline const PyObject* get() const noexcept { return m_ptr; }
  /** @returns @a Borrowed reference. */
  inline operator PyObject*() noexcept { return get(); }
  /** @returns @a Borrowed reference. */
  inline operator const PyObject*() const noexcept { return get(); }

  /** @brief Release ownership of Python object pointer.
   *  @returns @a New reference.
   */
  PyObject* release() noexcept;

  /** Convert Python @c str to C++ @c std::string. */
  operator std::string();
  /** Convert Python @c int to C++ @c long. */
  operator long();
  /** Convert Python @c float to C++ @c double. */
  operator double();

private:
  /** Python object pointer. */
  PyObject* m_ptr = nullptr;
};

} // namespace python
} // namespace lbann