coveragepy / coveragepy/coveragepy

Add something like Collector to the public API

Open
#603 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

api enhancement
Dominant language
Python
Stars
3.4k
Forks
525
Avg merge
18h 27m
Merged PRs (30d)
6

Description

Originally reported by David MacIver (Bitbucket: david_maciver_, GitHub: Unknown)


As part of Hypothesis's new coverage guided test generation, I want to be able to run the coverage collector infrastructure without worrying about saving to the file system, etc.

I am currently using a number of APIs that are clearly internal and would prefer not to be.

I don't know that the right thing to do would be to just declare the Collector API public - it has a lot of little details that made it a bit awkward to use here (e.g. file disposition types), but perhaps it would be possible to write a small user friendly wrapper around it and make that part of the public API?

I'd be happy to try to put together a pull request for this if you're amenable.


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.

Research direction

Start by reviewing the existing Collector API and the coverage-guided test generation work in pull request 861. Determine which internal APIs are being used and what public wrapper would avoid filesystem handling and awkward file disposition types; done means an agreed, user-friendly public API is implemented.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
devtools, testing-qa
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.