libs/python/doc/v2/dict.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
<!-- Software License, Version 1.0. (See accompanying -->
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
<html>
  <head>
    <meta name="generator" content=
    "HTML Tidy for Windows (vers 1st August 2002), see www.w3.org">
    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
    <link rel="stylesheet" type="text/css" href="../boost.css">

    <title>Boost.Python - &lt;boost/python/dict.hpp&gt;</title>
  </head>

  <body>
    <table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
    "header">
      <tr>
        <td valign="top" width="300">
          <h3><a href="../../../../index.htm"><img height="86" width="277"
          alt="C++ Boost" src="../../../../boost.png" border="0"></a></h3>
        </td>

        <td valign="top">
          <h1 align="center"><a href="../index.html">Boost.Python</a></h1>

          <h2 align="center">Header &lt;boost/python/dict.hpp&gt;</h2>
        </td>
      </tr>
    </table>
    <hr>

    <h2>Contents</h2>

    <dl class="page-index">
      <dt><a href="#introduction">Introduction</a></dt>

      <dt><a href="#classes">Classes</a></dt>

      <dd>
        <dl class="page-index">
          <dt><a href="#dict-spec">Class <code>dict</code></a></dt>

          <dd>
            <dl class="page-index">
              <dt><a href="#dict-spec-synopsis">Class <code>dict</code>
              synopsis</a></dt>
            </dl>
          </dd>
        </dl>
      </dd>

      <dt><a href="#examples">Example(s)</a></dt>
    </dl>
    <hr>

    <h2><a name="introduction"></a>Introduction</h2>

    <p>Exposes a <a href=
    "ObjectWrapper.html#TypeWrapper-concept">TypeWrapper</a> for the Python
    <a href=
    "http://www.python.org/dev/doc/devel/lib/typesmapping.html">dict</a>
    type.</p>

    <h2><a name="classes"></a>Classes</h2>

    <h3><a name="dict-spec"></a>Class <code>dict</code></h3>

    <p>Exposes the <a href=
    "http://www.python.org/dev/doc/devel/lib/typesmapping.html">mapping
    protocol</a> of Python's built-in <code>dict</code> type. The semantics
    of the constructors and member functions defined below can be fully
    understood by reading the <a href=
    "ObjectWrapper.html#TypeWrapper-concept">TypeWrapper</a> concept
    definition. Since <code>dict</code> is publicly derived from <code><a
    href="object.html#object-spec">object</a></code>, the public object
    interface applies to <code>dict</code> instances as well.</p>

    <h4><a name="dict-spec-synopsis"></a>Class <code>dict</code>
    synopsis</h4>
<pre>
namespace boost { namespace python
{
   class dict : public object
   {
      dict();

      template&lt; class T &gt;
      dict(T const &amp; data);

      // modifiers
      void clear();
      dict copy();

      template &lt;class T1, class T2&gt;
      tuple popitem();

      template &lt;class T&gt;
      object setdefault(T const &amp;k);

      template &lt;class T1, class T2&gt;
      object setdefault(T1 const &amp; k, T2 const &amp; d);

      void update(object_cref E);
 
      template&lt; class T &gt;
      void update(T const &amp; E);

      // observers
      list values() const;
    
      object get(object_cref k) const;

      template&lt;class T&gt;
      object get(T const &amp; k) const;

      object get(object_cref k, object_cref d) const;
      object get(T1 const &amp; k, T2 const &amp; d) const;

      bool has_key(object_cref k) const;

      template&lt; class T &gt;
      bool has_key(T const &amp; k) const;

      list items() const;
      object iteritems() const;
      object iterkeys() const;
      object itervalues() const;
      list keys() const;
  };
}}
</pre>

    <h2><a name="examples"></a>Example</h2>
<pre>
using namespace boost::python;
dict swap_object_dict(object target, dict d)
{
    dict result = extract&lt;dict&gt;(target.attr("__dict__"));
    target.attr("__dict__") = d;
    return result;
}
</pre>

    <p>Revised 30 September, 2002</p>

    <p><i>&copy; Copyright <a href=
    "http://www.boost.org/people/dave_abrahams.htm">Dave Abrahams</a> 2002.</i></p>
  </body>
</html>