CppOrPyList Class Reference

Wrapper class for a list of strings to either be held in a std::vector or in a python list. More...

#include <Configuration.h>

Public Member Functions
boost::python::list &	ensurePy ()
	Return the python list version.
std::vector< std::string > &	ensureCpp ()
	Return the C++ vector version.
void	append (const std::string &element)
	Append an element to whatever representation we currently have.
void	prepend (const std::string &element)
	Prepend an element to whatever representation we currently have.
void	shallowCopy (const boost::python::object &source)
	shallow copy all elements of the source object into the python representation.

Private Attributes
std::variant< std::vector< std::string >, boost::python::list >	m_value
	Store either a std::vector or a python list of strings.

Detailed Description

Wrapper class for a list of strings to either be held in a std::vector or in a python list.

It's basically a std::variant with some convenience members to convert between the two representations.

This is necessary as python lists can only exist after Py_Initialize() and before Py_Finalize() and since we want this configuration class to work also in command line tools we need to be able to use std::vector unless python functions are called.

Definition at line 30 of file Configuration.h.

Member Function Documentation

append()

void append

(

const std::string &

element

)

Append an element to whatever representation we currently have.

Definition at line 70 of file Configuration.cc.

  {
    std::visit(Utils::VisitOverload{
      [&element](std::vector<std::string>& list) {list.emplace_back(element);},
      [&element](boost::python::list & list) {list.append(element);}
    }, m_value);
  }

ensureCpp()

std::vector< std::string > & ensureCpp

(

)

Return the C++ vector version.

Convert if necessary

Definition at line 60 of file Configuration.cc.

  {
    // or convert to std::vector ...
    if (m_value.index() == 1) {
      std::vector<std::string> tmp = extractStringList(std::get<1>(m_value));
      m_value.emplace<std::vector<std::string>>(std::move(tmp));
    }
    return std::get<0>(m_value);
  }

ensurePy()

boost::python::list & ensurePy

(

)

Return the python list version.

Convert if necessary

Definition at line 49 of file Configuration.cc.

  {
    // convert to python list ...
    if (m_value.index() == 0) {
      boost::python::list tmp;
      for (const auto& e : std::get<0>(m_value)) { tmp.append(e); }
      m_value.emplace<boost::python::list>(std::move(tmp));
    }
    return std::get<1>(m_value);
  }

prepend()

void prepend

(

const std::string &

element

)

Prepend an element to whatever representation we currently have.

Definition at line 78 of file Configuration.cc.

  {
    std::visit(Utils::VisitOverload{
      [&element](std::vector<std::string>& list) {list.emplace(list.begin(), element);},
      [&element](boost::python::list & list) {list.insert(0, element);}
    }, m_value);
  }

shallowCopy()

void shallowCopy

(

const boost::python::object &

source

)

shallow copy all elements of the source object into the python representation.

Also converts to python representation

Definition at line 86 of file Configuration.cc.

  {
    ensurePy().slice(boost::python::_, boost::python::_) = source;
  }

Member Data Documentation

m_value

std::variant<std::vector<std::string>, boost::python::list> m_value

private

Store either a std::vector or a python list of strings.

Definition at line 45 of file Configuration.h.

---

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

• framework/database/include/Configuration.h
• framework/database/src/Configuration.cc