casaconfig 1.0.1__tar.gz → 1.0.3__tar.gz

casaconfig-1.0.3/PKG-INFO

@@ -0,0 +1,292 @@
+Metadata-Version: 2.2
+Name: casaconfig
+Version: 1.0.3
+Summary: CASA Operational Configuration Package
+Author-email: National Radio Astronomy Observatory <casa-feedback@nrao.edu>
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright 2020 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.
+        
+Project-URL: Homepage, https://casa.nrao.edu/
+Project-URL: Documentation, https://casadocs.readthedocs.io/
+Project-URL: Repository, https://github.com/casangi/casaconfig.git
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: certifi>=2023.5.7
+
+# casaconfig
+Runtime data necessary for CASA operation.
+
+- [latest casaconfig API on casadocs](https://casadocs.readthedocs.io/en/latest/api/casaconfig.html)
+- [stable casaconfig API on casadocs](https://casadocs.readthedocs.io/en/stable/api/casaconfig.html)
+      
+
+## Release Instructions
+1. Create a release branch with a version name (ie v1.6.2)
+2. Ensure the version number in pyproject.toml on the branch is set correctly
+3. Create a tag of the release branch (ie v1.6.2-1)
+4. Github Action runs automatically to publish a pip package to pypi
+
+## Installation
+
+```
+$: pip install casaconfig
+```
+
+## Usage
+
+See the casaconfig API documentation on casadocs (links above).
+
+Also see the External Data section of casadocs for additional details
+
+- [latext External Data section on casadocs](https://casadocs.readthedocs.io/en/latest/notebooks/external-data.html)
+- [stable External Data section on casadocs](https://casadocs.readthedocs.io/en/latest/notebooks/external-data.html)
+
+## Developers Instructions
+1. every push to the casaconfig repository will push a new wheel to [test pypi](https://test.pypi.org/project/casaconfig/#history)
+2. the version in pyproject.toml must be updated before each push so that the wheel has a unique name (e.g. "1.2.3dev2", where "dev?" could be incremented during development; see the [specification](https://packaging.python.org/en/latest/specifications/version-specifiers/#version-specifiers) for more information about valid version signifiers)
+3. When testing with a casatools build, "pip install" the development casaconfig wheel before running any tests - it may be installed before casatools is installed or after since the casatools build does not depend on casasconfig (uninstall any already installed casaconfig if necessary).
+4. For release, follow the above instructions.
+
+Wheels can be built locally following the same process used by the CI actions. To install the build-system dependencies as defined in pyproject.toml and then generate a source distribution and wheel:
+```
+python3 -m pip install build setuptools --user
+python3 -m build
+```
+This will create:
+```
+casaconfig.egg-info
+├── PKG-INFO
+├── SOURCES.txt
+├── dependency_links.txt
+├── requires.txt
+└── top_level.txt
+dist
+├── casaconfig-[VERSION]-py3-none-any.whl
+└── casaconfig-[VERSION].tar.gz
+```
+
+### Setting up CASA branches for casaconfig development
+
+The casaconfig build process publishes test wheels to test.pypi.org
+
+In order to test these with Casa packages, two changes are needed in the casa6 repository branch.
+
+1) Add a line to casa6/build.conf with the appropriate wheel version. For example:
+
+```
+casaconfig==1.0.3.dev2
+```
+2) Add the following line with the apppropriate branch name to casa6/casatools/setup.py
+
+```
+META_DATA["install_requires"] = "casaconfig@git+https://github.com/casangi/casaconfig@CAS-14512"
+```
+
+This adds the casaconfig branch as a casatools install time dependency. It will not use the wheel, but rather build the branch in place. This is required in order to avoid adding test.pypi.org as a pip extra-index-url, which might cause other development packages to be installed inadvertently. Note that casaconfig dependency is typically defined in setup.cfg, but the syntax above does not work with setup.cfg. 
+
+
+### Preparing the casa6 branch for merge
+
+1) Merge the casaconfig branch to main and create a wheel
+2) Update casa6/build.conf to use that wheel
+3) Comment out the extra "install_requires" line from setup.py

casaconfig-1.0.3/README.md

@@ -0,0 +1,77 @@
+# casaconfig
+Runtime data necessary for CASA operation.
+
+- [latest casaconfig API on casadocs](https://casadocs.readthedocs.io/en/latest/api/casaconfig.html)
+- [stable casaconfig API on casadocs](https://casadocs.readthedocs.io/en/stable/api/casaconfig.html)
+      
+
+## Release Instructions
+1. Create a release branch with a version name (ie v1.6.2)
+2. Ensure the version number in pyproject.toml on the branch is set correctly
+3. Create a tag of the release branch (ie v1.6.2-1)
+4. Github Action runs automatically to publish a pip package to pypi
+
+## Installation
+
+```
+$: pip install casaconfig
+```
+
+## Usage
+
+See the casaconfig API documentation on casadocs (links above).
+
+Also see the External Data section of casadocs for additional details
+
+- [latext External Data section on casadocs](https://casadocs.readthedocs.io/en/latest/notebooks/external-data.html)
+- [stable External Data section on casadocs](https://casadocs.readthedocs.io/en/latest/notebooks/external-data.html)
+
+## Developers Instructions
+1. every push to the casaconfig repository will push a new wheel to [test pypi](https://test.pypi.org/project/casaconfig/#history)
+2. the version in pyproject.toml must be updated before each push so that the wheel has a unique name (e.g. "1.2.3dev2", where "dev?" could be incremented during development; see the [specification](https://packaging.python.org/en/latest/specifications/version-specifiers/#version-specifiers) for more information about valid version signifiers)
+3. When testing with a casatools build, "pip install" the development casaconfig wheel before running any tests - it may be installed before casatools is installed or after since the casatools build does not depend on casasconfig (uninstall any already installed casaconfig if necessary).
+4. For release, follow the above instructions.
+
+Wheels can be built locally following the same process used by the CI actions. To install the build-system dependencies as defined in pyproject.toml and then generate a source distribution and wheel:
+```
+python3 -m pip install build setuptools --user
+python3 -m build
+```
+This will create:
+```
+casaconfig.egg-info
+├── PKG-INFO
+├── SOURCES.txt
+├── dependency_links.txt
+├── requires.txt
+└── top_level.txt
+dist
+├── casaconfig-[VERSION]-py3-none-any.whl
+└── casaconfig-[VERSION].tar.gz
+```
+
+### Setting up CASA branches for casaconfig development
+
+The casaconfig build process publishes test wheels to test.pypi.org
+
+In order to test these with Casa packages, two changes are needed in the casa6 repository branch.
+
+1) Add a line to casa6/build.conf with the appropriate wheel version. For example:
+
+```
+casaconfig==1.0.3.dev2
+```
+2) Add the following line with the apppropriate branch name to casa6/casatools/setup.py
+
+```
+META_DATA["install_requires"] = "casaconfig@git+https://github.com/casangi/casaconfig@CAS-14512"
+```
+
+This adds the casaconfig branch as a casatools install time dependency. It will not use the wheel, but rather build the branch in place. This is required in order to avoid adding test.pypi.org as a pip extra-index-url, which might cause other development packages to be installed inadvertently. Note that casaconfig dependency is typically defined in setup.cfg, but the syntax above does not work with setup.cfg. 
+
+
+### Preparing the casa6 branch for merge
+
+1) Merge the casaconfig branch to main and create a wheel
+2) Update casa6/build.conf to use that wheel
+3) Comment out the extra "install_requires" line from setup.py

{casaconfig-1.0.1 → casaconfig-1.0.3}/casaconfig/__main__.py

@@ -131,6 +131,10 @@ except casaconfig.RemoteError as 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.NoNetwork as exc:
+    print("No network seen, can not continue.")
+    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))

{casaconfig-1.0.1 → casaconfig-1.0.3}/casaconfig/private/CasaconfigErrors.py

@@ -36,7 +36,12 @@ class RemoteError(Exception):
 
 class NotWritable(Exception):
     """Raised when the path is not writable by the user"""
+    pass
 
 class UnsetMeasurespath(Exception):
     """Raised when a path argument is None"""
     pass
+
+class NoNetwork(Exception):
+    """Raised when there is no network connection."""
+    pass

{casaconfig-1.0.1 → casaconfig-1.0.3}/casaconfig/private/data_available.py

@@ -36,7 +36,8 @@ def data_available():
        list - version names returned as list of strings
 
     Raises
-       - casaconfig.RemoteError - Raised when there is an error fetching some remote content
+       - casaconfig.NoNetwork - Raised where there is no network seen, can not continue
+       - casaconfig.RemoteError - Raised when there is an error fetching some remote content for some reason other than no network
        - Exception - Unexpected exception while getting list of available casarundata versions
 
     """
@@ -48,6 +49,12 @@ def data_available():
     import certifi
 
     from casaconfig import RemoteError
+    from casaconfig import NoNetwork
+
+    from .have_network import have_network
+
+    if not have_network():
+        raise NoNetwork("No network, can not find the list of available data.")
     
     class LinkParser(html.parser.HTMLParser):
         def reset(self):

{casaconfig-1.0.1 → casaconfig-1.0.3}/casaconfig/private/data_update.py

@@ -17,7 +17,7 @@ this module will be included in the api
 
 def data_update(path=None, version=None, force=False, logger=None, auto_update_rules=False, verbose=None):
     """
-    Check for updates to the installed casarundata and install the update or change to 
+    Check for updates to the installed casarundata and install the update or change to
     the requested version when appropriate.
 
     The verbose argument controls the level of information provided when this function when the data
@@ -26,19 +26,19 @@ def data_update(path=None, version=None, force=False, logger=None, auto_update_r
 
     The path must contain a previously installed version of casarundata.
     Use pull_data to install casarundata into a new path (empty or does not exist).
-    
+
     If path is None then config.measurespath is used.
 
-    If the version is None (the default) then the most recent version returned by 
+    If the version is None (the default) then the most recent version returned by
     data_available is used.
 
-    If version is "release" then the version associated with the release in 
+    If version is "release" then the version associated with the release in
     the dictionary returned by get_data_info is used. If there is no release
-    version information available to casaconfig then an error message is printed 
+    version information available to casaconfig then an error message is printed
     and nothing is updated. Release version information is only available in
     monolithic CASA installations.
 
-    If a specific version is not requested (the default) and a check for the 
+    If a specific version is not requested (the default) and a check for the
     versions available for installation at path has been done within the past
     24 hours then this function does nothing even if there is a more
     recent version available from the CASA server unless force is True.
@@ -47,7 +47,7 @@ def data_update(path=None, version=None, force=False, logger=None, auto_update_r
     now) is installed even if that version is already installed or a check for the
     latest version has been done within the past 24 hours.
 
-    A text file (readme.txt at path) records the version string, the date 
+    A text file (readme.txt at path) records the version string, the date
     when that version was installed in path, and the files installed into path. That file
     must already exist in path in order to use this function. Use pull_data to install
     casarundata into a new location.
@@ -57,31 +57,31 @@ def data_update(path=None, version=None, force=False, logger=None, auto_update_r
     data_auto_update is True. Automatic updating happens during casatools initialization
     so that the updated casarundata and measures are in place before any tool needs to use them.
 
-    If an update is to be installed the previously installed files, as listed in the 
-    readme.txt file at path, are removed before the contents of the version 
+    If an update is to be installed the previously installed files, as listed in the
+    readme.txt file at path, are removed before the contents of the version
     being installed are unpacked. If the measures contents of path have been updated since
     the previously installed version of casarundata then those updates will also be removed
     by this data update while preparing to install the requested version of casarundata (which
-    includes a copy of the measures data that is likely older than today). A data update is 
-    typically followed by a measures_update to ensure that the most recent measures data 
+    includes a copy of the measures data that is likely older than today). A data update is
+    typically followed by a measures_update to ensure that the most recent measures data
     are installed.
 
     A file lock is used to prevent more that one data update (pull_data, measures_update,
-    or data_update) from updating any files in path at the same time. When locked, the 
+    or data_update) from updating any files in path at the same time. When locked, the
     lock file (data_update.lock in path) contains information about the process that
     has the lock. When data_update gets the lock it checks the readme.txt file in path
-    to make sure that an update is still necessary (if force is True then an update 
+    to make sure that an update is still necessary (if force is True then an update
     always happens). If the lock file is not empty then a previous update of path (pull_data,
     data_update, or measures_update) did not exit as expected or is still in process (via a
-    separate instance of CASA) and the contents of path may be suspect. In that case, 
-    an error will be reported and nothing will be updated. The lock file can be checked to 
-    see the details of when that file was locked. The lock file can be removed and data_update 
+    separate instance of CASA) and the contents of path may be suspect. In that case,
+    an error will be reported and nothing will be updated. The lock file can be checked to
+    see the details of when that file was locked. The lock file can be removed and data_update
     can be tried again. It may be safest in that case to remove path completely or use a
     different path and use pull_data to install a fresh copy of the desired version.
 
-    Some of the tables installed by data_update are only read when casatools starts. Use of 
-    data_update except during CASA startup by the auto update proess  should typically be 
-    followed by a restart of CASA so that any changes are seen by the tools and tasks that 
+    Some of the tables installed by data_update are only read when casatools starts. Use of
+    data_update except during CASA startup by the auto update proess  should typically be
+    followed by a restart of CASA so that any changes are seen by the tools and tasks that
     use this data.
 
     **Note:** data_update requires that the expected readme.txt file already exists at the top-level
@@ -101,10 +101,10 @@ def data_update(path=None, version=None, force=False, logger=None, auto_update_r
        - logger (casatools.logsink=None) - Instance of the casalogger to use for writing messages. Default None writes messages to the terminal.
        - auto_update_rules (bool=False) - If True then the user must be the owner of path, version must be None, and force must be False.
        - verbose (int) - Level of output, 0 is none, 1 is to logger, 2 is to logger and terminal, defaults to casaconfig_verbose in the config dictionary.
-        
+
     Returns
        None
-    
+
     Raises
        - casaconfig.AutoUpdatesNotAllowed - raised when path does not exist as a directory or is not owned by the user
        - casaconfig.BadLock - raised when the lock file was not empty when an attempt was made to obtain the lock
@@ -167,7 +167,7 @@ def data_update(path=None, version=None, force=False, logger=None, auto_update_r
     # path must be writable with execute bit set
     if (not os.access(path, os.W_OK | os.X_OK)) :
         raise NotWritable('data_update: No permission to write to %s, cannot update.' % path)
-    
+
     # try and digest the readme file
 
     installed_files = []
@@ -177,7 +177,7 @@ def data_update(path=None, version=None, force=False, logger=None, auto_update_r
 
     # already checked that path is OK, type is OK here, no need to trap for exceptions here
     dataReadmeInfo = get_data_info(path, logger, type='casarundata')
-    
+
     if dataReadmeInfo is None or dataReadmeInfo['version'] == 'invalid':
         msgs = []
         msgs.append('The readme.txt file at path could not be read as expected')
@@ -262,7 +262,7 @@ def data_update(path=None, version=None, force=False, logger=None, auto_update_r
             else:
                 if verbose > 0:
                     print_log_messages('Requested casarundata version is already installed in %s, %s' % (path, currentVersion), logger, verbose=verbose)
-                
+
             # no lock has been set yet, safe to simply return here
             return
 
@@ -307,7 +307,7 @@ def data_update(path=None, version=None, force=False, logger=None, auto_update_r
                         # always verbose here because the lock file is in use
                         print_log_messages('requested version is already installed.', logger)
                     do_update = False
-                    
+
             if do_update:
                 # update is still on, check the manifest
                 if len(installed_files) == 0:
@@ -330,7 +330,7 @@ def data_update(path=None, version=None, force=False, logger=None, auto_update_r
 
     except BadLock as exc:
         # the path is known to exist so this means that the lock file was not empty and it's not locked
-        msgs = str(exc)
+        msgs = [str(exc)]
         msgs.append('data_update: the lock file at %s is not empty.' % path)
         msgs.append('A previous attempt to update path may have failed or exited prematurely.')
         msgs.append('Remove the lock file and set force to True with the desired version (default to most recent).')
@@ -341,7 +341,7 @@ def data_update(path=None, version=None, force=False, logger=None, auto_update_r
 
     except BadReadme as exc:
         # something is wrong in the readme after an update was triggered, this shouldn't happen, print more context reraise this
-        msgs = str(exc)
+        msgs = [str(exc)]
         msgs.append('This should not happen unless multiple sessions are trying to update data at the same time and one experienced problems or was done out of sequence')
         msgs.append('Check for other updates in progress or choose a different path or clear out this path and try again using pull_data or update_all')
         print_log_messages(msgs, logger, True)
@@ -360,5 +360,5 @@ def data_update(path=None, version=None, force=False, logger=None, auto_update_r
             if clean_lock:
                 lock_fd.truncate(0)
             lock_fd.close()
-    
+
     return

{casaconfig-1.0.1 → casaconfig-1.0.3}/casaconfig/private/get_data_lock.py

@@ -29,6 +29,9 @@ def get_data_lock(path, fn_name):
 
     This function is intended for internal casaconfig use.
 
+    If there is not network (have_network returns False) then the lock file is not
+    set or initialized and a NoNetwork exception is raised.
+
     Parameters
        - path (str) - The location where 'data_update.log' is to be found.
        - fn_name (str) - A string giving the name of the calling function to be recorded in the lock file.
@@ -37,6 +40,7 @@ def get_data_lock(path, fn_name):
        - the open file descriptor holding the lock. Close this file descriptor to release the lock.
 
     Raises:
+        - casaconfig.NoNetwork - raised wheren there is no network, nothing can be downloaded so nothing should be locked.
         - casaconfig.BadLock - raised when the path to the lock file does not exist or the lock file is not empty as found
         - Exception - an unexpected exception was seen while writing the lock information to the file
 
@@ -48,6 +52,11 @@ def get_data_lock(path, fn_name):
     from datetime import datetime
 
     from casaconfig import BadLock
+    from casaconfig import NoNetwork
+    from .have_network import have_network
+
+    if not have_network():
+        raise NoNetwork("No network, lock file has not been set, unable to continue.")
 
     if not os.path.exists(path):
         raise BadLock("path to contain lock file does not exist : %s" % path)

casaconfig-1.0.3/casaconfig/private/have_network.py

@@ -0,0 +1,40 @@
+# Copyright 2025 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.
+
+import urllib.request
+import urllib.error
+
+def have_network():
+    """
+    check to see if an active network with general internet connectivity
+    is available. returns True if we have internet connectivity and
+    False if we do not.
+    """
+    ###
+    ### see: https://stackoverflow.com/questions/50558000/test-internet-connection-for-python3
+    ###
+    ### copied from in casagui/utils/__init__.py
+    ###
+    try:
+        with urllib.request.urlopen('http://clients3.google.com/generate_204') as response:
+            return response.status == 204
+    except urllib.error.HTTPError:
+        ### http error
+        return False
+    except urllib.error.ContentTooShortError:
+        return False
+    except urllib.error.URLError:
+        return False
+    except Exception:
+        return False