[pytango] 22/25: Add PyTango.asyncio shortcut module

[Sandor Bodo-Merle]

This is an automated email from the git hooks/post-receive script.

sbodomerle-guest pushed a commit to tag v8.1.9
in repository pytango.

commit f576b23e8da062dad7a4e73f75fbb793478093ae
Author: Vincent Michel <vincent.michel at maxlab.lu.se>
Date:   Tue Aug 9 11:38:57 2016 +0200

    Add PyTango.asyncio shortcut module
---
 src/boost/python/asyncio.py | 142 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 142 insertions(+)

diff --git a/src/boost/python/asyncio.py b/src/boost/python/asyncio.py
new file mode 100644
index 0000000..ead448c
--- /dev/null
+++ b/src/boost/python/asyncio.py
@@ -0,0 +1,142 @@
+# -----------------------------------------------------------------------------
+# 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 module exposes a asyncio version of :class:`PyTango.DeviceProxy` and
+:class:`PyTango.AttributeProxy"""
+
+__all__ = ["DeviceProxy", "AttributeProxy", "check_requirements",
+           "get_event_loop"]
+
+from functools import partial
+
+from PyTango import GreenMode
+from PyTango.device_proxy import get_device_proxy
+from PyTango.attribute_proxy import get_attribute_proxy
+from PyTango.tango_asyncio import get_event_loop
+
+
+def check_requirements():
+    try:
+        import asyncio
+    except ImportError:
+        try:
+            import trollius as asyncio
+        except ImportError:
+            raise ImportError(
+                "Not able to import asyncio or its backport trollius")
+    try:
+        import concurrent.futures
+    except ImportError:
+        raise ImportError(
+            "No module named concurrent. You need to "
+            "install the futures backport module to have "
+            "access to PyTango futures green mode")
+    return asyncio, concurrent.futures
+
+
+check_requirements()
+
+DeviceProxy = partial(get_device_proxy,
+                      green_mode=GreenMode.Asyncio,
+                      wait=False)
+DeviceProxy.__doc__ = """
+    DeviceProxy(self, dev_name, wait=False, timeout=None)
+        -> DeviceProxy
+
+    DeviceProxy(self, dev_name, need_check_acc, wait=False, timeout=None)
+        -> DeviceProxy
+
+    Creates a *asyncio* enabled :class:`~PyTango.DeviceProxy`.
+
+    The DeviceProxy constructor internally makes some network calls which makes
+    it *slow*. By using the asyncio *green mode* you may give the control back
+    to the asyncio event loop using the *yield from* or *await* synthax.
+
+    .. note::
+        The timeout parameter has no relation with the tango device client side
+        timeout (gettable by :meth:`~PyTango.DeviceProxy.get_timeout_millis`
+        and settable through :meth:`~PyTango.DeviceProxy.set_timeout_millis`)
+
+    :param dev_name: the device name or alias
+    :type dev_name: str
+    :param need_check_acc: in first version of the function it defaults to True
+                           Determines if at creation time of DeviceProxy it
+                           should check for channel access (rarely used)
+    :type need_check_acc: bool
+    :param wait: whether or not to wait for result of creating a DeviceProxy.
+    :type wait: bool
+    :param timeout: The number of seconds to wait for the result.
+                    If None, then there is no limit on the wait time.
+                    Ignored when wait is False.
+    :type timeout: float
+    :returns:
+        if wait is True:
+            :class:`~PyTango.DeviceProxy`
+        else:
+            :class:`concurrent.futures.Future`
+    :throws:
+        * a *DevFailed* if wait is True and there is an error creating
+          the device.
+        * an *asyncio.TimeoutError* if wait is False, timeout is not
+          None and the time to create the device has expired.
+
+    New in PyTango 8.1.0
+"""
+
+AttributeProxy = partial(get_attribute_proxy,
+                         green_mode=GreenMode.Asyncio,
+                         wait=False)
+AttributeProxy.__doc__ = """
+    AttributeProxy(self, full_attr_name, wait=False, timeout=False)
+        -> AttributeProxy
+
+    AttributeProxy(self, device_proxy, attr_name, wait=False, timeout=False)
+        -> AttributeProxy
+
+    Creates a *futures* enabled :class:`~PyTango.AttributeProxy`.
+
+    The AttributeProxy constructor internally makes some network calls which
+    makes it *slow*. By using the asyncio *green mode* you may give the control
+    back to the asyncio event loop using the *yield from* or *await* synthax.
+
+    :param full_attr_name: the full name of the attribute
+    :type full_attr_name: str
+    :param device_proxy: the :class:`~PyTango.DeviceProxy`
+    :type device_proxy: DeviceProxy
+    :param attr_name: attribute name for the given device proxy
+    :type attr_name: str
+    :param wait: whether or not to wait for result of creating an
+                 AttributeProxy.
+    :type wait: bool
+    :param timeout: The number of seconds to wait for the result.
+                    If None, then there is no limit on the wait time.
+                    Ignored when wait is False.
+    :type timeout: float
+    :returns:
+        if wait is True:
+            :class:`~PyTango.AttributeProxy`
+        else:
+            :class:`concurrent.futures.Future`
+    :throws:
+        * a *DevFailed* if wait is True  and there is an error creating the
+          attribute.
+        * a *asyncio.TimeoutError* if wait is False, timeout is not
+          None and the time to create the attribute has expired.
+
+    New in PyTango 8.1.0
+"""
+
+Device = DeviceProxy
+Attribute = AttributeProxy
+
+del GreenMode
+del get_device_proxy
+del get_attribute_proxy

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/pytango.git