1 <!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.01 Transitional//EN">
3 <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
4 <!-- Software License, Version 1.0. (See accompanying -->
5 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
8 <meta name=
"generator" content=
9 "HTML Tidy for Cygwin (vers 1st April 2002), see www.w3.org">
10 <meta http-equiv=
"Content-Type" content=
"text/html; charset=iso-8859-1">
11 <link rel=
"stylesheet" type=
"text/css" href=
"../boost.css">
13 <title>Boost.Python - Reference
</title>
15 <style type=
"text/css">
16 p
.c3
{font-style: italic
}
17 h2
.c2
{text-align: center
}
18 h1
.c1
{text-align: center
}
23 <table border=
"0" cellpadding=
"7" cellspacing=
"0" width=
"100%" summary=
26 <td valign=
"top" width=
"300">
27 <h3><a href=
"http://www.boost.org"><img height=
"86" width=
"277"
28 alt=
"C++ Boost" src=
"../../../../boost.png" border=
"0"></a></h3>
32 <h1 class=
"c1"><a href=
"../index.html">Boost.Python
</a></h1>
34 <h2 class=
"c2">Reference
</h2>
42 <dl class=
"Reference">
43 <dt><a href=
"#concepts">Concepts
</a></dt>
45 <dt><a href=
"#high_level">High Level Components
</a></dt>
47 <dt><a href=
"#object_wrappers">Object Wrappers
</a></dt>
49 <dt><a href=
"#invocation">Function Invocation and Creation
</a></dt>
53 <dt><a href=
"#models_of_call_policies">Models of
56 <dt><a href=
"#models_of_result_converter">Models of
57 ResultConverter
</a></dt>
59 <dt><a href=
"#result_converter_generators">Models of
60 ResultConverterGenerator
</a></dt>
64 <dt><a href=
"#type_conversion">To/From Python Type Conversion
</a></dt>
66 <dt><a href=
"#embedding">Embedding
</a></dt>
68 <dt><a href=
"#utility">Utility and Infrastructure
</a></dt>
70 <dt><a href=
"#topics">Topics
</a></dt>
75 <h2><a name=
"concepts">Concepts
</a></h2>
79 "CallPolicies.html#CallPolicies-concept">CallPolicies
</a></dt>
82 "Dereferenceable.html#Dereferenceable-concept">Dereferenceable
</a></dt>
84 <dt><a href=
"Extractor.html#Extractor-concept">Extractor
</a></dt>
87 "HolderGenerator.html#HolderGenerator-concept">HolderGenerator
</a></dt>
90 "ResultConverter.html#ResultConverter-concept">ResultConverter
</a></dt>
93 "ResultConverter.html#ResultConverterGenerator-concept">ResultConverterGenerator
</a></dt>
96 "ObjectWrapper.html#ObjectWrapper-concept">ObjectWrapper
</a></dt>
99 "ObjectWrapper.html#TypeWrapper-concept">TypeWrapper
</a></dt>
102 <h2><a name=
"high_level">High Level Components
</a></h2>
105 <dt><a href=
"class.html">class.hpp/class_fwd.hpp
</a></dt>
109 <dt><a href=
"class.html#classes">Classes
</a></dt>
113 <dt><a href=
"class.html#class_-spec">class_
</a></dt>
115 <dt><a href=
"class.html#bases-spec">bases
</a></dt>
121 <dt><a href=
"def.html">def.hpp
</a></dt>
125 <dt><a href=
"def.html#functions">Functions
</a></dt>
128 <dl class=
"page-index">
129 <dt><a href=
"def.html#def-spec">def
</a></dt>
135 <dt><a href=
"def_visitor.html">def_visitor.hpp
</a></dt>
139 <dt><a href=
"def_visitor.html#classes">Classes
</a></dt>
143 <dt><a href=
"docstring_options.html">docstring_options.hpp
</a></dt>
147 <dt><a href=
"docstring_options.html#classes">Classes
</a></dt>
151 <dt><a href=
"enum.html">enum.hpp
</a></dt>
155 <dt><a href=
"enum.html#classes">Classes
</a></dt>
159 <dt><a href=
"enum.html#enum_-spec">enum_
</a></dt>
165 <dt><a href=
"errors.html">errors.hpp
</a></dt>
169 <dt><a href=
"errors.html#classes">Classes
</a></dt>
174 "errors.html#error_already_set-spec">error_already_set
</a></dt>
178 <dt><a href=
"errors.html#functions">Functions
</a></dt>
183 "errors.html#handle_exception-spec">handle_exception
</a></dt>
186 "errors.html#expect_non_null-spec">expect_non_null
</a></dt>
189 "errors.html#throw_error_already_set-spec">throw_error_already_set
</a></dt>
196 "exception_translator.html">exception_translator.hpp
</a></dt>
201 "exception_translator.html#functions">Functions
</a></dt>
206 "exception_translator.html#register_exception_translator-spec">register_exception_translator
</a></dt>
212 <dt><a href=
"init.html">init.hpp
</a></dt>
216 <dt><a href=
"init.html#classes">Classes
</a></dt>
220 <dt><a href=
"init.html#init-spec">init
</a></dt>
222 <dt><a href=
"init.html#optional-spec">optional
</a></dt>
228 <dt><a href=
"iterator.html">iterator.hpp
</a></dt>
232 <dt><a href=
"iterator.html#classes">Classes
</a></dt>
236 <dt><a href=
"iterator.html#iterator-spec">iterator
</a></dt>
238 <dt><a href=
"iterator.html#iterators-spec">iterators
</a></dt>
242 <dt><a href=
"iterator.html#functions">Functions
</a></dt>
246 <dt><a href=
"iterator.html#range-spec">range
</a></dt>
252 <dt><a href=
"module.html">module.hpp
</a></dt>
256 <dt><a href=
"module.html#macros">Macros
</a></dt>
261 "module.html#BOOST_PYTHON_MODULE-spec">BOOST_PYTHON_MODULE
</a></dt>
267 <dt><a href=
"operators.html">operators.hpp
</a></dt>
271 <dt><a href=
"operators.html#classes">Classes
</a></dt>
275 <dt><a href=
"operators.html#self_t-spec">self_t
</a></dt>
277 <dt><a href=
"operators.html#other-spec">other
</a></dt>
279 <dt><a href=
"operators.html#operator_-spec">operator_
</a></dt>
283 <dt><a href=
"operators.html#objects">Objects
</a></dt>
287 <dt><a href=
"operators.html#self-spec">self
</a></dt>
293 <dt><a href=
"scope.html">scope.hpp
</a></dt>
297 <dt><a href=
"scope.html#classes">Classes
</a></dt>
301 <dt><a href=
"scope.html#scope-spec">scope
</a></dt>
307 <dt><a href=
"stl_iterator.html">stl_iterator.hpp
</a></dt>
311 <dt><a href=
"stl_iterator.html#classes">Classes
</a></dt>
315 <dt><a href=
"stl_iterator.html#stl_input_iterator-spec">stl_input_iterator
</a></dt>
321 <dt><a href=
"wrapper.html">wrapper.hpp
</a></dt>
325 <dt><a href=
"wrapper.html#classes">Classes
</a></dt>
329 <dt><a href=
"wrapper.html#override-spec">override
</a></dt>
331 <dt><a href=
"wrapper.html#wrapper-spec">wrapper
</a></dt>
338 <h2><a name=
"object_wrappers">Object Wrappers
</a></h2>
341 <dt><a href=
"dict.html">dict.hpp
</a></dt>
345 <dt><a href=
"dict.html#classes">Classes
</a></dt>
349 <dt><a href=
"dict.html#dict-spec">dict
</a></dt>
355 <dt><a href=
"list.html">list.hpp
</a></dt>
359 <dt><a href=
"list.html#classes">Classes
</a></dt>
363 <dt><a href=
"list.html#list-spec">list
</a></dt>
369 <dt><a href=
"long.html">long.hpp
</a></dt>
373 <dt><a href=
"long.html#classes">Classes
</a></dt>
377 <dt><a href=
"long.html#long_-spec">long_
</a></dt>
383 <dt><a href=
"numeric.html">numeric.hpp
</a></dt>
387 <dt><a href=
"numeric.html#classes">Classes
</a></dt>
391 <dt><a href=
"numeric.html#array-spec">numeric::array
</a></dt>
397 <dt><a href=
"object.html">object.hpp
</a></dt>
401 <dt><a href=
"object.html#classes">Classes
</a></dt>
405 <dt><a href=
"object.html#object-spec">object
</a></dt>
411 <dt><a href=
"str.html">str.hpp
</a></dt>
415 <dt><a href=
"str.html#classes">Classes
</a></dt>
419 <dt><a href=
"str.html#str-spec">str
</a></dt>
425 <dt><a href=
"tuple.html">tuple.hpp
</a></dt>
429 <dt><a href=
"tuple.html#classes">Classes
</a></dt>
433 <dt><a href=
"tuple.html#tuple-spec">tuple
</a></dt>
437 <dt><a href=
"tuple.html#functions">Functions
</a></dt>
441 <dt><a href=
"tuple.html#make_tuple-spec">make_tuple
</a></dt>
447 <dt><a href=
"slice.html">slice.hpp
</a></dt>
451 <dt><a href=
"slice.html#classes">Classes
</a></dt>
455 <dt><a href=
"slice.html#slice-spec">slice
</a></dt>
462 <h2><a name=
"invocation">Function Invocation and Creation
</a></h2>
465 <dt><a href=
"args.html">args.hpp
</a></dt>
469 <dt><a href=
"args.html#functions">Functions
</a></dt>
473 <dt><a href=
"args.html#args-spec">args
</a></dt>
479 <dt><a href=
"call.html">call.hpp
</a></dt>
483 <dt><a href=
"call.html#functions">Functions
</a></dt>
487 <dt><a href=
"call.html#call-spec">call
</a></dt>
493 <dt><a href=
"call_method.html">call_method.hpp
</a></dt>
497 <dt><a href=
"call_method.html#functions">Functions
</a></dt>
502 "call_method.html#call_method-spec">call_method
</a></dt>
508 <dt><a href=
"data_members.html">data_members.hpp
</a></dt>
512 <dt><a href=
"data_members.html#functions">Functions
</a></dt>
517 "data_members.html#make_getter-spec">make_getter
</a></dt>
520 "data_members.html#make_setter-spec">make_setter
</a></dt>
526 <dt><a href=
"make_function.html">make_function.hpp
</a></dt>
530 <dt><a href=
"make_function.html#functions">Functions
</a></dt>
535 "make_function.html#make_function-spec">make_function
</a></dt>
538 "make_function.html#make_constructor-spec">make_constructor
</a></dt>
544 <dt><a href=
"overloads.html">overloads.hpp
</a></dt>
548 <dt><a href=
"overloads.html#macros">macros
</a></dt>
553 "overloads.html#BOOST_PYTHON_FUNCTION_OVERLOADS-spec">BOOST_PYTHON_FUNCTION_OVERLOADS
</a></dt>
556 "overloads.html#BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS-spec">BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS
</a></dt>
562 <dt><a href=
"ptr.html">ptr.hpp
</a></dt>
566 <dt><a href=
"ptr.html#functions">Functions
</a></dt>
570 <dt><a href=
"ptr.html#ptr-spec">ptr
</a></dt>
574 <dt><a href=
"ptr.html#classes">Classes
</a></dt>
579 "ptr.html#pointer_wrapper-spec">pointer_wrapper
</a></dt>
583 <dt><a href=
"ptr.html#metafunctions">MetaFunctions
</a></dt>
588 "ptr.html#is_pointer_wrapper-spec">is_pointer_wrapper
</a></dt>
591 "ptr.html#unwrap_pointer-spec">unwrap_pointer
</a></dt>
597 <dt><a href=
"raw_function.html">raw_function.hpp
</a></dt>
601 <dt><a href=
"raw_function.html#functions">Functions
</a></dt>
604 <dl class=
"page-index">
606 "raw_function.html#raw_function-spec">raw_function
</a></dt>
613 <a name=
"models_of_call_policies"></a>
615 <h3>Models of CallPolicies
</h3>
619 "default_call_policies.html">default_call_policies.hpp
</a></dt>
624 "default_call_policies.html#classes">Classes
</a></dt>
629 "default_call_policies.html#default_call_policies-spec">default_call_policies
</a></dt>
632 "default_call_policies.html#default_result_converter-spec">default_result_converter
</a></dt>
638 <dt><a href=
"return_arg.html">return_arg.hpp
</a></dt>
642 <dt><a href=
"return_arg.html#classes">Classes
</a></dt>
647 "return_arg.html#return_arg-spec">return_arg
</a></dt>
650 "return_arg.html#return_self-spec">return_self
</a></dt>
657 "return_internal_reference.html">return_internal_reference.hpp
</a></dt>
662 "return_internal_reference.html#classes">Classes
</a></dt>
667 "return_internal_reference.html#return_internal_reference-spec">
668 return_internal_reference
</a></dt>
675 "return_value_policy.html">return_value_policy.hpp
</a></dt>
679 <dt><a href=
"return_value_policy.html#classes">Classes
</a></dt>
684 "return_value_policy.html#return_value_policy-spec">return_value_policy
</a></dt>
691 "with_custodian_and_ward.html">with_custodian_and_ward.hpp
</a></dt>
696 "with_custodian_and_ward.html#classes">Classes
</a></dt>
701 "with_custodian_and_ward.html#with_custodian_and_ward-spec">
702 with_custodian_and_ward
</a></dt>
705 "with_custodian_and_ward.html#with_custodian_and_ward_postcall-spec">
706 with_custodian_and_ward_postcall
</a></dt>
712 <a name=
"models_of_result_converter"></a>
714 <h3>Models of ResultConverter
</h3>
718 "to_python_indirect.html">to_python_indirect.hpp
</a></dt>
722 <dt><a href=
"to_python_indirect.html#classes">Classes
</a></dt>
727 "to_python_indirect.html#to_python_indirect-spec">to_python_indirect
</a></dt>
733 <dt><a href=
"to_python_value.html">to_python_value.hpp
</a></dt>
737 <dt><a href=
"to_python_value.html#classes">Classes
</a></dt>
742 "to_python_value.html#to_python_value-spec">to_python_value
</a></dt>
748 <a name=
"result_converter_generators"></a>
750 <h3>Models of ResultConverterGenerator
</h3>
754 "copy_const_reference.html">copy_const_reference.hpp
</a></dt>
759 "copy_const_reference.html#classes">Classes
</a></dt>
764 "copy_const_reference.html#copy_const_reference-spec">copy_const_reference
</a></dt>
771 "copy_non_const_reference.html">copy_non_const_reference.hpp
</a></dt>
776 "copy_non_const_reference.html#classes">Classes
</a></dt>
781 "copy_non_const_reference.html#copy_non_const_reference-spec">
782 copy_non_const_reference
</a></dt>
788 <dt><a href=
"manage_new_object.html">manage_new_object.hpp
</a></dt>
792 <dt><a href=
"manage_new_object.html#classes">Classes
</a></dt>
797 "manage_new_object.html#manage_new_object-spec">manage_new_object
</a></dt>
804 "reference_existing_object.html">reference_existing_object.hpp
</a></dt>
809 "reference_existing_object.html#classes">Classes
</a></dt>
814 "reference_existing_object.html#reference_existing_object-spec">
815 reference_existing_object
</a></dt>
821 <dt><a href=
"return_by_value.html">return_by_value.hpp
</a></dt>
825 <dt><a href=
"return_by_value.html#classes">Classes
</a></dt>
830 "return_by_value.html#return_by_value-spec">return_by_value
</a></dt>
837 "return_opaque_pointer.html">return_opaque_pointer.hpp
</a></dt>
842 "return_opaque_pointer.html#classes">Classes
</a></dt>
847 "return_opaque_pointer.html#return_opaque_pointer-spec">return_opaque_pointer
</a></dt>
856 <h2><a name=
"type_conversion">To/From Python Type Conversion
</a></h2>
859 <dt><a href=
"extract.html">extract.hpp
</a></dt>
863 <dt><a href=
"extract.html#classes">Classes
</a></dt>
867 <dt><a href=
"extract.html#extract-spec">extract
</a></dt>
873 <dt><a href=
"implicit.html">implicit.hpp
</a></dt>
877 <dt><a href=
"implicit.html#functions">Functions
</a></dt>
882 "implicit.html#implicitly_convertible-spec">implicitly_convertible
</a></dt>
888 <dt><a href=
"lvalue_from_pytype.html">lvalue_from_pytype.hpp
</a></dt>
892 <dt><a href=
"lvalue_from_pytype.html#classes">Classes
</a></dt>
897 "lvalue_from_pytype.html#lvalue_from_pytype-spec">lvalue_from_pytype
</a></dt>
900 "lvalue_from_pytype.html#extract_identity-spec">extract_identity
</a></dt>
903 "lvalue_from_pytype.html#extract_member-spec">extract_member
</a></dt>
910 "opaque.html">opaque_pointer_converter.hpp
</a></dt>
915 "opaque.html#classes">Classes
</a></dt>
920 "opaque.html#opaque-spec">opaque
</a></dt>
924 <dt><a href=
"opaque.html#macros">Macros
</a></dt>
929 "opaque.html#BOOST_PYTHON_OPAQUE_SPECIALIZED_TYPE_ID-spec">
930 BOOST_PYTHON_OPAQUE_SPECIALIZED_TYPE_ID
</a></dt>
936 <dt><a href=
"to_python_converter.html">to_python_converter.hpp
</a></dt>
940 <dt><a href=
"to_python_converter.html#classes">Classes
</a></dt>
945 "to_python_converter.html#to_python_converter-spec">to_python_converter
</a></dt>
952 "register_ptr_to_python.html">register_ptr_to_python.hpp
</a></dt>
957 "register_ptr_to_python.html#functions">Functions
</a></dt>
962 "register_ptr_to_python.html#register_ptr_to_python-spec">register_ptr_to_python
</a></dt>
969 <h2><a name=
"embedding">Embedding
</a></h2>
972 <dt><a href=
"exec.html">exec.hpp
</a></dt>
976 <dt><a href=
"exec.html#functions">Functions
</a></dt>
980 <dt><a href=
"exec.html#eval-spec">eval
</a></dt>
981 <dt><a href=
"exec.html#exec-spec">exec
</a></dt>
982 <dt><a href=
"exec.html#exec_file-spec">exec_file
</a></dt>
988 <dt><a href=
"import.html">import.hpp
</a></dt>
992 <dt><a href=
"import.html#functions">Functions
</a></dt>
996 <dt><a href=
"import.html#import-spec">import
</a></dt>
1003 <h2><a name=
"utility">Utility and Infrastructure
</a></h2>
1006 <dt><a href=
"has_back_reference.html">has_back_reference.hpp
</a></dt>
1010 <dt><a href=
"has_back_reference.html#classes">Classes
</a></dt>
1015 "has_back_reference.html#has_back_reference-spec">has_back_reference
</a></dt>
1021 <dt><a href=
"instance_holder.html">instance_holder.hpp
</a></dt>
1025 <dt><a href=
"instance_holder.html#classes">Classes
</a></dt>
1030 "instance_holder.html#instance_holder-spec">instance_holder
</a></dt>
1036 <dt><a href=
"pointee.html">pointee.hpp
</a></dt>
1040 <dt><a href=
"pointee.html#classes">Classes
</a></dt>
1044 <dt>class template
<a href=
1045 "pointee.html#pointee-spec">pointee
</a></dt>
1051 <dt><a href=
"python.html"><boost/python.hpp
></a></dt>
1053 <dt><a href=
"handle.html">handle.hpp
</a></dt>
1057 <dt><a href=
"handle.html#classes">Classes
</a></dt>
1061 <dt><a href=
"handle.html#handle-spec">handle
</a></dt>
1065 <dt><a href=
"handle.html#functions">Functions
</a></dt>
1069 <dt><a href=
"handle.html#borrowed-spec">borrowed
</a></dt>
1071 <dt><a href=
"handle.html#allow_null-spec">allow_null
</a></dt>
1077 <dt><a href=
"type_id.html">type_id.hpp
</a></dt>
1081 <dt><a href=
"type_id.html#functions">Functions
</a></dt>
1085 <dt><a href=
"type_id.html#type_id-spec">type_id
</a></dt>
1089 <dt><a href=
"type_id.html#classes">Classes
</a></dt>
1093 <dt><a href=
"type_id.html#type_info-spec">type_info
</a></dt>
1099 <dt><a href=
"ssize_t.html">ssize_t.hpp
</a></dt>
1103 <dt><a href=
"ssize_t.html#typedefs">Typedefs
</a></dt>
1105 <dt><a href=
"ssize_t.html#constants">Constants
</a></dt>
1110 <h2><a name=
"topics">Topics
</a></h2>
1113 <dt><a href=
"callbacks.html">Calling Python Functions and
1116 <dt><a href=
"pickle.html">Pickle Support
</a><br>
1117 <a href=
"indexing.html">Indexing Support
</a></dt>
1122 <!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
1124 <!--webbot bot="Timestamp" endspan i-checksum="39359" -->
1127 <p class=
"c3">© Copyright
<a href=
1128 "../../../../people/dave_abrahams.htm">Dave Abrahams
</a> 2002