lsst::base::ModuleImporter Class Reference

Base class that defines an interface for importing Python modules. More...

#include <ModuleImporter.h>

Inheritance diagram for lsst::base::ModuleImporter:

Public Member Functions
	ModuleImporter (const ModuleImporter &)=delete
ModuleImporter &	operator= (const ModuleImporter &)=delete
	ModuleImporter (ModuleImporter &&)=delete
ModuleImporter &	operator= (ModuleImporter &&)=delete

Static Public Member Functions
static bool	import (std::string const &name)
	Import the given Python module, and return true if successful.

Protected Member Functions
	ModuleImporter ()
virtual bool	_import (std::string const &name) const =0
virtual	~ModuleImporter ()

Friends
void	installPythonModuleImporter ()

Detailed Description

Base class that defines an interface for importing Python modules.

The default implementation (defined in the source file) simply returns false, indicating that it can't import the given module. The functional implementation is in the ioLib Swig module, which is installed when that module is imported. That machinery keeps us from calling Python C-API functions from standalone C++ binaries that aren't linked with Python.

Definition at line 46 of file ModuleImporter.h.

Constructor & Destructor Documentation

ModuleImporter() [1/3]

lsst::base::ModuleImporter::ModuleImporter ( const ModuleImporter & )

delete

ModuleImporter() [2/3]

lsst::base::ModuleImporter::ModuleImporter ( ModuleImporter && )

delete

ModuleImporter() [3/3]

lsst::base::ModuleImporter::ModuleImporter ( )

inlineprotected

Definition at line 62 of file ModuleImporter.h.

{}

~ModuleImporter()

virtual lsst::base::ModuleImporter::~ModuleImporter ( )

inlineprotectedvirtual

Definition at line 66 of file ModuleImporter.h.

{}

Member Function Documentation

_import()

virtual bool lsst::base::ModuleImporter::_import ( std::string const & name ) const

protectedpure virtual

Implemented in lsst::base::PythonModuleImporter.

import()

bool lsst::base::ModuleImporter::import ( std::string const & name )

static

Import the given Python module, and return true if successful.

Definition at line 49 of file ModuleImporter.cc.

                                                  {
    return getImporterSingleton()->_import(name);
}

operator=() [1/2]

ModuleImporter & lsst::base::ModuleImporter::operator= ( const ModuleImporter & )

delete

operator=() [2/2]

ModuleImporter & lsst::base::ModuleImporter::operator= ( ModuleImporter && )

delete

Friends And Related Symbol Documentation

installPythonModuleImporter

void installPythonModuleImporter ( )

friend

Definition at line 60 of file cppimport.cc.

{ ModuleImporter::install(PythonModuleImporter::get()); }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/base/g1653933729+a8ce1bb630/include/lsst/base/ModuleImporter.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/base/g1653933729+a8ce1bb630/src/ModuleImporter.cc