PythonModuleAPI Class Reference

Functions that investigate an existing module for the starting function. If the module contains only one funtion, it will be the starting function of the module. If the module holds multiple function definitions it requires one function called "__main__", which will be the starting function of the module. More...

#include "PythonModuleAPI.h"

Public Member Functions
std::string	getModuleEntryPoint (const std::string &_moduleName) const
std::string	getModuleEntryPoint (CPythonObject &_module) const
	PythonModuleAPI ()=default
bool	hasScriptHasEntryPoint (const CPythonObject &_module) const

Static Public Member Functions
static const PythonModuleAPI &	instance (void)

Public Attributes
std::string	m_defaultEntryPoint = "__main__"

Detailed Description

Functions that investigate an existing module for the starting function. If the module contains only one funtion, it will be the starting function of the module. If the module holds multiple function definitions it requires one function called "__main__", which will be the starting function of the module.

Constructor & Destructor Documentation

PythonModuleAPI()

PythonModuleAPI::PythonModuleAPI ( )

default

Member Function Documentation

getModuleEntryPoint() [1/2]

std::string PythonModuleAPI::getModuleEntryPoint

(

const std::string &

_moduleName

)

const

getModuleEntryPoint() [2/2]

std::string PythonModuleAPI::getModuleEntryPoint

(

CPythonObject &

_module

)

const

hasScriptHasEntryPoint()

bool PythonModuleAPI::hasScriptHasEntryPoint

(

const CPythonObject &

_module

)

const

instance()

const PythonModuleAPI & PythonModuleAPI::instance ( void )

static

Member Data Documentation

m_defaultEntryPoint

std::string PythonModuleAPI::m_defaultEntryPoint = "__main__"

---

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

• Services/PythonExecution/include/PythonModuleAPI.h
• Services/PythonExecution/src/PythonModuleAPI.cpp