NOAA-GFDL / fre-cli

Python-based command line interface for FRE (FMS Runtime Environment) to compile and run FMS-based models and post-process their output.
GNU Lesser General Public License v3.0
3 stars 11 forks source link

These tests should NOT fail #151

Closed ilaflott closed 2 months ago

ilaflott commented 3 months ago

Describe your changes

split up cli tests, add a new one based on the catalogbuilder interface, so we'll know if it changes again via a failed test.

Issue ticket number and link (if applicable)

149

Checklist before requesting a review

ilaflott commented 2 months ago

pylint score in current main branch is 3.34. These edits bring the code to about a 4.70. The aim is to address enough of the complaints that the score will easily fall if low quality code is committed in the future.

quick summary of changes:

  1. generally, lots of pylint cleanup.
  2. camel-case --> snake case changes,
  3. whitespace removal,
  4. long line breakups,
  5. add # pylint: disable=unused-argument, to ignore unused arguments in certain places for now
  6. asking pylint to ignore a fake-import-problem with netCDF4.Dataset
  7. add doc strings where easy to
  8. import order fixes
  9. add basic cli tests for all fre <tool> calls,
  10. add two extra cli tests for fre catalog builder calls to make sure we have something that might catch an API change on that front.
ilaflott commented 2 months ago

this PR now contains autogenerated documentation from python doc-strings! https://github.com/NOAA-GFDL/fre-cli/actions/runs/10372226899/job/28714459606?pr=151

ilaflott commented 2 months ago

ready to go