casaconfig 1.0.2__py3-none-any.whl

casaconfig/__init__.py

@@ -0,0 +1,15 @@
+"""
+Interface specification for all user facing external functions in the casaconfig package.
+"""
+# __init__.py
+from .private.pull_data import pull_data
+from .private.data_available import data_available
+from .private.data_update import data_update
+from .private.do_auto_updates import do_auto_updates
+from .private.measures_available import measures_available
+from .private.measures_update import measures_update
+from .private.update_all import update_all
+from .private.set_casacore_path import set_casacore_path
+from .private.get_config import get_config
+from .private.get_data_info import get_data_info
+from .private.CasaconfigErrors import *

casaconfig/__main__.py

@@ -0,0 +1,143 @@
+import sys
+import os
+from casaconfig.private.get_argparser import get_argparser
+
+parser = get_argparser(add_help=True)
+
+# get_argparser supplies configfile, noconfig, nositeconfig
+# add measurespath, pull-data, data-update, measures-update, update-all, reference-testing, current-data
+
+parser.prog = "casaconfig"
+
+# measurespath will default to the value in config if not set here
+parser.add_argument( "--measurespath", dest='measurespath', default=None,
+                     help="location of casarundata")
+
+parser.add_argument( "--pull-data", dest='pulldata', action='store_const', const=True, default=False,
+                     help="invoke pull_data() to populate measurespath with latest casarundata")
+parser.add_argument( "--data-update", dest='dataupdate', action='store_const', const=True, default=False,
+                     help="invoke data_update() to update measurespath to the latest casarundata")
+parser.add_argument( "--measures-update", dest='measuresupdate', action='store_const', const=True, default=False,
+                     help="invoke measures_update() to update measurespath to the latest measures data")
+parser.add_argument( "--update-all", dest='updateall', action='store_const', const=True, default=False,
+                     help="invoke update_all() to populate (update) measurespath with the latest casarundata and measures data")
+parser.add_argument( "--reference-testing", action='store_const', const=True, dest='referencetesting', default=False,
+                     help="set measurespath to the casarundata when this version was produced, used for testing purposes")
+parser.add_argument( "--current-data", dest='currentdata', action='store_const', const=True, default=False,
+                     help="print out a summary of the current casarundata and measures data installed in measurespath and then exit")
+parser.add_argument( "--summary", dest='summary', action='store_const', const=True, default=False,
+                     help="print out a summary of casaconfig data handling and the exit")
+parser.add_argument("--force", dest='force', action='store_const', const=True, default=False,
+                    help="force an update using the force=True option to update_all, data_update, and measures_update")
+
+# initialize the configuration to be used
+flags,args = parser.parse_known_args(sys.argv)
+from casaconfig import config
+
+# import the casaconfig module
+import casaconfig
+
+# make sure measurespath reflects any command line value
+if flags.measurespath is None:
+    flags.measurespath = config.measurespath
+else:
+    config.measurespath = flags.measurespath
+
+# watch for measurespath of None, that likely means that casasiteconfig.py is in use and this has not been set. It can't be used then.
+try:
+    if flags.measurespath is None:
+        print("measurespath has been set to None in the user or site config file.")
+        print("Either provide a measurespath on the casaconfig command line or edit the user or site config file to set measurespath to a location.")
+        sys.exit(1)
+
+    # do any expanduser and abspath - this is what should be used
+    measurespath = os.path.abspath(os.path.expanduser(flags.measurespath))
+
+    if flags.currentdata:
+        if not os.path.exists(measurespath) or not os.path.isdir(measurespath):
+            print("No data installed at %s. The measurespath does not exist or is not a directory." % measurespath)
+        else:
+            print("current data installed at %s" % measurespath)
+            dataInfo = casaconfig.get_data_info(measurespath)
+        
+            # casarundata
+            casarunInfo = dataInfo['casarundata']
+            if casarunInfo is None or casarunInfo['version'] == "invalid":
+                print("No casarundata found (missing readme.txt and not obviously legacy casa data).")
+            if casarunInfo['version'] == "error":
+                print("Unexpected casarundata readme.txt content; casarundata should be reinstalled.")
+            elif casarunInfo['version'] == "unknown":
+                print("casarundata version is unknown (probably legacy casa data not maintained by casaconfig).")
+            else:
+                currentVersion = casarunInfo['version']
+                currentDate = casarunInfo['date']
+                print('casarundata version %s installed on %s' % (currentVersion, currentDate))
+            
+            # measures
+            measuresInfo = dataInfo['measures']
+            if measuresInfo is None or measuresInfo['version'] == "invalid":
+                print("No measures data found (missing readme.txt and not obviously legacy measures data).")
+            if measuresInfo['version'] == "error":
+                print("Unexpected measures readme.txt content; measures should be reinstalled.")
+            elif measuresInfo['version'] == "unknown":
+                print("measures version is unknown (probably legacy measures data not maintained by casaconfig).")
+            else:
+                currentVersion = measuresInfo['version']
+                currentDate = measuresInfo['date']
+                print('measures version %s installed on %s' % (currentVersion, currentDate))
+ 
+        # ignore any other arguments
+    elif flags.summary:
+        from casaconfig.private.summary import summary
+        summary(config)
+        # ignore any other arguments
+    else:
+        if flags.referencetesting:
+            print("reference testing using pull_data and 'release' version into %s" % measurespath)
+            casaconfig.pull_data(measurespath,'release')
+            # ignore all other options
+        else:
+            # watch for nothing actually set
+            if not flags.updateall and not flags.pulldata and not flags.dataupdate and not flags.measuresupdate:
+                parser.print_help()
+                sys.exit(1)
+            # the update options, update all does everything, no need to invoke anything else
+            print("Checking for updates into %s" % measurespath)
+            if flags.updateall:
+                casaconfig.update_all(measurespath,force=flags.force)
+            else:
+                # do any pull_update first
+                if flags.pulldata:
+                    casaconfig.pull_data(measurespath)
+                # then data_update, not necessary if pull_data just happened
+                if flags.dataupdate and not flags.pulldata:
+                    casaconfig.data_update(measurespath, force=flags.force)
+                # then measures_update
+                if flags.measuresupdate:
+                    casaconfig.measures_update(measurespath, force=flags.force)
+
+except casaconfig.UnsetMeasurespath as exc:
+    # UnsetMeasurespath should not happen because measurespath is checked to not be None above, but just in case
+    print(str(exc))
+    print("This exception should not happen, check the previous messages for additional information and try a different path")
+    sys.exit(1)
+
+except casaconfig.BadReadme as exc:
+    print(str(exc))
+    sys.exit(1)
+
+except casaconfig.RemoteError as exc:
+    print(str(exc))
+    print("This is likely due to no network connection or bad connectivity to a remote site, wait and try again")
+    sys.exit(1)
+
+except casaconfig.BadLock as exc:
+    # the output produced by the update functions is sufficient, just re-echo the exception text itself
+    print(str(exc))
+    sys.exit(1)
+
+except casaconfig.NotWritable as exc:
+    print(str(exc))
+    sys.exit(1)
+
+sys.exit(0)

casaconfig/config.py

@@ -0,0 +1,155 @@
+########################################################################
+#
+# Copyright (C) 2022
+# Associated Universities, Inc. Washington DC, USA.
+#
+# This script is free software; you can redistribute it and/or modify it
+# under the terms of the GNU Library General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or (at your
+# option) any later version.
+#
+# This library is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
+# License for more details.
+#
+# You should have received a copy of the GNU Library General Public License
+# along with this library; if not, write to the Free Software Foundation,
+# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
+#
+# Correspondence concerning AIPS++ should be adressed as follows:
+#        Internet email: aips2-request@nrao.edu.
+#        Postal address: AIPS++ Project Office
+#                        National Radio Astronomy Observatory
+#                        520 Edgemont Road
+#                        Charlottesville, VA 22903-2475 USA
+#
+########################################################################
+'''
+Configuration state for all CASA python packages.
+DO NOT ADD new configuration variables here. Instead, add them in
+private/config_defaults_static.py.
+'''
+from .private import config_defaults as _config_defaults
+import traceback as __traceback
+import sys as __sys
+import os as __os
+import pkgutil as __pkgutil
+from .private import io_redirect as _io
+from .private.get_argparser import get_argparser as __get_argparser
+
+## dictionary to keep track of errors encountered
+__errors_encountered = { }
+
+def _standard_config_path( ):
+    standard_siteconfig_paths = [ '/opt/casa/casasiteconfig.py',
+                                  '/home/casa/casasiteconfig.py' ]
+
+    if 'CASASITECONFIG' in __os.environ:
+        f = __os.environ.get('CASASITECONFIG')
+        # if set, it must be a fully qualified file (leading '/') that exists
+        if f.find('/')==0 and __os.path.isfile(f):
+            return [ f ]
+        else:
+            global __errors_encountered
+            __errors_encountered[f] = f'CASASITECONFIG environment variable set to a path ({f}) which does not exist or is not fully qualified.'
+            print( f'Warning: {__errors_encountered[f]}', file=__sys.stderr )
+            return [ ]
+
+    for f in standard_siteconfig_paths:
+        if __os.path.isfile(f):
+            return [ f ]
+    return [ 'casasiteconfig' ]
+
+## list of config variables
+__defaults = [ x for x in dir(_config_defaults) if not x.startswith('_') ]
+
+## get the ArgumentParser with the arguments needed by casaconfig, help is turned off
+__parser = __get_argparser()
+__flags,__args = __parser.parse_known_args(__sys.argv)
+__user_config = [ ] if __flags.noconfig else [ __os.path.abspath( __os.path.expanduser( __flags.configfile )) ]
+__site_config = [ ] if __flags.nositeconfig else _standard_config_path( )
+
+## files to be evaluated/loaded
+__config_files = [ * __site_config , *__user_config ]
+__loaded_config_files = [ __file__ ]
+
+## evaluate config files
+## ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ---- ----
+## If the the execution mode of python is module execution (e.g. "python3 -m casatools") then
+## the output from the configuration files is thrown away. Otherwise, all output from the
+## configuration files is passed through. This allows for output from module execution to
+## be used by scripts.
+##
+_module_execution = len(__sys.argv) > 0 and __sys.argv[0] == '-m'
+with _io.all_redirected(to=__os.devnull) if _module_execution else _io.no_redirect( ):
+    for __f in  __config_files :
+        if __f.find('/') >= 0:
+            if __os.path.exists(__f):
+                 ## config file is a fully qualified path
+                 try:
+                     __orig = { k: _config_defaults._globals( )[k] for k in __defaults }
+                     exec( open(__f).read( ), __orig )
+                 except Exception as e:
+                     __errors_encountered[__f] = __traceback.format_exc( )
+                 else:
+                     for __v in __defaults:
+                         _config_defaults._globals( )[__v] = __orig[__v]
+                     __loaded_config_files.append( __f )
+        else:
+            ## config file is a package name
+            __pkg = __pkgutil.get_loader(__f)
+            if __pkg is not None:
+                try:
+                    __orig = { k: _config_defaults._globals( )[k] for k in __defaults }
+                    exec(open(__pkg.get_filename( )).read( ),__orig)
+                except Exception as e:
+                    __errors_encountered[__pkg.get_filename( )] = __traceback.format_exc( )
+                else:
+                    for __v in __defaults:
+                        _config_defaults._globals( )[__v] = __orig[__v]
+                    __loaded_config_files.append( __pkg.get_filename( ) )
+
+# if datapath is empty here, set it to [measurespath]
+if len(_config_defaults.datapath) == 0:
+    # watch for measurespath = None, which likely means the casasiteconfig.py is in use and has not been set
+    # it's up to downstream acts to catch that and give some feedback, but don't use it here if it's None
+    if _config_defaults.measurespath is not None:
+        _config_defaults.datapath = [ _config_defaults.measurespath ]
+
+# the names of config values that are path that need to be expanded here
+__path_names = ["cachedir","datapath","measurespath","logfile","iplogfile","startupfile"]
+
+for __v in __defaults:
+    globals()[__v] = getattr(_config_defaults,__v,None)
+    if (__v in __path_names) :
+        # expand ~ or ~user constructs and make sure they are absolute paths
+        if (type(globals()[__v]) is list) :
+            # None values cause problems with expanduser, do these individually
+            # None values aren't useful in a list, don't carry them forward
+            __vlist = []
+            for __vval in globals()[__v]:
+                if __vval is not None:
+                    __vval = __os.path.abspath(__os.path.expanduser(__vval))
+                    __vlist.append(__vval)
+                else:
+                    # debugging for now
+                    print("None value seen in config parameter list %s, skipped" % __v)
+                    print("__loaded_config_files : ")
+                    for __f in __loaded_config_files:
+                        print("  %s" % __f)
+                        
+            globals()[__v] = __vlist
+        else:
+            # watch for None values here (possibly also in the list, but just here for now)
+            if globals()[__v] is not None:
+                globals()[__v] = __os.path.abspath(__os.path.expanduser(globals()[__v]))
+            else:
+                pass
+                # debugging
+                # print("None value seen while expanding path-like fields for config parameter %s" % __v)
+                
+def load_success( ):
+    return __loaded_config_files
+def load_failure( ):
+    return __errors_encountered

casaconfig/private/CasaconfigErrors.py

@@ -0,0 +1,42 @@
+# Copyright 2024 AUI, Inc. Washington DC, USA
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+"""
+this module will be included in the api
+"""
+
+class AutoUpdatesNotAllowed(Exception):
+    """Raised when a path does not exist or is not owned by the user"""
+    pass
+
+class BadLock(Exception):
+    """Raised when the lock file is not empty and a lock attempt was made"""
+    pass
+
+class BadReadme(Exception):
+    """Raised when a readme.txt file does not contain the expected contents"""
+    pass
+
+class NoReadme(Exception):
+    """Raised when the readme.txt file is not found at path (path also may not exist)"""
+
+class RemoteError(Exception):
+    """Raised when there is an error fetching some remote content"""
+    pass
+
+class NotWritable(Exception):
+    """Raised when the path is not writable by the user"""
+
+class UnsetMeasurespath(Exception):
+    """Raised when a path argument is None"""
+    pass

casaconfig/private/casasiteconfig_example.py

@@ -0,0 +1,19 @@
+# An example site config file.
+# Place this in a location checked by casaconfig :
+#   /opt/casa/casasiteconfig.py
+#   /home/casa/casasiteconfig.py
+#   the environment value CASASITECONFIG - use the fully qualified path
+#   anywhere in the python path, e.g. the site-packages directory in the CASA being used.
+#
+
+# This file should be edited to set measurespath as appropriate
+
+# Set this to point to the location where the site maintained casarundata can be found
+# by default datapath will include measurespath
+
+measurespath = "/path/to/installed/casarundata"
+
+# turn off all auto updates of data
+
+measures_auto_update = False
+data_auto_update = False

casaconfig/private/config_defaults.py

@@ -0,0 +1,50 @@
+########################################################################
+#
+# Copyright (C) 2022
+# Associated Universities, Inc. Washington DC, USA.
+#
+# This script is free software; you can redistribute it and/or modify it
+# under the terms of the GNU Library General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or (at your
+# option) any later version.
+#
+# This library is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
+# License for more details.
+#
+# You should have received a copy of the GNU Library General Public License
+# along with this library; if not, write to the Free Software Foundation,
+# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
+#
+# Correspondence concerning AIPS++ should be adressed as follows:
+#        Internet email: aips2-request@nrao.edu.
+#        Postal address: AIPS++ Project Office
+#                        National Radio Astronomy Observatory
+#                        520 Edgemont Road
+#                        Charlottesville, VA 22903-2475 USA
+#
+########################################################################
+'''
+Default values for the configuration variables for all CASA python packages.
+DO NOT ADD new configuration variables here. Instead, add them in
+config_defaults_static.py (found in the same directory as this file).
+'''
+import os as _os
+import sys as _sys
+import time as _time
+import pkgutil as _pkgutil
+
+from .get_argparser import get_argparser as __get_argparser
+
+## get the ArgumentParser with the arguments needed by casaconfig, help is turned off
+## this is used to supply command line configuration variales to the static defaults
+## specification.
+__parser = __get_argparser()
+__flags,__args = __parser.parse_known_args(_sys.argv)
+
+def _globals( ):
+    return globals()
+
+exec( open(_os.path.join(_os.path.dirname(__file__),'config_defaults_static.py')).read( ), globals( ) )
+

casaconfig/private/config_defaults_static.py

@@ -0,0 +1,56 @@
+# lsit of paths where CASA should search for data subdirectories. Default [measurespath].
+datapath = [ ]
+
+# location of required measures data, takes precedence over any measures data also present in datapath.
+measurespath = "~/.casa/data"
+
+# automatically update measures data if not current (measurespath must be owned by the user)
+# when data_auto_update is True then measures_auto_update MUST also be True
+measures_auto_update = True
+
+# automatically update casarundata and measures data if not current (measurespath must be owned by the user)
+data_auto_update = True
+
+# location of the optional user's startup.py
+startupfile = '~/.casa/startup.py'
+
+# location of the cachedir
+cachedir = '~/.casa'
+
+# log file path/name
+logfile='casa-%s.log' % _time.strftime("%Y%m%d-%H%M%S", _time.gmtime())
+
+# do not create a log file when True, If True, then any logfile value is ignored and there is no log file
+nologfile = False
+
+# print log output to terminal when True (in addition to any logfile and CASA logger)
+log2term = False
+
+# do not start the CASA logger GUI when True
+nologger = False
+
+# avoid starting GUI tools when True. If True then the CASA logger is not started even if nologger is False
+nogui = False
+
+# the IPython prompt color scheme. Must be one of "Neutral", "NoColor", "Linux" or "LightBG", default "Neutral"
+# if an invalid color is given a warning message is printed and logged but CASA continues using the default color
+colors = "Neutral"
+
+# startup without a graphical backend if True
+agg = False
+
+# attempt to load the pipeline modules and set other options appropriate for pipeline use if True
+# when pipeline is True then agg will be assumed to be true even if agg is set to False here or on the command line
+pipeline = False
+
+# create and use an IPython log using the iplogfile path
+iplog = False
+
+# the IPython log file path name to be used when iplog is True
+iplogfile='ipython-%s.log' % _time.strftime("%Y%m%d-%H%M%S", _time.gmtime())
+
+# include the user's local site-packages in the python path if True. May conflict with CASA modules
+user_site = False
+
+# verbosity level for casaconfig
+casaconfig_verbose = 1

casaconfig/private/data_available.py

@@ -0,0 +1,88 @@
+# Copyright 2023 AUI, Inc. Washington DC, USA
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+"""
+this module will be included in the api
+"""
+
+def data_available():
+    """
+    List available casarundata versions on CASA server at https://go.nrao.edu/casarundata
+
+    This returns a list of the casarundata versions available on the CASA
+    server. The version parameter of data_update must be one
+    of the values in that list if set (otherwise the most recent version
+    in this list is used).
+
+    A casarundata version is the filename of the tarball and look 
+    like "casarundata.x.y.z.tar.*" (different compressions may be used by CASA without
+    changing casaconfig functions that use those tarballs). The full filename is
+    the casarundata version expected in casaconfig functions.
+
+    Parameters
+       None
+    
+    Returns
+       list - version names returned as list of strings
+
+    Raises
+       - casaconfig.RemoteError - Raised when there is an error fetching some remote content
+       - Exception - Unexpected exception while getting list of available casarundata versions
+
+    """
+
+    import html.parser
+    import urllib.request
+    import urllib.error
+    import ssl
+    import certifi
+
+    from casaconfig import RemoteError
+    
+    class LinkParser(html.parser.HTMLParser):
+        def reset(self):
+            super().reset()
+            self.rundataList = []
+
+        def handle_starttag(self, tag, attrs):
+            if tag == 'a':
+                for (name, value) in attrs:
+                    # only care if this is an href and the value starts with
+                    # casarundata and has '.tar.' somewhere later and does not end in .md5
+                    if name == 'href' and (value.startswith('casarundata') and (value.rfind('.tar')>11) and (value[-4:] != '.md5')):
+                        # only add it to the list if it's not already there
+                        if (value not in self.rundataList):
+                            self.rundataList.append(value)
+
+    try:
+        context = ssl.create_default_context(cafile=certifi.where())
+        with urllib.request.urlopen('https://go.nrao.edu/casarundata/', context=context, timeout=400) as urlstream:
+            parser = LinkParser()
+            encoding = urlstream.headers.get_content_charset() or 'UTF-8'
+            for line in urlstream:
+                parser.feed(line.decode(encoding))
+
+        # return the sorted list, earliest versions are first, newest is last
+        return sorted(parser.rundataList)
+
+    except urllib.error.URLError as urlerr:
+        raise RemoteError("Unable to retrieve list of available casarundata versions : " + str(urlerr)) from None
+        
+    except Exception as exc:
+        msg = "Unexpected exception while getting list of available casarundata versions : " + str(exc)
+        raise Exception(msg)
+
+    # nothing to return if it got here, must have been an exception
+    return []
+
+