OpenEnergyPlatform / OpenEnergyPlatform/omi

OMI stops on errors and lacks meaningful output

Open
#40 1 comment 0 reactions 2 assignees View on GitHub

@jh-RLI is already working on this.

Since Sep 28, 2021.

priority: low :sloth: status: blocked :stop_sign: type: bug :bug: type: enhancement :gear:
Dominant language
Python
Stars
8
Forks
8
PR merge metrics
No merged PRs in 30d

Description

We use the OMI tool in eGon-data to check the metadata. It is quite helpful but lacks some speaking output:

  • Optional keys do not seem to be checked, a warning would be helpful #35
  • If there's an error (more precise: some format problem, e.g. mandatory key is missing) while processing, OMI immediately stops e.g. stating omi.dialects.base.parser.ParserException: metadata string does not contain an id. In my opinion it'd be better to parse the entire metadata and give a list of errors/warnings, otherwise one might end up in a trial-and-error odyssey.
  • Lacking details where error is located: e.g. if there's a malformed string OMI prints dateutil.parser._parser.ParserError: String does not contain a date:. Pardon, which field?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.