11 June 2019, Charlottesville: Software design and engineering

[Daniel-Mietchen]

as per https://education.cadre.virginia.edu/#/workshop/1556 and https://arcs.virginia.edu/software-design-devel

[Daniel-Mietchen]

fun piece of Python:

import this

[Daniel-Mietchen]

• look into unit tests
  • Writing unit tests in Python: How do I start?
  • unittest

[Daniel-Mietchen]

• avoid printing stuff for pure testing purposes; use unit tests instead
  • enhances reusability of the code

[Daniel-Mietchen]

• PEP 8 -- Style Guide for Python Code
• Google Python Style Guide

[Daniel-Mietchen]

look into refactoring environments to help improve code legibility

• Refactoring Python Applications for Simplicity

[Daniel-Mietchen]

rough outline of what a given piece of software is supposed to do

def solve_problem(data):
  return result
def get_input(filename):
  return data
def print_output(result):
  pass
def main():
  data=get_input(filename)
  result=solve_problem(data)
  print_output(result)

[Daniel-Mietchen]

Spyder allows for code folding (i.e. hiding portions of code), similar to JavScript "collapse"

Syntax checkers (linters) for Python:

• PyFlakes checks only for syntax errors. It is included with the Anaconda distribution.
• PyLint tries to analyze style. It is also included in recent Anaconda versions.

[Daniel-Mietchen]

Python debugger pdb is built into Spyder

[Daniel-Mietchen]

For the Lab, I set up this Gdoc for further notes.