Skip to content

Commit

Permalink
whitespace change
Browse files Browse the repository at this point in the history
  • Loading branch information
@tnakazato
tnakazato committed Jan 20, 2025
1 parent 1995fe6 commit fef3a07
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 47 deletions.
52 changes: 26 additions & 26 deletions casaconfig/private/data_update.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

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
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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 = []
Expand All @@ -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')
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
42 changes: 21 additions & 21 deletions casaconfig/private/pull_data.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@ def pull_data(path=None, version=None, force=False, logger=None, verbose=None):
The verbose argument controls the level of information provided when this function when the data
are unchanged for expected reasons. A level of 0 prints and logs nothing. A
value of 1 logs the information and a value of 2 logs and prints the information.
The path must either contain a previously installed version of casarundata
The path must either contain a previously installed version of casarundata
or it must not exist or be empty.
If path is None then config.measurespath will be used.
If version is None (the default) then the most recent version is pulled.
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 known then an error message is printed and nothing is
checked or installed.
Expand All @@ -43,20 +43,20 @@ def pull_data(path=None, version=None, force=False, logger=None, verbose=None):
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.
This file is used to determine if the contents are a previously installed
This file is used to determine if the contents are a previously installed
version. If path is not empty then this file must exist with the expected
contents in order for pull_data to proceed.
If the version to be pulled matches the version in the readme.txt file then
If the version to be pulled matches the version in the readme.txt file then
pull_data does nothing unless force is True. No error messages will result when the
version already matches what was previously installed (no installation is then
necessary unless force is True).
The measures tables included in casarundata will typically not be the most
The measures tables included in casarundata will typically not be the most
recent version. To get the most recent measures data, measures_update
should be used after pull_data.
If path contains a previously installed version then all of the files listed in
If path contains a previously installed version then all of the files listed in
the manifest part of the readme.txt file are first removed from path. This ensures
that files not present in the version being installed are removed in moving to the
other version.
Expand All @@ -65,23 +65,23 @@ def pull_data(path=None, version=None, force=False, logger=None, verbose=None):
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 pull_data gets the lock it checks the readme.txt file in path
to make sure that a copy of the data should still be pulled (the version doesn't
to make sure that a copy of the data should still be pulled (the version doesn't
match what was requested, or force is True). 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 and the contents of path are suspect. In that case, pull_data
will report that as an error 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
pull_data can then be used to install the desired version. It may be safest in that case
to remove path completely or use a different path and run pull_data to install
to remove path completely or use a different path and run pull_data to install
a fresh copy of the desired version.
Some of the tables installed by pull_data are only read when casatools starts. Use of
pull_data should typically be followed by a restart of CASA so that
Some of the tables installed by pull_data are only read when casatools starts. Use of
pull_data 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:** When version is None (the default), data_available is always used to find out
what versions are available. There is no check on when the data were last updated before
calling data_available (as there is in the two update functions).
calling data_available (as there is in the two update functions).
Parameters
- path (str) - Folder path to place casarundata contents. It must be empty or not exist or contain a valid, previously installed version. If not set then config.measurespath is used.
Expand Down Expand Up @@ -131,7 +131,7 @@ def pull_data(path=None, version=None, force=False, logger=None, verbose=None):
available_data = None
currentVersion = None
currentDate = None

# attempt a pull if path does not exist or is empty (except for any lock file, handled later)
readmeInfo = get_data_info(path, logger, type='casarundata')
do_pull = readmeInfo is None
Expand Down Expand Up @@ -164,7 +164,7 @@ def pull_data(path=None, version=None, force=False, logger=None, verbose=None):
# this shouldn't happen
# no lock has been set yet, safe to raise this exception without worrying about the lock
raise BadReadme('pull_data: the readme.txt file at path did not contain the expected list of installed files')

# the readme file looks as expected, pull if the version is different or force is true
if version is None:
# use most recent available
Expand All @@ -179,16 +179,16 @@ def pull_data(path=None, version=None, force=False, logger=None, verbose=None):
# safe to return here, no lock has been set
print_log_messages('pull_data: version is already at the expected version and force is False. Nothing was changed', logger, verbose=verbose)
return

# a pull will happen, unless the version string is not available

if version is None:
# need a version, use most recent available

if available_data is None:
# this may raise a RemoteError, no need to catch that here but it may need to be caught upstream
available_data = data_available()

version = available_data[-1]

expectedMeasuresVersion = None
Expand All @@ -205,7 +205,7 @@ def pull_data(path=None, version=None, force=False, logger=None, verbose=None):
if available_data is None:
# this may raise a RemoteError, no need to catch that here but it may need to be caught upstream
available_data = data_available()

if version not in available_data:
print_log_messages('version %s not found on CASA server, use casaconfig.data_available() for a list of casarundata versions' % version, logger, True)
return
Expand All @@ -226,7 +226,7 @@ def pull_data(path=None, version=None, force=False, logger=None, verbose=None):

lock_fd = get_data_lock(path, 'pull_data')
# the BadLock exception that may happen here is caught below

do_pull = True
if not force:
# need to recheck any readme file that may be present here
Expand Down Expand Up @@ -297,7 +297,7 @@ def pull_data(path=None, version=None, force=False, logger=None, verbose=None):
msgs.append('Check for other updates in progress or choose a different path or clear out this path and try again')
print_log_messages(msgs, logger, True)
raise

except Exception as exc:
msgs = []
msgs.append('ERROR! : Unexpected exception while populating casarundata version %s to %s' % (version, path))
Expand All @@ -311,5 +311,5 @@ def pull_data(path=None, version=None, force=False, logger=None, verbose=None):
if clean_lock:
lock_fd.truncate(0)
lock_fd.close()

return

0 comments on commit fef3a07

Please sign in to comment.