/usr/share/doc/python-tango-doc/html/utilities.html is in python-tango-doc 9.2.2-1build1.
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 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 | <!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>The Utilities API — PyTango 9.2.2 documentation</title>
<link rel="stylesheet" href="_static/pytango.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '9.2.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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/logo.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Exception API" href="exception.html" />
<link rel="prev" title="Encoded API" href="encoded.html" />
</head>
<body>
<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="exception.html" title="Exception API"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="encoded.html" title="Encoded API"
accesskey="P">previous</a> |</li>
<li><a href="index.html">home</a>| </li>
<li><a href="start.html">getting started</a>| </li>
<li><a href="quicktour.html">quick tour</a>| </li>
<li><a href="howto.html">how to</a>| </li>
<li><a href="faq.html">FAQ</a>| </li>
<li><a href="contents.html">documentation (v9.2.2)</a> »</li>
<li class="nav-item nav-item-1"><a href="api.html" accesskey="U">PyTango API</a> »</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="contents.html">
<img class="logo" src="_static/logo.png" alt="Logo"/>
</a></p>
<h4>Previous topic</h4>
<p class="topless"><a href="encoded.html"
title="previous chapter">Encoded API</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="exception.html"
title="next chapter">Exception API</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/utilities.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="the-utilities-api">
<span id="utilities"></span><h1>The Utilities API<a class="headerlink" href="#the-utilities-api" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="tango.utils.EventCallback">
<em class="property">class </em><code class="descclassname">tango.utils.</code><code class="descname">EventCallback</code><span class="sig-paren">(</span><em>format='{date} {dev_name} {name} {type} {value}'</em>, <em>fd=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='UTF-8'></em>, <em>max_buf=100</em><span class="sig-paren">)</span><a class="headerlink" href="#tango.utils.EventCallback" title="Permalink to this definition">¶</a></dt>
<dd><p>Useful event callback for test purposes</p>
<p>Usage:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">dev</span> <span class="o">=</span> <span class="n">tango</span><span class="o">.</span><span class="n">DeviceProxy</span><span class="p">(</span><span class="n">dev_name</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">cb</span> <span class="o">=</span> <span class="n">tango</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">EventCallback</span><span class="p">()</span>
<span class="gp">>>> </span><span class="nb">id</span> <span class="o">=</span> <span class="n">dev</span><span class="o">.</span><span class="n">subscribe_event</span><span class="p">(</span><span class="s2">"state"</span><span class="p">,</span> <span class="n">tango</span><span class="o">.</span><span class="n">EventType</span><span class="o">.</span><span class="n">CHANGE_EVENT</span><span class="p">,</span> <span class="n">cb</span><span class="p">,</span> <span class="p">[])</span>
<span class="go">2011-04-06 15:33:18.910474 sys/tg_test/1 STATE CHANGE [ATTR_VALID] ON</span>
</pre></div>
</div>
<p>Allowed format keys are:</p>
<blockquote>
<div><ul class="simple">
<li>date (event timestamp)</li>
<li>reception_date (event reception timestamp)</li>
<li>type (event type)</li>
<li>dev_name (device name)</li>
<li>name (attribute name)</li>
<li>value (event value)</li>
</ul>
</div></blockquote>
<p>New in PyTango 7.1.4</p>
<dl class="method">
<dt id="tango.utils.EventCallback.get_events">
<code class="descname">get_events</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tango.utils.EventCallback.get_events" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the list of events received by this callback</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the list of events received by this callback</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">sequence<obj></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="tango.utils.EventCallback.push_event">
<code class="descname">push_event</code><span class="sig-paren">(</span><em>evt</em><span class="sig-paren">)</span><a class="headerlink" href="#tango.utils.EventCallback.push_event" title="Permalink to this definition">¶</a></dt>
<dd><p>Internal usage only</p>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="tango.utils.is_pure_str">
<code class="descclassname">tango.utils.</code><code class="descname">is_pure_str</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#tango.utils.is_pure_str" title="Permalink to this definition">¶</a></dt>
<dd><p>Tells if the given object is a python string.</p>
<p>In python 2.x this means any subclass of basestring.
In python 3.x this means any subclass of str.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>obj</strong> (<code class="xref py py-obj docutils literal"><span class="pre">object</span></code>) – the object to be inspected</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True is the given obj is a string or False otherwise</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">bool</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="tango.utils.is_seq">
<code class="descclassname">tango.utils.</code><code class="descname">is_seq</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#tango.utils.is_seq" title="Permalink to this definition">¶</a></dt>
<dd><p>Tells if the given object is a python sequence.</p>
<p>It will return True for any collections.Sequence (list, tuple,
str, bytes, unicode), bytearray and (if numpy is enabled)
numpy.ndarray</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>obj</strong> (<code class="xref py py-obj docutils literal"><span class="pre">object</span></code>) – the object to be inspected</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True is the given obj is a sequence or False otherwise</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">bool</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="tango.utils.is_non_str_seq">
<code class="descclassname">tango.utils.</code><code class="descname">is_non_str_seq</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#tango.utils.is_non_str_seq" title="Permalink to this definition">¶</a></dt>
<dd><p>Tells if the given object is a python sequence (excluding string
sequences).</p>
<p>It will return True for any collections.Sequence (list, tuple (and
bytes in python3)), bytearray and (if numpy is enabled)
numpy.ndarray</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>obj</strong> (<code class="xref py py-obj docutils literal"><span class="pre">object</span></code>) – the object to be inspected</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True is the given obj is a sequence or False otherwise</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">bool</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="tango.utils.is_integer">
<code class="descclassname">tango.utils.</code><code class="descname">is_integer</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#tango.utils.is_integer" title="Permalink to this definition">¶</a></dt>
<dd><p>Tells if the given object is a python integer.</p>
<p>It will return True for any int, long (in python 2) and
(if numpy is enabled) numpy.integer</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>obj</strong> (<code class="xref py py-obj docutils literal"><span class="pre">object</span></code>) – the object to be inspected</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True is the given obj is a python integer or False otherwise</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">bool</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="tango.utils.is_number">
<code class="descclassname">tango.utils.</code><code class="descname">is_number</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#tango.utils.is_number" title="Permalink to this definition">¶</a></dt>
<dd><p>Tells if the given object is a python number.</p>
<p>It will return True for any numbers.Number and (if numpy is
enabled) numpy.number</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>obj</strong> (<code class="xref py py-obj docutils literal"><span class="pre">object</span></code>) – the object to be inspected</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True is the given obj is a python number or False otherwise</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">bool</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="tango.utils.is_bool">
<code class="descclassname">tango.utils.</code><code class="descname">is_bool</code><span class="sig-paren">(</span><em>tg_type</em>, <em>inc_array=False</em><span class="sig-paren">)</span><a class="headerlink" href="#tango.utils.is_bool" title="Permalink to this definition">¶</a></dt>
<dd><p>Tells if the given tango type is boolean</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>tg_type</strong> (<a class="reference internal" href="client_api/other.html#tango.CmdArgType" title="tango.CmdArgType"><code class="xref py py-class docutils literal"><span class="pre">tango.CmdArgType</span></code></a>) – tango type</li>
<li><strong>inc_array</strong> (<code class="xref py py-obj docutils literal"><span class="pre">bool</span></code>) – (optional, default is False) determines if include array
in the list of checked types</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the given tango type is boolean or False otherwise</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal"><span class="pre">bool</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="tango.utils.is_scalar_type">
<code class="descclassname">tango.utils.</code><code class="descname">is_scalar_type</code><span class="sig-paren">(</span><em>tg_type</em><span class="sig-paren">)</span><a class="headerlink" href="#tango.utils.is_scalar_type" title="Permalink to this definition">¶</a></dt>
<dd><p>Tells if the given tango type is a scalar</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>tg_type</strong> (<a class="reference internal" href="client_api/other.html#tango.CmdArgType" title="tango.CmdArgType"><code class="xref py py-class docutils literal"><span class="pre">tango.CmdArgType</span></code></a>) – tango type</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the given tango type is a scalar or False otherwise</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">bool</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="tango.utils.is_array_type">
<code class="descclassname">tango.utils.</code><code class="descname">is_array_type</code><span class="sig-paren">(</span><em>tg_type</em><span class="sig-paren">)</span><a class="headerlink" href="#tango.utils.is_array_type" title="Permalink to this definition">¶</a></dt>
<dd><p>Tells if the given tango type is an array type</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>tg_type</strong> (<a class="reference internal" href="client_api/other.html#tango.CmdArgType" title="tango.CmdArgType"><code class="xref py py-class docutils literal"><span class="pre">tango.CmdArgType</span></code></a>) – tango type</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the given tango type is an array type or False otherwise</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">bool</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="tango.utils.is_numerical_type">
<code class="descclassname">tango.utils.</code><code class="descname">is_numerical_type</code><span class="sig-paren">(</span><em>tg_type</em>, <em>inc_array=False</em><span class="sig-paren">)</span><a class="headerlink" href="#tango.utils.is_numerical_type" title="Permalink to this definition">¶</a></dt>
<dd><p>Tells if the given tango type is numerical</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>tg_type</strong> (<a class="reference internal" href="client_api/other.html#tango.CmdArgType" title="tango.CmdArgType"><code class="xref py py-class docutils literal"><span class="pre">tango.CmdArgType</span></code></a>) – tango type</li>
<li><strong>inc_array</strong> (<code class="xref py py-obj docutils literal"><span class="pre">bool</span></code>) – (optional, default is False) determines if include array
in the list of checked types</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the given tango type is a numerical or False otherwise</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal"><span class="pre">bool</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="tango.utils.is_int_type">
<code class="descclassname">tango.utils.</code><code class="descname">is_int_type</code><span class="sig-paren">(</span><em>tg_type</em>, <em>inc_array=False</em><span class="sig-paren">)</span><a class="headerlink" href="#tango.utils.is_int_type" title="Permalink to this definition">¶</a></dt>
<dd><p>Tells if the given tango type is integer</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>tg_type</strong> (<a class="reference internal" href="client_api/other.html#tango.CmdArgType" title="tango.CmdArgType"><code class="xref py py-class docutils literal"><span class="pre">tango.CmdArgType</span></code></a>) – tango type</li>
<li><strong>inc_array</strong> (<code class="xref py py-obj docutils literal"><span class="pre">bool</span></code>) – (optional, default is False) determines if include array
in the list of checked types</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the given tango type is integer or False otherwise</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal"><span class="pre">bool</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="tango.utils.is_float_type">
<code class="descclassname">tango.utils.</code><code class="descname">is_float_type</code><span class="sig-paren">(</span><em>tg_type</em>, <em>inc_array=False</em><span class="sig-paren">)</span><a class="headerlink" href="#tango.utils.is_float_type" title="Permalink to this definition">¶</a></dt>
<dd><p>Tells if the given tango type is float</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>tg_type</strong> (<a class="reference internal" href="client_api/other.html#tango.CmdArgType" title="tango.CmdArgType"><code class="xref py py-class docutils literal"><span class="pre">tango.CmdArgType</span></code></a>) – tango type</li>
<li><strong>inc_array</strong> (<code class="xref py py-obj docutils literal"><span class="pre">bool</span></code>) – (optional, default is False) determines if include array
in the list of checked types</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the given tango type is float or False otherwise</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal"><span class="pre">bool</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="tango.utils.is_bool_type">
<code class="descclassname">tango.utils.</code><code class="descname">is_bool_type</code><span class="sig-paren">(</span><em>tg_type</em>, <em>inc_array=False</em><span class="sig-paren">)</span><a class="headerlink" href="#tango.utils.is_bool_type" title="Permalink to this definition">¶</a></dt>
<dd><p>Tells if the given tango type is boolean</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>tg_type</strong> (<a class="reference internal" href="client_api/other.html#tango.CmdArgType" title="tango.CmdArgType"><code class="xref py py-class docutils literal"><span class="pre">tango.CmdArgType</span></code></a>) – tango type</li>
<li><strong>inc_array</strong> (<code class="xref py py-obj docutils literal"><span class="pre">bool</span></code>) – (optional, default is False) determines if include array
in the list of checked types</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the given tango type is boolean or False otherwise</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal"><span class="pre">bool</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="tango.utils.is_binary_type">
<code class="descclassname">tango.utils.</code><code class="descname">is_binary_type</code><span class="sig-paren">(</span><em>tg_type</em>, <em>inc_array=False</em><span class="sig-paren">)</span><a class="headerlink" href="#tango.utils.is_binary_type" title="Permalink to this definition">¶</a></dt>
<dd><p>Tells if the given tango type is binary</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>tg_type</strong> (<a class="reference internal" href="client_api/other.html#tango.CmdArgType" title="tango.CmdArgType"><code class="xref py py-class docutils literal"><span class="pre">tango.CmdArgType</span></code></a>) – tango type</li>
<li><strong>inc_array</strong> (<code class="xref py py-obj docutils literal"><span class="pre">bool</span></code>) – (optional, default is False) determines if include array
in the list of checked types</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the given tango type is binary or False otherwise</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal"><span class="pre">bool</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="tango.utils.is_str_type">
<code class="descclassname">tango.utils.</code><code class="descname">is_str_type</code><span class="sig-paren">(</span><em>tg_type</em>, <em>inc_array=False</em><span class="sig-paren">)</span><a class="headerlink" href="#tango.utils.is_str_type" title="Permalink to this definition">¶</a></dt>
<dd><p>Tells if the given tango type is string</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>tg_type</strong> (<a class="reference internal" href="client_api/other.html#tango.CmdArgType" title="tango.CmdArgType"><code class="xref py py-class docutils literal"><span class="pre">tango.CmdArgType</span></code></a>) – tango type</li>
<li><strong>inc_array</strong> (<code class="xref py py-obj docutils literal"><span class="pre">bool</span></code>) – (optional, default is False) determines if include array
in the list of checked types</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the given tango type is string or False otherwise</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal"><span class="pre">bool</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="tango.utils.obj_2_str">
<code class="descclassname">tango.utils.</code><code class="descname">obj_2_str</code><span class="sig-paren">(</span><em>obj</em>, <em>tg_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#tango.utils.obj_2_str" title="Permalink to this definition">¶</a></dt>
<dd><p>Converts a python object into a string according to the given tango type</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>obj</strong> (<code class="xref py py-obj docutils literal"><span class="pre">object</span></code>) – the object to be converted</li>
<li><strong>tg_type</strong> (<a class="reference internal" href="client_api/other.html#tango.CmdArgType" title="tango.CmdArgType"><code class="xref py py-class docutils literal"><span class="pre">tango.CmdArgType</span></code></a>) – tango type</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">a string representation of the given object</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal"><span class="pre">str</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="tango.utils.seqStr_2_obj">
<code class="descclassname">tango.utils.</code><code class="descname">seqStr_2_obj</code><span class="sig-paren">(</span><em>seq</em>, <em>tg_type</em>, <em>tg_format=None</em><span class="sig-paren">)</span><a class="headerlink" href="#tango.utils.seqStr_2_obj" title="Permalink to this definition">¶</a></dt>
<dd><p>Translates a sequence<str> to a sequence of objects of give type and format</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>seq</strong> (<em>sequence<str></em>) – the sequence</li>
<li><strong>tg_type</strong> (<a class="reference internal" href="client_api/other.html#tango.CmdArgType" title="tango.CmdArgType"><code class="xref py py-class docutils literal"><span class="pre">tango.CmdArgType</span></code></a>) – tango type</li>
<li><strong>tg_format</strong> (<a class="reference internal" href="client_api/other.html#tango.AttrDataFormat" title="tango.AttrDataFormat"><code class="xref py py-class docutils literal"><span class="pre">tango.AttrDataFormat</span></code></a>) – (optional, default is None, meaning SCALAR) tango format</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a new sequence</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="tango.utils.scalar_to_array_type">
<code class="descclassname">tango.utils.</code><code class="descname">scalar_to_array_type</code><span class="sig-paren">(</span><em>tg_type</em><span class="sig-paren">)</span><a class="headerlink" href="#tango.utils.scalar_to_array_type" title="Permalink to this definition">¶</a></dt>
<dd><p>Gives the array tango type corresponding to the given tango
scalar type. Example: giving DevLong will return DevVarLongArray.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>tg_type</strong> (<a class="reference internal" href="client_api/other.html#tango.CmdArgType" title="tango.CmdArgType"><code class="xref py py-class docutils literal"><span class="pre">tango.CmdArgType</span></code></a>) – tango type</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the array tango type for the given scalar tango type</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="client_api/other.html#tango.CmdArgType" title="tango.CmdArgType"><code class="xref py py-class docutils literal"><span class="pre">tango.CmdArgType</span></code></a></td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><strong>ValueError</strong> – in case the given dtype is not a tango scalar type</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="tango.utils.get_home">
<code class="descclassname">tango.utils.</code><code class="descname">get_home</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#tango.utils.get_home" title="Permalink to this definition">¶</a></dt>
<dd><p>Find user’s home directory if possible. Otherwise raise error.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">user’s home directory</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal"><span class="pre">str</span></code></td>
</tr>
</tbody>
</table>
<p>New in PyTango 7.1.4</p>
</dd></dl>
<dl class="function">
<dt id="tango.utils.requires_pytango">
<code class="descclassname">tango.utils.</code><code class="descname">requires_pytango</code><span class="sig-paren">(</span><em>min_version=None</em>, <em>conflicts=()</em>, <em>software_name='Software'</em><span class="sig-paren">)</span><a class="headerlink" href="#tango.utils.requires_pytango" title="Permalink to this definition">¶</a></dt>
<dd><p>Determines if the required PyTango version for the running
software is present. If not an exception is thrown.
Example usage:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">tango</span> <span class="k">import</span> <span class="n">requires_pytango</span>
<span class="n">requires_pytango</span><span class="p">(</span><span class="s1">'7.1'</span><span class="p">,</span> <span class="n">conflicts</span><span class="o">=</span><span class="p">[</span><span class="s1">'8.1.1'</span><span class="p">],</span> <span class="n">software</span><span class="o">=</span><span class="s1">'MyDS'</span><span class="p">)</span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>min_version</strong> (None, str, <code class="xref py py-class docutils literal"><span class="pre">LooseVersion</span></code>) – minimum PyTango version [default: None, meaning no minimum
required]. If a string is given, it must be in the valid
version number format
(see: <code class="xref py py-class docutils literal"><span class="pre">LooseVersion</span></code>)</li>
<li><strong>conflics</strong> (<em>seq<str|LooseVersion></em>) – a sequence of PyTango versions which conflict with the
software using it</li>
<li><strong>software_name</strong> (<em>str</em>) – software name using tango. Used in the exception message</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><strong>Exception</strong> – if the required PyTango version is not met</p>
</td>
</tr>
</tbody>
</table>
<p>New in PyTango 8.1.4</p>
</dd></dl>
<dl class="function">
<dt id="tango.utils.requires_tango">
<code class="descclassname">tango.utils.</code><code class="descname">requires_tango</code><span class="sig-paren">(</span><em>min_version=None</em>, <em>conflicts=()</em>, <em>software_name='Software'</em><span class="sig-paren">)</span><a class="headerlink" href="#tango.utils.requires_tango" title="Permalink to this definition">¶</a></dt>
<dd><p>Determines if the required Tango version for the running
software is present. If not an exception is thrown.
Example usage:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">tango</span> <span class="k">import</span> <span class="n">requires_tango</span>
<span class="n">requires_tango</span><span class="p">(</span><span class="s1">'7.1'</span><span class="p">,</span> <span class="n">conflicts</span><span class="o">=</span><span class="p">[</span><span class="s1">'8.1.1'</span><span class="p">],</span> <span class="n">software</span><span class="o">=</span><span class="s1">'MyDS'</span><span class="p">)</span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>min_version</strong> (None, str, <code class="xref py py-class docutils literal"><span class="pre">LooseVersion</span></code>) – minimum Tango version [default: None, meaning no minimum
required]. If a string is given, it must be in the valid
version number format
(see: <code class="xref py py-class docutils literal"><span class="pre">LooseVersion</span></code>)</li>
<li><strong>conflics</strong> (<em>seq<str|LooseVersion></em>) – a sequence of Tango versions which conflict with the
software using it</li>
<li><strong>software_name</strong> (<em>str</em>) – software name using Tango. Used in the exception message</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><strong>Exception</strong> – if the required Tango version is not met</p>
</td>
</tr>
</tbody>
</table>
<p>New in PyTango 8.1.4</p>
</dd></dl>
</div>
</div>
</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="exception.html" title="Exception API"
>next</a> |</li>
<li class="right" >
<a href="encoded.html" title="Encoded API"
>previous</a> |</li>
<li><a href="index.html">home</a>| </li>
<li><a href="start.html">getting started</a>| </li>
<li><a href="quicktour.html">quick tour</a>| </li>
<li><a href="howto.html">how to</a>| </li>
<li><a href="faq.html">FAQ</a>| </li>
<li><a href="contents.html">documentation (v9.2.2)</a> »</li>
<li class="nav-item nav-item-1"><a href="api.html" >PyTango API</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright Except where otherwise noted, content on this site is
licensed under a Creative Commons Attribution 3.0 License.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
</div>
</body>
</html>
|