/usr/share/doc/python3-autopilot/html/api/autopilot.introspection.types.html is in python3-autopilot 1.5.1+16.04.20160412-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>autopilot.introspection.types - Introspection Type details — Autopilot 1.5 documentation</title>
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/otto.css" type="text/css" />
<link rel="stylesheet" href="../_static/centertext.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="top" title="Autopilot 1.5 documentation" href="../index.html" />
<link rel="up" title="Autopilot API Documentation" href="index.html" />
<link rel="next" title="autopilot.matchers - Custom matchers for test assertions" href="autopilot.matchers.html" />
<link rel="prev" title="autopilot.introspection - Retrieve proxy objects" href="autopilot.introspection.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="autopilot.matchers.html" title="autopilot.matchers - Custom matchers for test assertions"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="autopilot.introspection.html" title="autopilot.introspection - Retrieve proxy objects"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Autopilot 1.5 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Autopilot API Documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-autopilot.introspection.types">
<span id="autopilot-introspection-types-introspection-type-details"></span><h1><code class="docutils literal"><span class="pre">autopilot.introspection.types</span></code> - Introspection Type details<a class="headerlink" href="#module-autopilot.introspection.types" title="Permalink to this headline">¶</a></h1>
<div class="section" id="autopilot-proxy-type-support">
<h2>Autopilot proxy type support.<a class="headerlink" href="#autopilot-proxy-type-support" title="Permalink to this headline">¶</a></h2>
<p>This module defines the classes that are used for all attributes on proxy
objects. All proxy objects contain attributes that transparently mirror the
values present in the application under test. Autopilot takes care of keeping
these values up to date.</p>
<p>Object attributes fall into two categories. Attributes that are a single
string, boolean, or integer property are sent directly across DBus. These are
called “plain” types, and are stored in autopilot as instnaces of the
<a class="reference internal" href="#autopilot.introspection.types.PlainType" title="autopilot.introspection.types.PlainType"><code class="xref py py-class docutils literal"><span class="pre">PlainType</span></code></a> class. Attributes that are more complex (a rectangle, for
example) are called “complex” types, and are split into several component
values, sent across dbus, and are then reconstituted in autopilot into useful
objects.</p>
<dl class="class">
<dt id="autopilot.introspection.types.PlainType">
<em class="property">class </em><code class="descclassname">autopilot.introspection.types.</code><code class="descname">PlainType</code><a class="reference internal" href="../_modules/autopilot/introspection/types.html#PlainType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#autopilot.introspection.types.PlainType" title="Permalink to this definition">¶</a></dt>
<dd><p>Plain type support in autopilot proxy objects.</p>
<p>Instances of this class will be used for all plain attrubites. The word
“plain” in this context means anything that’s marshalled as a string,
boolean or integer type across dbus.</p>
<p>Instances of these classes can be used just like the underlying type. For
example, given an object property called ‘length’ that is marshalled over
dbus as an integer value, the following will be true:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="nb">isinstance</span><span class="p">(</span><span class="nb">object</span><span class="o">.</span><span class="n">length</span><span class="p">,</span> <span class="n">PlainType</span><span class="p">)</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="nb">isinstance</span><span class="p">(</span><span class="nb">object</span><span class="o">.</span><span class="n">length</span><span class="p">,</span> <span class="nb">int</span><span class="p">)</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="k">print</span><span class="p">(</span><span class="nb">object</span><span class="o">.</span><span class="n">length</span><span class="p">)</span>
<span class="go">123</span>
<span class="gp">>>> </span><span class="k">print</span><span class="p">(</span><span class="nb">object</span><span class="o">.</span><span class="n">length</span> <span class="o">+</span> <span class="mi">32</span><span class="p">)</span>
<span class="go">155</span>
</pre></div>
</div>
<p>However, a special case exists for boolean values: because you cannot
subclass from the ‘bool’ type, the following check will fail (
<code class="docutils literal"><span class="pre">object.visible</span></code> is a boolean property):</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="nb">isinstance</span><span class="p">(</span><span class="nb">object</span><span class="o">.</span><span class="n">visible</span><span class="p">,</span> <span class="nb">bool</span><span class="p">)</span>
<span class="go">False</span>
</pre></div>
</div>
<p>However boolean values will behave exactly as you expect them to.</p>
</dd></dl>
<dl class="class">
<dt id="autopilot.introspection.types.Rectangle">
<em class="property">class </em><code class="descclassname">autopilot.introspection.types.</code><code class="descname">Rectangle</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/autopilot/introspection/types.html#Rectangle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#autopilot.introspection.types.Rectangle" title="Permalink to this definition">¶</a></dt>
<dd><p>The RectangleType class represents a rectangle in cartesian space.</p>
<p>To construct a rectangle, pass the x, y, width and height parameters in to
the class constructor:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">my_rect</span> <span class="o">=</span> <span class="n">Rectangle</span><span class="p">(</span><span class="mi">12</span><span class="p">,</span><span class="mi">13</span><span class="p">,</span><span class="mi">100</span><span class="p">,</span><span class="mi">150</span><span class="p">)</span>
</pre></div>
</div>
<p>These attributes can be accessed either using named attributes, or via
sequence indexes:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="go">>>>my_rect = Rectangle(12,13,100,150)</span>
<span class="gp">>>> </span><span class="n">my_rect</span><span class="o">.</span><span class="n">x</span> <span class="o">==</span> <span class="n">my_rect</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="mi">12</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">my_rect</span><span class="o">.</span><span class="n">y</span> <span class="o">==</span> <span class="n">my_rect</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="mi">13</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">my_rect</span><span class="o">.</span><span class="n">w</span> <span class="o">==</span> <span class="n">my_rect</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="o">==</span> <span class="mi">100</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">my_rect</span><span class="o">.</span><span class="n">h</span> <span class="o">==</span> <span class="n">my_rect</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="o">==</span> <span class="mi">150</span>
<span class="go">True</span>
</pre></div>
</div>
<p>You may also access the width and height values using the <code class="docutils literal"><span class="pre">width</span></code> and
<code class="docutils literal"><span class="pre">height</span></code> properties:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">my_rect</span><span class="o">.</span><span class="n">width</span> <span class="o">==</span> <span class="n">my_rect</span><span class="o">.</span><span class="n">w</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">my_rect</span><span class="o">.</span><span class="n">height</span> <span class="o">==</span> <span class="n">my_rect</span><span class="o">.</span><span class="n">h</span>
<span class="go">True</span>
</pre></div>
</div>
<p>Rectangles can be compared using <code class="docutils literal"><span class="pre">==</span></code> and <code class="docutils literal"><span class="pre">!=</span></code>, either to another
Rectangle instance, or to any mutable sequence type:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">my_rect</span> <span class="o">==</span> <span class="p">[</span><span class="mi">12</span><span class="p">,</span> <span class="mi">13</span><span class="p">,</span> <span class="mi">100</span><span class="p">,</span> <span class="mi">150</span><span class="p">]</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">my_rect</span> <span class="o">!=</span> <span class="n">Rectangle</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">,</span><span class="mi">4</span><span class="p">)</span>
<span class="go">True</span>
</pre></div>
</div>
</dd></dl>
<dl class="class">
<dt id="autopilot.introspection.types.Point">
<em class="property">class </em><code class="descclassname">autopilot.introspection.types.</code><code class="descname">Point</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/autopilot/introspection/types.html#Point"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#autopilot.introspection.types.Point" title="Permalink to this definition">¶</a></dt>
<dd><p>The Point class represents a 2D point in cartesian space.</p>
<p>To construct a Point, pass in the x, y parameters to the class
constructor:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">my_point</span> <span class="o">=</span> <span class="n">Point</span><span class="p">(</span><span class="mi">50</span><span class="p">,</span><span class="mi">100</span><span class="p">)</span>
</pre></div>
</div>
<p>These attributes can be accessed either using named attributes, or via
sequence indexes:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">my_point</span><span class="o">.</span><span class="n">x</span> <span class="o">==</span> <span class="n">my_point</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="mi">50</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">my_point</span><span class="o">.</span><span class="n">y</span> <span class="o">==</span> <span class="n">my_point</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="mi">100</span>
<span class="go">True</span>
</pre></div>
</div>
<p>Point instances can be compared using <code class="docutils literal"><span class="pre">==</span></code> and <code class="docutils literal"><span class="pre">!=</span></code>, either to another
Point instance, or to any mutable sequence type with the correct number of
items:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">my_point</span> <span class="o">==</span> <span class="p">[</span><span class="mi">50</span><span class="p">,</span> <span class="mi">100</span><span class="p">]</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">my_point</span> <span class="o">!=</span> <span class="n">Point</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">10</span><span class="p">)</span>
<span class="go">True</span>
</pre></div>
</div>
</dd></dl>
<dl class="class">
<dt id="autopilot.introspection.types.Size">
<em class="property">class </em><code class="descclassname">autopilot.introspection.types.</code><code class="descname">Size</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/autopilot/introspection/types.html#Size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#autopilot.introspection.types.Size" title="Permalink to this definition">¶</a></dt>
<dd><p>The Size class represents a 2D size in cartesian space.</p>
<p>To construct a Size, pass in the width, height parameters to the class
constructor:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">my_size</span> <span class="o">=</span> <span class="n">Size</span><span class="p">(</span><span class="mi">50</span><span class="p">,</span><span class="mi">100</span><span class="p">)</span>
</pre></div>
</div>
<p>These attributes can be accessed either using named attributes, or via
sequence indexes:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">my_size</span><span class="o">.</span><span class="n">width</span> <span class="o">==</span> <span class="n">my_size</span><span class="o">.</span><span class="n">w</span> <span class="o">==</span> <span class="n">my_size</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="mi">50</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">my_size</span><span class="o">.</span><span class="n">height</span> <span class="o">==</span> <span class="n">my_size</span><span class="o">.</span><span class="n">h</span> <span class="o">==</span> <span class="n">my_size</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="mi">100</span>
<span class="go">True</span>
</pre></div>
</div>
<p>Size instances can be compared using <code class="docutils literal"><span class="pre">==</span></code> and <code class="docutils literal"><span class="pre">!=</span></code>, either to another
Size instance, or to any mutable sequence type with the correct number of
items:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">my_size</span> <span class="o">==</span> <span class="p">[</span><span class="mi">50</span><span class="p">,</span> <span class="mi">100</span><span class="p">]</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">my_size</span> <span class="o">!=</span> <span class="n">Size</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">10</span><span class="p">)</span>
<span class="go">True</span>
</pre></div>
</div>
</dd></dl>
<dl class="class">
<dt id="autopilot.introspection.types.DateTime">
<em class="property">class </em><code class="descclassname">autopilot.introspection.types.</code><code class="descname">DateTime</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/autopilot/introspection/types.html#DateTime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#autopilot.introspection.types.DateTime" title="Permalink to this definition">¶</a></dt>
<dd><p>The DateTime class represents a date and time in the UTC timezone.</p>
<p>DateTime is constructed by passing a unix timestamp in to the constructor.
The incoming timestamp is assumed to be in UTC.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>This class expects the passed in timestamp to be in UTC but will
display the resulting date and time in local time (using the local
timezone).</p>
<p class="last">This is done to mimic the behaviour of most applications which will
display date and time in local time by default</p>
</div>
<p>Timestamps are expressed as the number of seconds since 1970-01-01T00:00:00
in the UTC timezone:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">my_dt</span> <span class="o">=</span> <span class="n">DateTime</span><span class="p">(</span><span class="mi">1377209927</span><span class="p">)</span>
</pre></div>
</div>
<p>This timestamp can always be accessed either using index access or via a
named property:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">my_dt</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="n">my_dt</span><span class="o">.</span><span class="n">timestamp</span> <span class="o">==</span> <span class="mi">1377209927</span>
<span class="go">True</span>
</pre></div>
</div>
<p>DateTime objects also expose the usual named properties you would expect on
a date/time object:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">my_dt</span><span class="o">.</span><span class="n">year</span>
<span class="go">2013</span>
<span class="gp">>>> </span><span class="n">my_dt</span><span class="o">.</span><span class="n">month</span>
<span class="go">8</span>
<span class="gp">>>> </span><span class="n">my_dt</span><span class="o">.</span><span class="n">day</span>
<span class="go">22</span>
<span class="gp">>>> </span><span class="n">my_dt</span><span class="o">.</span><span class="n">hour</span>
<span class="go">22</span>
<span class="gp">>>> </span><span class="n">my_dt</span><span class="o">.</span><span class="n">minute</span>
<span class="go">18</span>
<span class="gp">>>> </span><span class="n">my_dt</span><span class="o">.</span><span class="n">second</span>
<span class="go">47</span>
</pre></div>
</div>
<p>Two DateTime objects can be compared for equality:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">my_dt</span> <span class="o">==</span> <span class="n">DateTime</span><span class="p">(</span><span class="mi">1377209927</span><span class="p">)</span>
<span class="go">True</span>
</pre></div>
</div>
<p>You can also compare a DateTime with any mutable sequence type containing
the timestamp (although this probably isn’t very useful for test authors):</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">my_dt</span> <span class="o">==</span> <span class="p">[</span><span class="mi">1377209927</span><span class="p">]</span>
<span class="go">True</span>
</pre></div>
</div>
<p>Finally, you can also compare a DateTime instance with a python datetime
instance:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">my_datetime</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">utcfromtimestamp</span><span class="p">(</span><span class="mi">1377209927</span><span class="p">)</span>
<span class="go">True</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>Autopilot supports dates beyond 2038 on 32-bit platforms. To
achieve this the underlying mechanisms require to work with timezone aware
datetime objects.</p>
<blockquote class="last">
<div><p>This means that the following won’t always be true (due to the naive
timestamp not having the correct daylight-savings time details):</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="c1"># This time stamp is within DST in the 'Europe/London' timezone</span>
<span class="gp">>>> </span><span class="n">dst_ts</span> <span class="o">=</span> <span class="mi">1405382400</span>
<span class="gp">>>> </span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">'TZ'</span><span class="p">]</span> <span class="o">=</span><span class="s1">'Europe/London'</span>
<span class="gp">>>> </span><span class="n">time</span><span class="o">.</span><span class="n">tzset</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">datetime</span><span class="o">.</span><span class="n">fromtimestamp</span><span class="p">(</span><span class="n">dst_ts</span><span class="p">)</span><span class="o">.</span><span class="n">hour</span> <span class="o">==</span> <span class="n">DateTime</span><span class="p">(</span><span class="n">dst_ts</span><span class="p">)</span><span class="o">.</span><span class="n">hour</span>
<span class="go">False</span>
</pre></div>
</div>
<p>But this will work:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">dateutil.tz</span> <span class="kn">import</span> <span class="n">gettz</span>
<span class="gp">>>> </span><span class="n">datetime</span><span class="o">.</span><span class="n">fromtimestamp</span><span class="p">(</span>
<span class="go"> dst_ts, gettz()).hour == DateTime(dst_ts).hour</span>
<span class="go">True</span>
</pre></div>
</div>
<p>And this will always work to:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">dt1</span> <span class="o">=</span> <span class="n">DateTime</span><span class="p">(</span><span class="n">nz_dst_timestamp</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">dt2</span> <span class="o">=</span> <span class="n">datetime</span><span class="p">(</span>
<span class="go"> dt1.year, dt1.month, dt1.day, dt1.hour, dt1.minute, dt1.second</span>
<span class="go"> )</span>
<span class="gp">>>> </span><span class="n">dt1</span> <span class="o">==</span> <span class="n">dt2</span>
<span class="go">True</span>
</pre></div>
</div>
</div></blockquote>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">DateTime.timestamp() will not always equal the passed in
timestamp.
To paraphrase a message from [<a class="reference external" href="http://bugs.python.org/msg229393">http://bugs.python.org/msg229393</a>]
“datetime.timestamp is supposed to be inverse of
datetime.fromtimestamp(), but since the later is not monotonic, no such
inverse exists in the strict mathematical sense.”</p>
</div>
<p>DateTime instances can be converted to datetime instances:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="nb">isinstance</span><span class="p">(</span><span class="n">my_dt</span><span class="o">.</span><span class="n">datetime</span><span class="p">,</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="p">)</span>
<span class="go">True</span>
</pre></div>
</div>
</dd></dl>
<dl class="class">
<dt id="autopilot.introspection.types.Time">
<em class="property">class </em><code class="descclassname">autopilot.introspection.types.</code><code class="descname">Time</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/autopilot/introspection/types.html#Time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#autopilot.introspection.types.Time" title="Permalink to this definition">¶</a></dt>
<dd><p>The Time class represents a time, without a date component.</p>
<p>You can construct a Time instnace by passing the hours, minutes, seconds,
and milliseconds to the class constructor:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">my_time</span> <span class="o">=</span> <span class="n">Time</span><span class="p">(</span><span class="mi">12</span><span class="p">,</span> <span class="mi">34</span><span class="p">,</span> <span class="mo">01</span><span class="p">,</span> <span class="mi">23</span><span class="p">)</span>
</pre></div>
</div>
<p>The values passed in must be valid for their positions (ie..- 0-23 for
hours, 0-59 for minutes and seconds, and 0-999 for milliseconds). Passing
invalid values will cause a ValueError to be raised.</p>
<p>The hours, minutes, seconds, and milliseconds can be accessed using either
index access or named properties:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">my_time</span><span class="o">.</span><span class="n">hours</span> <span class="o">==</span> <span class="n">my_time</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="mi">12</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">my_time</span><span class="o">.</span><span class="n">minutes</span> <span class="o">==</span> <span class="n">my_time</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="mi">34</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">my_time</span><span class="o">.</span><span class="n">seconds</span> <span class="o">==</span> <span class="n">my_time</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="o">==</span> <span class="mo">01</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">my_time</span><span class="o">.</span><span class="n">milliseconds</span> <span class="o">==</span> <span class="n">my_time</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="o">==</span> <span class="mi">23</span>
<span class="go">True</span>
</pre></div>
</div>
<p>Time instances can be compared to other time instances, any mutable
sequence containing four integers, or datetime.time instances:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">my_time</span> <span class="o">==</span> <span class="n">Time</span><span class="p">(</span><span class="mi">12</span><span class="p">,</span> <span class="mi">34</span><span class="p">,</span> <span class="mo">01</span><span class="p">,</span> <span class="mi">23</span><span class="p">)</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">my_time</span> <span class="o">==</span> <span class="n">Time</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">,</span><span class="mi">4</span><span class="p">)</span>
<span class="go">False</span>
<span class="gp">>>> </span><span class="n">my_time</span> <span class="o">==</span> <span class="p">[</span><span class="mi">12</span><span class="p">,</span> <span class="mi">34</span><span class="p">,</span> <span class="mo">01</span><span class="p">,</span> <span class="mi">23</span><span class="p">]</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">my_time</span> <span class="o">==</span> <span class="n">datetime</span><span class="o">.</span><span class="n">time</span><span class="p">(</span><span class="mi">12</span><span class="p">,</span> <span class="mi">34</span><span class="p">,</span> <span class="mo">01</span><span class="p">,</span> <span class="mi">23000</span><span class="p">)</span>
<span class="go">True</span>
</pre></div>
</div>
<p>Note that the Time class stores milliseconds, while the <code class="docutils literal"><span class="pre">datettime.time</span></code>
class stores microseconds.</p>
<p>Finally, you can get a <code class="docutils literal"><span class="pre">datetime.time</span></code> instance from a Time instance:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="nb">isinstance</span><span class="p">(</span><span class="n">my_time</span><span class="o">.</span><span class="n">time</span><span class="p">,</span> <span class="n">datetime</span><span class="o">.</span><span class="n">time</span><span class="p">)</span>
<span class="go">True</span>
</pre></div>
</div>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/otto-64.png" alt="Logo"/>
</a></p>
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#"><code class="docutils literal"><span class="pre">autopilot.introspection.types</span></code> - Introspection Type details</a><ul>
<li><a class="reference internal" href="#autopilot-proxy-type-support">Autopilot proxy type support.</a></li>
</ul>
</li>
</ul>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<h4>Previous topic</h4>
<p class="topless"><a href="autopilot.introspection.html"
title="previous chapter"><code class="docutils literal"><span class="pre">autopilot.introspection</span></code> - Retrieve proxy objects</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="autopilot.matchers.html"
title="next chapter"><code class="docutils literal"><span class="pre">autopilot.matchers</span></code> - Custom matchers for test assertions</a></p>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="autopilot.matchers.html" title="autopilot.matchers - Custom matchers for test assertions"
>next</a> |</li>
<li class="right" >
<a href="autopilot.introspection.html" title="autopilot.introspection - Retrieve proxy objects"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Autopilot 1.5 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" >Autopilot API Documentation</a> »</li>
</ul>
</div>
<div class="footer">
<div class=center_text>
<a href="../faq/contribute.html">Learn how you can contribute!</a> / <a href="https://bugs.launchpad.net/autopilot/+filebug">File a bug</a>
<br/>
</div>
© Copyright 2012-2014, Canonical.
</div>
</body>
</html>
|