Is _pytest.config.create_terminal_writer a private api?

[garyvdm]

I'm currently working on microsoft/vscode-python#22594.

I want to reuse some functionality from TerminalWriter, which is available as a public api, but the method to initialize it with config _pytest.config.create_terminal_writer is not available from the pytest module.

Is using code that is not directly importable from pytest and only importable from _pytest considered private apis?

[RonnyPfannschmidt]

Anything not exported under pytest is private

A key reason why its all in _pytest

Please elaborate on the use case as there's various valid and acceptable ways to get a terminal writer

[garyvdm]

I'm trying to generate the full summary for a test report, so it can be shown when a user clicks on a individual test, they can see the report for just that test:

So I'm going something like this:

@pytest.hookimpl(hookwrapper=True, trylast=True)
def pytest_report_teststatus(report: pytest.TestReport, config: pytest.Config):
    file = StringIO()
    tw = _pytest.config.create_terminal_writer(config, file)
    report.toterminal(tw)
    ...
    output = file.getvalue()
    ...
    # Send output to vscode individual test panel.

I want the user to be able to set the color and code_highlight options, and any options that are added by pytest in the future, hence the desire to use _pytest.config.create_terminal_writer which configures the TerminalWriter based on the Config options.

[RonnyPfannschmidt]

i see, that is a valid option but ha a caveat as it may accidentally opt out of color since hasmarkup has a default that chooses based on the passed in file capabilities,

validating it stays functional by running integration test against main should suffice for now

i sincerely hope that in future we will just have a report.__rich__...

[garyvdm]

Ok. I think what I'll do for now is just have my own version of create_terminal_writer