Module 5: Odds and Ends¶
This module contains materials that are extraneous to the essentials of Python as a language and of NumPy, but are nonetheless critical to doing day-to-day work using these tools.
The first section introduces some general guidelines for writing “good code”. Specifically, it points you, the reader, to a style guide that many people in the Python community abide by. It also introduces a relatively new and increasingly-popular feature of Python, called type-hinting, which permits us to enhance our code with type-documentation annotations. The reader will also be introduced to NumPy’s and Google’s respective specifications for writing good docstrings.
The second section of this module intoduces matplotlib, a library that allows us to plot and visually inspect data. Here, we will specifically learn how to leverage matplotlib’s object-oriented API, as opposed to its functional API, for creating scatter plots, line plots, histograms, and image plots.
The next section presents the “best practices” for working with files in Python. This includes reading from and writing to files within a context manager. We will learn to leverage the powerful
pathlib.Path class to work with paths in elegant and platform-independent ways. Finally, we review some critical file utilities, like searching for files with
glob, saving files with
pickle, and saving NumPy arrays.
Moving forward, we will study Python’s packaging system, which gives us insight into what the
import statement is all about. This naturally leads us to consider what it actually means to install a Python package on one’s machine. We will review the
conda package managers, which are the two prominent means for installing and managing Python packages on one’s machine. This is section will be critical for anyone interesting in maturing from a Jupyter notebook-only Python user to someone who can craft their own installable Python project. It will also greatly improve your ability to troubleshoot Python-related technical issues on your machine.
More sections will be added to this module down the road.
- Writing Good Code
- Working with Files
- Import: Modules and Packages