python / python/mypy

Separate flag for enabling soft word wrap

Open
#16,688 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature
Dominant language
Python
Stars
20.6k
Forks
3.3k
PR merge metrics
PR metrics pending

Description

Feature

--pretty flag has all the features minus the soft word wrap
--word-wrap flag enables the soft word wrap

Pitch

Currently trying to add annotations during my mypy GHA workflow. However, parsing the full error message is difficult with the --pretty flag b/c it adds line breaks into the full error message which adds complexity to the error message matching regex. Although we could run it with --no-pretty this removes useful information such as code snippets and error location markers. It would be great if we could disable the word wrap/keep the error description on one line.

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

Start by locating the command-line handling for the --pretty and --word-wrap flags, then trace how pretty error output is formatted. The change is done when pretty output keeps its existing snippets and location markers while word wrapping can be enabled or disabled independently, with coverage for both flag settings.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.