OD::PythonAccess Class Reference

#include <pythonaccess.h>

Inheritance diagram for OD::PythonAccess:

Classes
struct	ModuleInfo

Public Member Functions
	PythonAccess ()
	~PythonAccess ()
void	addBasePath (const FilePath &)
bool	execute (const OS::MachineCommand &, BufferString &stdoutstr, uiRetVal &, BufferString *stderrstr=nullptr) const
bool	execute (const OS::MachineCommand &, const OS::CommandExecPars &, uiRetVal &, int *pid=nullptr, BufferString *stdoutstr=nullptr, BufferString *stderrstr=nullptr) const
bool	execute (const OS::MachineCommand &, uiRetVal &, bool wait4finish=true, BufferString *stdoutstr=nullptr, BufferString *stderrstr=nullptr) const
bool	executeScript (const BufferStringSet &, BufferString &stdoutstr, uiRetVal &, BufferString *stderrstr=nullptr) const
bool	executeScript (const BufferStringSet &, uiRetVal &, bool wait4finish=true, BufferString *stdoutstr=nullptr, BufferString *stderrstr=nullptr) const
bool	executeScript (const char *, BufferString &stdoutstr, uiRetVal &, BufferString *stderrstr=nullptr) const
bool	executeScript (const char *, uiRetVal &, bool wait4finish, BufferString *stdoutstr=nullptr, BufferString *stderrstr=nullptr) const
const FilePath *	getActivateFp () const
BufferStringSet	getBasePythonPath () const
const char *	getEnvName () const
uiRetVal	getModules (ManagedObjectSet< ModuleInfo > &)
BufferString	getPacmanExecNm () const
FilePath	getPythonEnvFp () const
PythonSource	getPythonSource () const
BufferStringSet	getUserPythonPath () const
uiRetVal	hasModule (const char *modname, bool isminver=true, const char *version=nullptr) const
bool	isModuleUsable (const char *nm, uiRetVal &) const
uiRetVal	isUsable (bool force=false, BufferString *stdoutstr=nullptr, BufferString *stderrstr=nullptr) const
bool	openTerminal (const char *cmd, uiRetVal &, const BufferStringSet *args=nullptr, const char *workdir=nullptr) const
uiString	pySummary () const
BufferString	pyVersion () const
uiRetVal	setEnvironment (const FilePath *rootfp, const char *envnm)
void	setForScript (const char *scriptnm, OS::MachineCommand &) const
uiRetVal	updateModuleInfo (const char *defprog="pip", const char *defarg="list")
void	updatePythonPath () const
uiRetVal	verifyEnvironment (const char *piname)
Public Member Functions inherited from CallBacker
	CallBacker ()
	CallBacker (const CallBacker &)
virtual	~CallBacker ()
bool	attachCB (const NotifierAccess &, const CallBack &, bool onlyifnew=false) const
bool	attachCB (const NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false) const
void	detachAllNotifiers () const
	Call from the destructor of your inherited object.
void	detachCB (const NotifierAccess &, const CallBack &) const
void	detachCB (const NotifierAccess *notif, const CallBack &cb) const
virtual bool	isCapsule () const
bool	isNotifierAttached (const NotifierAccess *) const
	Only for debugging purposes, don't use.
CallBacker &	operator= (const CallBacker &)=delete
void	stopReceivingNotifications () const
virtual CallBacker *	trueCaller ()

Static Public Member Functions
static uiString	firewallDesc ()
static bool	getCondaEnvFromTxtPath (ObjectSet< FilePath > &)
static OD::DataRepType	getDataType (const char *)
static BufferString	getDataTypeStr (OD::DataRepType)
static void	getPathToInternalEnv (FilePath &, bool userdef)
static const char *	getPythonActivatorPath ()
static void	GetPythonEnvBinPath (FilePath &)
static FilePath	getPythonEnvFp (const FilePath &activatefp)
static void	GetPythonEnvPath (FilePath &)
static PythonSource	getPythonSource (const FilePath *envrootfp)
static bool	getSortedVirtualEnvironmentLoc (ObjectSet< FilePath > &, BufferStringSet &envnms, const BufferString *envnm=nullptr, const FilePath *extroot=nullptr)
static bool	hasInternalEnvironment (bool allowuserdef=true)
static uiRetVal	hasModule (const ObjectSet< ModuleInfo > &, const char *modname, bool isminver=true, const char *minversion=nullptr)
static void	initClass ()
static bool	needCheckRunScript ()
static void	reReadFWRules (const BufferString &fpstr)
static void	setPythonActivator (const char *)
static const char *	sKeyActivatePath ()
static const char *	sKeyEnviron ()
static const char *	sKeyPythonPath ()
static const char *	sKeyPythonSrc ()
static BufferString	sKeyUseExtPyPath ()
static const char *	sPythonExecNm (bool v3=false, bool v2=false)
static bool	validInternalEnvironment (const FilePath &)
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()

Public Attributes
Notifier< PythonAccess >	envChange
CNotifier< PythonAccess, const uiRetVal & >	envVerified

Private Member Functions
void	appToBeStartedCB (CallBacker *)
void	createFireWallExeList (ManagedObjectSet< FilePath > &)
uiRetVal	doExecute (const OS::MachineCommand &, const OS::CommandExecPars *, int *pid, const FilePath *activatefp, const char *envnm, BufferString *stdoutstr, BufferString *stderrstr) const
const BufferStringSet &	getBasePythonPath_ () const
bool	isEnvUsable (const FilePath *pythonenvfp, const char *envnm, uiRetVal &, BufferString *stdoutstr=nullptr, BufferString *stderrstr=nullptr)
bool	isUsable_ (bool force, uiRetVal &, BufferString *stdoutstr=nullptr, BufferString *stderrstr=nullptr)
bool	retrievePythonVersionStr ()
void	verifyEnvironmentCB (CallBacker *)

Static Private Member Functions
static FilePath *	getActivateScript (const FilePath &root)
static FilePath *	getCommand (OS::MachineCommand &, bool background, const FilePath *activatefp, const char *envnm)
static bool	getCondaEnvsFromTxt (BufferStringSet &)
static bool	getInternalEnvironmentLocation (FilePath &, bool userdef)
static FilePath	getInternalEnvPath (bool userdef)
static OS::CommandLauncher *	getLauncher (const OS::MachineCommand &, bool background, const FilePath *activatefp, const char *envnm, FilePath &scriptfp)
static void	getPIDFromFile (const char *pidfnm, int *pid)

Private Attributes
FilePath *	activatefp_ = nullptr
bool	istested_ = false
bool	isusable_ = false
Threads::Lock	lock_
ManagedObjectSet< ModuleInfo >	moduleinfos_
BufferString	pythversion_
BufferString	virtenvnm_

Static Private Attributes
static BufferStringSet	pystartpath_

Detailed Description

<>

Constructor & Destructor Documentation

PythonAccess()

OD::PythonAccess::PythonAccess

(

)

~PythonAccess()

OD::PythonAccess::~PythonAccess

(

)

Member Function Documentation

addBasePath()

void OD::PythonAccess::addBasePath

(

const FilePath &

)

appToBeStartedCB()

void OD::PythonAccess::appToBeStartedCB ( CallBacker * )

private

createFireWallExeList()

void OD::PythonAccess::createFireWallExeList ( ManagedObjectSet< FilePath > & )

private

doExecute()

uiRetVal OD::PythonAccess::doExecute ( const OS::MachineCommand & , const OS::CommandExecPars * , int * pid, const FilePath * activatefp, const char * envnm, BufferString * stdoutstr, BufferString * stderrstr ) const

private

execute() [1/3]

bool OD::PythonAccess::execute	(	const OS::MachineCommand &	,
		BufferString &	stdoutstr,
		uiRetVal &	,
		BufferString *	stderrstr = nullptr ) const

execute() [2/3]

bool OD::PythonAccess::execute	(	const OS::MachineCommand &	,
		const OS::CommandExecPars &	,
		uiRetVal &	,
		int *	pid = nullptr,
		BufferString *	stdoutstr = nullptr,
		BufferString *	stderrstr = nullptr ) const

execute() [3/3]

bool OD::PythonAccess::execute	(	const OS::MachineCommand &	,
		uiRetVal &	,
		bool	wait4finish = true,
		BufferString *	stdoutstr = nullptr,
		BufferString *	stderrstr = nullptr ) const

executeScript() [1/4]

bool OD::PythonAccess::executeScript	(	const BufferStringSet &	,
		BufferString &	stdoutstr,
		uiRetVal &	,
		BufferString *	stderrstr = nullptr ) const

executeScript() [2/4]

bool OD::PythonAccess::executeScript	(	const BufferStringSet &	,
		uiRetVal &	,
		bool	wait4finish = true,
		BufferString *	stdoutstr = nullptr,
		BufferString *	stderrstr = nullptr ) const

executeScript() [3/4]

bool OD::PythonAccess::executeScript	(	const char *	,
		BufferString &	stdoutstr,
		uiRetVal &	,
		BufferString *	stderrstr = nullptr ) const

executeScript() [4/4]

bool OD::PythonAccess::executeScript	(	const char *	,
		uiRetVal &	,
		bool	wait4finish,
		BufferString *	stdoutstr = nullptr,
		BufferString *	stderrstr = nullptr ) const

firewallDesc()

static uiString OD::PythonAccess::firewallDesc ( )

static

getActivateFp()

const FilePath * OD::PythonAccess::getActivateFp ( ) const

inline

getActivateScript()

static FilePath * OD::PythonAccess::getActivateScript ( const FilePath & root )

staticprivate

getBasePythonPath()

BufferStringSet OD::PythonAccess::getBasePythonPath

(

)

const

getBasePythonPath_()

const BufferStringSet & OD::PythonAccess::getBasePythonPath_ ( ) const

private

getCommand()

static FilePath * OD::PythonAccess::getCommand ( OS::MachineCommand & , bool background, const FilePath * activatefp, const char * envnm )

staticprivate

getCondaEnvFromTxtPath()

static bool OD::PythonAccess::getCondaEnvFromTxtPath ( ObjectSet< FilePath > & )

static

getCondaEnvsFromTxt()

static bool OD::PythonAccess::getCondaEnvsFromTxt ( BufferStringSet & )

staticprivate

getDataType()

static OD::DataRepType OD::PythonAccess::getDataType ( const char * )

static

getDataTypeStr()

static BufferString OD::PythonAccess::getDataTypeStr ( OD::DataRepType )

static

getEnvName()

const char * OD::PythonAccess::getEnvName ( ) const

inline

getInternalEnvironmentLocation()

static bool OD::PythonAccess::getInternalEnvironmentLocation ( FilePath & , bool userdef )

staticprivate

getInternalEnvPath()

static FilePath OD::PythonAccess::getInternalEnvPath ( bool userdef )

staticprivate

getLauncher()

static OS::CommandLauncher * OD::PythonAccess::getLauncher ( const OS::MachineCommand & , bool background, const FilePath * activatefp, const char * envnm, FilePath & scriptfp )

staticprivate

getModules()

uiRetVal OD::PythonAccess::getModules

(

ManagedObjectSet< ModuleInfo > &

)

getPacmanExecNm()

BufferString OD::PythonAccess::getPacmanExecNm

(

)

const

getPathToInternalEnv()

static void OD::PythonAccess::getPathToInternalEnv ( FilePath & , bool userdef )

static

getPIDFromFile()

static void OD::PythonAccess::getPIDFromFile ( const char * pidfnm, int * pid )

staticprivate

getPythonActivatorPath()

static const char * OD::PythonAccess::getPythonActivatorPath ( )

static

GetPythonEnvBinPath()

static void OD::PythonAccess::GetPythonEnvBinPath ( FilePath & )

static

getPythonEnvFp() [1/2]

FilePath OD::PythonAccess::getPythonEnvFp

(

)

const

getPythonEnvFp() [2/2]

static FilePath OD::PythonAccess::getPythonEnvFp ( const FilePath & activatefp )

static

GetPythonEnvPath()

static void OD::PythonAccess::GetPythonEnvPath ( FilePath & )

static

getPythonSource() [1/2]

PythonSource OD::PythonAccess::getPythonSource

(

)

const

getPythonSource() [2/2]

static PythonSource OD::PythonAccess::getPythonSource ( const FilePath * envrootfp )

static

getSortedVirtualEnvironmentLoc()

static bool OD::PythonAccess::getSortedVirtualEnvironmentLoc ( ObjectSet< FilePath > & , BufferStringSet & envnms, const BufferString * envnm = nullptr, const FilePath * extroot = nullptr )

static

getUserPythonPath()

BufferStringSet OD::PythonAccess::getUserPythonPath

(

)

const

hasInternalEnvironment()

static bool OD::PythonAccess::hasInternalEnvironment ( bool allowuserdef = true )

static

hasModule() [1/2]

uiRetVal OD::PythonAccess::hasModule	(	const char *	modname,
		bool	isminver = true,
		const char *	version = nullptr ) const

hasModule() [2/2]

static uiRetVal OD::PythonAccess::hasModule ( const ObjectSet< ModuleInfo > & , const char * modname, bool isminver = true, const char * minversion = nullptr )

static

initClass()

static void OD::PythonAccess::initClass ( )

static

isEnvUsable()

bool OD::PythonAccess::isEnvUsable ( const FilePath * pythonenvfp, const char * envnm, uiRetVal & , BufferString * stdoutstr = nullptr, BufferString * stderrstr = nullptr )

private

isModuleUsable()

bool OD::PythonAccess::isModuleUsable	(	const char *	nm,
		uiRetVal &	) const

isUsable()

uiRetVal OD::PythonAccess::isUsable	(	bool	force = false,
		BufferString *	stdoutstr = nullptr,
		BufferString *	stderrstr = nullptr ) const

isUsable_()

bool OD::PythonAccess::isUsable_ ( bool force, uiRetVal & , BufferString * stdoutstr = nullptr, BufferString * stderrstr = nullptr )

private

needCheckRunScript()

static bool OD::PythonAccess::needCheckRunScript ( )

static

openTerminal()

bool OD::PythonAccess::openTerminal	(	const char *	cmd,
		uiRetVal &	,
		const BufferStringSet *	args = nullptr,
		const char *	workdir = nullptr ) const

pySummary()

uiString OD::PythonAccess::pySummary

(

)

const

pyVersion()

BufferString OD::PythonAccess::pyVersion

(

)

const

reReadFWRules()

static void OD::PythonAccess::reReadFWRules ( const BufferString & fpstr )

static

retrievePythonVersionStr()

bool OD::PythonAccess::retrievePythonVersionStr ( )

private

setEnvironment()

uiRetVal OD::PythonAccess::setEnvironment	(	const FilePath *	rootfp,
		const char *	envnm )

setForScript()

void OD::PythonAccess::setForScript	(	const char *	scriptnm,
		OS::MachineCommand &	) const

setPythonActivator()

static void OD::PythonAccess::setPythonActivator ( const char * )

static

sKeyActivatePath()

static const char * OD::PythonAccess::sKeyActivatePath ( )

static

sKeyEnviron()

static const char * OD::PythonAccess::sKeyEnviron ( )

static

sKeyPythonPath()

static const char * OD::PythonAccess::sKeyPythonPath ( )

static

sKeyPythonSrc()

static const char * OD::PythonAccess::sKeyPythonSrc ( )

static

sKeyUseExtPyPath()

static BufferString OD::PythonAccess::sKeyUseExtPyPath ( )

inlinestatic

sPythonExecNm()

static const char * OD::PythonAccess::sPythonExecNm ( bool v3 = false, bool v2 = false )

static

updateModuleInfo()

uiRetVal OD::PythonAccess::updateModuleInfo	(	const char *	defprog = "pip",
		const char *	defarg = "list" )

updatePythonPath()

void OD::PythonAccess::updatePythonPath

(

)

const

validInternalEnvironment()

static bool OD::PythonAccess::validInternalEnvironment ( const FilePath & )

static

verifyEnvironment()

uiRetVal OD::PythonAccess::verifyEnvironment

(

const char *

piname

)

verifyEnvironmentCB()

void OD::PythonAccess::verifyEnvironmentCB ( CallBacker * )

private

Member Data Documentation

activatefp_

FilePath* OD::PythonAccess::activatefp_ = nullptr

private

envChange

Notifier<PythonAccess> OD::PythonAccess::envChange

envVerified

CNotifier<PythonAccess,const uiRetVal&> OD::PythonAccess::envVerified

istested_

bool OD::PythonAccess::istested_ = false

private

isusable_

bool OD::PythonAccess::isusable_ = false

private

lock_

Threads::Lock OD::PythonAccess::lock_

mutableprivate

moduleinfos_

ManagedObjectSet<ModuleInfo> OD::PythonAccess::moduleinfos_

private

pystartpath_

BufferStringSet OD::PythonAccess::pystartpath_

staticprivate

pythversion_

BufferString OD::PythonAccess::pythversion_

private

virtenvnm_

BufferString OD::PythonAccess::virtenvnm_

private