ISA-tools / ISA-tools/isa-api

ISA Tab Validation Rule Exception Messaging

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

@proccaserra is already working on this.

Since Jan 23, 2024.

Dominant language
Python
Stars
48
Forks
42
PR merge metrics
No merged PRs in 30d

Description

In isatools\isatab\validate\rules\core.py in the "Rule" class in the "execute" method if a rule has an exception it is caught here as "e" and "e" is printed. I'm not sure what the intent was here, but simply printing "e" does not show the full traceback and is very limited. For instance, I had a rule that was throwing an exception because "Sample Name" was not in the dataframe, and "print(e)" simply prints "Sample Name". No indication of the rule that had an issue or what the exception was, just "Sample Name". I feel that this should be more informative, but it isn't clear to me what the best solution would be. Some things are logged and some are printed, and I'm not sure exactly what the modus operandi is here.

For me personally, I would like a message that gave information about: the rule with the exception, the name of the study or assay with the issue, and the full traceback. You can use the "traceback" library and print the full traceback with "print(traceback.format_exc())".

Contributor guide

No contributing guide indexed for this repository

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.