added bash and mypy script

Author: thomasWeise

.gitignore

@@ -1,5 +1,6 @@
 ## Core latex/pdflatex auxiliary files:
 *.aux
+*.ind
 *.lof
 *.log
 *.lot

bibliography/bibliography.bib

@@ -43,6 +43,7 @@ @string { a_bommarito_michael
 @string { a_bose_cherokee = "Cherokee Boose" }
 @string { a_bott_ed = "Ed Bott" }
 @string { a_bradbury_james = "James Bradbury" }
+@string { a_brash_ron = "Ron Brash" }
 @string { a_brett_matthew = "Matthew Brett" }
 @string { a_bright_jonathan = "Jonathan Bright" }
 @string { a_brucher_matthieu = "Matthieu Brucher" }
@@ -156,6 +157,7 @@ @string { a_moore_eric_w
 @string { a_moore_sherry = "Sherry Moore" }
 @string { a_morris_sidney_a = "Sidney A.\ Morris" }
 @string { a_murray_derek_gordon = "Derek Gordon Murray" }
+@string { a_naik_ganesh = "Ganesh Naik" }
 @string { a_negus_christopher = "Christopher Negus" }
 @string { a_nelson_andrew_r_j = "Andrew R.\ J.\ Nelson" }
 @string { a_nguyen_quan = "Quan Nguyen" }
@@ -250,6 +252,7 @@ @string { a_yang_edward_z
 @string { a_yang_xuanda = "Xuanda Yang" }
 @string { a_ye_jingchen = "Jingchen Ye" }
 @string { a_yu_yuan = "Yuan Yu" }
+@string { a_zarrelli_giorgio = "Giorgio Zarrelli" }
 @string { a_zheng_xiaoqiang = "Xiaoqiang Zheng" }
 @string { a_zijlstra_jelle = "Jelle Zijlstra" }
 @string { a_zinoviev_dimitry = "Dmitry Zinoviev" }
@@ -643,7 +646,7 @@ @book{B2023G2GLS
 
 @book{B2023PFS,
  author = a_bruhin_florian,
- title = {\python\ f\nobreakdash-strings},
+ title = {\python\ \pglspl{fstring}},
  publisher = p_bruhin_software,
  address = pa_bruhin_software,
  date = {2023-05-31},
@@ -691,6 +694,15 @@ @inbook{BHK2006NS
  urldate = {2024-07-27}
 }
 
+@book{BN2018BC,
+ author = a_brash_ron # and # a_naik_ganesh,
+ title = {\bash\ Cookbook},
+ date = {2018-07},
+ publisher = p_packt,
+ address = pa_packt,
+ isbn = {9781788629362},
+}
+
 @article{C2002LFLHADWTDM,
  title = {Learning from Liu Hui? A Different Way to Do Mathematics},
  author = a_cullen_christopher,
@@ -980,7 +992,7 @@ @book{LNL2020LJ
 
 @book{M2017WAFSIPAHCIUT,
  author = a_maxwell_aaron,
- title = {What are f-strings in \python\ and how can I use them?},
+ title = {What are \pglspl{fstring} in \python\ and how can I use them?},
  publisher = p_infinite_skills,
  address = pa_infinite_skills,
  date = {2017-06},
@@ -1392,6 +1404,15 @@ @book{Y2022PPADT
  isbn = {9781837632442}
 }
 
+@book{Z2017MB,
+ author = a_zarrelli_giorgio,
+ title = {Mastering \bash},
+ date = {2017-06},
+ publisher = p_packt,
+ address = pa_packt,
+ isbn = {9781784396879}
+}
+
 @techreport{Z2024DESIEWS,
  author = a_zinoviev_dimitry,
  title = {Discrete Event Simulation: It's Easy with \simpy!},

notation/software.sty

@@ -5,6 +5,18 @@
 \protected\gdef\softwareStyle#1{\scalebox{0.95}[1]{\texttt{#1}}}%
 %
 %
+\newglossaryentry{bash}{%
+text={\softwareStyle{Bash}},%
+name={Bash},%
+sort={Bash},%
+description={%
+is a the shell used under \ubuntu\ \linux, i.e., the program that \inQuotes{runs} in the \pgls{terminal} and interprets your commands, allowing you to start and interact with other programs~\cite{Z2017MB,BN2018BC}. %
+Learn more at \url{https://www.gnu.org/software/bash/}.%
+}%
+}%
+\protected\gdef\bash{\pgls{bash}}%
+%
+%
 \newglossaryentry{linux}{%
 text={\softwareStyle{Linux}},%
 name={Linux},%

notation/terms.sty

@@ -153,7 +153,7 @@ description={%
 A terminal is a text-based window where you can enter commands and execute them~\cite{CN2020ULB,B2022ELATCL}. %
 Knowing what a terminal is and how to use it is very essential in any programming- or system administration-related task. %
 If you want to open a terminal under \windows, you can \windowsTerminal, as shown, e.g., in \cpageref{fig:installingPythonWindows01openTerminal}. %
-Under \ubuntu\ \linux, \ubuntuTerminal\ opens a terminal.%
+Under \ubuntu\ \linux, \ubuntuTerminal\ opens a terminal, which then runs a \bash\ shell inside.%
 }%
 }%
 %

styles/listing.sty

@@ -6,59 +6,33 @@
 %
 \def\@lstbasicstyle{\small\color{listing-text-color}\linespread{1.0}\lst@ifdisplaystyle\small\fi\ttfamily{}}%
 %
-\lstdefinestyle{python_style}{%
-%
+\lstdefinestyle{basic_style}{%
 backgroundcolor=\color{listing-background},%
 numbers=left,%
 frame=single,%
 rulecolor=\color{listing-rule},%
 frameround=ffff,%
-%
 breaklines=true,%
 tabsize=4,%
-%
-language=Python,%
 sensitive=true,%
-%
 basicstyle=\@lstbasicstyle,%
 identifierstyle=\color{listing-identifier},%
 numberstyle=\color{listing-line-numbers},%
-%
-otherkeywords={\%,\},\{,\&,\|},%
 keywordstyle=\color{listing-keyword-1}\bfseries,%
-%
-emph={and,break,class,continue,def,yield,del,elif,else,except,exec,finally,for,from,global,if,import,in,lambda,not,or,pass,print,raise,return,try,while,assert,with},%
 emphstyle=\color{listing-emph-1}\bfseries,%
-%
-emph={[2]True,False,None},%
 emphstyle=[2]\color{listing-emph-2},%
-%
-emph={[3]object,type,isinstance,deepcopy,zip,enumerate,reversed,list,set,len,dict,tuple,xrange,append,execfile,real,imag,reduce,str,repr},%
 emphstyle=[3]\color{listing-emph-3},%
-%
-emph={[4]Exception,NameError,IndexError,SyntaxError,TypeError,ValueError,OverflowError,ZeroDivisionError},%
 emphstyle=[4]\color{listing-emph-4}\bfseries,%
-%
-emph={[5]ode,fsolve,sqrt,exp,sin,cos,arctan,arctan2,arccos,pi,array,norm,dot,arange,isscalar,max,sum,flatten,shape,reshape,find,any,all,abs,plot,linspace,legend,quad,polyval,polyfit,hstack,concatenate,vstack,column_stack,empty,zeros,ones,rand,vander,grid,pcolor,eig,eigs,eigvals,svd,qr,tan,det,logspace,roll,min,mean,cumsum,cumprod,diff,vectorize,lstsq,cla,eye,xlabel,ylabel,squeeze},%
 emphstyle=[5]\color{listing-emph-5},%
-%
-emph={[6]__init__,__add__,__mul__,__div__,__sub__,__call__,__getitem__,__setitem__,__eq__,__ne__,__new__,__nonzero__,__rmul__,__radd__,__repr__,__str__,__get__,__truediv__,__pow__,__name__,__future__,__all__},%
 emphstyle=[6]\color{listing-emph-6},%
-%
-emph={[7]assert,yield},%
 emphstyle=[7]\color{listing-emph-7}\bfseries,%
-%
-emph={[8]range},%
 emphstyle={[8]\color{listing-emph-8}\bfseries},%
-%
 keywordstyle={[2]\color{listing-keyword-2}\bfseries},%
 keywordstyle={[3]\color{listing-keyword-3}\bfseries\itshape},%
-%
 commentstyle=\itshape\color{listing-comment},%
-%
 stringstyle=\color{listing-string},%
 showstringspaces=false,%
-morestring=[s]{"""}{"""},%
+postbreak=\mbox{\textcolor{red}{$\hookrightarrow$}\space},%
 %
 literate=%
 {á}{{\'a}}1 {é}{{\'e}}1 {í}{{\'i}}1 {ó}{{\'o}}1 {ú}{{\'u}}1%
@@ -76,25 +50,28 @@ literate=%
 {…}{{\ldots}}1 {≥}{{>=}}1 {≤}{{<=}}1 {„}{{\glqq}}1 {“}{{\grqq}}1%
 {”}{{''}}1 {π}{{$\pi$}}1%
 }%
+%
+\lstdefinestyle{python_style}{%
+style=basic_style,%
+language=Python,%
+otherkeywords={\%,\},\{,\&,\|},%
+emph={and,break,class,continue,def,yield,del,elif,else,except,exec,finally,for,from,global,if,import,in,lambda,not,or,pass,print,raise,return,try,while,assert,with},%
+emph={[2]True,False,None},%
+emph={[3]object,type,isinstance,deepcopy,zip,enumerate,reversed,list,set,len,dict,tuple,xrange,append,execfile,real,imag,reduce,str,repr},%
+emph={[4]Exception,NameError,IndexError,SyntaxError,TypeError,ValueError,OverflowError,ZeroDivisionError},%
+emph={[5]ode,fsolve,sqrt,exp,sin,cos,arctan,arctan2,arccos,pi,array,norm,dot,arange,isscalar,max,sum,flatten,shape,reshape,find,any,all,abs,plot,linspace,legend,quad,polyval,polyfit,hstack,concatenate,vstack,column_stack,empty,zeros,ones,rand,vander,grid,pcolor,eig,eigs,eigvals,svd,qr,tan,det,logspace,roll,min,mean,cumsum,cumprod,diff,vectorize,lstsq,cla,eye,xlabel,ylabel,squeeze},%
+emph={[6]__init__,__add__,__mul__,__div__,__sub__,__call__,__getitem__,__setitem__,__eq__,__ne__,__new__,__nonzero__,__rmul__,__radd__,__repr__,__str__,__get__,__truediv__,__pow__,__name__,__future__,__all__},%
+emph={[7]assert,yield},%
+emph={[8]range},%
+morestring=[s]{"""}{"""},%
+}%
 \lstset{style=python_style}%
 %
 %
 \lstdefinestyle{text_style}{%
-%
-backgroundcolor=\color{listing-background},%
-numbers=left,%
-frame=single,%
-rulecolor=\color{listing-rule},%
-frameround=ffff,%
-%
-breaklines=true,%
-tabsize=4,%
-%
+style=basic_style,%
 language={},%
-sensitive=true,%
-%
 basicstyle=\@lstbasicstyle,%
-numberstyle=\color{listing-line-numbers},%
 identifierstyle=\@lstbasicstyle,%
 keywords={},%
 otherkeywords={},%
@@ -122,27 +99,15 @@ emph={[7]},%
 emphstyle={[7]\@lstbasicstyle},%
 emph={[8]},%
 emphstyle={[8]\@lstbasicstyle},%
-breaklines=true,%
-postbreak=\mbox{\textcolor{red}{$\hookrightarrow$}\space},%
-%
-literate=%
-{á}{{\'a}}1 {é}{{\'e}}1 {í}{{\'i}}1 {ó}{{\'o}}1 {ú}{{\'u}}1%
-{Á}{{\'A}}1 {É}{{\'E}}1 {Í}{{\'I}}1 {Ó}{{\'O}}1 {Ú}{{\'U}}1%
-{à}{{\`a}}1 {è}{{\'e}}1 {ì}{{\`i}}1 {ò}{{\`o}}1 {ù}{{\`u}}1%
-{À}{{\`A}}1 {È}{{\'E}}1 {Ì}{{\`I}}1 {Ò}{{\`O}}1 {Ù}{{\`U}}1%
-{ä}{{\"a}}1 {ë}{{\"e}}1 {ï}{{\"i}}1 {ö}{{\"o}}1 {ü}{{\"u}}1%
-{Ä}{{\"A}}1 {Ë}{{\"E}}1 {Ï}{{\"I}}1 {Ö}{{\"O}}1 {Ü}{{\"U}}1%
-{â}{{\^a}}1 {ê}{{\^e}}1 {î}{{\^i}}1 {ô}{{\^o}}1 {û}{{\^u}}1%
-{Â}{{\^A}}1 {Ê}{{\^E}}1 {Î}{{\^I}}1 {Ô}{{\^O}}1 {Û}{{\^U}}1%
-{œ}{{\oe}}1 {Œ}{{\OE}}1 {æ}{{\ae}}1 {Æ}{{\AE}}1 {ß}{{\ss}}1%
-{ç}{{\c c}}1 {Ç}{{\c C}}1 {ø}{{\o}}1 {å}{{\r a}}1 {Å}{{\r A}}1%
-{€}{{\EUR}}1 {£}{{\pounds}}1 {«}{{\guillemotleft}}1%
-{»}{{\guillemotright}}1 {ñ}{{\~n}}1 {Ñ}{{\~N}}1 {¿}{{?`}}1%
-{…}{{\ldots}}1 {≥}{{>=}}1 {≤}{{<=}}1 {„}{{\glqq}}1 {“}{{\grqq}}1%
-{”}{{''}}1 {π}{{$\pi$}}1%
+breaklines=true%
 }%
 %
 %
+\lstdefinestyle{bash_style}{%
+style=basic_style,%
+language=bash,%
+}%
+%
 %
 %% the box around the inline listings
 \protected\gdef\inlinelistingbox#1{\bgroup%
@@ -167,7 +132,7 @@ literate=%
 %% #1 the optional args
 %% #2 the code to be printed inline
 \gdef\bashil#1{%
-\inlinelistingbox{\lstinline[language=bash]$#1$}}%
+\inlinelistingbox{\lstinline[style=bash_style]$#1$}}%
 %
 \newlength\@lstbasicstylesheight%
 \settoheight{\@lstbasicstylesheight}{\mbox{\bgroup\@lstbasicstyle{s}\egroup}}%
@@ -188,9 +153,9 @@ literate=%
 %% #6 the style to use
 \protected\gdef\gitCode#1#2#3#4#5#6{%
 \gitLoad{#1}{#2}{#3}%
-\expandafter\expandafter\expandafter\edef\expandafter\csname @pwp@gitUrl:lst:#5\endcsname{\gitUrl}%
-\expandafter\expandafter\expandafter\edef\expandafter\csname @pwp@gitFile:lst:#5\endcsname{\gitFile}%
-\lstinputlisting[float,label={lst:#4}#6,caption={#5~(\href{\csname @pwp@gitUrl:lst:#5\endcsname}{src})}]{\csname @pwp@gitFile:lst:#5\endcsname}%
+\expandafter\expandafter\expandafter\edef\expandafter\csname @pwp@gitUrl:lst:#4\endcsname{\gitUrl}%
+\expandafter\expandafter\expandafter\edef\expandafter\csname @pwp@gitFile:lst:#4\endcsname{\gitFile}%
+\lstinputlisting[float,label={lst:#4}#6,caption={#5~(\href{\csname @pwp@gitUrl:lst:#4\endcsname}{src})}]{\csname @pwp@gitFile:lst:#4\endcsname}%
 }%
 %
 %%

text/back/backmatter.tex

@@ -8,6 +8,10 @@
 \setulmarginsandblock{2.5cm}{2.5cm}{*}%0
 \checkandfixthelayout%
 %
+\hsection{}%
+\hinput{.}{scripts.tex}%
+\endhsection%
+%
 \printBestPractices%
 \printglossaries%
 %

text/back/scripts.tex

@@ -0,0 +1,13 @@
+\hsection{Scripts}%
+%
+Here we provide some scripts that are used within this book.
+The book focuses on \python\ programming, so \bash\ shell scripts are not in the center of our attention and may mess up the flow of chapters.
+Nevertheless, the book would be incomplete if these scripts were not provided as well.
+So we put them here, at the end of the book.%
+%
+\gitCode{\programmingWithPythonCodeRepo}{scripts/mypy.sh}{}{bash:mypy}{%
+A \bash\ script for executing \mypy, which prints the command line and the exit code.%
+}{,style=bash_style}%
+%
+\endhsection%
+%

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

@@ -84,10 +84,12 @@
 \end{figure}%
 %
 \gitOutput{\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}.}%
+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}{%
-The results of static type checking with \mypy\ of the program given in \cref{lst:variables:types}.}%
+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}.)}%
 %
 A first step to avoiding any type-related errors in programs is, ofcourse, careful programming.
 The second step is to use tools that check whether your program code contains ambiguities or errors.