Skip to content

Commit 3d8938f

Browse files
AliciaBentley-NOAAalicia bentleyalicia bentley
authored
Python "FutureWarnings" in EE2 Standards (#19)
As more production packages use Python, we are going to start seeing Python "FutureWarning" messages in operational log files. Python "FutureWarning" messages do not indicate a current problem with the production code–they warn about a Python or Python package incompatibility that may cause jobs to fail _when a future version of Python or the Python library is used._ Python "FutureWarning" messages should be considered acceptable during the EE2 Review process and in operational log files. Developers should make an effort to address the underlying cause of "FutureWarning" messages, when possible, to prevent jobs from failing in the future. I'd like the EE2 Standards document updated to reflect this. Please feel free to suggest changes to the wording that I used in this PR. Thanks! CC @JacobCarley-NOAA @aerorahul @JustinCooke-NCO --------- Co-authored-by: alicia bentley <alicia.bentley@dlogin01.dogwood.wcoss2.ncep.noaa.gov> Co-authored-by: alicia bentley <alicia.bentley@dlogin05.dogwood.wcoss2.ncep.noaa.gov>
1 parent 51b0012 commit 3d8938f

1 file changed

Lines changed: 1 addition & 0 deletions

File tree

docs/standards.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -623,6 +623,7 @@ Please also observe the following points:
623623
* All packages that use Python scripts must specify a Python version through the module system, and must only call a Python executable that is from a module, not the system version.
624624
* "``module load python/${python_ver:?}``" or similar must be present in all job files that will lead to python script calls, where the python version is defined in the version file.
625625
* Python version must be at version 3 or higher.
626+
* Python “FutureWarning” messages indicate that a specific feature, function, or syntax that is currently being used will be changed or removed in a future version of Python or in a future version of a Python library. Python “FutureWarning” messages are acceptable messages in operations and should not be suppressed. Developers should make an effort to resolve “FutureWarning” messages, when possible, in order to prevent production jobs from failing in the future.
626627

627628
Reference `Appendix A: Workflow Examples`_ for commented examples of a version file, ecFlow script, J-job, ex-script, modulefile and makefile.
628629

0 commit comments

Comments
 (0)