python / python/mypy

Add junit_format "per_diagnostic"

Open
#21,629 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature
Dominant language
Python
Stars
20.6k
Forks
3.3k
PR merge metrics
PR metrics pending

Description

Feature

Add to the existing "global" and "per_file" formats. This format would have a testcase for every error/note generated.

Pitch

Its useful for new contributors to the packages I maintain to have it broken down where they can address one problem at a time. When they start trying to add type hints to a to large files they fine it overwhelming when our CI just reports it all as one failure.

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.

Research direction

Locate the existing junit_format implementations for the "global" and "per_file" formats and read their tests first. Add the new "per_diagnostic" behavior so each generated error or note becomes its own testcase, then extend the relevant format tests to verify one testcase is produced per diagnostic.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.