5. Deprecating an Old Config Variable

If a config variable changes names, an alert is needed to let the user know that they need to update the config files if they are using a deprecated variable.

5.1. Example


changed to


The new variable is set to wgrib2 in the default config file (parm/metplus_config/defaults.conf). If the user is still using WGRIB2_EXE to set to /usr/local/bin/wgrib2, this value will not be read and the user will have no way to know that they are setting the wrong variable and it is using WGRIB2 = wgrib2.

5.2. check_for_deprecated_config()

In metplus/util/config_metplus.py there is a function called check_for_deprecated_config. It contains a dictionary of dictionaries called deprecated_dict that specifies the old config name, the section it was found in, and a suggested alternative (None if no alternative exists).

Example 1

'WGRIB2_EXE' : {'sec' : 'exe', 'alt' : 'WGRIB2'}

This says that WGRIB2_EXE was found in the [exe] section and should be replaced with WGRIB2.

Example 2

'PREPBUFR_DIR_REGEX' : {'sec' : 'regex_pattern', 'alt' : None}

This says that [regex_pattern] PREPBUFR_DIR_REGEX is no longer used and there is no alternative (because the wrapper uses filename templates instead of regex now).

If any of these old variables are found in any config file passed to METplus by the user, an error report will be displayed with the old variables and suggested new ones if applicable.

If support for an old config variable is temporarily needed, the user should be warned to update their config file because the variable will be phased out in the future. In this case, add the ‘req’ item to the dictionary and set it to False. This will provide a warning to the user but will not stop the execution of the code. If this is done, be sure to modify the code to check for the new config variable, and if it is not set, check the old config variable to see if it is set.


'LOOP_METHOD' : {'sec' : 'config', 'alt' : 'LOOP_ORDER', 'req' : False}

This says that [config] LOOP_METHOD is deprecated and the user should use LOOP_ORDER, but it is not required to change immediately. If this is done, it is important to check for LOOP_ORDER and then check for LOOP_METHOD if it is not set.

In run_metplus.py:

loop_order = config.getstr('config', 'LOOP_ORDER', '')
if loop_order == '':
    loop_order = config.getstr('config', 'LOOP_METHOD')