docs/module_5.html

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Module 5: Odds and Ends &mdash; Python Like You Mean It</title>
      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
      <link rel="stylesheet" href="_static/my_theme.css" type="text/css" />
  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
        <script src="_static/jquery.js"></script>
        <script src="_static/underscore.js"></script>
        <script src="_static/doctools.js"></script>
        <script async="async" src="https://www.googletagmanager.com/gtag/js?id=UA-115029372-1"></script>
        <script src="_static/gtag.js"></script>
        <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
    <script src="_static/js/theme.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Writing Good Code" href="Module5_OddsAndEnds/Writing_Good_Code.html" />
    <link rel="prev" title="Inheritance" href="Module4_OOP/Inheritance.html" /> 
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
            <a href="index.html" class="icon icon-home"> Python Like You Mean It
          </a>
              <div class="version">
                1.4
              </div>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <p class="caption" role="heading"><span class="caption-text">Table of Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="intro.html">Python Like You Mean It</a></li>
<li class="toctree-l1"><a class="reference internal" href="module_1.html">Module 1: Getting Started with Python</a></li>
<li class="toctree-l1"><a class="reference internal" href="module_2.html">Module 2: The Essentials of Python</a></li>
<li class="toctree-l1"><a class="reference internal" href="module_2_problems.html">Module 2: Problems</a></li>
<li class="toctree-l1"><a class="reference internal" href="module_3.html">Module 3: The Essentials of NumPy</a></li>
<li class="toctree-l1"><a class="reference internal" href="module_3_problems.html">Module 3: Problems</a></li>
<li class="toctree-l1"><a class="reference internal" href="module_4.html">Module 4: Object Oriented Programming</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Module 5: Odds and Ends</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/Writing_Good_Code.html">Writing Good Code</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/Matplotlib.html">Matplotlib</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/WorkingWithFiles.html">Working with Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/Modules_and_Packages.html">Import: Modules and Packages</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="changes.html">Changelog</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">Python Like You Mean It</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
      <li>Module 5: Odds and Ends</li>
      <li class="wy-breadcrumbs-aside">
            <a href="_sources/module_5.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  
<style>
/* CSS overrides for sphinx_rtd_theme */

/* 24px margin */
.nbinput.nblast.container,
.nboutput.nblast.container {
    margin-bottom: 19px;  /* padding has already 5px */
}

/* ... except between code cells! */
.nblast.container + .nbinput.container {
    margin-top: -19px;
}

.admonition > p:before {
    margin-right: 4px;  /* make room for the exclamation icon */
}

/* Fix math alignment, see https://github.com/rtfd/sphinx_rtd_theme/pull/686 */
.math {
    text-align: unset;
}
</style>
<div class="section" id="module-5-odds-and-ends">
<h1>Module 5: Odds and Ends<a class="headerlink" href="#module-5-odds-and-ends" title="Permalink to this headline"></a></h1>
<p>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.</p>
<p>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.</p>
<p>The second section of this module introduces 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.</p>
<p>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 <code class="code docutils literal notranslate"><span class="pre">pathlib.Path</span></code> class to work with paths in elegant and platform-independent ways. Finally, we review some critical file utilities, like searching for files with <code class="code docutils literal notranslate"><span class="pre">glob</span></code>, saving files with <code class="code docutils literal notranslate"><span class="pre">pickle</span></code>, and saving NumPy arrays.</p>
<p>Moving forward, we will study Python’s packaging system, which gives us insight into what the <code class="code docutils literal notranslate"><span class="pre">import</span></code> 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 <code class="code docutils literal notranslate"><span class="pre">pip</span></code> and <code class="code docutils literal notranslate"><span class="pre">conda</span></code> 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.</p>
<p>More sections will be added to this module down the road.</p>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Module5_OddsAndEnds/Writing_Good_Code.html">Writing Good Code</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/Writing_Good_Code.html#The-PEP8-Style-Guide-to-Python-Code">The PEP8 Style Guide to Python Code</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/Writing_Good_Code.html#Type-Hinting">Type-Hinting</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/Writing_Good_Code.html#Documentation-Styles">Documentation Styles</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/Writing_Good_Code.html#Links-to-Official-Documentation">Links to Official Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/Writing_Good_Code.html#Reading-Comprehension-Solutions">Reading Comprehension Solutions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Module5_OddsAndEnds/Matplotlib.html">Matplotlib</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/Matplotlib.html#Plotting-in-Jupyter-Notebooks">Plotting in Jupyter Notebooks</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/Matplotlib.html#Creating-Figures-and-Axes-with-pyplot.subplots">Creating Figures and Axes with <code class="docutils literal notranslate"><span class="pre">pyplot.subplots</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/Matplotlib.html#Displaying-Images">Displaying Images</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/Matplotlib.html#Beyond-Matplotlib">Beyond Matplotlib</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/Matplotlib.html#Links-to-Official-Documentation">Links to Official Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/Matplotlib.html#Reading-Comprehension-Exercise-Solutions:">Reading Comprehension Exercise Solutions:</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Module5_OddsAndEnds/WorkingWithFiles.html">Working with Files</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/WorkingWithFiles.html#Working-with-Paths">Working with Paths</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/WorkingWithFiles.html#Opening-Files">Opening Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/WorkingWithFiles.html#Example:-Writing-and-Reading-a-Text-File">Example: Writing and Reading a Text File</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/WorkingWithFiles.html#Globbing-for-Files">Globbing for Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/WorkingWithFiles.html#Saving-&amp;-Loading-Python-Objects:-pickle">Saving &amp; Loading Python Objects: pickle</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/WorkingWithFiles.html#Saving-and-Loading-NumPy-Arrays">Saving and Loading NumPy Arrays</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/WorkingWithFiles.html#Links-to-Official-Documentation">Links to Official Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/WorkingWithFiles.html#Reading-Comprehension-Solutions">Reading Comprehension Solutions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Module5_OddsAndEnds/Modules_and_Packages.html">Import: Modules and Packages</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/Modules_and_Packages.html#Modules">Modules</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/Modules_and_Packages.html#Import-Statements">Import Statements</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/Modules_and_Packages.html#Packages">Packages</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/Modules_and_Packages.html#Intra-Module-Imports">Intra-Module Imports</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/Modules_and_Packages.html#Installing-a-Package">Installing a Package</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/Modules_and_Packages.html#pip-and-conda:-Package-Managers">pip and conda: Package Managers</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/Modules_and_Packages.html#Links-to-Official-Documentation">Links to Official Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="Module5_OddsAndEnds/Modules_and_Packages.html#Reading-Comprehension-Exercise-Solutions:">Reading Comprehension Exercise Solutions:</a></li>
</ul>
</li>
</ul>
</div>
</div>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="Module4_OOP/Inheritance.html" class="btn btn-neutral float-left" title="Inheritance" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="Module5_OddsAndEnds/Writing_Good_Code.html" class="btn btn-neutral float-right" title="Writing Good Code" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2021, Ryan Soklaski.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>