From 8f1718fab8fcd07a8367b95763e19c14b7e644ab Mon Sep 17 00:00:00 2001 From: Guifre Cuni Date: Thu, 24 Aug 2017 16:42:41 +0200 Subject: [PATCH] Update docs and changelog to 9.2.2 --- doc/howto.rst | 4 +- doc/revision.rst | 205 ++++++++++++++++++++++++----------------- doc/start.rst | 2 +- doc/utilities.rst | 6 +- tango/device_proxy.py | 19 +++- tango/device_server.py | 18 ++-- tango/server.py | 2 +- 7 files changed, 154 insertions(+), 102 deletions(-) diff --git a/doc/howto.rst b/doc/howto.rst index f71fc5f9..ab203d9a 100644 --- a/doc/howto.rst +++ b/doc/howto.rst @@ -44,9 +44,9 @@ The PyTango version:: >>> import tango >>> tango.__version__ - '9.2.1' + '9.2.2' >>> tango.__version_info__ - (9, 2, 1) + (9, 2, 2) and the Tango C++ library version that PyTango was compiled with:: diff --git a/doc/revision.rst b/doc/revision.rst index 3dbfd01d..0717ac33 100644 --- a/doc/revision.rst +++ b/doc/revision.rst @@ -13,88 +13,90 @@ History of changes Document revisions ------------------- -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| Date | Revision | Description | Author | -+==========+==================================================================================+=====================================================+=======================+ -| 18/07/03 | 1.0 | Initial Version | M\. Ounsy | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 06/10/03 | 2.0 | Extension of the "Getting Started" paragraph | A\. Buteau/M\. Ounsy | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 14/10/03 | 3.0 | Added Exception Handling paragraph | M\. Ounsy | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 13/06/05 | 4.0 | Ported to Latex, added events, AttributeProxy | V\. Forchì | -| | | and ApiUtil | | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| | | fixed bug with python 2.5 and and state events | | -| 13/06/05 | 4.1 | new Database constructor | V\. Forchì | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 15/01/06 | 5.0 | Added Device Server classes | E\.Taurel | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 15/03/07 | 6.0 | Added AttrInfoEx, AttributeConfig events, 64bits, | T\. Coutinho | -| | | write_attribute | | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 21/03/07 | 6.1 | Added groups | T\. Coutinho | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 15/06/07 | `6.2 `_ | Added dynamic attributes doc | E\. Taurel | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 06/05/08 | `7.0 `_ | Update to Tango 6.1. Added DB methods, version info | T\. Coutinho | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 10/07/09 | `8.0 `_ | Update to Tango 7. Major refactoring. Migrated doc | T\. Coutinho/R\. Suñe | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 24/07/09 | `8.1 `_ | Added migration info, added missing API doc | T\. Coutinho/R\. Suñe | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 21/09/09 | `8.2 `_ | Added migration info, release of 7.0.0beta2 | T\. Coutinho/R\. Suñe | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 12/11/09 | `8.3 `_ | Update to Tango 7.1. | T\. Coutinho/R\. Suñe | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| ??/12/09 | `8.4 `_ | Update to PyTango 7.1.0 rc1 | T\. Coutinho/R\. Suñe | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 19/02/10 | `8.5 `_ | Update to PyTango 7.1.1 | T\. Coutinho/R\. Suñe | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 06/08/10 | `8.6 `_ | Update to PyTango 7.1.2 | T\. Coutinho | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 05/11/10 | `8.7 `_ | Update to PyTango 7.1.3 | T\. Coutinho | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 08/04/11 | `8.8 `_ | Update to PyTango 7.1.4 | T\. Coutinho | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 13/04/11 | `8.9 `_ | Update to PyTango 7.1.5 | T\. Coutinho | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 14/04/11 | `8.10 `_ | Update to PyTango 7.1.6 | T\. Coutinho | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 15/04/11 | `8.11 `_ | Update to PyTango 7.2.0 | T\. Coutinho | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 12/12/11 | `8.12 `_ | Update to PyTango 7.2.2 | T\. Coutinho | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 24/04/12 | `8.13 `_ | Update to PyTango 7.2.3 | T\. Coutinho | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 21/09/12 | `8.14 `_ | Update to PyTango 8.0.0 | T\. Coutinho | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 10/10/12 | `8.15 `_ | Update to PyTango 8.0.2 | T\. Coutinho | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 20/05/13 | `8.16 `_ | Update to PyTango 8.0.3 | T\. Coutinho | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 28/08/13 | `8.13 `_ | Update to PyTango 7.2.4 | T\. Coutinho | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 27/11/13 | `8.18 `_ | Update to PyTango 8.1.1 | T\. Coutinho | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 16/05/14 | `8.19 `_ | Update to PyTango 8.1.2 | T\. Coutinho | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 30/09/14 | `8.20 `_ | Update to PyTango 8.1.4 | T\. Coutinho | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 01/10/14 | `8.21 `_ | Update to PyTango 8.1.5 | T\. Coutinho | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 05/02/15 | `8.22 `_ | Update to PyTango 8.1.6 | T\. Coutinho | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 03/02/16 | `8.23 `_ | Update to PyTango 8.1.8 | T\. Coutinho | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 12/08/16 | 8.24 | Update to PyTango 8.1.9 | V\. Michel | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 26/02/16 | `9.2 `_ | Update to PyTango 9.2.0a | T\. Coutinho | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 15/08/16 | `9.3 `_ | Update to PyTango 9.2.0 | V\. Michel | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ -| 23/01/17 | `9.4 `_ | Update to PyTango 9.2.1 | V\. Michel | -+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+-----------------------+ ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| Date | Revision | Description | Author | ++==========+==================================================================================+=====================================================+================================+ +| 18/07/03 | 1.0 | Initial Version | M\. Ounsy | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 06/10/03 | 2.0 | Extension of the "Getting Started" paragraph | A\. Buteau/M\. Ounsy | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 14/10/03 | 3.0 | Added Exception Handling paragraph | M\. Ounsy | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 13/06/05 | 4.0 | Ported to Latex, added events, AttributeProxy | V\. Forchì | +| | | and ApiUtil | | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| | | fixed bug with python 2.5 and and state events | | +| 13/06/05 | 4.1 | new Database constructor | V\. Forchì | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 15/01/06 | 5.0 | Added Device Server classes | E\.Taurel | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 15/03/07 | 6.0 | Added AttrInfoEx, AttributeConfig events, 64bits, | T\. Coutinho | +| | | write_attribute | | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 21/03/07 | 6.1 | Added groups | T\. Coutinho | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 15/06/07 | `6.2 `_ | Added dynamic attributes doc | E\. Taurel | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 06/05/08 | `7.0 `_ | Update to Tango 6.1. Added DB methods, version info | T\. Coutinho | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 10/07/09 | `8.0 `_ | Update to Tango 7. Major refactoring. Migrated doc | T\. Coutinho/R\. Suñe | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 24/07/09 | `8.1 `_ | Added migration info, added missing API doc | T\. Coutinho/R\. Suñe | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 21/09/09 | `8.2 `_ | Added migration info, release of 7.0.0beta2 | T\. Coutinho/R\. Suñe | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 12/11/09 | `8.3 `_ | Update to Tango 7.1. | T\. Coutinho/R\. Suñe | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| ??/12/09 | `8.4 `_ | Update to PyTango 7.1.0 rc1 | T\. Coutinho/R\. Suñe | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 19/02/10 | `8.5 `_ | Update to PyTango 7.1.1 | T\. Coutinho/R\. Suñe | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 06/08/10 | `8.6 `_ | Update to PyTango 7.1.2 | T\. Coutinho | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 05/11/10 | `8.7 `_ | Update to PyTango 7.1.3 | T\. Coutinho | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 08/04/11 | `8.8 `_ | Update to PyTango 7.1.4 | T\. Coutinho | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 13/04/11 | `8.9 `_ | Update to PyTango 7.1.5 | T\. Coutinho | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 14/04/11 | `8.10 `_ | Update to PyTango 7.1.6 | T\. Coutinho | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 15/04/11 | `8.11 `_ | Update to PyTango 7.2.0 | T\. Coutinho | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 12/12/11 | `8.12 `_ | Update to PyTango 7.2.2 | T\. Coutinho | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 24/04/12 | `8.13 `_ | Update to PyTango 7.2.3 | T\. Coutinho | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 21/09/12 | `8.14 `_ | Update to PyTango 8.0.0 | T\. Coutinho | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 10/10/12 | `8.15 `_ | Update to PyTango 8.0.2 | T\. Coutinho | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 20/05/13 | `8.16 `_ | Update to PyTango 8.0.3 | T\. Coutinho | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 28/08/13 | `8.13 `_ | Update to PyTango 7.2.4 | T\. Coutinho | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 27/11/13 | `8.18 `_ | Update to PyTango 8.1.1 | T\. Coutinho | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 16/05/14 | `8.19 `_ | Update to PyTango 8.1.2 | T\. Coutinho | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 30/09/14 | `8.20 `_ | Update to PyTango 8.1.4 | T\. Coutinho | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 01/10/14 | `8.21 `_ | Update to PyTango 8.1.5 | T\. Coutinho | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 05/02/15 | `8.22 `_ | Update to PyTango 8.1.6 | T\. Coutinho | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 03/02/16 | `8.23 `_ | Update to PyTango 8.1.8 | T\. Coutinho | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 12/08/16 | 8.24 | Update to PyTango 8.1.9 | V\. Michel | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 26/02/16 | `9.2.0a `_ | Update to PyTango 9.2.0a | T\. Coutinho | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 15/08/16 | `9.2.0 `_ | 9.2.0 Release | V\. Michel | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 23/01/17 | `9.2.1 `_ | 9.2.1 Release | V\. Michel | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ +| 27/09/17 | `9.2.2 `_ | 9.2.2 Release | G\. Cuni/V\. Michel/J\. Moldes | ++----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+ .. _pytango-version-history: @@ -104,6 +106,45 @@ Version history +----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Version | Changes | +==========+=======================================================================================================================================================================+ +| 9.2.2 | 9.2.2 release. | +| | | +| | Features: | +| | - `Pull Request #104: Pipe Events `_ | +| | - `Pull Request #106: Implement pipe write (client and server, issue #9) `_ | +| | - `Pull Request #122: Dynamic commands `_ | +| | - `Pull Request #124: Add forward attribute `_ | +| | - `Pull Request #129: Implement mandatory property (issue #30) `_ | +| | | +| | Changes: | +| | - `Pull Request #109: Device Interface Change Events `_ | +| | - `Pull Request #113: Adding asyncio green mode documentation and a how-to on contributing `_ | +| | - `Pull Request #114: Added PEP8-ified files in tango module. `_ | +| | - `Pull Request #115: Commands polling tests (client and server) `_ | +| | - `Pull Request #116: Attribute polling tests (client and server) `_ | +| | - `Pull Request #117: Use official tango-controls conda channel `_ | +| | - `Pull Request #125: Forward attribute example `_ | +| | - `Pull Request #134: Linting pytango (with pylint + flake8) `_ | +| | - `Pull Request #137: Codacy badge in README and code quality policy in How to Contribute `_ | +| | - `Pull Request #143: Added missing PipeEventData & DevIntrChangeEventData `_ | +| | | +| | Bug fixes: | +| | - `Pull Request #85 (issue #84): Fix Gevent ThreadPool exceptions `_ | +| | - `Pull Request #94 (issue #93): Fix issues in setup file (GCC-7 build) `_ | +| | - `Pull Request #96: Filter badges from the long description `_ | +| | - `Pull Request #97: Fix/linker options `_ | +| | - `Pull Request #98: Refactor green mode for client and server APIs `_ | +| | - `Pull Request #101 (issue #100) check for None and return null string `_ | +| | - `Pull Request #102: Update server tests `_ | +| | - `Pull Request #103: Cache build objects to optimize travis builds `_ | +| | - `Pull Request #112 (issue #111): Use _DeviceClass as tango device class constructor `_ | +| | - `Pull Request #128 (issue #127): Set default worker in server.py `_ | +| | - `Pull Request #135: Better exception handling in server.run and test context (issue #131) `_ | +| | - `Pull Request #142 (issue #142): Added missing PipeEventData & DevIntrChangeEventData `_ | +| | - `Pull Request #148 (issue #144): Expose utils helpers `_ | +| | - `Pull Request #149: Fix return value of proxy.subscribe_event `_ | +| | - `Pull Request #158 (issue #155): Fix timestamp and casing in utils.EventCallback `_ | +| | | ++----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 9.2.1 | 9.2.1 release. | | | | | | Features: | diff --git a/doc/start.rst b/doc/start.rst index a7c80928..00d34350 100644 --- a/doc/start.rst +++ b/doc/start.rst @@ -115,6 +115,6 @@ To test the installation, import ``tango`` and check ``tango.Release.version``: .. sourcecode:: console $ python -c "import tango; print(tango.Release.version)" - 9.2.1 + 9.2.2 Next steps: Check out the :ref:`pytango-quick-tour`. diff --git a/doc/utilities.rst b/doc/utilities.rst index fa1250df..8d61c172 100644 --- a/doc/utilities.rst +++ b/doc/utilities.rst @@ -5,7 +5,7 @@ The Utilities API .. currentmodule:: tango.utils -.. autoclass:: tango.utils.EventCallBack +.. autoclass:: tango.utils.EventCallback :members: :undoc-members: @@ -22,7 +22,7 @@ The Utilities API .. autofunction:: tango.utils.is_bool .. autofunction:: tango.utils.is_scalar_type - + .. autofunction:: tango.utils.is_array_type .. autofunction:: tango.utils.is_numerical_type @@ -33,7 +33,7 @@ The Utilities API .. autofunction:: tango.utils.is_bool_type -.. autofunction:: tango.utils.is_bin_type +.. autofunction:: tango.utils.is_binary_type .. autofunction:: tango.utils.is_str_type diff --git a/tango/device_proxy.py b/tango/device_proxy.py index 96c3cc1c..4a90c353 100644 --- a/tango/device_proxy.py +++ b/tango/device_proxy.py @@ -1053,7 +1053,7 @@ def __DeviceProxy__get_event_map(self): def __DeviceProxy__subscribe_event(self, *args, **kwargs): """ - subscribe_event(event_type, cb, stateless=False, green_mode=None) -> int + subscribe_event(event_type, cb, stateless=False, green_mode=None) -> int The client call to subscribe for event reception in the push model. The client implements a callback method which is triggered when the @@ -1073,7 +1073,7 @@ def __DeviceProxy__subscribe_event(self, *args, **kwargs): seconds to subscribe for the specified event. At every subscription retry, a callback is executed which contains the corresponding exception - - green_mode : + - green_mode : the corresponding green mode (default is GreenMode.Synchronous) Return : An event id which has to be specified when unsubscribing from this event. @@ -1081,7 +1081,8 @@ def __DeviceProxy__subscribe_event(self, *args, **kwargs): Throws : EventSystemFailed - subscribe_event(self, attr_name, event, callback, filters=[], stateless=False, extract_as=Numpy, green_mode=None) -> int + subscribe_event(self, attr_name, event, callback, filters=[], stateless=False, extract_as=Numpy, green_mode=None) -> int + The client call to subscribe for event reception in the push model. The client implements a callback method which is triggered when the event is received. Filtering is done based on the reason specified and @@ -1090,6 +1091,7 @@ def __DeviceProxy__subscribe_event(self, *args, **kwargs): changes. Events consist of an attribute name and the event reason. A standard set of reasons are implemented by the system, additional device specific reasons can be implemented by device servers programmers. + Parameters : - attr_name : (str) The device attribute name which will be sent as an event e.g. "current". @@ -1113,17 +1115,23 @@ def __DeviceProxy__subscribe_event(self, *args, **kwargs): subscription retry, a callback is executed which contains the corresponding exception - extract_as : (ExtractAs) - - green_mode : + - green_mode : the corresponding green mode (default is GreenMode.Synchronous) + Return : An event id which has to be specified when unsubscribing from this event. + Throws : EventSystemFailed - subscribe_event(self, attr_name, event, queuesize, filters=[], stateless=False, green_mode=None) -> int + + subscribe_event(self, attr_name, event, queuesize, filters=[], stateless=False, green_mode=None) -> int + The client call to subscribe for event reception in the pull model. Instead of a callback method the client has to specify the size of the event reception buffer. + The event reception buffer is implemented as a round robin buffer. This way the client can set-up different ways to receive events: + * Event reception buffer size = 1 : The client is interested only in the value of the last event received. All other events that have been received since the last reading are discarded. @@ -1133,6 +1141,7 @@ def __DeviceProxy__subscribe_event(self, *args, **kwargs): * Event reception buffer size = ALL_EVENTS : The client buffers all received events. The buffer size is unlimited and only restricted by the available memory for the client. + All other parameters are similar to the descriptions given in the other subscribe_event() version. """ diff --git a/tango/device_server.py b/tango/device_server.py index 2ce8d8c3..359d613e 100644 --- a/tango/device_server.py +++ b/tango/device_server.py @@ -318,7 +318,8 @@ def __DeviceImpl__add_attribute(self, attr, r_meth=None, w_meth=None, is_allo_me Return : (Attr) the newly created attribute. - Throws : DevFailed""" + Throws : DevFailed + """ attr_data = None if isinstance(attr, AttrData): @@ -363,8 +364,7 @@ def __DeviceImpl__add_attribute(self, attr, r_meth=None, w_meth=None, is_allo_me def __DeviceImpl__remove_attribute(self, attr_name): - """ - remove_attribute(self, attr_name) -> None + """remove_attribute(self, attr_name) -> None Remove one attribute from the device attribute list. @@ -373,7 +373,8 @@ def __DeviceImpl__remove_attribute(self, attr_name): Return : None - Throws : DevFailed""" + Throws : DevFailed + """ try: # Call this method in a try/except in case remove_attribute # is called during the DS shutdown sequence @@ -416,8 +417,7 @@ def __DeviceImpl___remove_attr_meth(self, attr_name): def __DeviceImpl__add_command(self, cmd, device_level=True): - """ - add_command(self, cmd, level=TANGO::OPERATOR) -> cmd + """add_command(self, cmd, level=TANGO::OPERATOR) -> cmd Add a new command to the device command list. @@ -425,7 +425,9 @@ def __DeviceImpl__add_command(self, cmd, device_level=True): - cmd : the new command to be added to the list - device_level : Set this flag to true if the command must be added for only this device + Return : Command + Throws : DevFailed """ add_name_in_list = False # This flag is always False, what use is it? @@ -449,7 +451,7 @@ def __DeviceImpl__add_command(self, cmd, device_level=True): def __DeviceImpl__remove_command(self, cmd_name, free_it=False, clean_db=True): """ - remove_command(self, attr_name) -> None + remove_command(self, attr_name) -> None Remove one command from the device command list. @@ -458,7 +460,7 @@ def __DeviceImpl__remove_command(self, cmd_name, free_it=False, clean_db=True): - free_it : Boolean set to true if the command object must be freed. - clean_db : Clean command related information (included polling info if the command is polled) from database. - Return : None + Return : None Throws : DevFailed """ diff --git a/tango/server.py b/tango/server.py index ed5eab56..b0b6ae6d 100644 --- a/tango/server.py +++ b/tango/server.py @@ -725,7 +725,7 @@ def voltage(self): green_mode :obj:`~tango.GreenMode` None green mode for read and write. None means use server green mode. read_green_mode :obj:`~tango.GreenMode` None green mode for read. None means use server green mode. write_green_mode :obj:`~tango.GreenMode` None green mode for write. None means use server green mode. - forwarded :obj:'bool' False the attribute should be forwarded if True + forwarded :obj:`bool` False the attribute should be forwarded if True ===================== ================================ ======================================= ======================================================================================= .. note::