pytest-dev / pytest-dev/pytest-xdist

DumpError: strings must be utf-8 decodable

Open
#843 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.9k
Forks
287
Avg merge
9h 30m
Merged PRs (30d)
2

Description

In pypa/distutils#183, I've stumbled onto an issue with xdist. In that issue, distutils/setuptools are moving from a stdout-based logging system to the Python logging framework. As a result, the quiet() context, which suppresses writes to sys.stdout no longer has the effect of suppressing logs.

One of the things that setuptools is logging is a filename containing surrogate escapes. It logs the name so the user can identify which filename was failing.

With pytest-xdist, however, the test fails with an INTERNALERROR in gateway_base.

A minimal test is to run pytest -n auto on the following:

def test_log_non_utf8():
    __import__('logging').getLogger().warn(
        'föö'.encode('latin-1').decode('utf-8', errors='surrogateescape')
    )
    __import__('pytest').fail('failing to emit messages')

That test seems legitimate and capturing behavior that provides value to the user. The issue doesn't occur without pytest-xdist.

My instinct is that pytest-xdist shouldn't be putting constraints on the allowed outputs for logging. Can something be done to be more lenient about legitimate non-encodeable values being passed? If the encoding is only an internal implementation detail between worker and supervisor, it should serialize any strings in a way that they're deserialized with fidelity to the original.

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 examining gateway_base, where pytest-xdist reports the INTERNALERROR when logging a string containing surrogate escapes. Reproduce the issue with the minimal test and pytest -n auto, then verify that worker-to-supervisor logging preserves the original string without rejecting legitimate non-UTF-8-decodable values.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
distributed-systems, testing
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.