chore: remove code coverage from pytest screen output (#565)

[planetf1]

Misc PR

Fixes #565

Type of PR

• Bug Fix
• New Feature
• Documentation
• Other

Description

• Link to Issue: Fixes Move Code Coverage out of screen output #565

Removed --cov-report=term from the [tool.pytest.ini_options] configuration in pyproject.toml to prevent test runs from dumping large code coverage tables to the terminal. Test coverage is still generated and output to files htmlcov/ and coverage.json.

Testing

• Tests added to the respective file if code was changed
• New code has 100% coverage if code as added
• Ensure existing tests and github automation passes (a maintainer will kick off the github automation when the rest of the PR is populated)

[github-actions]

The PR description has been updated. Please fill out the template for your PR to be reviewed.

[mergify]

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🟢 Enforce conventional commit

Wonderful, this rule succeeded.

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

• title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert|release)(?:\(.+\))?:

[planetf1]

@psschwei As per #565 I agree the output was getting burdensome.

I propose to remove the terminal output, but keep the other files so that other tools can be used to view that output either programatically (ie from the json) or by user in browser (html).

I did wonder whether to retain the output in CI -- but I think it causes lack of clarity there too. Instead we should have a review of coverage, get it to a sensible level we're happy with (if not already) then look at defining thresholds & add checks in CI?

[psschwei]

I did wonder whether to retain the output in CI -- but I think it causes lack of clarity there too.

I agree.

If it is possible to fold the code coverage screen output into a different step (so that it can be collapsed / ignored in the UI), then I could see leaving it in. But the higher-value thing is probably to define and verify thresholds as you say above.