python.hpp

Go to the documentation of this file.

// Copyright (c) 2014-2023, Lawrence Livermore National Security, LLC.
// Produced at the Lawrence Livermore National Laboratory.
// Written by the LBANN Research Team (B. Van Essen, et al.) listed in
// the CONTRIBUTORS file. <lbann-dev@llnl.gov>
//
// LLNL-CODE-697807.
// All rights reserved.
//
// This file is part of LBANN: Livermore Big Artificial Neural Network
// Toolkit. For details, see http://software.llnl.gov/LBANN or
// https://github.com/LLNL/LBANN.
//
// Licensed under the Apache License, Version 2.0 (the "Licensee"); you
// may not use this file except in compliance with the License.  You may
// obtain a copy of the License at:
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the license.

#ifndef LBANN_UTILS_PYTHON_HPP_INCLUDED
#define LBANN_UTILS_PYTHON_HPP_INCLUDED

#include "lbann/base.hpp"
#ifdef LBANN_HAS_EMBEDDED_PYTHON

// Forward declarations of Python objects to avoid including Python.h
struct _object;
typedef struct _object PyObject;

#include <mutex>
#include <string>

namespace lbann {
namespace python {

void initialize();

void finalize();

bool is_active();

void check_error(bool force_error = false);

class global_interpreter_lock
{
public:
  global_interpreter_lock();
  ~global_interpreter_lock();

private:
  global_interpreter_lock(const global_interpreter_lock&) = delete;
  global_interpreter_lock& operator=(const global_interpreter_lock&) = delete;
  int m_gil_state;
};

class object
{
public:
  object(PyObject* ptr);

  object(const std::string& val);
  object(long val);
  object(double val);

  object() {}
  object(const object& other);
  object& operator=(const object& other);
  object(object&& other) noexcept;
  object& operator=(object&& other);
  ~object();

  inline PyObject* get() noexcept { return m_ptr; }
  inline const PyObject* get() const noexcept { return m_ptr; }
  inline operator PyObject*() noexcept { return get(); }
  inline operator const PyObject*() const noexcept { return get(); }

  PyObject* release() noexcept;

  operator std::string();
  operator long();
  operator double();

private:
  PyObject* m_ptr = nullptr;
};

} // namespace python
} // namespace lbann

#endif // LBANN_HAS_EMBEDDED_PYTHON
#endif // LBANN_UTILS_PYTHON_HPP_INCLUDED