pytest-dev / pytest-dev/pytest

Make `TerminalWriter` public API?

Open
#10,436 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: proposal
Dominant language
Python
Stars
14.5k
Forks
3.4k
Avg merge
2d 9h
Merged PRs (30d)
35

Description

Looking at the fallout of the py dropping, it seems like one recurrent issue is that people create their own py.io.TerminalWriter:

...and probably a lot more!

sooo... I wonder if we should make it public API of some kind, given how it's used like one even in pytest-dev plugins?

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

The issue names no pytest files or tests; start by locating the current TerminalWriter implementation and reviewing pytest's public-API guidance. Compare the linked plugin uses and determine whether a supported API can be defined. Done means reaching and documenting a clear decision about exposing TerminalWriter, with tests covering the supported interface if the decision is affirmative.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing
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.