tool output nicely formatted

Author: thomasWeise

styles/colors.sty

@@ -39,6 +39,9 @@
 \colorlet{listing-string}{red!60!black}%
 \colorlet{listing-numbers}{green!60!black}%
 \colorlet{listing-comment}{gray!60!black}%
+%
+\colorlet{listing-tool-command}{red!50!black}%
+\colorlet{listing-tool-result}{blue!50!black}%
 %%
 %% Title Page Colors
 %%

styles/listing.sty

@@ -123,6 +123,14 @@ language=bash,%
 }%
 %
 %
+\lstdefinestyle{tool_style}{%
+style=text_style,%
+morecomment=[f][\color{listing-tool-command}][0]{\$ },
+morecomment=[f][\color{listing-tool-result}][0]{\# },
+breaklines=true%
+}%
+%
+%
 %% the box around the inline listings
 \protected\gdef\inlinelistingbox#1{\bgroup%
 \fboxsep=0.5pt%
@@ -199,20 +207,21 @@ language=bash,%
 %% #3 the command
 %% #4 the label (exec: will be pre-pended)
 %% #5 the additional parameters, if any
-\protected\gdef\gitOutputRaw#1#2#3#4#5{%
+%% #6 the style to use
+\protected\gdef\gitOutputWithStyle#1#2#3#4#5#6{%
 \gitExec{#1}{#2}{#3}%
 \expandafter\expandafter\expandafter\edef\expandafter\csname @pwp@gitFile:exec:#4\endcsname{\gitFile}%
-\lstinputlisting[style=text_style#5]{\csname @pwp@gitFile:exec:#4\endcsname}%
+\lstinputlisting[style=#6#5]{\csname @pwp@gitFile:exec:#4\endcsname}%
 }%
 %
-%% Use latexgit to place a listing with program output.
+%% Use latexgit to place a listing with tool output.
 %% #1 the git repository
 %% #2 the local path
 %% #3 the command
 %% #4 the label (exec: will be pre-pended)
 %% #5 the caption
-\protected\gdef\gitOutput#1#2#3#4#5{%
-\gitOutputRaw{#1}{#2}{#3}{#4}{,label={exec:#4},caption={#5},float}%
+\protected\gdef\gitOutputTool#1#2#3#4#5{%
+\gitOutputWithStyle{#1}{#2}{#3}{#4}{,label={exec:#4},caption={#5},float}{tool_style}%
 }%
 %
 %% Use latexgit to place a listing with code and the program output.

text/front/preface/preface.tex

@@ -69,4 +69,4 @@ \chapter*{Preface}%
 %
 \strut\vfill\strut%
 This book was built using the following software:%
-\gitOutputRaw{}{}{scripts/dependencyVersions.sh}{versions}{}%
+\gitOutputWithStyle{}{}{scripts/dependencyVersions.sh}{versions}{}{text_style}%

text/main/basics/collections/lists/lists.tex

@@ -153,7 +153,7 @@
 It does not have any \emph{error} in the strict sense.
 We can execute it just fine and it will produce the output \textil{[1, 2, 3]} as shown in \cref{exec:lists:lists_error}.
 
-\gitOutput{\programmingWithPythonCodeRepo}{.}{scripts/mypy.sh 02_collections lists_error.py}{lists:lists_error:mypy}{%
+\gitOutputTool{\programmingWithPythonCodeRepo}{.}{scripts/mypy.sh 02_collections lists_error.py}{lists:lists_error:mypy}{%
 The results of static type checking with \mypy\ of the program given in \cref{lst:lists:lists_error}.}
 
 However, upon closer inspection, we discover some issues.
@@ -179,7 +179,7 @@
 We provide a script for using \ruff\ with a reasonable default configuration in \cref{lst:bash:ruff} on \cpageref{lst:bash:ruff}.%
 }%
 %
-\gitOutput{\programmingWithPythonCodeRepo}{.}{scripts/ruff.sh 02_collections lists_error.py}{lists:lists_error:ruff}{%
+\gitOutputTool{\programmingWithPythonCodeRepo}{.}{scripts/ruff.sh 02_collections lists_error.py}{lists:lists_error:ruff}{%
 The results of linting with \ruff\ of the program given in \cref{lst:lists:lists_error}. (We used the script given in \cref{lst:bash:ruff} on \cpageref{lst:bash:ruff} to apply \ruff.)}%
 %
 Let us apply \ruff\ to the program \textil{lists_error.py} given in \cref{lst:lists:lists_error}, which produces the output \cref{exec:lists:lists_error:ruff}.
@@ -220,10 +220,10 @@
 %
 \FloatBarrier%
 %
-\gitOutput{\programmingWithPythonCodeRepo}{.}{scripts/mypy.sh 02_collections lists_fixed.py}{lists:lists_fixed:mypy}{%
+\gitOutputTool{\programmingWithPythonCodeRepo}{.}{scripts/mypy.sh 02_collections lists_fixed.py}{lists:lists_fixed:mypy}{%
 The results of static type checking with \mypy\ of the program given in \cref{lst:lists:lists_fixed}.}%
 %
-\gitOutput{\programmingWithPythonCodeRepo}{.}{scripts/ruff.sh 02_collections lists_fixed.py}{lists:lists_fixed:ruff}{%
+\gitOutputTool{\programmingWithPythonCodeRepo}{.}{scripts/ruff.sh 02_collections lists_fixed.py}{lists:lists_fixed:ruff}{%
 The results of static type checking with \ruff\ of the program given in \cref{lst:lists:lists_fixed}.}
 
 Well, this was only a two-line program.

text/main/basics/collections/tuples/tuples.tex

@@ -10,7 +10,7 @@
 \gitPythonAndErrorOutput{\programmingWithPythonCodeRepo}{02_collections}{tuples_3.py}{--args format}{tuples:tuples_3}{%
 A third example for using tuples in \python: testing the immutability property.}%
 %
-\gitOutput{\programmingWithPythonCodeRepo}{.}{scripts/mypy.sh 02_collections tuples_3.py}{tuples:tuples_3:mypy}{%
+\gitOutputTool{\programmingWithPythonCodeRepo}{.}{scripts/mypy.sh 02_collections tuples_3.py}{tuples:tuples_3:mypy}{%
 The results of static type checking with \mypy\ of the program given in \cref{lst:tuples:tuples_3}.}%
 %
 \pythonIdx{tuple}%

text/main/basics/variables/typesAndTypeHints/typesAndTypeHints.tex

@@ -86,11 +86,11 @@
 \label{fig:pipInstallMypy}%
 \end{figure}%
 %
-\gitOutput{\programmingWithPythonCodeRepo}{.}{scripts/mypy.sh 01_variables variable_types_wrong.py}{variables:variable_types_wrong:mypy}{%
+\gitOutputTool{\programmingWithPythonCodeRepo}{.}{scripts/mypy.sh 01_variables variable_types_wrong.py}{variables:variable_types_wrong:mypy}{%
 The results of static type checking with \mypy\ of the program given in \cref{lst:variables:types_wrong}. %
 (This is actually output generated by the script~\cref{lst:bash:mypy} on \cpageref{lst:bash:mypy}.)}%
 %
-\gitOutput{\programmingWithPythonCodeRepo}{.}{scripts/mypy.sh 01_variables variable_types.py}{variables:variable_types:mypy}{%
+\gitOutputTool{\programmingWithPythonCodeRepo}{.}{scripts/mypy.sh 01_variables variable_types.py}{variables:variable_types:mypy}{%
 The results of static type checking with \mypy\ of the program given in \cref{lst:variables:types}. %
 (This is actually output generated by the script~\cref{lst:bash:mypy} on \cpageref{lst:bash:mypy}.)}%
 %
@@ -171,10 +171,10 @@
 \gitPythonAndOutput{\programmingWithPythonCodeRepo}{01_variables}{variable_types_wrong_hints_2.py}{--args format}{variables:types_wrong_hints_2}{%
 \cref{lst:variables:types_wrong}, but with the variable explicitly hinted as either \pythonil{int} or \pythonil{float} and named appropriately.}%
 %
-\gitOutput{\programmingWithPythonCodeRepo}{.}{scripts/mypy.sh 01_variables variable_types_wrong_hints_1.py}{variables:variable_types_wrong_hints_1:mypy}{%
+\gitOutputTool{\programmingWithPythonCodeRepo}{.}{scripts/mypy.sh 01_variables variable_types_wrong_hints_1.py}{variables:variable_types_wrong_hints_1:mypy}{%
 The results of static type checking with \mypy\ of the program given in \cref{lst:variables:types_wrong_hints_1}.}%
 %
-\gitOutput{\programmingWithPythonCodeRepo}{.}{scripts/mypy.sh 01_variables variable_types_wrong_hints_2.py}{variables:variable_types_wrong_hints_2:mypy}{%
+\gitOutputTool{\programmingWithPythonCodeRepo}{.}{scripts/mypy.sh 01_variables variable_types_wrong_hints_2.py}{variables:variable_types_wrong_hints_2:mypy}{%
 The results of static type checking with \mypy\ of the program given in \cref{lst:variables:types_wrong_hints_2}.}%%
 
 If the author of \cref{lst:variables:types_wrong} had used type hints, they could have written their program differently, as illustrated in \cref{lst:variables:types_wrong_hints_1,lst:variables:types_wrong_hints_2}.
@@ -207,7 +207,7 @@
 \gitPython{\programmingWithPythonCodeRepo}{01_variables/variable_types_hints.py}{--args format}{variables:types_hints}{%
 A variant of \cref{lst:variables:types} which has been improved by adding type annotations.}%
 %
-\gitOutput{\programmingWithPythonCodeRepo}{.}{scripts/mypy.sh 01_variables variable_types_hints.py}{variables:variable_types_hints:mypy}{%
+\gitOutputTool{\programmingWithPythonCodeRepo}{.}{scripts/mypy.sh 01_variables variable_types_hints.py}{variables:variable_types_hints:mypy}{%
 The results of static type checking with \mypy\ of the program given in \cref{lst:variables:types_hints}.}
 
 For the sake of completeness, let us also annotate \cref{lst:variables:types} with type hints as a small exercise.

text/main/controlFlow/conditionals/conditionals.tex

@@ -138,7 +138,7 @@
 \gitPythonAndOutput{\programmingWithPythonCodeRepo}{03_conditionals}{if_elif_example.py}{--args format}{conditionals:if_elif}{%
 An example for using the \pythonil{if ... elif}\pythonIdx{if{\idxdots}elif{\idxdots}else} statement.}%
 %
-\gitOutput{\programmingWithPythonCodeRepo}{.}{scripts/ruff.sh 03_conditionals if_else_nested.py}{conditionals:if_else_nested:ruff}{%
+\gitOutputTool{\programmingWithPythonCodeRepo}{.}{scripts/ruff.sh 03_conditionals if_else_nested.py}{conditionals:if_else_nested:ruff}{%
 The results of linting with \ruff\ of the program given in \cref{lst:conditionals:if_else_nested}.}%
 %
 \gitPythonAndOutput{\programmingWithPythonCodeRepo}{03_conditionals}{if_elif_nested.py}{--args format}{conditionals:if_elif_nested}{%
@@ -221,7 +221,7 @@
 An example for using the nested \pythonil{if ... else}\pythonIdx{if{\idxdots}elif{\idxdots}else} statements that could be inlined. %
 See \cref{lst:conditionals:inline_if_else} for the more compact inlined variant.}%
 %
-\gitOutput{\programmingWithPythonCodeRepo}{.}{scripts/ruff.sh 03_conditionals if_else_could_be_inline.py}{conditionals:if_else_could_be_inline:ruff}{%
+\gitOutputTool{\programmingWithPythonCodeRepo}{.}{scripts/ruff.sh 03_conditionals if_else_could_be_inline.py}{conditionals:if_else_could_be_inline:ruff}{%
 The results of linting with \ruff\ of the program given in \cref{lst:conditionals:if_else_could_be_inline}.}%
 %
 \gitPythonAndOutput{\programmingWithPythonCodeRepo}{03_conditionals}{inline_if_else.py}{--args format}{conditionals:inline_if_else}{%

text/main/controlFlow/functions/functions.tex

@@ -316,7 +316,7 @@
 \gitPython{\programmingWithPythonCodeRepo}{05_functions/test_my_math.py}{--args format}{functions:test_my_math}{%
 A small unit test suite for \cref{lst:functions:my_math}.}%
 %
-\gitOutput{\programmingWithPythonCodeRepo}{.}{scripts/pytest.sh 05_functions test_my_math.py}{functions:test_my_math:pytest}{%
+\gitOutputTool{\programmingWithPythonCodeRepo}{.}{scripts/pytest.sh 05_functions test_my_math.py}{functions:test_my_math:pytest}{%
 The output of the unit tests in \cref{lst:functions:test_my_math}: While the test of \pythonil{factorial} succeeds, our \pythonil{sqrt} function fails for input~\pythonil{0.0}.}%
 
 In \cref{lst:functions:test_my_math} we do just that.
@@ -402,7 +402,7 @@
 \gitPython{\programmingWithPythonCodeRepo}{05_functions/test_my_math_2.py}{--args format}{functions:test_my_math_2}{%
 We use the same small unit test suite given in \cref{lst:functions:test_my_math} for \pythonil{sqrt} in \cref{lst:functions:my_math_2}.}%
 %
-\gitOutput{\programmingWithPythonCodeRepo}{.}{scripts/pytest.sh 05_functions test_my_math_2.py}{functions:test_my_math_2:pytest}{%
+\gitOutputTool{\programmingWithPythonCodeRepo}{.}{scripts/pytest.sh 05_functions test_my_math_2.py}{functions:test_my_math_2:pytest}{%
 The output of the unit tests in \cref{lst:functions:test_my_math_2}: This time, we hit the timeout because of an endless loop!}
 
 In order to fix this problem, we introduce the check \pythonil{if number <= 0.0} into our \pythonil{sqrt} function in \cref{lst:functions:test_my_math_2}.
@@ -439,7 +439,7 @@
 \gitPython{\programmingWithPythonCodeRepo}{05_functions/test_my_math_3.py}{--args format}{functions:test_my_math_3}{%
 We use the same small unit test suite given in \cref{lst:functions:test_my_math} for \pythonil{sqrt} in \cref{lst:functions:my_math_3}.}%
 %
-\gitOutput{\programmingWithPythonCodeRepo}{.}{scripts/pytest.sh 05_functions test_my_math_3.py}{functions:test_my_math_3:pytest}{%
+\gitOutputTool{\programmingWithPythonCodeRepo}{.}{scripts/pytest.sh 05_functions test_my_math_3.py}{functions:test_my_math_3:pytest}{%
 The output of the successful unit tests in \cref{lst:functions:test_my_math_3}.}%
 %
 \begin{sloppypar}%

text/main/controlFlow/loops/loops.tex

@@ -330,7 +330,7 @@
 We provide a script for using \pylint\ with a reasonable default configuration in \cref{lst:bash:pylint} on \cpageref{lst:bash:pylint}.%
 }%
 %
-\gitOutput{\programmingWithPythonCodeRepo}{.}{scripts/pylint.sh 04_loops for_loop_no_enumerate.py}{loops:for_loop_no_enumerate:pylint}{%
+\gitOutputTool{\programmingWithPythonCodeRepo}{.}{scripts/pylint.sh 04_loops for_loop_no_enumerate.py}{loops:for_loop_no_enumerate:pylint}{%
 The results of static code analysis using the \pylint\ \pgls{linter} for the program given in \cref{lst:loops:for_loop_no_enumerate}.}%
 %
 \gitPythonAndOutput{\programmingWithPythonCodeRepo}{04_loops}{for_loop_enumerate.py}{--args format}{loops:for_loop_enumerate}{%