249 lines
9.3 KiB
TeX
249 lines
9.3 KiB
TeX
\documentclass[letterpaper, 10pt, twoside]{article}
|
|
|
|
% Packages without options %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
\usepackage{lipsum}
|
|
\usepackage{verbatim} % Better code blocks
|
|
\usepackage{fancyvrb} % Even better code blocks
|
|
\usepackage{fvextra} % Even more better code blocks
|
|
\usepackage{enumitem} % Control spacing inside list environments
|
|
\usepackage{microtype} % Better typography
|
|
\usepackage{wrapfig} % Allows us to use \wrapfigure command
|
|
\usepackage{adjustbox} % Adjust padding inside \minipage environment
|
|
\usepackage{tikz} % Draw pictures
|
|
|
|
% Packages with options %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
|
|
\usepackage{multicol} % Most of our text will have two columns
|
|
\setlength\columnsep{25pt}
|
|
|
|
\usepackage{fancyhdr} % Granular control over headers and footers
|
|
\pagestyle{fancy} % Define pagesyle «fancy»
|
|
\fancyhf{} % Clear existing header/footer entries
|
|
\fancyhead[LE, RO]{\thepage} % Page number is always on the outside
|
|
\fancyhead[CE, CO]{Notes on Python} % Title is always in the middle
|
|
\fancyhfoffset[LE,RO]{0in} % Adjust header and footer width to match text width
|
|
\renewcommand{\headrulewidth}{0.5pt}
|
|
|
|
\usepackage{geometry} % Adjust margins
|
|
\geometry{ % Package options
|
|
bmargin=0.75in, % bottom margin
|
|
tmargin=1in, % top margin
|
|
hmargin=0.75in, % horizontal margin (both sides)
|
|
bindingoffset=0.25in % Just in case this is printed and bound
|
|
}
|
|
|
|
\usepackage[nottoc,numbib]{tocbibind} % Add references to TOC
|
|
|
|
\usepackage[hidelinks]{hyperref} % Include URLs
|
|
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
% My macros %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
|
|
% Make a nice border and box for the tops of our examples
|
|
\newcommand\klab[3]{\vspace{#1}\noindent{}\hrulefill~~\fbox{\texttt{~#2~}}~~\hrulefill\vspace{#3}}
|
|
|
|
% Add an \hrule with space above and below
|
|
\newcommand\krule[2]{\vspace{#1}\hrule\vspace{#2}}
|
|
|
|
% Make hrefs easier (must load package hyperref}
|
|
\newcommand\kref[2]{\href{#1}{{\texttt{#2}}}}
|
|
|
|
% Make some call outs
|
|
\newcommand\kpull[2]{
|
|
\setlength{\intextsep}{3.0pt plus 2.0pt minus 2.0pt}
|
|
\setlength{\columnsep}{10pt}
|
|
\begin{wrapfigure}[]{r}[8pt]{0pt}
|
|
\fbox{
|
|
\adjustbox{padding*=0pt 2pt 0pt 1pt}{
|
|
\begin{minipage}{#2} % This is the width of the call out
|
|
\begin{small}
|
|
\begin{flushleft}
|
|
{#1} % This is the contents of the call out
|
|
\end{flushleft}
|
|
\end{small}
|
|
\end{minipage}
|
|
} % End adjustbox
|
|
} % End fbox
|
|
\end{wrapfigure}
|
|
} % The width variable comes after the contents variable because the contents should give you some idea of how wide to make this.
|
|
|
|
% And make them work nicely with out multicol environment
|
|
% Not quite sure if commented lines are needed. More testing is required.
|
|
%\def\ksep{25pt}
|
|
\newcommand\kcolb{
|
|
% \setlength{\columnsep}{\ksep}
|
|
\begin{multicols}{2}
|
|
}
|
|
\newcommand\kcole{
|
|
\end{multicols}
|
|
}
|
|
|
|
% Add an indent to bibliography items
|
|
% This is a bit of a kludge, but it works. Look for a best practice to replace this.
|
|
\newcommand\kbib{
|
|
\begin{tikzpicture} \draw [white, line width=6] (0,0) -- (0.1,0); \end{tikzpicture}
|
|
}
|
|
|
|
% Make a Python Symbol like a LaTeX symbol
|
|
\newcommand\kpy{P{\scriptsize \raisebox{-0.4em}{\hspace{-0.16em}Y}}T{\scriptsize \raisebox{-0.3em}{h}}\hspace{-0.15em}\raisebox{0.4em}{o}\hspace{0.05em}\raisebox{-0.2em}N}
|
|
|
|
|
|
% Additional options %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
\raggedbottom
|
|
|
|
% Title info %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
\title{\textbf{Notes on Python}}
|
|
\author{Kenneth John Odle\\ {\small \texttt{ken at kjodle dot net}}}
|
|
\date{2023\\ \medskip v. 0.0.1}
|
|
|
|
% Notes to self %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
% Make sure that \section{} is OUTside the multicols environment
|
|
% Make sure that \subsection{} is INside the multilcols environment
|
|
% If needed, add \newpage before a \section if the placement of the heading is weird
|
|
|
|
\begin{document}
|
|
|
|
\maketitle
|
|
|
|
\begin{abstract}
|
|
This document consists of notes on Python, gleaned from various sources. A list of references (often with commentary) follows.
|
|
|
|
The latest version of this document can be found at \kref{https://git.kjodle.net/kjodle/Notes-on-Python}{https://git.kjodle.net/kjodle/Notes-\\on-Python}.
|
|
|
|
This document was typeset in \LaTeX{}.
|
|
\end{abstract}
|
|
|
|
\tableofcontents
|
|
|
|
\newpage
|
|
|
|
\section{Preliminaries}
|
|
|
|
\kcolb
|
|
|
|
\subsection{What is Python?}
|
|
|
|
|
|
\subsection{Why use Python?}
|
|
|
|
I won't bore you with details. If you have made enough effort to find this document, you are probably aware of the importance of the Python programming language. If not, however, I'll give a brief summary.
|
|
|
|
Python is platform independent. It emphasizes a concise syntax that aids in code readability. It also supports multiple coding styles, such as functional, imperative, object-oriented, and procedural.
|
|
|
|
\paragraph{Functional} Every statement is a kind of math equation. Functional programming is good for use in parallel processing activities.
|
|
|
|
\paragraph{Imperative} Computations occur as changes to program state. This is most often used for manipulating data structures.
|
|
|
|
\paragraph{Object-Oriented} This programming style uses objects to model the real world. It isn't fully implemented in Python because Python doesn't support features like data hiding.
|
|
|
|
\paragraph{Procedural} Tasks proceed one step at a time. Most often used for iteration, sequencing, selection, and modularization. It is the simplest form of programming.
|
|
|
|
\bigskip
|
|
|
|
Many fields depend on \kpy\footnote{This is my attempt to produce a text symbol for Python, similar to \LaTeX{}. My thought is that it looks like a snake wriggling back and forth. Your mileage, of course, may (and probably will) vary. If you would like to use this in your own documents (why?) I have defined it as a macro, which you can obtain from the source code for this document. See the abstract for its location.} to process data.
|
|
|
|
Mueller\cite{mueller-jp:23} has many reasons why a knowledge of Python may be useful in a job search. \kpull{This is \textit{not} my favorite book.}{22mm} They were fairly accurate as of their publication (2023),but things change quickly, so a keyword search of your preferred job boards is always in order.
|
|
|
|
\subsection{IDEs and Python}
|
|
|
|
\subsection{Version 2 versus Version 3}
|
|
|
|
\subsection{Comments in Python}
|
|
|
|
Python supports single line comments by adding a hashtag (\texttt{\#}) to the beginning of each line:
|
|
|
|
\begin{Verbatim}
|
|
# This line is a comment.
|
|
\end{Verbatim}
|
|
|
|
Mulitline comments are not directly supported by Python. However, you can surround groups of lines to be commented out by using three double quotations marks or three single quotations marks on the lines before and after them:
|
|
|
|
\begin{Verbatim}[frame=lines, framesep=3mm, breaklines=true, label=Multiline Comments]
|
|
"""
|
|
These lines
|
|
will be ignored by Python
|
|
"""
|
|
|
|
'''
|
|
These lines will also
|
|
be ignored by Python
|
|
'''
|
|
\end{Verbatim}
|
|
|
|
The main difference between single line comments and multiline comments is that single line comments do not get exported to reports, whereas multiline comments do. Again, this is because Python does not fully support multiline commenting.
|
|
|
|
\subsubsection{Uses of Comments}
|
|
|
|
Comments are highly useful when writing code and often underutilized or poorly utilized. It has been suggested\cite{denker-j} that
|
|
|
|
\begin{quote}
|
|
\rule{\linewidth}{0.5pt}
|
|
software = code + documentation
|
|
\vspace{-12pt}
|
|
\rule{\linewidth}{0.5pt}
|
|
\end{quote}
|
|
|
|
That documentation is both external (i.e., user manuals) and internal (i.e., comments). You can (and should) use comments to:
|
|
|
|
\begin{itemize}[noitemsep]
|
|
\item Remind yourself what the code does and why you wrote it.
|
|
\item Record who wrote the code in a multi-person project.
|
|
\item Tell others how to maintain the code.
|
|
\item Make your code accessible to other developers.
|
|
\item List ideas for future updates.
|
|
\item Document the sources you used to build the code.
|
|
\item Maintain a list of improvements you've made.
|
|
\end{itemize}
|
|
|
|
You can, of course, also use comments to prevent certain lines of code from executing, a practice known as ``commenting out''. This is useful when troubleshooting your code.
|
|
|
|
\kcole
|
|
|
|
\newpage
|
|
\section{Python Basics}
|
|
|
|
\kcolb
|
|
|
|
\subsection{Python Data Types}
|
|
|
|
\kcole
|
|
|
|
% References page begins below %%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
|
|
\newpage
|
|
|
|
\begin{thebibliography}{XX}
|
|
|
|
\kcolb
|
|
|
|
\bibitem{denker-j}
|
|
Denker, John S.
|
|
``Suggestions for Writing Good Software''.\\
|
|
\kbib\kref{https://www.av8n.com/computer/htm/good-software.htm}{https://www.av8n.com/computer/htm/good-\\software.htm}.
|
|
|
|
\bibitem{mueller-jp:23}
|
|
Mueller, John Paul.
|
|
\textit{Beginning Programming with Python for Dummies}.
|
|
John Wiley \& Sons Inc. (United States: New Jersey: Hoboken).
|
|
3rd Edition,
|
|
2023.\\
|
|
\kbib{}This book \textit{heavily} emphasizes the use of Google Colab. It's basically an advertisement for the $\Gamma$oogle and \textit{highly} disappointing. Python is meant to be fairly universal and this book's approach seems to work counter to that intention.
|
|
|
|
\bibitem{pythonorg:main}
|
|
python.org.
|
|
``Python for Beginners'',\\
|
|
\kbib\kref{https://www.python.org/about/gettingstarted/}{https://www.python.org/about/\\gettingstarted/}\\
|
|
\kbib The official site of the Python Software Foundation.
|
|
|
|
\bibitem{pythonorg:blurb}
|
|
python.org.
|
|
``What is Python? Executive Summary'',\\
|
|
\kbib\kref{https://www.python.org/doc/essays/blurb/}{https://www.python.org/doc/essays/blurb/}\\
|
|
\kbib The official description of what Python is.
|
|
|
|
\kcole
|
|
|
|
\end{thebibliography}
|
|
|
|
\end{document} |