Console progress output #2858

nicoddemus · 2017-10-21T21:25:40Z

Still needs tests, docs and some cleanup, I'm opening this to gather some feedback.

This works in "normal" mode (including xdist), still needs work with -v.

Please see comments below.

nicoddemus · 2017-10-21T21:27:00Z

_pytest/terminal.py

@@ -155,13 +160,37 @@ def _tw(self):
                      stacklevel=2)
        return self.writer

+    @staticmethod
+    def _new_tw_write(msg, **kw):


Of course this is hackish. 😉

I believe the correct thing would be to add this functionality to py.io.TerminalWriter instead, what do you guys think?

before i tried to kill TerminalWriter altogether - it deserves a general removal as its quite bad as an api and people regularly try to obtain it in a hackish was inside of pytest

nicoddemus · 2017-10-21T21:27:40Z

_pytest/terminal.py

@@ -320,7 +375,7 @@ def report_collect(self, final=False):
        if skipped:
            line += " / %d skipped" % skipped
        if self.isatty:
-            self.rewrite(line, bold=True, erase=True)
+            self.writer.reline(line, bold=True)


This avoids the flickering while collecting, not really related.

coveralls · 2017-10-21T21:49:21Z

Coverage increased (+0.04%) to 92.698% when pulling 1e95642 on nicoddemus:console-progress-2657 into 083084f on pytest-dev:features.

coveralls · 2017-10-21T22:13:22Z

Coverage increased (+0.04%) to 92.698% when pulling 1e95642 on nicoddemus:console-progress-2657 into 083084f on pytest-dev:features.

nicoddemus · 2017-10-21T22:58:53Z

_pytest/terminal.py


        self.stats = {}
        self.startdir = py.path.local()
        if file is None:
            file = sys.stdout
        self._writer = _pytest.config.create_terminal_writer(config, file)
+        self._screen_width = self.writer.fullwidth


I had to cache this otherwise I noticed a good 20% performance penalty. We probably need to fix this in py somehow, which we have tried to do in the past.

coveralls · 2017-11-14T23:01:38Z

Coverage increased (+0.03%) to 92.73% when pulling d01e871 on nicoddemus:console-progress-2657 into 685387a on pytest-dev:features.

RonnyPfannschmidt · 2017-11-18T08:24:25Z

setup.py

@@ -45,7 +45,7 @@ def has_environment_marker_support():
 def main():
    extras_require = {}
    install_requires = [
-        'py>=1.4.33',
+        'py>=1.5.0',


please rebase to avoid this bit creating issues

Definitely, I'm still working on this.

coveralls · 2017-11-18T13:48:04Z

Coverage increased (+0.03%) to 92.739% when pulling 456871c on nicoddemus:console-progress-2657 into ca1f4bc on pytest-dev:features.

nicoddemus · 2017-11-18T14:34:01Z

Also changed the color to CYAN. Some screenshots:

nicoddemus · 2017-11-18T14:34:53Z

I will also add an ini option (console_output_style=classic/progress) so this can be disabled if the user wants to. I want to add this option in case this somehow causes problems in some edge cases.

nicoddemus · 2017-11-18T14:58:28Z

Still needs to update the docs and CHANGELOG. I will get to it on Monday.

Fix pytest-dev#2657

coveralls · 2017-11-21T23:26:59Z

Coverage increased (+0.003%) to 92.709% when pulling 2455f86 on nicoddemus:console-progress-2657 into ca1f4bc on pytest-dev:features.

nicoddemus · 2017-11-21T23:36:51Z

Cleaned up commits and added what was missing, so this is now ready for review as far as I'm concerned. 😁

coveralls · 2017-11-22T02:20:37Z

Coverage increased (+0.003%) to 92.709% when pulling f05333a on nicoddemus:console-progress-2657 into ca1f4bc on pytest-dev:features.

The-Compiler

Haven't really reviewed the logic clearly - I commented on what caught my eye at 7am 😉

The-Compiler · 2017-11-22T05:50:45Z

_pytest/pytester.py

+        """Check lines exist in the output.
+
+        The argument is a list of lines which have to occur in the
+        output, in any order.  Each line can contain glob whildcards.


whildcards -> wildcards - but it looks like this actually takes a regex pattern, and not globs?

done, thanks

The-Compiler · 2017-11-22T05:53:42Z

_pytest/terminal.py

        self.currentfspath = None
        self.reportchars = getreportopt(config)
        self.hasmarkup = self.writer.hasmarkup
        self.isatty = file.isatty()
+        self._progress_items_reported = 0


Do we really have no way already to get how many tests have run so far?

Not that I know of; usually this is not really tracked by pytest explicitly, each runtestprotocol just triggers the appropriate hooks and each plugin does with that information what it needs.

The-Compiler · 2017-11-22T05:55:34Z

testing/test_terminal.py

+    def test_normal(self, many_tests_file, testdir):
+        output = testdir.runpytest()
+        output.stdout.re_match_lines([
+            r'test_bar.py \.\.\.\.\.\.\.\.\.\. \s+ \[ 50%\]',


Might want to do \.{10} here and in other tests.

Definitely 👍

nicoddemus · 2017-11-22T19:20:57Z

@The-Compiler thanks for the review, I believe I have addressed all your comments so far. 👍

coveralls · 2017-11-22T19:40:49Z

Coverage increased (+0.003%) to 92.709% when pulling dc574c6 on nicoddemus:console-progress-2657 into ca1f4bc on pytest-dev:features.

wimglenn · 2018-08-25T21:06:24Z

Note: this progress output inspired pytest-dev/py#196
If we can get that reliable and performant enough, I would like to change self.writer.chars_on_current_line into self.writer.width_of_current_line. Or maybe width issues will go away, if we come across some better solution when purging py code from pytest.

nicoddemus · 2018-08-26T12:16:37Z

@wimglenn definitely! Thanks a lot for that implementation no py! 👍

nicoddemus requested review from RonnyPfannschmidt and The-Compiler October 21, 2017 21:25

nicoddemus force-pushed the console-progress-2657 branch from beb2e11 to 562ea0f Compare October 21, 2017 21:30

nicoddemus commented Oct 21, 2017

View reviewed changes

nicoddemus mentioned this pull request Oct 24, 2017

add TerminalWriter.chars_on_current_line read-only property pytest-dev/py#155

Merged

nicoddemus force-pushed the console-progress-2657 branch from 1e95642 to d01e871 Compare November 14, 2017 22:29

RonnyPfannschmidt reviewed Nov 18, 2017

View reviewed changes

nicoddemus force-pushed the console-progress-2657 branch from 4658781 to 456871c Compare November 18, 2017 13:26

nicoddemus added 6 commits November 21, 2017 21:01

Require py>=1.5.0

7a7cb8c

Implement progress percentage reporting while running tests

dab8893

Fix pytest-dev#2657

Add re_match_lines and re_match_lines_random to pytester fixture

8b92527

Add progress output for verbose mode with xdist

3441084

Add tests for progress output and docs for console_output_style

3a5dbab

Fix pytest-dev#2657

Add changelog

2455f86

nicoddemus force-pushed the console-progress-2657 branch from 5a2d55e to 2455f86 Compare November 21, 2017 23:06

nicoddemus changed the title ~~[WIP] Console progress output~~ Console progress output Nov 21, 2017

Fix rewrite to not write past the edge of the screen

f05333a

nicoddemus force-pushed the console-progress-2657 branch from 01391b9 to f05333a Compare November 22, 2017 02:00

The-Compiler requested changes Nov 22, 2017

View reviewed changes

nicoddemus added 2 commits November 22, 2017 17:15

Fix docstrings in pytester

1d26f37

Use regex match-count syntax to improve test readability

dc574c6

RonnyPfannschmidt merged commit b533c26 into pytest-dev:features Nov 23, 2017

nicoddemus deleted the console-progress-2657 branch August 26, 2018 01:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Console progress output #2858

Console progress output #2858

nicoddemus commented Oct 21, 2017 •

edited

Loading

nicoddemus Oct 21, 2017

RonnyPfannschmidt Oct 24, 2017

nicoddemus Oct 21, 2017

coveralls commented Oct 21, 2017

coveralls commented Oct 21, 2017

nicoddemus Oct 21, 2017

coveralls commented Nov 14, 2017

RonnyPfannschmidt Nov 18, 2017

nicoddemus Nov 18, 2017

coveralls commented Nov 18, 2017

nicoddemus commented Nov 18, 2017

nicoddemus commented Nov 18, 2017

nicoddemus commented Nov 18, 2017

coveralls commented Nov 21, 2017

nicoddemus commented Nov 21, 2017

coveralls commented Nov 22, 2017

The-Compiler left a comment

The-Compiler Nov 22, 2017

nicoddemus Nov 22, 2017

The-Compiler Nov 22, 2017

nicoddemus Nov 22, 2017

The-Compiler Nov 22, 2017

nicoddemus Nov 22, 2017

nicoddemus commented Nov 22, 2017

coveralls commented Nov 22, 2017

wimglenn commented Aug 25, 2018 •

edited

Loading

nicoddemus commented Aug 26, 2018

Console progress output #2858

Console progress output #2858

Conversation

nicoddemus commented Oct 21, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Oct 21, 2017

coveralls commented Oct 21, 2017

Choose a reason for hiding this comment

coveralls commented Nov 14, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Nov 18, 2017

nicoddemus commented Nov 18, 2017

nicoddemus commented Nov 18, 2017

nicoddemus commented Nov 18, 2017

coveralls commented Nov 21, 2017

nicoddemus commented Nov 21, 2017

coveralls commented Nov 22, 2017

The-Compiler 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

nicoddemus commented Nov 22, 2017

coveralls commented Nov 22, 2017

wimglenn commented Aug 25, 2018 • edited Loading

nicoddemus commented Aug 26, 2018

nicoddemus commented Oct 21, 2017 •

edited

Loading

wimglenn commented Aug 25, 2018 •

edited

Loading