Remove release.py file from individual directory. Add single release.py file...

Remove release.py file from individual directory. Add single release.py file for entire package. Corrected some failing unit tests.

docs/source/SKAAlarmHandler.rst

@@ -9,5 +9,5 @@ SKA AlarmHandler
 .. toctree::
    :maxdepth: 2
 
-.. automodule:: SKAAlarmHandler
-   :members: SKAAlarmHandler.SKAAlarmHandler
+.. automodule:: SKAAlarmHandler.SKAAlarmHandler
+    :members: SKAAlarmHandler
\ No newline at end of file

docs/source/SKABaseDevice.rst

@@ -10,5 +10,5 @@ SKA BaseDevice
    :maxdepth: 2
 
 .. automodule:: SKABaseDevice.SKABaseDevice
-   :members: SKABaseDevice
+   :members: __all__
 

docs/source/SKAObsDevice.rst

@@ -10,5 +10,5 @@ SKA ObsDevice
    :maxdepth: 2
 
 .. automodule:: SKAObsDevice.SKAObsDevice
-   :members: SKAObsDevice
+   :members:
 

docs/source/conf.py

@@ -30,7 +30,6 @@ sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.abspath('../../skabase'))
-print ("from conf sys.path: ", sys.path)
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.

docs/source/index.rst

@@ -6,12 +6,12 @@
 Welcome to LMC Base Classes documentation!
 ============================================
 
-Contents:
-
 .. toctree::
+  :caption: Table of Contents
   :maxdepth: 2
 
-   SKA AlarmHandler<SKAAlarmHandler>
+.. automodule:: SKABaseDevice.SKABaseDevice
+   :members: SKABaseDevice
 
 Indices and tables
 ==================

setup.py

 #!/usr/bin/env python
 
+import os
 import sys
 
 from setuptools import setup, find_packages
 
+setup_dir = os.path.dirname(os.path.abspath(__file__))
+release_filename = os.path.join(setup_dir, 'skabase', 'release.py')
+exec(open(release_filename).read())
+
 # prevent unnecessary installation of pytest-runner
 needs_pytest = {'pytest', 'test', 'ptr'}.intersection(sys.argv)
 pytest_runner = ['pytest-runner'] if needs_pytest else []
 
-setup(name="lmc_base_classes",
-      description="Element Base Classes - Evolutionary Prototype",
-      author="SKA Team",
+setup(name=name,
+      description=description,
+      version=version,
+      author=author,
+      author_email=author_email,
+      license=license,
       packages=find_packages(),
       include_package_data=True,
       scripts=["scripts/gen_csv_info.py",

skabase/SKAAlarmHandler/SKAAlarmHandler.py

@@ -24,14 +24,11 @@ import sys
 from future.utils import with_metaclass
 
 # SKA specific imports\
-file_path = os.path.dirname(os.path.abspath(__file__))
-# TODO: remove the release.py file
-sys.path.insert(0, os.path.abspath(os.path.join(file_path, os.curdir)))
-import release # DO NOT import after modifying system path
+from skabase import release
 
+file_path = os.path.dirname(os.path.abspath(__file__))
 basedevice_path = os.path.abspath(os.path.join(file_path, os.pardir)) + "/SKABaseDevice"
 sys.path.insert(0, basedevice_path)
-print ("SKAAlarmHandler sys.path: ", sys.path)
 from SKABaseDevice import SKABaseDevice
 # PROTECTED REGION END #    //  SKAAlarmHandler.additionnal_import
 

skabase/SKAAlarmHandler/__init__.py

@@ -12,11 +12,11 @@ SKA Alarms and SKA/Element Alerts are rules-based configurable conditions that c
 attribute values and quality factors, and are separate from the "built-in" TANGO attribute alarms.
 """
 
-__all__ = ["SKAAlarmHandler", "main", "release"]
+__all__ = ["SKAAlarmHandler", "main"]
 
-# from . import release
-# from .SKAAlarmHandler import SKAAlarmHandler, main
+from skabase import release
+from .SKAAlarmHandler import SKAAlarmHandler, main
 
-# __version__ = release.version
-# __version_info__ = release.version_info
-# __author__ = release.author
+__version__ = release.version
+__version_info__ = release.version_info
+__author__ = release.author

skabase/SKAAlarmHandler/release.py

-# -*- coding: utf-8 -*-
-#
-# This file is part of the SKAAlarmHandler project
-#
-#
-#
-
-"""Release information for Python Package"""
-
-name = """tangods-skaalarmhandler"""
-version = "1.0.0"
-version_info = version.split(".")
-description = """A generic base device for Alarms for SKA."""
-author = "cam"
-author_email = "cam at ska.ac.za"
-license = """BSD-3-Clause"""
-url = """www.skatelescope.org"""
-copyright = """"""

skabase/SKAAlarmHandler/setup.py

-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-#
-# This file is part of the SKAAlarmHandler project
-#
-#
-#
-"""Setup file for SKAAlarmHandler base class"""
-import os
-import sys
-from setuptools import setup
-
-setup_dir = os.path.dirname(os.path.abspath(__file__))
-
-# make sure we use latest info from local code
-sys.path.insert(0, setup_dir)
-
-readme_filename = os.path.join(setup_dir, 'README.rst')
-with open(readme_filename) as file:
-    long_description = file.read()
-
-release_filename = os.path.join(setup_dir, 'SKAAlarmHandler', 'release.py')
-exec(open(release_filename).read())
-
-pack = ['SKAAlarmHandler']
-
-setup(name=name,
-      version=version,
-      description='A generic base device for Alarms for SKA.',
-      packages=pack,
-      include_package_data=True,
-      test_suite="test",
-      entry_points={'console_scripts':['SKAAlarmHandler = SKAAlarmHandler:main']},
-      author='cam',
-      author_email='cam at ska.ac.za',
-      license='BSD-3-Clause',
-      long_description=long_description,
-      url='www.tango-controls.org',
-      platforms="All Platforms"
-      )

skabase/SKAAlarmHandler/test/SKAAlarmHandler_test.py

@@ -18,6 +18,7 @@ sys.path.insert(0, os.path.abspath(path))
 # Imports
 import pytest
 from tango import DevState
+import re
 
 # PROTECTED REGION ID(SKAAlarmHandler.test_additional_imports) ENABLED START #
 # PROTECTED REGION END #    //  SKAAlarmHandler.test_additional_imports
@@ -141,8 +142,11 @@ class TestSKAAlarmHandler(object):
     def test_GetVersionInfo(self, tango_context):
         """Test for GetVersionInfo"""
         # PROTECTED REGION ID(SKAAlarmHandler.test_GetVersionInfo) ENABLED START #
-        assert tango_context.device.GetVersionInfo() == ['tangods-skaalarmhandler, 1.0.0,'
-                                                         ' A generic base device for Alarms for SKA.']
+        versionPattern = re.compile(
+            r'SKAAlarmHandler, lmc-base-classes, [0-9].[0-9].[0-9], '
+            r'A set of generic base devices for SKA Telescope.')
+        versionInfo = tango_context.device.GetVersionInfo()
+        assert (re.match(versionPattern, versionInfo[0])) != None
         # PROTECTED REGION END #    //  SKAAlarmHandler.test_GetVersionInfo
 
 
@@ -191,8 +195,10 @@ class TestSKAAlarmHandler(object):
     def test_buildState(self, tango_context):
         """Test for buildState"""
         # PROTECTED REGION ID(SKAAlarmHandler.test_buildState) ENABLED START #
-        assert tango_context.device.buildState == 'tangods-skaalarmhandler, 1.0.0,' \
-                                                  ' A generic base device for Alarms for SKA.'
+        buildPattern = re.compile(
+            r'lmc-base-classes, [0-9].[0-9].[0-9], '
+            r'A set of generic base devices for SKA Telescope')
+        assert (re.match(buildPattern, tango_context.device.buildState)) != None
         # PROTECTED REGION END #    //  SKAAlarmHandler.test_buildState
 
     # PROTECTED REGION ID(SKAAlarmHandler.test_versionId_decorators) ENABLED START #
@@ -200,7 +206,8 @@ class TestSKAAlarmHandler(object):
     def test_versionId(self, tango_context):
         """Test for versionId"""
         # PROTECTED REGION ID(SKAAlarmHandler.test_versionId) ENABLED START #
-        assert tango_context.device.versionId == '1.0.0'
+        versionIdPattern = re.compile(r'[0-9].[0-9].[0-9]')
+        assert (re.match(versionIdPattern, tango_context.device.versionId)) != None
         # PROTECTED REGION END #    //  SKAAlarmHandler.test_versionId
 
     # PROTECTED REGION ID(SKAAlarmHandler.test_centralLoggingLevel_decorators) ENABLED START #

skabase/SKABaseDevice/SKABaseDevice.py

@@ -5,9 +5,8 @@
 #
 #
 
-""" SKABASE
-
-A generic base device for SKA. It exposes the generic attributes, properties and commands of an SKA device.
+"""skabasedevice.py: A generic base device for SKA. It exposes the generic attributes,
+properties and commands of an SKA device.
 """
 from __future__ import print_function
 from __future__ import absolute_import
@@ -33,12 +32,9 @@ from builtins import range
 
 # SKA specific imports
 file_path = os.path.dirname(os.path.abspath(__file__))
-sys.path.insert(0, os.path.abspath(os.path.join(file_path, os.curdir)))
-import release # DO NOT import after modifying system path
-
 auxiliary_path = os.path.abspath(os.path.join(file_path, os.pardir)) + "/auxiliary"
 sys.path.insert(0, auxiliary_path)
-
+from skabase import release
 from utils import (get_dp_command, exception_manager,
                            tango_type_conversion, coerce_value,
                            get_groups_from_json, get_tango_device_type_id)
@@ -50,12 +46,10 @@ from logging.handlers import SysLogHandler
 
 # Initialize logging
 logging.basicConfig()
-
 # PROTECTED REGION END #    //  SKABaseDevice.additionnal_import
 
 __all__ = ["SKABaseDevice", "main"]
 
-
 class SKABaseDevice(with_metaclass(DeviceMeta, Device)):
     """
     A generic base device for SKA.

skabase/SKABaseDevice/__init__.py

@@ -7,14 +7,13 @@
 
 """SKABASE
 
-A generic base device for SKA. It exposes the generic attributes, properties and commands of an SKA device.
+__init__.py: A generic base device for SKA. It exposes the generic attributes, properties and commands of an SKA device.
 """
+__all__ = ["SKABaseDevice", "main"]
 
-__all__ = ["SKABaseDevice", "main", "release"]
+from skabase import release
+from .SKABaseDevice import SKABaseDevice, main
 
-# import release
-# from .SKABaseDevice import SKABaseDevice, main
-#
-# __version__ = release.version
+__version__ = release.version
+__version_info__ = release.version_info
+__author__ = release.author
\ No newline at end of file
-# __version_info__ = release.version_info
-# __author__ = release.author

skabase/SKABaseDevice/release.py

-# -*- coding: utf-8 -*-
-#
-# This file is part of the SKABaseDevice project
-#
-#
-#
-
-"""Release information for Python Package"""
-
-name = """tangods-skabasedevice"""
-version = "1.0.0"
-version_info = version.split(".")
-description = """A generic base device for SKA."""
-author = "cam"
-author_email = "cam at ska.ac.za"
-license = """BSD-3-Clause"""
-url = """www.tango-controls.org"""
-copyright = """"""

skabase/SKABaseDevice/test/SKABaseDevice_test.py

@@ -18,6 +18,7 @@ sys.path.insert(0, os.path.abspath(path))
 # Imports
 import pytest
 from tango import DevState
+import re
 
 # PROTECTED REGION ID(SKABaseDevice.test_additional_imports) ENABLED START #
 # PROTECTED REGION END #    //  SKABaseDevice.test_additional_imports
@@ -90,7 +91,11 @@ class TestSKABaseDevice(object):
     def test_GetVersionInfo(self, tango_context):
         """Test for GetVersionInfo"""
         # PROTECTED REGION ID(SKABaseDevice.test_GetVersionInfo) ENABLED START #
-        assert tango_context.device.GetVersionInfo() == [""]
+        versionPattern = re.compile(
+            r'SKABaseDevice, lmc-base-classes, [0-9].[0-9].[0-9], '
+            r'A set of generic base devices for SKA Telescope.')
+        versionInfo = tango_context.device.GetVersionInfo()
+        assert (re.match(versionPattern, versionInfo[0])) != None
         # PROTECTED REGION END #    //  SKABaseDevice.test_GetVersionInfo
 
     # PROTECTED REGION ID(SKABaseDevice.test_Reset_decorators) ENABLED START #
@@ -107,7 +112,10 @@ class TestSKABaseDevice(object):
     def test_buildState(self, tango_context):
         """Test for buildState"""
         # PROTECTED REGION ID(SKABaseDevice.test_buildState) ENABLED START #
-        assert tango_context.device.buildState == ''
+        buildPattern = re.compile(
+            r'lmc-base-classes, [0-9].[0-9].[0-9], '
+            r'A set of generic base devices for SKA Telescope')
+        assert (re.match(buildPattern, tango_context.device.buildState)) != None
         # PROTECTED REGION END #    //  SKABaseDevice.test_buildState
 
     # PROTECTED REGION ID(SKABaseDevice.test_versionId_decorators) ENABLED START #
@@ -115,7 +123,8 @@ class TestSKABaseDevice(object):
     def test_versionId(self, tango_context):
         """Test for versionId"""
         # PROTECTED REGION ID(SKABaseDevice.test_versionId) ENABLED START #
-        assert tango_context.device.versionId == ''
+        versionIdPattern = re.compile(r'[0-9].[0-9].[0-9]')
+        assert (re.match(versionIdPattern, tango_context.device.versionId)) != None
         # PROTECTED REGION END #    //  SKABaseDevice.test_versionId
 
     # PROTECTED REGION ID(SKABaseDevice.test_centralLoggingLevel_decorators) ENABLED START #

skabase/SKACapability/SKACapability.py

@@ -24,7 +24,7 @@ import sys
 from future.utils import with_metaclass
 
 # SKA specific imports
-import release # DO NOT import after modifying system path
+from skabase import release
 
 file_path = os.path.dirname(os.path.abspath(__file__))
 obs_device_path = os.path.abspath(os.path.join(file_path, os.pardir)) + "/SKAObsDevice"

skabase/SKACapability/__init__.py

@@ -10,10 +10,10 @@
 A Subarray handling device. It exposes the instances of configured capabilities.
 """
 
-__all__ = ["SKACapability", "main", "release"]
-# from . import release
-# from .SKACapability import SKACapability, main
-#
-# __version__ = release.version
-# __version_info__ = release.version_info
-# __author__ = release.author
+__all__ = ["SKACapability", "main"]
+from skabase import release
+from .SKACapability import SKACapability, main
+
+__version__ = release.version
+__version_info__ = release.version_info
+__author__ = release.author

skabase/SKACapability/release.py

-# -*- coding: utf-8 -*-
-#
-# This file is part of the SKACapability project
-#
-#
-#
-
-"""Release information for Python Package"""
-
-name = """tangods-skacapability"""
-version = "1.0.0"
-version_info = version.split(".")
-description = """Subarray handling device"""
-author = "cam"
-author_email = "cam at ska.ac.za"
-license = """BSD-3-Clause"""
-url = """www.tango-controls.org"""
-copyright = """"""

skabase/SKACapability/setup.py

-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-#
-# This file is part of the SKACapability project
-#
-#
-#
-
-""" Setup file for SKAcapability base class"""
-
-import os
-import sys
-from setuptools import setup
-
-setup_dir = os.path.dirname(os.path.abspath(__file__))
-
-# make sure we use latest info from local code
-sys.path.insert(0, setup_dir)
-
-readme_filename = os.path.join(setup_dir, 'README.rst')
-with open(readme_filename) as file:
-    long_description = file.read()
-
-release_filename = os.path.join(setup_dir, 'SKACapability', 'release.py')
-exec(open(release_filename).read())
-
-pack = ['SKACapability']
-
-setup(name=name,
-      version=version,
-      description='Subarray handling device',
-      packages=pack,
-      include_package_data=True,
-      test_suite="test",
-      entry_points={'console_scripts':['SKACapability = SKACapability:main']},
-      author='cam',
-      author_email='cam at ska.ac.za',
-      license='BSD-3-Clause',
-      long_description=long_description,
-      url='www.tango-controls.org',
-      platforms="All Platforms"
-      )

skabase/SKACapability/test/SKACapability_test.py

@@ -18,6 +18,7 @@ sys.path.insert(0, os.path.abspath(path))
 # Imports
 import pytest
 from tango import DevState
+import re
 
 # PROTECTED REGION ID(SKACapability.test_additional_imports) ENABLED START #
 # PROTECTED REGION END #    //  SKACapability.test_additional_imports
@@ -102,7 +103,11 @@ class TestSKACapability(object):
     def test_GetVersionInfo(self, tango_context):
         """Test for GetVersionInfo"""
         # PROTECTED REGION ID(SKACapability.test_GetVersionInfo) ENABLED START #
-        assert tango_context.device.GetVersionInfo() == [""]
+        versionPattern = re.compile(
+            r'SKACapability, lmc-base-classes, [0-9].[0-9].[0-9], '
+            r'A set of generic base devices for SKA Telescope.')
+        versionInfo = tango_context.device.GetVersionInfo()
+        assert (re.match(versionPattern, versionInfo[0])) != None
         # PROTECTED REGION END #    //  SKACapability.test_GetVersionInfo
 
     # PROTECTED REGION ID(SKACapability.test_ConfigureInstances_decorators) ENABLED START #
@@ -167,7 +172,10 @@ class TestSKACapability(object):
     def test_buildState(self, tango_context):
         """Test for buildState"""
         # PROTECTED REGION ID(SKACapability.test_buildState) ENABLED START #
-        assert tango_context.device.buildState == ''
+        buildPattern = re.compile(
+            r'lmc-base-classes, [0-9].[0-9].[0-9], '
+            r'A set of generic base devices for SKA Telescope')
+        assert (re.match(buildPattern, tango_context.device.buildState)) != None
         # PROTECTED REGION END #    //  SKACapability.test_buildState
 
     # PROTECTED REGION ID(SKACapability.test_versionId_decorators) ENABLED START #
@@ -175,7 +183,8 @@ class TestSKACapability(object):
     def test_versionId(self, tango_context):
         """Test for versionId"""
         # PROTECTED REGION ID(SKACapability.test_versionId) ENABLED START #
-        assert tango_context.device.versionId == ''
+        versionIdPattern = re.compile(r'[0-9].[0-9].[0-9]')
+        assert (re.match(versionIdPattern, tango_context.device.versionId)) != None
         # PROTECTED REGION END #    //  SKACapability.test_versionId
 
     # PROTECTED REGION ID(SKACapability.test_centralLoggingLevel_decorators) ENABLED START #