Skip to content

Create WARNING message for operations that overwrite output files #3218

Description

@j-opatz

Describe the New Feature

It was brought to our attention by users that it is an undesirable behavior when output file templates do not include a run-specific keyword, then the output files may be overwritten. This is especially common in SeriesAnalysis.

This issue would see the creation of a WARNING when files are being overwritten by the same METplus run. This provides users instant feedback that the final file(s) from the run may be only the final result, rather than all of the intermediate steps that were desired.

Additionally, this WARNING would NOT be issued if a new METplus run overwrites existing files. This is to eliminate unnecessary WARNING messages when the user may have changed the configuration file but wants to only preserve the new output, rather than requiring a clean directory or new output file templates every time.

Acceptance Testing

WARNING message would be present when overwriting files in the same METplus run.
No WARNING messages would be present when overwriting files with a different METplus run, even from the same configuration.

Time Estimate

1-2 days

Sub-Issues

Consider breaking the new feature down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

List relevant project deadlines here or state NONE.

Funding Source

PRJ014176 MET OFFICE

Define the Metadata

Assignee

  • Select engineer(s) or no engineer required
  • Select scientist(s) or no scientist required

Labels

  • Review default alert labels
  • Select component(s)
  • Select priority
  • Select requestor(s)

Milestone and Projects

  • Select Milestone as a METplus-Wrappers-X.Y.Z version, Consider for Next Release, or Backlog of Development Ideas
  • For a METplus-Wrappers-X.Y.Z version, select the METplus-Wrappers-X.Y.Z Development project

Define Related Issue(s)

Consider the impact to the other METplus components.

New Feature Checklist

See the METplus Workflow for details.

  • Complete the issue definition above, including the Time Estimate and Funding source.
  • Fork this repository or create a branch of develop.
    Branch name: feature_<Issue Number>_<Description>
  • Complete the development and test your changes.
  • Add/update log messages for easier debugging.
  • Add/update unit tests.
  • Add/update documentation.
  • Add any new Python packages to the METplus Components Python Requirements table.
  • For any new datasets, an entry to the METplus Verification Datasets Guide.
  • Push local changes to GitHub.
  • Submit a pull request to merge into develop.
    Pull request: feature <Issue Number> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s) and Development issue
    Select: Milestone as the next official version
    Select: METplus-Wrappers-X.Y.Z Development project for development toward the next official release
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.

Metadata

Metadata

Assignees

Type

No type

Projects

Status
🔎 In review

Relationships

None yet

Development

No branches or pull requests

Issue actions