FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Make pygments mandatory and fix string highlighting by The-Compiler · Pull Request #13189 · pytest-dev/pytest · GitHub

/ pytest Public

Make pygments mandatory and fix string highlighting - #13189

Merged
The-Compiler merged 2 commits into
pytest-dev:mainfrom
The-Compiler:pygments-improvements
Feb 8, 2025
ConversationCommits (2)ChecksFiles changed
Merged

Make pygments mandatory and fix string highlighting#13189
The-Compiler merged 2 commits into
pytest-dev:mainfrom
The-Compiler:pygments-improvements

Conversation

The-Compiler commented Feb 3, 2025

Copy link
Copy Markdown
Member

psf-chronographer Bot added the bot:chronographer:provided (automation) changelog entry is part of PR label Feb 3, 2025
This was referenced Feb 3, 2025
Closed
Closed
nicoddemus approved these changes Feb 3, 2025
View reviewed changes

nicoddemus left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Awesome, thanks!

The-Compiler force-pushed the pygments-improvements branch from 747caba to 44e9f68 Compare February 3, 2025 18:06

The-Compiler commented Feb 3, 2025

Copy link
Copy Markdown
Member Author

Didn't quite work out as planned, as I didn't see that the not in assertion output also uses _diff_text, but then post-processes the diff to show a nicer output:

pytest/src/_pytest/assertion/util.py

Lines 590 to 599 in afdf03b

newdiff = [f"{saferepr(term, maxsize=42)} is contained here:"]
for line in diff:
if line.startswith("Skipping"):
continue
if line.startswith("- "):
continue
if line.startswith("+ "):
newdiff.append(" " + line[2:])
else:
newdiff.append(line)

Opted to add a dummy_highlighter function to avoid having to special-case this in _diff_text, WDYT?

nicoddemus commented Feb 3, 2025

Copy link
Copy Markdown
Member

Opted to add a dummy_highlighter function to avoid having to special-case this in _diff_text, WDYT?

Sounds good to me. 👍

BenjaminSchubert approved these changes Feb 3, 2025
View reviewed changes

BenjaminSchubert left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Looks great, thanks!

KotlinIsland reviewed Feb 3, 2025
View reviewed changes

KotlinIsland left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

awesome PR, this is a very welcome change

I think it would make sense to document the extra somewhere. explain why it exists/what it does

The-Compiler commented Feb 4, 2025

Copy link
Copy Markdown
Member Author

I think it would make sense to document the extra somewhere. explain why it exists/what it does

I don't think there's a good place for this in the docs, especially because we don't do this kind of thing for any of the other dependencies either. And if you see it in action (and/or know what Pygments does), I think it's kind of obvious.

KotlinIsland commented Feb 4, 2025 •
edited
Loading

Copy link
Copy Markdown

think it's kind of obvious

I have no idea what pygments is/does, and I have no idea how to discover if a package has any extras or not. I think not stating that this extra functionality is available would be a disservice to your users 🙂

The-Compiler commented Feb 4, 2025

Copy link
Copy Markdown
Member Author

This PR makes it a dependency, not an extra. You don't need to know it exists, you will just get syntax highlighting after installing pytest.

KotlinIsland commented Feb 4, 2025

Copy link
Copy Markdown

oh, my mistake! sorry, okay that's great!

nicoddemus reviewed Feb 4, 2025
View reviewed changes
Comment thread changelog/7683.improvement.rst Outdated
The-Compiler force-pushed the pygments-improvements branch from 44e9f68 to ca6557e Compare February 4, 2025 16:52
The-Compiler force-pushed the pygments-improvements branch from ca6557e to cb089b6 Compare February 4, 2025 16:53

The-Compiler commented Feb 5, 2025

Copy link
Copy Markdown
Member Author

@Pierre-Sassoulas @Zac-HD @RonnyPfannschmidt Do you have any objections/concerns with adding Pygments as a default dependency (at least until PEP 771 – Default Extras for Python Software Packages | peps.python.org is a thing), or should I merge this?

(Sorry for the explicit ping - not asking for a full review as I think we have this covered, just for an opinion on the dependency because I'd like to give everyone a chance to speak up if there is some implication I didn't consider)

Zac-HD commented Feb 5, 2025

Copy link
Copy Markdown
Member

In general I prefer minimal dependencies, but I think the case for Pygments is strong enough to add it in this case.

If we do get a default-extras PEP I'd be keen to move it to that and make sure we test without it too though.

hugovk commented Feb 7, 2025

Copy link
Copy Markdown
Member

(at least until PEP 771 – Default Extras for Python Software Packages | peps.python.org is a thing)

The PEP is now up for discussion, please leave a comment if you'd like to add your support or give other feedback:

https://discuss.python.org/t/pep-771-default-extras-for-python-software-packages/79706

The-Compiler merged commit a3d55a6 into pytest-dev:main Feb 8, 2025
Zac-HD mentioned this pull request Jul 22, 2026
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

nicoddemus nicoddemus approved these changes
RonnyPfannschmidt RonnyPfannschmidt approved these changes
BenjaminSchubert BenjaminSchubert approved these changes
Pierre-Sassoulas Pierre-Sassoulas approved these changes
+1 more reviewer
KotlinIsland KotlinIsland left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

bot:chronographer:provided (automation) changelog entry is part of PR

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

(🎁) color the diff of strings Add "color" install extra

8 participants

Back | FazBrowse Home | New Git URL