Skip to content

Python "FutureWarnings" in EE2 Standards#19

Open
AliciaBentley-NOAA wants to merge 4 commits intoNCO-HPC:developfrom
AliciaBentley-NOAA:feature/FutureWarnings
Open

Python "FutureWarnings" in EE2 Standards#19
AliciaBentley-NOAA wants to merge 4 commits intoNCO-HPC:developfrom
AliciaBentley-NOAA:feature/FutureWarnings

Conversation

@AliciaBentley-NOAA
Copy link

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

@JacobCarley-NOAA
Copy link
Contributor

I think this is a sensible addition and should be included. I do think it would be better as a bullet point under Subsection C of the Standards section (interpreted code).

Don't forget to open an Issue that corresponds to this PR!

@AliciaBentley-NOAA
Copy link
Author

@JacobCarley-NOAA Thanks! That makes sense to me. Would you like us to move the new "FutureWarning" text to Section C (Interpreted Code) after the bullet that says "Python version must be at version 3 or higher."? It would look something like:

  • Python version must be at version 3 or higher.
  • 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.

CC @JustinCooke-NCO

@JacobCarley-NOAA
Copy link
Contributor

I think that works great. Thanks!

@AliciaBentley-NOAA
Copy link
Author

EE2 standards Issue #20 has been created to capture this.

Copy link
Contributor

@JacobCarley-NOAA JacobCarley-NOAA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look good and in the right place. This is a logical update to the standards.

Copy link
Contributor

@aerorahul aerorahul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. I left a comment in the issue on a possible way to reduce the occurrences of repeated FutureWarning without suppressing them while developing the software.
This hopefully will yield less repetition in the logs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants