Screen optimizations

AUTHORS

@@ -17,3 +17,4 @@ Contributors
 - Byron Roosa
 - Andrew Crozier
 - @eight04
+- Martin Di Paola @eldipa

benchmark.py

@@ -10,6 +10,15 @@
         .....................
         ls.input: Mean +- std dev: 644 ns +- 23 ns
 
+        $ BENCHMARK=tests/captured/ls.input GEOMETRY=1024x1024 python benchmark.py -o results.json
+        .....................
+        ls.input: Mean +- std dev: 644 ns +- 23 ns
+
+    Environment variables:
+
+    BENCHMARK: the input file to feed pyte's Stream and render on the Screen
+    GEOMETRY: the dimensions of the screen with format "<lines>x<cols>" (default 24x80)
+
     :copyright: (c) 2016-2021 by pyte authors and contributors,
                     see AUTHORS for details.
     :license: LGPL, see LICENSE for more details.
@@ -27,21 +36,63 @@
 
 import pyte
 
-
-def make_benchmark(path, screen_cls):
-    with io.open(path, "rt", encoding="utf-8") as handle:
+def setup(path, screen_cls, columns, lines, optimize_conf):
+    with io.open(path, "rb") as handle:
         data = handle.read()
 
-    stream = pyte.Stream(screen_cls(80, 24))
+    extra_args = {}
+    if optimize_conf:
+        extra_args = {
+                'track_dirty_lines': False,
+                'disable_display_graphic': True,
+                }
+
+    screen = screen_cls(columns, lines, **extra_args)
+    stream = pyte.ByteStream(screen)
+
+    return data, screen, stream
+
+def make_stream_feed_benchmark(path, screen_cls, columns, lines, optimize_conf):
+    data, _, stream = setup(path, screen_cls, columns, lines, optimize_conf)
     return partial(stream.feed, data)
 
+def make_screen_display_benchmark(path, screen_cls, columns, lines, optimize_conf):
+    data, screen, stream = setup(path, screen_cls, columns, lines, optimize_conf)
+    stream.feed(data)
+    return lambda: screen.display
+
+def make_screen_reset_benchmark(path, screen_cls, columns, lines, optimize_conf):
+    data, screen, stream = setup(path, screen_cls, columns, lines, optimize_conf)
+    stream.feed(data)
+    return screen.reset
+
+def make_screen_resize_half_benchmark(path, screen_cls, columns, lines, optimize_conf):
+    data, screen, stream = setup(path, screen_cls, columns, lines, optimize_conf)
+    stream.feed(data)
+    return partial(screen.resize, lines=lines//2, columns=columns//2)
 
 if __name__ == "__main__":
     benchmark = os.environ["BENCHMARK"]
-    sys.argv.extend(["--inherit-environ", "BENCHMARK"])
+    lines, columns = map(int, os.environ.get("GEOMETRY", "24x80").split('x'))
+    optimize_conf = int(os.environ.get("OPTIMIZECONF", "0"))
+    sys.argv.extend(["--inherit-environ", "BENCHMARK,GEOMETRY,OPTIMIZECONF"])
 
     runner = Runner()
 
-    for screen_cls in [pyte.Screen, pyte.DiffScreen, pyte.HistoryScreen]:
-        name = os.path.basename(benchmark) + "->" + screen_cls.__name__
-        runner.bench_func(name, make_benchmark(benchmark, screen_cls))
+    metadata = {
+        'input_file': benchmark,
+        'columns': columns,
+        'lines': lines,
+        'optimize_conf': optimize_conf
+        }
+
+    benchmark_name = os.path.basename(benchmark)
+    for screen_cls in [pyte.Screen, pyte.HistoryScreen]:
+        screen_cls_name = screen_cls.__name__
+        for make_test in (make_stream_feed_benchmark, make_screen_display_benchmark, make_screen_reset_benchmark, make_screen_resize_half_benchmark):
+            scenario = make_test.__name__[5:-10] # remove make_ and _benchmark
+
+            name = f"[{scenario} {lines}x{columns}] {benchmark_name}->{screen_cls_name}"
+            metadata.update({'scenario': scenario, 'screen_cls': screen_cls_name})
+            runner.bench_func(name, make_test(benchmark, screen_cls, columns, lines, optimize_conf), metadata=metadata)
+

full_benchmark.sh

@@ -0,0 +1,51 @@
+#!/usr/bin/bash
+
+if [ "$#" != "1" -a "$#" != "2" ]; then
+    echo "Usage benchmark.sh <outputfile>"
+    echo "Usage benchmark.sh <outputfile> tracemalloc"
+    exit 1
+fi
+
+if [ "$2" = "tracemalloc" ]; then
+    tracemalloc="--tracemalloc"
+elif [ "$2" = "" ]; then
+    tracemalloc=""
+else
+    echo "Usage benchmark.sh <outputfile>"
+    echo "Usage benchmark.sh <outputfile> tracemalloc"
+    exit 1
+fi
+
+outputfile=$1
+
+if [ ! -f benchmark.py ]; then
+    echo "File benchmark.py missing. Are you in the home folder of pyte project?"
+    exit 1
+fi
+
+for inputfile in $(ls -1 tests/captured/*.input); do
+    export GEOMETRY=24x80
+    echo "$inputfile - $GEOMETRY"
+    echo "======================"
+    BENCHMARK=$inputfile python benchmark.py $tracemalloc --append $outputfile
+
+    export GEOMETRY=240x800
+    echo "$inputfile - $GEOMETRY"
+    echo "======================"
+    BENCHMARK=$inputfile python benchmark.py $tracemalloc --append $outputfile
+
+    export GEOMETRY=2400x8000
+    echo "$inputfile - $GEOMETRY"
+    echo "======================"
+    BENCHMARK=$inputfile python benchmark.py $tracemalloc --append $outputfile
+
+    export GEOMETRY=24x8000
+    echo "$inputfile - $GEOMETRY"
+    echo "======================"
+    BENCHMARK=$inputfile python benchmark.py $tracemalloc --append $outputfile
+
+    export GEOMETRY=2400x80
+    echo "$inputfile - $GEOMETRY"
+    echo "======================"
+    BENCHMARK=$inputfile python benchmark.py $tracemalloc --append $outputfile
+done