[ceph.git] / ceph / src / boost / libs / python / doc / reference / import.qbk

[section boost/python/import.hpp]
[section Introduction]
Exposes a mechanism for importing python modules.
[endsect]
[section Function `import`]
``object import(str name);``
[variablelist
[[Effects][Imports the module named by name.]]
[[Returns][An instance of object which holds a reference to the imported module.]]
]
[endsect]
[section Examples]
The following example demonstrates the use of import to access a function in python, and later call it from within C++. 
``
#include <iostream>
#include <string>

using namespace boost::python;

void print_python_version()
{ 
  // Load the sys module.
  object sys = import("sys");

  // Extract the python version.
  std::string version = extract<std::string>(sys.attr("version"));
  std::cout << version << std::endl;
}
``
[endsect]
[endsect]
Commit	Line	Data
7c673cae FG	1	[section boost/python/import.hpp]
	2	[section Introduction]
	3	Exposes a mechanism for importing python modules.
	4	[endsect]
	5	[section Function `import`]
	6	``object import(str name);``
	7	[variablelist
	8	[[Effects][Imports the module named by name.]]
	9	[[Returns][An instance of object which holds a reference to the imported module.]]
	10	]
	11	[endsect]
	12	[section Examples]
	13	The following example demonstrates the use of import to access a function in python, and later call it from within C++.
	14	``
	15	#include <iostream>
	16	#include <string>
	17
	18	using namespace boost::python;
	19
	20	void print_python_version()
	21	{
	22	// Load the sys module.
	23	object sys = import("sys");
	24
	25	// Extract the python version.
	26	std::string version = extract<std::string>(sys.attr("version"));
	27	std::cout << version << std::endl;
	28	}
	29	``
	30	[endsect]
	31	[endsect]