Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

315.fre list tool #329

Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open

315.fre list tool #329

wants to merge 19 commits into from

Conversation

singhd789
Copy link
Collaborator

@singhd789 singhd789 commented Jan 23, 2025

Describe your changes

Adds fre list exps and fre list platforms tools, along with tests and some documentation.

fre list exps:

  • combines the model yaml with "experiment", "platforms", "target" placeholder (if not done, will get undefined alias error message) to create intermediate combined file
  • parses the combined file to list pp experiments available
  • cleans/removes the combined yaml file

fre list platforms:

  • combines the model and platforms yaml with "experiment", "platforms", "target" placeholder (if not done, will get undefined alias error message) to create intermediate combined file
  • parses the combined file to list the platforms available
  • cleans/removes combined yaml file

Issue ticket number and link (if applicable)

#315

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

@singhd789 singhd789 marked this pull request as ready for review January 27, 2025 14:59
else:
assert False

@pytest.mark.xfail()
Copy link
Member

@ilaflott ilaflott Jan 29, 2025

Choose a reason for hiding this comment

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

is this test just expected to fail right now because of circumstances (e.g. CANNOT succeed in platform)? or is a specific failure supposed to occur because of e.g. raise within one of the functions?

if former- OK. If latter, consult pytest doc on expected exceptions

Copy link
Collaborator Author

@singhd789 singhd789 Jan 29, 2025

Choose a reason for hiding this comment

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

The former. This was just a little test thrown in there for if a bad yaml file was given (one that doesn't exist) - since -y is the only click option passed. I do see now that this kind of test would be inthe test_fre_cli ... unit test file though. I'll try to thin of better tests for these tools

Copy link
Member

@ilaflott ilaflott left a comment

Choose a reason for hiding this comment

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

this is a solid effort but i have questions before i click an approve button

@singhd789 singhd789 requested a review from ilaflott January 30, 2025 21:25
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.

2 participants