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

Deprecate petablint with individual tables #274

Merged
merged 4 commits into from
Jun 26, 2024

Conversation

dweindl
Copy link
Member

@dweindl dweindl commented Jun 25, 2024

I think the main use case is running petablint on a full petab problem, so we don't need the option to pass individual tables. To support individual tables with the upcoming petab v2, we'd have to extend the list of files and require a version number. I don't it's worth maintaining this functionality (correct me if I am wrong), since validation of individual files is anyways rather limited.

Therefore, this adds deprecation warnings to command line arguments for individual PEtab tables and for the -y --yaml flags, which are no longer required, and the removal of which will make petablint easier to use.

Related to #271

@dweindl dweindl requested a review from a team as a code owner June 25, 2024 12:34
@codecov-commenter
Copy link

codecov-commenter commented Jun 25, 2024

Codecov Report

Attention: Patch coverage is 0% with 20 lines in your changes missing coverage. Please review.

Project coverage is 76.09%. Comparing base (98951d1) to head (f39e1ea).

Files Patch % Lines
petab/petablint.py 0.00% 20 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #274      +/-   ##
===========================================
- Coverage    76.30%   76.09%   -0.22%     
===========================================
  Files           36       36              
  Lines         3224     3233       +9     
  Branches       783      786       +3     
===========================================
  Hits          2460     2460              
- Misses         559      568       +9     
  Partials       205      205              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@dilpath dilpath left a comment

Choose a reason for hiding this comment

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

👍

dest="yaml_file_name",
help="PEtab YAML problem filename",
nargs="?",
Copy link
Member

Choose a reason for hiding this comment

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

I wonder if it's possible to say yaml_file_name_deprecated takes 0 arguments, i.e. it's treated as just a "flag", and instead its argument then gets treated as a positional argument, and hence saved to yaml_file_name. Anyway, not important

Copy link
Member Author

@dweindl dweindl Jun 25, 2024

Choose a reason for hiding this comment

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

It can be done and would slightly simplify the code, but the petablint --help output would be more confusing, I think.

petab/petablint.py Outdated Show resolved Hide resolved
dweindl and others added 2 commits June 25, 2024 14:44
Co-authored-by: Dilan Pathirana <59329744+dilpath@users.noreply.github.com>
@dweindl dweindl changed the title Deprecated petablint with individual tables Deprecate petablint with individual tables Jun 25, 2024
@dweindl dweindl merged commit 74ac20d into PEtab-dev:develop Jun 26, 2024
7 checks passed
@dweindl dweindl deleted the deprecate_petablint_files branch June 26, 2024 13:13
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