first steps to static type checking

Author: thomasWeise

bibliography/bibliography.bib

@@ -38,6 +38,8 @@ @string { a_beuke_fabian
 @string { a_beygelzimer_alina = "Alina Beygelzimer" }
 @string { a_blin_kai = "Kai Blin" }
 @string { a_blondel_mathieu = "Mathieu Blondel" }
+@string { a_bommarito_ethan = "Ethan Bommarito" }
+@string { a_bommarito_michael = "Michael Bommarito" }
 @string { a_bose_cherokee = "Cherokee Boose" }
 @string { a_bott_ed = "Ed Bott" }
 @string { a_bradbury_james = "James Bradbury" }
@@ -83,6 +85,7 @@ @string { a_flannery_brian_p
 @string { a_flight_robert_m = "Robert M.\ Flight" }
 @string { a_fox_emily_b = "Emily B.\ Fox" }
 @string { a_fufezan_christian = "Christian Fufezan" }
+@string { a_garcia_alessandro = "Alessandro Garcia" }
 @string { a_garnett_roman = "Roman Garnett" }
 @string { a_gatto_laurent = "Laurent Gatto" }
 @string { a_gerard_marchant_pierre = "Pierre G{\'e}rard{-}Marchant" }
@@ -99,17 +102,20 @@ @string { a_grus_joel
 @string { a_grys_slawomir = "S{\l}awomir Gry{\'s}" }
 @string { a_haberland_matt = "Matt Haberland" }
 @string { a_haldane_allan = "Allan Haldane" }
+@string { a_hance_jared = "Jared Hance" }
 @string { a_harris_charles_r = "Charles R.\ Harris" }
 @string { a_hausenblas_michael = "Michael Hausenblas" }
 @string { a_heap_danny = "Danny Heap" }
 @string { a_henriksen_ian = "Ian Henriksen" }
+@string { a_herbsleb_james_d = "James D.\ Herbsleb" }
 @string { a_hollasch_steve = "Steve Hollasch" }
 @string { a_hoyer_stephan = "Stephan Hoyer" }
 @string { a_hubbard_steve = "Steve Hubbard" }
 @string { a_hunter_john_d = "John D. Hunter" }
 @string { a_hunt_john = "John Hunt" }
 @string { a_irving_geoffrey = "Geoffrey Irving" }
 @string { a_isard_michael = "Michael Isard" }
+@string { a_jain_shantanu = "Shantanu Jain" }
 @string { a_johansson_robert = "Robert Johansson" }
 @string { a_jones_eric = "Eric Jones" }
 @string { a_katz_daniel_s = "Daniel S.\ Katz" }
@@ -125,11 +131,14 @@ @string { a_landau_charles
 @string { a_larochelle_hugo = "Hugo Larochelle" }
 @string { a_larson_eric = "Eric Larson" }
 @string { a_laxalde_denis = "Denis Laxalde" }
+@string { a_leavens_gary_t = "Gary T.\ Leavens" }
 @string { a_lee_kent_d = "Kent D.\ Lee" }
+@string { a_lehtosalo_jukka = "Jukka Lehtosalo" }
 @string { a_lerer_adam = "Adam Lerer" }
 @string { a_lerner_reuven_m = "Reuven M.\ Lerner" }
 @string { a_leuck_daniel = "Daniel Leuck" }
 @string { a_levenberg_josh = "Josh Levenberg" }
+@string { a_levkivskyi_ivan = "Ivan Levkivskyi" }
 @string { a_lin_zeming = "Zeming Lin" }
 @string { a_liu_yuxi = "Yuxi Liu" }
 @string { a_loy_marc = "Marc Loy" }
@@ -157,6 +166,7 @@ @string { a_oconnor_john_j
 @string { a_oliphant_travis_e = "Travis E.\ Oliphant" }
 @string { a_pajankar_ashwin = "Ashwin Pajankar" }
 @string { a_paquete_luis = "Lu{\'i}s Paquete" }
+@string { a_pasareanu_corina_s = "Corina S.\ P{\u{a}}s{\u{a}}reanu" }
 @string { a_passos_alexandre = "Alexandre Passos" }
 @string { a_paszke_adam = "Adam Paszke" }
 @string { a_pearson_kenneth_r = "Kenneth R.\ Pearson" }
@@ -189,10 +199,13 @@ @string { a_sheppart_kevin
 @string { a_silva_sara = "Sara Silva" }
 @string { a_skoulikari_anna = "Anna Skoulikari" }
 @string { a_smith_eric_v = "Eric V.\ Smith" }
+@string { a_smith_ethan = "Ethan Smith" }
 @string { a_smith_nathaniel_j = "Nathaniel J.\ Smith" }
+@string { a_sobolev_nikita = "Nikita Sobolev" }
 @string { a_sottet_jean_sebastien = "Jean{-}S{\'e}bastien Sottet" }
 @string { a_steiner_benoit = "Benoit Steiner" }
 @string { a_straffin_jr_philip_d = "Philip D.\ {Straffin~Jr.}" }
+@string { a_sullival_michael_j = "Michael J.\ Sullivan" }
 @string { a_taylor_julian = "Julian Taylor" }
 @string { a_tejani_alykhan = "Alykhan Tejani" }
 @string { a_ternent_tobias = "Tobias Ternent" }
@@ -204,6 +217,7 @@ @string { a_torvalds_linus
 @string { a_tsitoara_mariot = "Mariot Tsitoara" }
 @string { a_tucker_paul_a = "Paul A.\ Tucker" }
 @string { a_uszkoreit_julian = "Julian Uszkoreit" }
+@string { a_valiev_marat = "Marat Valiev" }
 @string { a_vanderplas_jake = "Jake {VanderPlas}" }
 @string { a_van_der_walt_stefan = "St{\'e}fan {van der Walt}" }
 @string { a_van_horn_bruce_m_2 = "Bruce M.\ {Van Horn}~II" }
@@ -213,6 +227,7 @@ @string { a_van_rossum_guido
 @string { a_van_rysdam = "Peter {van Rysdam}" }
 @string { a_varoquaux_gael = "Ga{\"e}l Varoquaux" }
 @string { a_varro_daniel = "D{\'a}niel Varr{\'o}" }
+@string { a_vasilescu_bogdan = "Bogdan Vasilescu" }
 @string { a_vasudevan_vijay = "Vijay Vasudevan" }
 @string { a_vetterling_william_t = "William T.\ Vetterling" }
 @string { a_virtanen_pauli = "Pauli Virtanen" }
@@ -232,8 +247,11 @@ @string { a_wu_zhize
 @string { a_xiong_peng = "Peng Xiong" }
 @string { a_yanev_martin = "Martin Yanev" }
 @string { a_yang_edward_z = "Edward Z.\ Yang" }
+@string { a_yang_xuanda = "Xuanda Yang" }
+@string { a_ye_jingchen = "Jingchen Ye" }
 @string { a_yu_yuan = "Yuan Yu" }
 @string { a_zheng_xiaoqiang = "Xiaoqiang Zheng" }
+@string { a_zijlstra_jelle = "Jelle Zijlstra" }
 @string { a_zinoviev_dimitry = "Dmitry Zinoviev" }
 
 
@@ -263,6 +281,7 @@ @string { l_usa_centennial
 @string { l_usa_columbia = "{{Columbia}, {SC}, {USA}}" }
 @string { l_usa_hoboken = "{{Hoboken}, {NJ}, {USA}}" }
 @string { l_usa_ithaca = "{{Ithaca}, {NY}, {USA}}" }
+@string { l_usa_lake_buena_vista = "{{Lake Buena Vista}, {FL}, {USA}}" }
 @string { l_usa_new_york = "{{New York}, {NY}, {USA}}" }
 @string { l_usa_piscataway = "{{Piscataway}, {NJ}, {USA}}" }
 @string { l_usa_providence = "{{Providence}, {RI}, {USA}}" }
@@ -642,6 +661,18 @@ @book{B2023W1IO
  execute = {\sloppy}
 }
 
+@techreport{BB2019AEAOTPPIP,
+ author = a_bommarito_ethan # and # a_bommarito_michael,
+ title = {An Empirical Analysis of the \python\ Package Index~(\pypi)},
+ xdata = {rep_arxiv_corr},
+ number = {abs/1907.11073},
+ date = {2019-07-26},
+ url = {https://arxiv.org/abs/1907.11073},
+ urldate = {2024-08-17},
+ doi = {10.48550/arXiv.1907.11073},
+ note = {\mbox{arXiv:1907.11073v2} \mbox{[cs.SE]} \mbox{26~Jul~2019}}
+}
+
 @book{BHK2006CNFCMEARFCS,
  author = a_baumgartner_gary # and # a_heap_danny # and # a_krueger_richard,
  title = {Course Notes for {CSC165H}: Mathematical Expression and Reasoning for Computer Science},
@@ -927,6 +958,16 @@ @book{LH2015DSAAWP
  isbn = {978-3-319-13071-2},
 }
 
+@book{LLHSVRZSJYYMC2024MOSTFP,
+ author = a_lehtosalo_jukka # and # a_levkivskyi_ivan # and # a_hance_jared # and # a_smith_ethan # and # a_van_rossum_guido # and # a_zijlstra_jelle # and # a_sullival_michael_j # and # a_jain_shantanu # and # a_yang_xuanda # and # a_ye_jingchen # and # a_sobolev_nikita # and # {{\mypy~Contributors}},
+ title = {\mypy\ -- Static Typing for \python},
+ date = {2024},
+ publisher = p_github,
+ address = pa_github,
+ url = {https://github.com/python/mypy},
+ urldate = {2024-08-17},
+}
+
 @book{LNL2020LJ,
  author = a_loy_marc # and # a_niemeyer_patrick # and # a_leuck_daniel,
  title = {Learning \pgls{Java}},
@@ -1049,6 +1090,15 @@ @proceedings{PROC2016OSDI
  isbn = {978-1-931971-33-1},
 }
 
+@proceedings{PROC2018ESECFSE,
+ title = {Proceedings of the 2018 {ACM} Joint Meeting on European Software Engineering Conference and Symposium on the Foundations of Software Engineering ({ESEC/SIGSOFT}~{FSE}'18), } # nov # {~4-9, 2018, } # l_usa_lake_buena_vista,
+ editor = a_leavens_gary_t # and # a_garcia_alessandro # and # a_pasareanu_corina_s,
+ publisher = p_acm,
+ address = pa_acm,
+ date = {2018-10-26},
+ isbn = {978-1-4503-5573-5},
+}
+
 @proceedings{PROC2019NEURIPS,
  title = {Advances in Neural Information Processing Systems~32: Annual Conference on Neural Information Processing Systems 2019~({NeurIPS'19}), } # dec # {~8-14, 2019, } # l_canada_vancouver,
  editor = a_wallach_hanna_m # and # a_larochelle_hugo # and # a_beygelzimer_alina # and # a_d_alche_buc_florence # and # a_fox_emily_b # and # a_garnett_roman,
@@ -1075,6 +1125,13 @@ @inbook{PSF2024FSL
  urldate = {2024-07-25},
 }
 
+@inbook{PSF2024IPM,
+ title = {Installing \python\ Modules},
+ crossref = {PSF2024P3D},
+ url = {https://docs.python.org/3/installing/index.html},
+ urldate = {2024-08-17},
+}
+
 @inbook{PSF2024NTIFC,
  title = {Numeric Types -- \pythonilIdx{int}, \pythonilIdx{float}, \pythonilIdx{complex}},
  crossref = {PSF2024P3D},
@@ -1098,6 +1155,15 @@ @inbook{PSF2024PSAU
  urldate = {2024-07-05},
 }
 
+@book{PSF2024TPPIP,
+ title = {The \python\ Package Index~(\pypi)},
+ url = {https://pypi.org/},
+ urldate = {2024-08-17},
+ date = {2024},
+ publisher = p_python_software_foundation,
+ address = pa_python_software_foundation,
+}
+
 @inbook{PSF2024TSTS,
  title = {Text Sequence Type -- \pythonilIdx{str}},
  crossref = {PSF2024P3D},
@@ -1301,6 +1367,14 @@ @techreport{VR1999CPFERPASEFTPOT
  urldate = {2024-06-27}
 }
 
+@inproceedings{VVH2018ELDOSAIOSPACSOTPE,
+ author = a_valiev_marat # and # a_vasilescu_bogdan # and # a_herbsleb_james_d,
+ title = {Ecosystem-Level Determinants of Sustained Activity in Open-Source Projects: A Case Study of the \pypi\ Ecosystem},
+ pages = {644--655},
+ doi = {10.1145/3236024.3236062},
+ crossref = {PROC2018ESECFSE},
+}
+
 @inproceedings{WW2023RSDEWASSAA,
  author = a_weise_thomas # and # a_wu_zhize,
  title = {Replicable Self-Documenting Experiments with Arbitrary Search Spaces and Algorithms},

notation/software.sty

@@ -42,6 +42,19 @@ Learn more at \url{https://thomasweise.github.io/moptipy}.%
 }%
 \protected\gdef\moptipy{\pgls{moptipy}}%
 %
+%
+\newglossaryentry{mypy}{%
+text={\softwareStyle{Mypy}},%
+name={Mypy},%
+sort={Mypy},%
+description={%
+is the static type-checking tool for \python~\cite{LLHSVRZSJYYMC2024MOSTFP}. %
+Learn more at \url{https://github.com/python/mypy} or in \cref{sec:variableTypesAndTypeHints}.%
+}%
+}%
+\protected\gdef\mypy{\pgls{mypy}}%
+%
+%
 \newglossaryentry{numpy}{%
 text={\softwareStyle{NumPy}},%
 name={NumPy},%
@@ -66,6 +79,19 @@ Learn more at \url{https://pandas.pydata.org}.%
 \protected\gdef\pandas{\pgls{pandas}}%
 %
 %
+\newglossaryentry{pip}{%
+text={\softwareStyle{pip}},%
+name={pip},%
+sort={pip},%
+description={%
+is the standard tool to install \python\ software packages from the \pgls{pypi} repository~\cite{PSF2024IPM}. %
+To install a package \bashil{thepackage} hosted on \pgls{pypi}, type \bashil{pip install thepackage} into the \pgls{terminal}. %
+Learn more at \url{https://packaging.python.org/installing}.%
+}%
+}%
+\protected\gdef\pip{\pgls{pip}}%
+%
+%
 \newglossaryentry{pycharm}{%
 text={\softwareStyle{PyCharm}},%
 name={PyCharm},%
@@ -91,6 +117,18 @@ Learn more at \url{https://python.org}.}
 \protected\gdef\pythonWithVersion{\softwareStyle{\python~\pythonVersion}}%
 %
 %
+\newglossaryentry{pypi}{%
+text={\softwareStyle{PyPI}},%
+name={PyPI},%
+sort={PyPI},%
+description={%
+The \python\ Package Index~(PyPI) is an online repository that provides the software packages that you can install with~\pip~\cite{PSF2024TPPIP,BB2019AEAOTPPIP,VVH2018ELDOSAIOSPACSOTPE}. %
+Learn more at \url{https://pypi.org}.%
+}%
+}%
+\protected\gdef\pypi{\pgls{pypi}}%
+%
+%
 \newglossaryentry{pytorch}{%
 text={\softwareStyle{PyTorch}},%
 name={PyTorch},%

styles/keys.sty

@@ -13,7 +13,7 @@
 \tw@make@key@macro*{\OS}%
 %
 \protected\gdef\ubuntuTerminal{\keys{\ctrl+\Alt+T}}%
-\protected\gdef\windowsTerminal{press \keys{\OSwin + R}, type in \bashil{cmd}, and hit \keys{\return}}%
+\protected\gdef\windowsTerminal{press \keys{\OSwin + R}, type in \textil{cmd}, and hit \keys{\return}}%
 %
 %% the PyCharm main menu key
 \protected\gdef\pycharmMainMenu{\ensuremath{\mathrel{\rlap{\raisebox{\fontdimen22\textfont2}{\ensuremath{=}}}\raisebox{-0.5\fontdimen22\textfont2}{\ensuremath{=}}}}}

text/main/basics/variables/assignment/assignment.tex

@@ -117,7 +117,7 @@
 We can use \pythonil{int_var} just like any other value.
 For example, we can compute \pythonil{2 + int_var} and pass the result to the \pythonilIdx{print} function.
 This will then print \pythonil{3} to the standard output of our program.
-We can also use \pythonil{int_var} in f-strings\pythonIdx{f-string}\pythonIdx{str!f} about which we leared back in \cref{sec:fstrings}.
+We can also use \pythonil{int_var} in \pglspl{fstring}\pythonIdx{f-string}\pythonIdx{str!f} about which we leared back in \cref{sec:fstrings}.
 \pythonil{f"int_var has value \{int_var\}."} will render to \pythonil{"int_var has value 1."}.%
 \end{sloppypar}%
 %
@@ -135,7 +135,7 @@
 Ofcourse, we can have multiple variables.
 The command \pythonil{float_var = 3.5} creates a variable named \pythonil{float_var}.
 It also allocates a piece of memory, writes the floating point value \pythonil{3.5} into it, and lets \pythonil{float_var} point to that piece of memory, as illustrated in \cref{fig:variable:assignment3}.
-We can use this variable in an f-string\pythonIdx{f-string}\pythonIdx{str!f} as well:
+We can use this variable in an \pgls{fstring}\pythonIdx{f-string}\pythonIdx{str!f} as well:
 \pythonil{print(f"float_var has value \{float_var\}.")} is interpolated to \pythonil{"float_var has value 3.5."}.%
 %
 \begin{sloppypar}%