871.list yamls tool

[singhd789]

Describe your changes

Create fre list yamls subtool:

• lists yamls listed in the model yaml to combine into one, resolved yaml config
• returns a comma separated list so it can potentially be piped to fre yamltools combine (uw tools integration)
• spits out warning for yamls that dont exist
• Updated documentation and tried to make inline script doc compatible with how the fre-cli chatbot reads
• if no experiment name is given --> it returns the model, compile, and platform yamls
• if an experiment name is given, the default behavior is to return ALL, yamls associated with the experiment (model, compile, platform, settings, pp, analysis yamls)

Issue ticket number and link (if applicable)

Fixes #871

Checklist before requesting a review

• I ran my code
• I tried to make my code readable
• I tried to comment my code
• I wrote a new test, if applicable
• I wrote new instructions/documentation, if applicable
• I ran pytest and inspected it's output
• I ran pylint and attempted to implement some of it's feedback
• No print statements; all user-facing info uses logging module

Note: If you are a code maintainer updating the tag or releasing a new fre-cli version, please use the release_procedure.md template. To quickly use this template, open a new pull request, choose your branch, and add ?template=release_procedure.md to the end of the url.

[codecov]

Codecov Report

❌ Patch coverage is 98.43750% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 82.36%. Comparing base (3c5a980) to head (45fe77b).

Files with missing lines	Patch %	Lines
fre/list_/frelist.py	90.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #933      +/-   ##
==========================================
+ Coverage   82.09%   82.36%   +0.27%     
==========================================
  Files          67       68       +1     
  Lines        3736     3799      +63     
==========================================
+ Hits         3067     3129      +62     
- Misses        669      670       +1     

Flag	Coverage Δ
unittests	82.36% <98.43%> (+0.27%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
fre/list_/list_experiments_script.py	100.00% <100.00%> (ø)
fre/list_/list_yamls_script.py	100.00% <100.00%> (ø)
fre/list_/frelist.py	86.20% <90.00%> (+1.99%)	⬆️

---

Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3c5a980...45fe77b. Read the comment docs.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[mlee03]

Would explicit examples be more helpful?
Or adding info about when this tool is or could be used?

[singhd789]

I think the examples would be in the quickstart right? Unless you think more examples should go here.

I added to the description for use cases of the subtool though! Good suggestion, thanks.

[ilaflott]

it's basically ready for approval and merging post comments

[singhd789]

@mlee03 @ilaflott I hear your suggestions for output for the readme examples, haha. I'll add it in since it's desired

[singhd789]

ANOTHER NOTE: This fre list yamls subtool is kind of the first installment of yaml format changes!! So this fre list yamls subtool will only work with certain model yaml changes. I will open a subsequent issue to update all fre list test yamls to reflect these changes. This PR will be followed by the uw tools integration that will implement these changes as well

Update: here's the issue #955