Fix-6906: Added code-highlight option to disable highlighting optionally #6934

gdhameeja · 2020-03-17T11:38:46Z

Closes #6906
code-highlight has default value to True, this value is used in TerminalWriter
in order to control highlighting of the code.

gdhameeja · 2020-03-17T11:42:08Z

testing/test_terminal.py

+                    "        {print}print{hl-reset}({str}'''{hl-reset}{str}{hl-reset}",
+                    ">   {str}    {hl-reset}{str}'''{hl-reset}); {kw}assert{hl-reset} {number}0{hl-reset}",
+                    "assert 0{reset}",
+                ]


I believe the test does not work, I'm not familiar with this format. I shall fix it.

gdhameeja · 2020-03-17T11:42:36Z

testing/code/test_terminal_writer.py

@@ -18,6 +18,7 @@ def test_code_highlight(has_markup, expected, color_mapping):
    f = StringIO()
    tw = TerminalWriter(f)
    tw.hasmarkup = has_markup
+    tw.code_highlight = True


Added this with the assumption that this test assumes code is to be highlighted.

src/_pytest/_io/__init__.py

gdhameeja · 2020-03-23T06:40:17Z

@nicoddemus review please?

bluetech

Hi @gdhameeja,

I don't have time for a full review yet, but left some comments.

Also, the CI fails, which will need to be fixed before merging. You can click on the job in the "Checks" section and it will show you a log with what failed.

src/_pytest/_io/__init__.py

src/_pytest/terminal.py

blueyed · 2020-03-27T01:16:44Z

It would be better to have a config setting that would allow for specifying the formatter/args for it also. See #6658 for some feedback I've given there already.

(it is rather bad that is uses the 16 colors formatter currently by default, and even goes through all the imports all the time)

nicoddemus · 2020-03-28T14:45:45Z

It would be better to have a config setting that would allow for specifying the formatter/args for it also.

Agree, but out of scope for this PR.

blueyed · 2020-03-28T16:20:30Z

It would be better to have a config setting that would allow for specifying the formatter/args for it also.

Agree, but out of scope for this PR.

Well, you are about to add an option to control this behavior: it would be better to do it "properly" already then, and not add another option afterwards.

nicoddemus · 2020-03-28T19:10:38Z

An option to turn it on/off and selecting styles are separate options.

blueyed · 2020-03-28T19:24:08Z

IMHO it would/could select the formatter, and "no" would use none, i.e. disable it then.
"auto" (which is used here, but unclear IIRC) would then e.g. use the best option (true colors, 256 colors, or 16 (what is used currently)).

While having multiple options is not that bad I wanted to give my opinion anyway / still think it could be combined / should be discussed / considered.

nicoddemus · 2020-03-28T19:33:44Z

Not sure we will ever have a single option for color highlighting, we might grow some other options rather than just number of colors. I think having an explicit option to turn everything highlight related is more future proof.

gdhameeja · 2020-04-07T13:44:10Z

@nicoddemus @bluetech fixed the comments. Can you please review it again. Thanks.

The-Compiler · 2020-04-07T15:52:03Z

If we might want to have some more related options in the future, shouldn't this be an option in the .ini file rather than a commandline switch?

bluetech

A couple of comments. Please also note that the CI checks fail.

src/_pytest/_io/__init__.py

src/_pytest/config/__init__.py

bluetech · 2020-04-11T10:49:47Z

@The-Compiler

If we might want to have some more related options in the future, shouldn't this be an option in the .ini file rather than a commandline switch?

Is there a general principle to commandline vs. ini? Looking at pytest --help I can't really discern one I must say ;)

The-Compiler · 2020-04-14T09:45:03Z

Is there a general principle to commandline vs. ini? Looking at pytest --help I can't really discern one I must say ;)

Fair point. My personal take:

Something that someone would probably set for individual invocations rather than always (e.g. -x, -k, -m, --fixtures, --lf, ...): command-line option
Something that someone would probably want to always set (e.g. testpaths, xfail_strict, but also --strict): config option
Something requiring a lot of data (e.g. markers, filterwarnings): config option
Something where there could be multiple related options: config options

But I agree that's not really how things look at the moment, we also have lots of --doctest=* or --log-* options, so I don't have strong feelings on this.

asottile

cool, looks good -- just needs a test to show that when the option is not "yes" that it is turned off -- also we'll need a changelog and probably some documentation as well

asottile · 2020-06-03T20:13:10Z

src/_pytest/config/__init__.py

@@ -1260,6 +1260,7 @@ def create_terminal_writer(config: Config, *args, **kwargs) -> TerminalWriter:
    tw = TerminalWriter(*args, **kwargs)
    if config.option.color == "yes":
        tw.hasmarkup = True
+    tw.code_highlight = False if config.option.code_highlight == "yes" else True


Suggested change

tw.code_highlight = False if config.option.code_highlight == "yes" else True

tw.code_highlight = config.option.code_highlight == "yes"

(I have a wiki page about this)

Fixed this.

Still looks the same to me... did you forget to push it maybe?

looks like this didn't get fixed?

nicoddemus

Thanks @gdhameeja!

Besides the comments left by me and others, please also add:

A CHANGELOG
An entry in reference.rst describing this new option.

Let us know if you have any questions!

src/_pytest/_io/terminalwriter.py

asottile · 2020-06-15T19:07:09Z

doc/en/changelog.rst

@@ -504,6 +504,8 @@ Features
  such as default values or which set of command line options to add.


+- `#6906 <https://github.com/pytest-dev/pytest/issues/6906>`_: ``--code-highlight`` decides whethere code should be highlighted in terminal output.
+


we manage changelogs for new features by adding a changelog fragment. You can see how these are set up by looking at the ./changelog directory (there's a bunch of files in there already that you can base yours on). The CONTRIBUTING guide also covers changelogs as well

asottile · 2020-06-15T19:07:35Z

src/_pytest/_code/code.py

@@ -984,6 +984,7 @@ class ReprTraceback(TerminalRepr):
    entrysep = "_ "

    def toterminal(self, tw: TerminalWriter) -> None:
+        tw.code_highlight = False


was this left over from debugging? this doesn't quite feel right here

No this was added purposely. The tests fail if code_highlight is set to true (which by default is it). I assumed all tests were written asserting to non highlighted code, so I put it here. Please guide me on this.

I suspect this shouldn't happen here, and maybe we'll need to adjust some of the tests. I'm not 100% certain though

FAILED testing/code/test_excinfo.py::TestFormattedExcinfo::test_repr_traceback_with_invalid_cwd - Failed: nomatch: 'def entry():' FAILED testing/code/test_excinfo.py::TestFormattedExcinfo::test_exc_chain_repr_without_traceback[cause] - Failed: exact match: 'ValueError: invalid value' FAILED testing/code/test_excinfo.py::TestFormattedExcinfo::test_exc_chain_repr_without_traceback[context] - Failed: exact match: 'ValueError: invalid value' FAILED testing/io/test_terminalwriter.py::test_code_highlight[no markup] - AssertionError: assert ['\x1b[94mass...[39;49;00m\n'] == ['assert 0\n'] FAILED testing/acceptance_test.py::TestGeneralUsage::test_root_conftest_syntax_error - Failed: nomatch: '*raise SyntaxError*' FAILED testing/acceptance_test.py::TestGeneralUsage::test_early_hook_error_issue38_1 - Failed: nomatch: '*INTERNALERROR*def pytest_sessionstart():*' FAILED testing/acceptance_test.py::TestGeneralUsage::test_better_reporting_on_conftest_load_failure - assert ["ImportError...med 'qwerty'"] == ["ImportError...med 'qwerty'"] FAILED testing/test_conftest.py::test_conftest_exception_handling - assert 'raise ValueError()' in ["ImportError while loading conftest '/tmp/pytest-of-melvault/pytest-0/test_conftest_exception_h... FAILED testing/test_junitxml.py::TestPython::test_xfailure_xpass_strict[xunit1] - AssertionError: assert {'message': '...1B[39;49;00m'} == {'message': '...eds to fail!'} FAILED testing/test_junitxml.py::TestPython::test_xfailure_xpass_strict[xunit2] - AssertionError: assert {'message': '...1B[39;49;00m'} == {'message': '...eds to fail!'} FAILED testing/test_reports.py::TestReportSerialization::test_chained_exceptions[TestReport] - assert "ValueError('value error')" in "\x1b[94mdef\x1b[39;49;00m \x1b[92mtest_a\x1b[39;49;00m():\n ... FAILED testing/test_reports.py::TestReportSerialization::test_chained_exceptions[CollectReport] - assert "ValueError('value error')" in "test_chained_exceptions.py:5: in test_a\n foo()\ntest_c... FAILED testing/test_resultlog.py::TestWithFunctionIntegration::test_log_test_outcomes - assert -1 != -1 FAILED testing/python/collect.py::TestModule::test_show_traceback_import_error[0] - Failed: nomatch: 'ImportError while importing test module*' FAILED testing/python/collect.py::TestModule::test_show_traceback_import_error[1] - Failed: nomatch: 'ImportError while importing test module*' FAILED testing/python/collect.py::TestModule::test_show_traceback_import_error[2] - Failed: nomatch: 'ImportError while importing test module*' FAILED testing/python/collect.py::TestModule::test_show_traceback_import_error_unicode - Failed: nomatch: 'ImportError while importing test module*'

These are all the tests which failed with code_highlight set to True. I'm lost on what is the right way to do this. Please guide me here.

@asottile @nicoddemus

Hi @gdhameeja,

The problem was the conditional in _highlight: that should be an or, not an and. I've fixed it and pushed to your branch, hope you don't mind.

asottile · 2020-06-15T19:08:12Z

src/_pytest/config/__init__.py

@@ -1260,6 +1260,7 @@ def create_terminal_writer(config: Config, *args, **kwargs) -> TerminalWriter:
    tw = TerminalWriter(*args, **kwargs)
    if config.option.color == "yes":
        tw.hasmarkup = True
+    tw.code_highlight = False if config.option.code_highlight == "yes" else True


looks like this didn't get fixed?

asottile · 2020-06-15T19:08:38Z

src/_pytest/terminal.py

+        action="store",
+        dest="code_highlight",


can leave these two lines out, they are the default when using argparse

asottile · 2020-06-15T19:09:30Z

testing/io/test_terminalwriter.py

-        ValueError,
-        match=re.escape("indents size (2) should have same size as lines (1)"),
-    ):
-        tw._write_source(["assert 0"], [" ", " "])


why is this missing now?

nicoddemus · 2020-06-15T18:21:19Z

src/_pytest/config/__init__.py

@@ -1260,6 +1260,7 @@ def create_terminal_writer(config: Config, *args, **kwargs) -> TerminalWriter:
    tw = TerminalWriter(*args, **kwargs)
    if config.option.color == "yes":
        tw.hasmarkup = True
+    tw.code_highlight = False if config.option.code_highlight == "yes" else True


Still looks the same to me... did you forget to push it maybe?

src/_pytest/terminal.py

src/_pytest/_code/code.py

asottile

I figured out the weirdness in that one test, I think this is good to go now

src/_pytest/terminal.py

nicoddemus · 2020-06-18T15:40:44Z

@bluetech would you like to take another look?

(Note to selves: squash on merge)

src/_pytest/_io/terminalwriter.py

src/_pytest/config/__init__.py

testing/io/test_terminalwriter.py

bluetech · 2020-06-21T20:38:05Z

Also please see the discussion in #7132, where the ability to control the pygments style is discussed. If we want to support that, it would presumably use the same cmd line argument, e.g. --code-highlight=<style>. If that doesn't look right, we should probably come up with something that would be...

bluetech · 2020-06-21T20:45:46Z

There's also a Terminal256Formatter: https://pygments.org/docs/formatters/?highlight=terminalformatter#Terminal256Formatter

gnikonorov · 2020-06-25T04:16:50Z

Hi @gdhameeja. If this PR is meant to close an issue, could you please update the description as described here so that the linked issue may autoclose?

nicoddemus · 2020-06-26T12:40:35Z

Also please see the discussion in #7132, where the ability to control the pygments style is discussed. If we want to support that, it would presumably use the same cmd line argument, e.g. --code-highlight=<style>.

I think we can postpone the discussion of styles to a separate PR, as I think it warrants more discussion ( #7132 (comment)) and either way whatever we decide later will probably be backward compatible. 👍

asottile

Co-authored-by: Ran Benita <[email protected]>

nicoddemus · 2020-06-27T13:43:22Z

Thanks @asottile for finishing it up. 👍

gdhameeja changed the title ~~Fix-6906: Added code-highlight option to disable highlighting optionally~~ #6906: Added code-highlight option to disable highlighting optionally Mar 17, 2020

gdhameeja changed the title ~~#6906: Added code-highlight option to disable highlighting optionally~~ Fix-6906: Added code-highlight option to disable highlighting optionally Mar 17, 2020

gdhameeja commented Mar 17, 2020

View reviewed changes

src/_pytest/_io/__init__.py Outdated Show resolved Hide resolved

bluetech reviewed Mar 23, 2020

View reviewed changes

src/_pytest/_io/__init__.py Outdated Show resolved Hide resolved

src/_pytest/terminal.py Outdated Show resolved Hide resolved

src/_pytest/terminal.py Outdated Show resolved Hide resolved

This comment has been minimized.

Sign in to view

gdhameeja force-pushed the Fix-6906 branch from ce0d677 to ce758ce Compare April 7, 2020 13:42

bluetech reviewed Apr 11, 2020

View reviewed changes

src/_pytest/_io/__init__.py Outdated Show resolved Hide resolved

src/_pytest/config/__init__.py Outdated Show resolved Hide resolved

bluetech mentioned this pull request Apr 29, 2020

Ability to choose syntax highlighting style by configuration #7132

Closed

nicoddemus mentioned this pull request Apr 29, 2020

Ability to disable pygments highlighting even if pygments is installed #6906

Closed

gdhameeja force-pushed the Fix-6906 branch from ce758ce to 73d4a17 Compare June 3, 2020 20:09

asottile reviewed Jun 3, 2020

View reviewed changes

nicoddemus requested changes Jun 3, 2020

View reviewed changes

src/_pytest/_io/terminalwriter.py Outdated Show resolved Hide resolved

gdhameeja force-pushed the Fix-6906 branch 3 times, most recently from dafe4f5 to 6455ece Compare June 15, 2020 19:00

asottile reviewed Jun 15, 2020

View reviewed changes

gdhameeja force-pushed the Fix-6906 branch from 6455ece to bd6e89c Compare June 15, 2020 19:25

gdhameeja force-pushed the Fix-6906 branch 2 times, most recently from 1483ea1 to 0ba5433 Compare June 15, 2020 19:42

nicoddemus reviewed Jun 15, 2020

View reviewed changes

gdhameeja force-pushed the Fix-6906 branch from 1296bf0 to 2d5a1af Compare June 17, 2020 20:17

asottile force-pushed the Fix-6906 branch from 2d5a1af to d804e0c Compare June 17, 2020 22:58

asottile approved these changes Jun 17, 2020

View reviewed changes

nicoddemus reviewed Jun 18, 2020

View reviewed changes

src/_pytest/terminal.py Outdated Show resolved Hide resolved

nicoddemus approved these changes Jun 18, 2020

View reviewed changes

bluetech reviewed Jun 21, 2020

View reviewed changes

src/_pytest/_io/terminalwriter.py Outdated Show resolved Hide resolved

src/_pytest/config/__init__.py Outdated Show resolved Hide resolved

testing/io/test_terminalwriter.py Outdated Show resolved Hide resolved

gdhameeja force-pushed the Fix-6906 branch from c445d32 to a187aa4 Compare June 26, 2020 19:53

asottile approved these changes Jun 26, 2020

View reviewed changes

asottile force-pushed the Fix-6906 branch from a187aa4 to 8736127 Compare June 26, 2020 20:20

asottile force-pushed the Fix-6906 branch from 8736127 to 03230b4 Compare June 26, 2020 20:25

asottile merged commit 61014c5 into pytest-dev:master Jun 26, 2020

	tw.code_highlight = False if config.option.code_highlight == "yes" else True
	tw.code_highlight = config.option.code_highlight == "yes"

		@@ -504,6 +504,8 @@ Features
		such as default values or which set of command line options to add.


		- `#6906 <https://github.com/pytest-dev/pytest/issues/6906>`_: ``--code-highlight`` decides whethere code should be highlighted in terminal output.

Fix-6906: Added code-highlight option to disable highlighting optionally #6934

Fix-6906: Added code-highlight option to disable highlighting optionally #6934

Conversation

gdhameeja commented Mar 17, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gdhameeja commented Mar 23, 2020

bluetech left a comment

Choose a reason for hiding this comment

blueyed commented Mar 27, 2020

nicoddemus commented Mar 28, 2020

blueyed commented Mar 28, 2020

nicoddemus commented Mar 28, 2020

blueyed commented Mar 28, 2020 • edited Loading

This comment has been minimized.

nicoddemus commented Mar 28, 2020

gdhameeja commented Apr 7, 2020

The-Compiler commented Apr 7, 2020

bluetech left a comment

Choose a reason for hiding this comment

bluetech commented Apr 11, 2020

The-Compiler commented Apr 14, 2020

asottile left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicoddemus left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

asottile left a comment

Choose a reason for hiding this comment

nicoddemus commented Jun 18, 2020

bluetech commented Jun 21, 2020

bluetech commented Jun 21, 2020

gnikonorov commented Jun 25, 2020

nicoddemus commented Jun 26, 2020

asottile left a comment • edited Loading

Choose a reason for hiding this comment

nicoddemus commented Jun 27, 2020

gdhameeja commented Mar 17, 2020 •

edited

Loading

blueyed commented Mar 28, 2020 •

edited

Loading

asottile left a comment •

edited

Loading