Skip to content

ENH: Allow required value in reportlet configs.#122

Open
rwblair wants to merge 5 commits intonipreps:mainfrom
rwblair:enh/mandatory_config
Open

ENH: Allow required value in reportlet configs.#122
rwblair wants to merge 5 commits intonipreps:mainfrom
rwblair:enh/mandatory_config

Conversation

@rwblair
Copy link
Copy Markdown
Contributor

@rwblair rwblair commented May 17, 2024

Interprets 'required' key when present in a reportlets config dictionary.
If its true and no files/figures were found then raise an exception. Report indexer will catch these exceptions and raise a single exception at the end of its run with all of the collected reportlet exceptions.

fixes #78

@codecov
Copy link
Copy Markdown

codecov Bot commented May 17, 2024

Codecov Report

❌ Patch coverage is 90.62500% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 28.90%. Comparing base (6404af3) to head (e9b3a82).
⚠️ Report is 299 commits behind head on main.

Files with missing lines Patch % Lines
nireports/assembler/report.py 85.71% 3 Missing ⚠️

❗ There is a different number of reports uploaded between BASE (6404af3) and HEAD (e9b3a82). Click for more details.

HEAD has 113 uploads less than BASE
Flag BASE (6404af3) HEAD (e9b3a82)
120 7
Additional details and impacted files
@@             Coverage Diff             @@
##             main     #122       +/-   ##
===========================================
- Coverage   60.34%   28.90%   -31.45%     
===========================================
  Files          20       21        +1     
  Lines        2242     2266       +24     
  Branches      399      401        +2     
===========================================
- Hits         1353      655      -698     
- Misses        795     1595      +800     
+ Partials       94       16       -78     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment thread nireports/exceptions.py
rwblair and others added 5 commits October 4, 2024 16:23
If its true and no files/figures were found then raise an exception.
Report indexer will catch these exceptions and raise a single exception
at the end of its run with all of the collected reportlet exceptions.
@effigies effigies force-pushed the enh/mandatory_config branch from 7730215 to e9b3a82 Compare October 4, 2024 20:23
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.

Allow a notion of "mandatory" reportlet/section in the bootstrap configuration file

2 participants