#!/usr/bin/env python
# coding: utf-8

# # Writing Testable Numerics Code
# 
# Copyright (C) 2020 Andreas Kloeckner
# 
# <details>
# <summary>MIT License</summary>
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# 
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
# 
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
# </details>

# Here's the contents of a file containing numerics code:

# In[15]:


get_ipython().system('pygmentize norms.py')


# Note:
# 
# - Docstring
# - Defensive programming

# In[16]:


get_ipython().system('pygmentize test_norms.py')


# * Now use [pytest](https://pytest.org) to run the test.

# In[17]:


get_ipython().system('python -m pytest')


# A typical use for these tests would be to run them on every commit to a codebase.
# 
# Example: https://github.com/inducer/boxtree (click the "Pipeline" button)

# In[ ]: