/usr/lib/python3/dist-packages/tango/connection.py is in python3-tango 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 | # ------------------------------------------------------------------------------
# This file is part of PyTango (http://pytango.rtfd.io)
#
# 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__ = ["connection_init"]
__docformat__ = "restructuredtext"
import collections
from ._tango import Connection, DeviceData, __CallBackAutoDie, CmdArgType, \
DeviceProxy, Database, ExtractAs
from .utils import document_method as __document_method
from .utils import document_static_method as __document_static_method
from .green import green
def __CallBackAutoDie__cmd_ended_aux(self, fn):
def __new_fn(cmd_done_event):
try:
cmd_done_event.argout = cmd_done_event.argout_raw.extract(
self.defaultCommandExtractAs)
except Exception:
pass
return fn(cmd_done_event)
return __new_fn
def __get_command_inout_param(self, cmd_name, cmd_param=None):
if cmd_param is None:
return DeviceData()
if isinstance(cmd_param, DeviceData):
return cmd_param
if isinstance(self, DeviceProxy):
# This is not part of 'Connection' interface, but
# DeviceProxy only.
info = self.command_query(cmd_name)
param = DeviceData()
param.insert(info.in_type, cmd_param)
return param
elif isinstance(self, Database):
# I just try to guess types DevString and DevVarStringArray
# as they are used for Database
param = DeviceData()
if isinstance(cmd_param, str):
param.insert(CmdArgType.DevString, cmd_param)
return param
elif isinstance(cmd_param, collections.Sequence) and all([isinstance(x, str) for x in cmd_param]):
param.insert(CmdArgType.DevVarStringArray, cmd_param)
return param
else:
raise TypeError(
"command_inout() parameter must be a DeviceData object or a string or a sequence of strings")
else:
raise TypeError("command_inout() parameter must be a DeviceData object.")
def __Connection__command_inout(self, name, *args, **kwds):
"""
command_inout( self, cmd_name, cmd_param=None, green_mode=None, wait=True, timeout=None) -> any
Execute a command on a device.
Parameters :
- cmd_name : (str) Command name.
- cmd_param : (any) It should be a value of the type expected by the
command or a DeviceData object with this value inserted.
It can be ommited if the command should not get any argument.
- green_mode : (GreenMode) Defaults to the current DeviceProxy GreenMode.
(see :meth:`~tango.DeviceProxy.get_green_mode` and
:meth:`~tango.DeviceProxy.set_green_mode`).
- wait : (bool) whether or not to wait for result. If green_mode
is *Synchronous*, this parameter is ignored as it always
waits for the result.
Ignored when green_mode is Synchronous (always waits).
- timeout : (float) The number of seconds to wait for the result.
If None, then there is no limit on the wait time.
Ignored when green_mode is Synchronous or wait is False.
Return : The result of the command. The type depends on the command. It may be None.
Throws : ConnectionFailed, CommunicationFailed, DeviceUnlocked, DevFailed from device
TimeoutError (green_mode == Futures) If the future didn't finish executing before the given timeout.
Timeout (green_mode == Gevent) If the async result didn't finish executing before the given timeout.
.. versionadded:: 8.1.0
*green_mode* parameter.
*wait* parameter.
*timeout* parameter.
"""
r = Connection.command_inout_raw(self, name, *args, **kwds)
if isinstance(r, DeviceData):
try:
return r.extract(self.defaultCommandExtractAs)
except Exception:
return None
else:
return r
__Connection__command_inout.__name__ = "command_inout"
def __Connection__command_inout_raw(self, cmd_name, cmd_param=None):
"""
command_inout_raw( self, cmd_name, cmd_param=None) -> DeviceData
Execute a command on a device.
Parameters :
- cmd_name : (str) Command name.
- cmd_param : (any) It should be a value of the type expected by the
command or a DeviceData object with this value inserted.
It can be ommited if the command should not get any argument.
Return : A DeviceData object.
Throws : ConnectionFailed, CommunicationFailed, DeviceUnlocked, DevFailed from device
"""
param = __get_command_inout_param(self, cmd_name, cmd_param)
return self.__command_inout(cmd_name, param)
def __Connection__command_inout_asynch(self, cmd_name, *args):
"""
command_inout_asynch(self, cmd_name) -> id
command_inout_asynch(self, cmd_name, cmd_param) -> id
command_inout_asynch(self, cmd_name, cmd_param, forget) -> id
Execute asynchronously (polling model) a command on a device
Parameters :
- cmd_name : (str) Command name.
- cmd_param : (any) It should be a value of the type expected by the
command or a DeviceData object with this value inserted.
It can be ommited if the command should not get any argument.
If the command should get no argument and you want
to set the 'forget' param, use None for cmd_param.
- forget : (bool) If this flag is set to true, this means that the client
does not care at all about the server answer and will even
not try to get it. Default value is False. Please,
note that device re-connection will not take place (in case
it is needed) if the fire and forget mode is used. Therefore,
an application using only fire and forget requests is not able
to automatically re-connnect to device.
Return : (int) This call returns an asynchronous call identifier which is
needed to get the command result (see command_inout_reply)
Throws : ConnectionFailed, TypeError, anything thrown by command_query
command_inout_asynch( self, cmd_name, callback) -> None
command_inout_asynch( self, cmd_name, cmd_param, callback) -> None
Execute asynchronously (callback model) a command on a device.
Parameters :
- cmd_name : (str) Command name.
- cmd_param : (any)It should be a value of the type expected by the
command or a DeviceData object with this value inserted.
It can be ommited if the command should not get any argument.
- callback : Any callable object (function, lambda...) or any oject
with a method named "cmd_ended".
Return : None
Throws : ConnectionFailed, TypeError, anything thrown by command_query
.. important::
by default, TANGO is initialized with the **polling** model. If you want
to use the **push** model (the one with the callback parameter), you
need to change the global TANGO model to PUSH_CALLBACK.
You can do this with the :meth:`tango.ApiUtil.set_asynch_cb_sub_model`
"""
if len(args) == 0: # command_inout_asynch()
argin = DeviceData()
forget = False
return self.__command_inout_asynch_id(cmd_name, argin, forget)
elif len(args) == 1:
if isinstance(args[0], collections.Callable): # command_inout_asynch(lambda)
cb = __CallBackAutoDie()
cb.cmd_ended = __CallBackAutoDie__cmd_ended_aux(self, args[0])
argin = __get_command_inout_param(self, cmd_name)
return self.__command_inout_asynch_cb(cmd_name, argin, cb)
elif hasattr(args[0], 'cmd_ended'): # command_inout_asynch(Cbclass)
cb = __CallBackAutoDie()
cb.cmd_ended = __CallBackAutoDie__cmd_ended_aux(self, args[0].cmd_ended)
argin = __get_command_inout_param(self, cmd_name)
return self.__command_inout_asynch_cb(cmd_name, argin, cb)
else: # command_inout_asynch(value)
argin = __get_command_inout_param(self, cmd_name, args[0])
forget = False
return self.__command_inout_asynch_id(cmd_name, argin, forget)
elif len(args) == 2:
if isinstance(args[1], collections.Callable): # command_inout_asynch( value, lambda)
cb = __CallBackAutoDie()
cb.cmd_ended = __CallBackAutoDie__cmd_ended_aux(self, args[1])
argin = __get_command_inout_param(self, cmd_name, args[0])
return self.__command_inout_asynch_cb(cmd_name, argin, cb)
elif hasattr(args[1], 'cmd_ended'): # command_inout_asynch(value, cbClass)
cb = __CallBackAutoDie()
cb.cmd_ended = __CallBackAutoDie__cmd_ended_aux(self, args[1].cmd_ended)
argin = __get_command_inout_param(self, cmd_name, args[0])
return self.__command_inout_asynch_cb(cmd_name, argin, cb)
else: # command_inout_asynch(value, forget)
argin = __get_command_inout_param(self, cmd_name, args[0])
forget = bool(args[1])
return self.__command_inout_asynch_id(cmd_name, argin, forget)
else:
raise TypeError("Wrong number of attributes!")
__Connection__command_inout_asynch.__name__ = "command_inout_asynch"
def __Connection__command_inout_reply(self, idx, timeout=None):
"""
command_inout_reply(self, id) -> DeviceData
Check if the answer of an asynchronous command_inout is arrived
(polling model). If the reply is arrived and if it is a valid
reply, it is returned to the caller in a DeviceData object. If
the reply is an exception, it is re-thrown by this call. An
exception is also thrown in case of the reply is not yet arrived.
Parameters :
- id : (int) Asynchronous call identifier.
Return : (DeviceData)
Throws : AsynCall, AsynReplyNotArrived, CommunicationFailed, DevFailed from device
command_inout_reply(self, id, timeout) -> DeviceData
Check if the answer of an asynchronous command_inout is arrived
(polling model). id is the asynchronous call identifier. If the
reply is arrived and if it is a valid reply, it is returned to
the caller in a DeviceData object. If the reply is an exception,
it is re-thrown by this call. If the reply is not yet arrived,
the call will wait (blocking the process) for the time specified
in timeout. If after timeout milliseconds, the reply is still
not there, an exception is thrown. If timeout is set to 0, the
call waits until the reply arrived.
Parameters :
- id : (int) Asynchronous call identifier.
- timeout : (int)
Return : (DeviceData)
Throws : AsynCall, AsynReplyNotArrived, CommunicationFailed, DevFailed from device
"""
if timeout is None:
r = self.command_inout_reply_raw(idx)
else:
r = self.command_inout_reply_raw(idx, timeout)
if isinstance(r, DeviceData):
try:
return r.extract(self.defaultCommandExtractAs)
except Exception:
return None
else:
return r
__Connection__command_inout_reply.__name__ = "command_inout_reply"
def __init_Connection():
Connection.defaultCommandExtractAs = ExtractAs.Numpy
Connection.command_inout_raw = __Connection__command_inout_raw
Connection.command_inout = green(__Connection__command_inout)
Connection.command_inout_asynch = __Connection__command_inout_asynch
Connection.command_inout_reply = __Connection__command_inout_reply
def __doc_Connection():
def document_method(method_name, desc, append=True):
return __document_method(Connection, method_name, desc, append)
def document_static_method(method_name, desc, append=True):
return __document_static_method(Connection, method_name, desc, append)
Connection.__doc__ = """
The abstract Connection class for DeviceProxy. Not to be initialized directly.
"""
document_method("dev_name", """
dev_name(self) -> str
Return the device name as it is stored locally
Parameters : None
Return : (str)
""")
document_method("get_db_host", """
get_db_host(self) -> str
Returns a string with the database host.
Parameters : None
Return : (str)
New in PyTango 7.0.0
""")
document_method("get_db_port", """
get_db_port(self) -> str
Returns a string with the database port.
Parameters : None
Return : (str)
New in PyTango 7.0.0
""")
document_method("get_db_port_num", """
get_db_port_num(self) -> int
Returns an integer with the database port.
Parameters : None
Return : (int)
New in PyTango 7.0.0
""")
document_method("get_from_env_var", """
get_from_env_var(self) -> bool
Returns True if determined by environment variable or
False otherwise
Parameters : None
Return : (bool)
New in PyTango 7.0.0
""")
document_method("connect", """
connect(self, corba_name) -> None
Creates a connection to a TANGO device using it's stringified
CORBA reference i.e. IOR or corbaloc.
Parameters :
- corba_name : (str) Name of the CORBA object
Return : None
New in PyTango 7.0.0
""")
document_method("reconnect", """
reconnect(self, db_used) -> None
Reconnecto to a CORBA object.
Parameters :
- db_used : (bool) Use thatabase
Return : None
New in PyTango 7.0.0
""")
document_method("get_idl_version", """
get_idl_version(self) -> int
Get the version of the Tango Device interface implemented
by the device
Parameters : None
Return : (int)
""")
document_method("set_timeout_millis", """
set_timeout_millis(self, timeout) -> None
Set client side timeout for device in milliseconds. Any method
which takes longer than this time to execute will throw an
exception
Parameters :
- timeout : integer value of timeout in milliseconds
Return : None
Example :
dev.set_timeout_millis(1000)
""")
document_method("get_timeout_millis", """
get_timeout_millis(self) -> int
Get the client side timeout in milliseconds
Parameters : None
Return : (int)
""")
document_method("get_source", """
get_source(self) -> DevSource
Get the data source(device, polling buffer, polling buffer
then device) used by command_inout or read_attribute methods
Parameters : None
Return : (DevSource)
Example :
source = dev.get_source()
if source == DevSource.CACHE_DEV : ...
""")
document_method("set_source", """
set_source(self, source) -> None
Set the data source(device, polling buffer, polling buffer
then device) for command_inout and read_attribute methods.
Parameters :
- source: (DevSource) constant.
Return : None
Example :
dev.set_source(DevSource.CACHE_DEV)
""")
document_method("get_transparency_reconnection", """
get_transparency_reconnection(self) -> bool
Returns the device transparency reconnection flag.
Parameters : None
Return : (bool) True if transparency reconnection is set
or False otherwise
""")
document_method("set_transparency_reconnection", """
set_transparency_reconnection(self, yesno) -> None
Set the device transparency reconnection flag
Parameters :
" - val : (bool) True to set transparency reconnection
" or False otherwise
Return : None
""")
document_method("command_inout_reply_raw", """
command_inout_reply_raw(self, id) -> DeviceData
Check if the answer of an asynchronous command_inout is arrived
(polling model). If the reply is arrived and if it is a valid
reply, it is returned to the caller in a DeviceData object. If
the reply is an exception, it is re-thrown by this call. An
exception is also thrown in case of the reply is not yet arrived.
Parameters :
- id : (int) Asynchronous call identifier.
Return : (DeviceData)
Throws : AsynCall, AsynReplyNotArrived, CommunicationFailed, DevFailed from device
""")
document_method("command_inout_reply_raw", """
command_inout_reply_raw(self, id, timeout) -> DeviceData
Check if the answer of an asynchronous command_inout is arrived
(polling model). id is the asynchronous call identifier. If the
reply is arrived and if it is a valid reply, it is returned to
the caller in a DeviceData object. If the reply is an exception,
it is re-thrown by this call. If the reply is not yet arrived,
the call will wait (blocking the process) for the time specified
in timeout. If after timeout milliseconds, the reply is still
not there, an exception is thrown. If timeout is set to 0, the
call waits until the reply arrived.
Parameters :
- id : (int) Asynchronous call identifier.
- timeout : (int)
Return : (DeviceData)
Throws : AsynCall, AsynReplyNotArrived, CommunicationFailed, DevFailed from device
""")
# //
# // Asynchronous methods
# //
document_method("get_asynch_replies", """
get_asynch_replies(self) -> None
Try to obtain data returned by a command asynchronously
requested. This method does not block if the reply has not yet
arrived. It fires callback for already arrived replies.
Parameters : None
Return : None
New in PyTango 7.0.0
""")
document_method("get_asynch_replies", """
get_asynch_replies(self, call_timeout) -> None
Try to obtain data returned by a command asynchronously
requested. This method blocks for the specified timeout if the
reply is not yet arrived. This method fires callback when the
reply arrived. If the timeout is set to 0, the call waits
undefinitely for the reply
Parameters :
- call_timeout : (int) timeout in miliseconds
Return : None
New in PyTango 7.0.0
""")
document_method("cancel_asynch_request", """
cancel_asynch_request(self, id ) -> None
Cancel a running asynchronous request
This is a client side call. Obviously, the call cannot be
aborted while it is running in the device.
Parameters :
- id : The asynchronous call identifier
Return : None
New in PyTango 7.0.0
""")
document_method("cancel_all_polling_asynch_request", """
cancel_all_polling_asynch_request(self) -> None
Cancel all running asynchronous request
This is a client side call. Obviously, the calls cannot be
aborted while it is running in the device.
Parameters : None
Return : None
New in PyTango 7.0.0
""")
# //
# // Control access related methods
# //
document_method("get_access_control", """
get_access_control(self) -> AccessControlType
Returns the current access control type
Parameters : None
Return : (AccessControlType) The current access control type
New in PyTango 7.0.0
""")
document_method("set_access_control", """
set_access_control(self, acc) -> None
Sets the current access control type
Parameters :
- acc: (AccessControlType) the type of access
control to set
Return : None
New in PyTango 7.0.0
""")
document_method("get_access_right", """
get_access_right(self) -> AccessControlType
Returns the current access control type
Parameters : None
Return : (AccessControlType) The current access control type
New in PyTango 8.0.0
""")
document_static_method("get_fqdn", """
get_fqdn(self) -> str
Returns the fully qualified domain name
Parameters : None
Return : (str) the fully qualified domain name
New in PyTango 7.2.0
""")
document_method("is_dbase_used", """
is_dbase_used(self) -> bool
Returns if the database is being used
Parameters : None
Return : (bool) True if the database is being used
New in PyTango 7.2.0
""")
document_method("get_dev_host", """
get_dev_host(self) -> str
Returns the current host
Parameters : None
Return : (str) the current host
New in PyTango 7.2.0
""")
document_method("get_dev_port", """
get_dev_port(self) -> str
Returns the current port
Parameters : None
Return : (str) the current port
New in PyTango 7.2.0
""")
def connection_init(doc=True):
__init_Connection()
if doc:
__doc_Connection()
|