/usr/lib/python2.7/dist-packages/PyTango/pyutil.py is in python-pytango 8.1.1-1build3.
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 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 | # ------------------------------------------------------------------------------
# This file is part of PyTango (http://www.tinyurl.com/PyTango)
#
# Copyright 2006-2012 CELLS / ALBA Synchrotron, Bellaterra, Spain
# Copyright 2013-2014 European Synchrotron Radiation Facility, Grenoble, France
#
# Distributed under the terms of the GNU Lesser General Public License,
# either version 3 of the License, or (at your option) any later version.
# See LICENSE.txt for more info.
# ------------------------------------------------------------------------------
"""
This is an internal PyTango module.
"""
__all__ = [ "Util", "pyutil_init" ]
__docformat__ = "restructuredtext"
import os
import copy
from ._PyTango import _Util, Except, DevFailed, DbDevInfo
from .utils import document_method as __document_method
#from utils import document_static_method as __document_static_method
from .globals import class_list, cpp_class_list, get_constructed_classes
import collections
def __simplify_device_name(dev_name):
if dev_name.startswith("tango://"):
dev_name = dev_name[8:]
if dev_name.count("/") > 2:
dev_name = dev_name[dev_name.index("/")+1:]
return dev_name.lower()
#
# Methods on Util
#
def __Util__get_class_list(self):
"""
get_class_list(self) -> seq<DeviceClass>
Returns a list of objects of inheriting from DeviceClass
Parameters : None
Return : (seq<DeviceClass>) a list of objects of inheriting from DeviceClass"""
return get_constructed_classes()
def __Util__create_device(self, klass_name, device_name, alias=None, cb=None):
"""
create_device(self, klass_name, device_name, alias=None, cb=None) -> None
Creates a new device of the given class in the database, creates a new
DeviceImpl for it and calls init_device (just like it is done for
existing devices when the DS starts up)
An optional parameter callback is called AFTER the device is
registered in the database and BEFORE the init_device for the
newly created device is called
Throws PyTango.DevFailed:
- the device name exists already or
- the given class is not registered for this DS.
- the cb is not a callable
New in PyTango 7.1.2
Parameters :
- klass_name : (str) the device class name
- device_name : (str) the device name
- alias : (str) optional alias. Default value is None meaning do not create device alias
- cb : (callable) a callback that is called AFTER the device is registered
in the database and BEFORE the init_device for the newly created
device is called. Typically you may want to put device and/or attribute
properties in the database here. The callback must receive a parameter:
device name (str). Default value is None meaning no callback
Return : None"""
if cb is not None and not isinstance(cb, collections.Callable):
Except.throw_exception("PyAPI_InvalidParameter",
"The optional cb parameter must be a python callable",
"Util.create_device")
db = self.get_database()
device_name = __simplify_device_name(device_name)
device_exists = True
try:
db.import_device(device_name)
except DevFailed as df:
device_exists = not df[0].reason == "DB_DeviceNotDefined"
# 1 - Make sure device name doesn't exist already in the database
if device_exists:
Except.throw_exception("PyAPI_DeviceAlreadyDefined",
"The device %s is already defined in the database" % device_name,
"Util.create_device")
# 2 - Make sure the device class is known
klass_list = self.get_class_list()
klass = None
for k in klass_list:
name = k.get_name()
if name == klass_name:
klass = k
break
if klass is None:
Except.throw_exception("PyAPI_UnknownDeviceClass",
"The device class %s could not be found" % klass_name,
"Util.create_device")
# 3 - Create entry in the database (with alias if necessary)
dev_info = DbDevInfo()
dev_info.name = device_name
dev_info._class = klass_name
dev_info.server = self.get_ds_name()
db.add_device(dev_info)
if alias is not None:
db.put_device_alias(device_name, alias)
# from this point on, if anything wrong happens we need to clean the database
try:
# 4 - run the callback which tipically is used to initialize
# device and/or attribute properties in the database
if cb is not None:
cb(device_name)
# 5 - Initialize device object on this server
k.device_factory([device_name])
except:
try:
if alias is not None:
db.delete_device_alias(alias)
except:
pass
db.delete_device(device_name)
def __Util__delete_device(self, klass_name, device_name):
"""
delete_device(self, klass_name, device_name) -> None
Deletes an existing device from the database and from this running
server
Throws PyTango.DevFailed:
- the device name doesn't exist in the database
- the device name doesn't exist in this DS.
New in PyTango 7.1.2
Parameters :
- klass_name : (str) the device class name
- device_name : (str) the device name
Return : None"""
db = self.get_database()
device_name = __simplify_device_name(device_name)
device_exists = True
try:
db.import_device(device_name)
except DevFailed as df:
device_exists = not df[0].reason == "DB_DeviceNotDefined"
# 1 - Make sure device name exists in the database
if not device_exists:
Except.throw_exception("PyAPI_DeviceNotDefined",
"The device %s is not defined in the database" % device_name,
"Util.delete_device")
# 2 - Make sure device name is defined in this server
class_device_name = "%s::%s" % (klass_name, device_name)
ds = self.get_dserver_device()
dev_names = ds.query_device()
device_exists = False
for dev_name in dev_names:
p = dev_name.index("::")
dev_name = dev_name[:p] + dev_name[p:].lower()
if dev_name == class_device_name:
device_exists =True
break
if not device_exists:
Except.throw_exception("PyAPI_DeviceNotDefinedInServer",
"The device %s is not defined in this server" % class_device_name,
"Util.delete_device")
db.delete_device(device_name)
dimpl = self.get_device_by_name(device_name)
dc = dimpl.get_device_class()
dc.device_destroyer(device_name)
def __Util__server_set_event_loop(self, event_loop):
self._server_event_loop = event_loop
self._server_set_event_loop()
class Util(_Util):
"""
This class is a used to store TANGO device server process data and to
provide the user with a set of utilities method.
This class is implemented using the singleton design pattern.
Therefore a device server process can have only one instance of this
class and its constructor is not public. Example::
util = PyTango.Util.instance()
print(util.get_host_name())"""
def __init__(self, args):
args = copy.copy(args)
args[0] = os.path.splitext(args[0])[0]
_Util.init(args)
_Util.init_python()
def add_TgClass(self, klass_device_class, klass_device, device_class_name=None):
"""Register a new python tango class. Example::
util.add_TgClass(MotorClass, Motor)
util.add_TgClass(MotorClass, Motor, 'Motor') # equivalent to previous line
.. deprecated:: 7.1.2
Use :meth:`PyTango.Util.add_class` instead."""
if device_class_name is None:
device_class_name = klass_device.__name__
class_list.append((klass_device_class, klass_device, device_class_name))
def add_Cpp_TgClass(self, device_class_name, tango_device_class_name):
"""Register a new C++ tango class.
If there is a shared library file called MotorClass.so which
contains a MotorClass class and a _create_MotorClass_class method. Example::
util.add_Cpp_TgClass('MotorClass', 'Motor')
.. note:: the parameter 'device_class_name' must match the shared
library name.
.. deprecated:: 7.1.2
Use :meth:`PyTango.Util.add_class` instead."""
cpp_class_list.append((device_class_name, tango_device_class_name))
def add_class(self, *args, **kwargs):
"""
add_class(self, args, language="python") -> None
Register a new tango class ('python' or 'c++').
If language is 'python' then args must be the same as
:meth:`PyTango.Util.add_TgClass`. Otherwise, args should be the ones
in :meth:`PyTango.Util.add_Cpp_TgClass`. Example::
util.add_class(MotorClass, Motor)
util.add_class('CounterClass', 'Counter', language='c++')
New in PyTango 7.1.2"""
language = kwargs.get("language", "python")
f = self.add_TgClass
if language != "python":
f = f = self.add_Cpp_TgClass
return f(*args)
def __init_Util():
_Util.get_class_list = __Util__get_class_list
_Util.create_device = __Util__create_device
_Util.delete_device = __Util__delete_device
def __doc_Util():
def document_method(method_name, desc, append=True):
return __document_method(Util, method_name, desc, append)
# def document_static_method(method_name, desc, append=True):
# return __document_static_method(_Util, method_name, desc, append)
# document_static_method("instance", """
# instance(exit = True) -> Util
#
# Static method that gets the singleton object reference.
# If the class has not been initialised with it's init method,
# this method prints a message and aborts the device server process
#
# Parameters :
# - exit : (bool)
#
# Return : (Util) the tango Util object
# """ )
document_method("set_trace_level", """
set_trace_level(self, level) -> None
Set the process trace level.
Parameters :
- level : (int) the new process level
Return : None
""" )
document_method("get_trace_level", """
get_trace_level(self) -> int
Get the process trace level.
Parameters : None
Return : (int) the process trace level.
""" )
document_method("get_ds_inst_name", """
get_ds_inst_name(self) -> str
Get a COPY of the device server instance name.
Parameters : None
Return : (str) a COPY of the device server instance name.
New in PyTango 3.0.4
""" )
document_method("get_ds_exec_name", """
get_ds_exec_name(self) -> str
Get a COPY of the device server executable name.
Parameters : None
Return : (str) a COPY of the device server executable name.
New in PyTango 3.0.4
""" )
document_method("get_ds_name", """
get_ds_name(self) -> str
Get the device server name.
The device server name is the <device server executable name>/<the device server instance name>
Parameters : None
Return : (str) device server name
New in PyTango 3.0.4
""" )
document_method("get_host_name", """
get_host_name(self) -> str
Get the host name where the device server process is running.
Parameters : None
Return : (str) the host name where the device server process is running
New in PyTango 3.0.4
""" )
document_method("get_pid_str", """
get_pid_str(self) -> str
Get the device server process identifier as a string.
Parameters : None
Return : (str) the device server process identifier as a string
New in PyTango 3.0.4
""" )
document_method("get_pid", """
get_pid(self) -> TangoSys_Pid
Get the device server process identifier.
Parameters : None
Return : (int) the device server process identifier
""" )
document_method("get_tango_lib_release", """
get_tango_lib_release(self) -> int
Get the TANGO library version number.
Parameters : None
Return : (int) The Tango library release number coded in
3 digits (for instance 550,551,552,600,....)
""" )
document_method("get_version_str", """
get_version_str(self) -> str
Get the IDL TANGO version.
Parameters : None
Return : (str) the IDL TANGO version.
New in PyTango 3.0.4
""" )
document_method("get_server_version", """
get_server_version(self) -> str
Get the device server version.
Parameters : None
Return : (str) the device server version.
""" )
document_method("set_server_version", """
set_server_version(self, vers) -> None
Set the device server version.
Parameters :
- vers : (str) the device server version
Return : None
""" )
document_method("set_serial_model", """
set_serial_model(self, ser) -> None
Set the serialization model.
Parameters :
- ser : (SerialModel) the new serialization model. The serialization model must
be one of BY_DEVICE, BY_CLASS, BY_PROCESS or NO_SYNC
Return : None
""" )
document_method("get_serial_model", """
get_serial_model(self) ->SerialModel
Get the serialization model.
Parameters : None
Return : (SerialModel) the serialization model
""" )
document_method("connect_db", """
connect_db(self) -> None
Connect the process to the TANGO database.
If the connection to the database failed, a message is
displayed on the screen and the process is aborted
Parameters : None
Return : None
""" )
document_method("reset_filedatabase", """
reset_filedatabase(self) -> None
Reread the file database.
Parameters : None
Return : None
""" )
document_method("unregister_server", """
unregister_server(self) -> None
Unregister a device server process from the TANGO database.
Parameters : None
Return : None
""" )
document_method("get_dserver_device", """
get_dserver_device(self) -> DServer
Get a reference to the dserver device attached to the device server process.
Parameters : None
Return : (DServer) the dserver device attached to the device server process
New in PyTango 7.0.0
""" )
document_method("server_init", """
server_init(self, with_window = False) -> None
Initialize all the device server pattern(s) embedded in a device server process.
Parameters :
- with_window : (bool) default value is False
Return : None
Throws : DevFailed If the device pattern initialistaion failed
""" )
document_method("server_run", """
server_run(self) -> None
Run the CORBA event loop.
This method runs the CORBA event loop. For UNIX or Linux operating system,
this method does not return. For Windows in a non-console mode, this method
start a thread which enter the CORBA event loop.
Parameters : None
Return : None
""" )
document_method("trigger_cmd_polling", """
trigger_cmd_polling(self, dev, name) -> None
Trigger polling for polled command.
This method send the order to the polling thread to poll one object registered
with an update period defined as "externally triggerred"
Parameters :
- dev : (DeviceImpl) the TANGO device
- name : (str) the command name which must be polled
Return : None
Throws : DevFailed If the call failed
""" )
document_method("trigger_attr_polling", """
trigger_attr_polling(self, dev, name) -> None
Trigger polling for polled attribute.
This method send the order to the polling thread to poll one object registered
with an update period defined as "externally triggerred"
Parameters :
- dev : (DeviceImpl) the TANGO device
- name : (str) the attribute name which must be polled
Return : None
""" )
document_method("set_polling_threads_pool_size", """
set_polling_threads_pool_size(self, thread_nb) -> None
Set the polling threads pool size.
Parameters :
- thread_nb : (int) the maximun number of threads in the polling threads pool
Return : None
New in PyTango 7.0.0
""" )
document_method("get_polling_threads_pool_size", """
get_polling_threads_pool_size(self) -> int
Get the polling threads pool size.
Parameters : None
Return : (int) the maximun number of threads in the polling threads pool
""" )
document_method("is_svr_starting", """
is_svr_starting(self) -> bool
Check if the device server process is in its starting phase
Parameters : None
Return : (bool) True if the server is in its starting phase
New in PyTango 8.0.0
""" )
document_method("is_svr_shutting_down", """
is_svr_shutting_down(self) -> bool
Check if the device server process is in its shutting down sequence
Parameters : None
Return : (bool) True if the server is in its shutting down phase.
New in PyTango 8.0.0
""" )
document_method("is_device_restarting", """
is_device_restarting(self, (str)dev_name) -> bool
Check if the device is actually restarted by the device server
process admin device with its DevRestart command
Parameters :
dev_name : (str) device name
Return : (bool) True if the device is restarting.
New in PyTango 8.0.0
""" )
document_method("get_sub_dev_diag", """
get_sub_dev_diag(self) -> SubDevDiag
Get the internal sub device manager
Parameters : None
Return : (SubDevDiag) the sub device manager
New in PyTango 7.0.0
""" )
document_method("reset_filedatabase", """
reset_filedatabase(self) -> None
Reread the file database
Parameters : None
Return : None
New in PyTango 7.0.0
""" )
document_method("get_database", """
get_database(self) -> Database
Get a reference to the TANGO database object
Parameters : None
Return : (Database) the database
New in PyTango 7.0.0
""" )
document_method("unregister_server", """
unregister_server(self) -> None
Unregister a device server process from the TANGO database.
If the database call fails, a message is displayed on the screen
and the process is aborted
Parameters : None
Return : None
New in PyTango 7.0.0
""" )
document_method("get_device_list_by_class", """
get_device_list_by_class(self, class_name) -> sequence<DeviceImpl>
Get the list of device references for a given TANGO class.
Return the list of references for all devices served by one implementation
of the TANGO device pattern implemented in the process.
Parameters :
- class_name : (str) The TANGO device class name
Return : (sequence<DeviceImpl>) The device reference list
New in PyTango 7.0.0
""" )
document_method("get_device_by_name", """
get_device_by_name(self, dev_name) -> DeviceImpl
Get a device reference from its name
Parameters :
- dev_name : (str) The TANGO device name
Return : (DeviceImpl) The device reference
New in PyTango 7.0.0
""" )
document_method("get_dserver_device", """
get_dserver_device(self) -> DServer
Get a reference to the dserver device attached to the device server process
Parameters : None
Return : (DServer) A reference to the dserver device
New in PyTango 7.0.0
""" )
document_method("get_device_list", """
get_device_list(self) -> sequence<DeviceImpl>
Get device list from name.
It is possible to use a wild card ('*') in the name parameter
(e.g. "*", "/tango/tangotest/n*", ...)
Parameters : None
Return : (sequence<DeviceImpl>) the list of device objects
New in PyTango 7.0.0
""" )
document_method("server_set_event_loop", """
server_set_event_loop(self, event_loop) -> None
This method registers an event loop function in a Tango server.
This function will be called by the process main thread in an infinite loop
The process will not use the classical ORB blocking event loop.
It is the user responsability to code this function in a way that it implements
some kind of blocking in order not to load the computer CPU. The following
piece of code is an example of how you can use this feature::
_LOOP_NB = 1
def looping():
global _LOOP_NB
print "looping", _LOOP_NB
time.sleep(0.1)
_LOOP_NB += 1
return _LOOP_NB > 100
def main():
py = PyTango.Util(sys.argv)
# ...
U = PyTango.Util.instance()
U.server_set_event_loop(looping)
U.server_init()
U.server_run()
Parameters : None
Return : None
New in PyTango 8.1.0
""" )
# document_static_method("init_python", """
# init_python() -> None
#
# Static method
# For internal usage.
#
# Parameters : None
# Return : None
# """ )
def pyutil_init(doc=True):
__init_Util()
if doc:
__doc_Util()
|