Like a sane person.
Use Python 3
Like last time, I like to implore you to write in Python 3, Python 2’s EOL is next year, 2020.
Read PEP 20
python -m this, every now and again. Granted I forget to read this since the last time I wrote this article, but I kept some of it by heart. Let me go over my last year’s take-aways.
Explicit is still better than implicit
I think I can count a handful of ways I’ve tried to maneuver our way out of creating an implicit behavior in our API to provide “cool” features, this is easy deceivingly easy to forget.
Flat is better than nested
This isn’t always the case, and I’ve modified what this means for me, a lot of the API that I write is no longer flat, real flat becomes hard to maintain and communicate with sparse documentation. “Flat” is a relative term, find your own “flat”.
Sparse is better than dense
This I like to keep as is, as this keeps us from feature creep.
If the implementation is hard to explain, it’s a bad idea
This is still true, especially for me, I tend to envision really expensive APIs that I end up later dismissing as too complicated literally at the end of the same day I thought of it. It helps to have people call you out on it.
I ended up writing docstrings in an arbitrary format, because we don’t really generate documentation for it. Which is not a good thing. To enforce writing docstrings, you should start generating API documentation for it.
When you generate documentation from docstrings, you can get a clear picture of your API as well. This helps you find code to improve.
I use a combination of Flake8, and Pylint, because I hate myself. However, I’ve adjusted them to fit black’s requirements to keep me sane.
Use pyenv to manage Python versions
Stop using brew, or other package managers. They’re opinionated, they don’t care about maintaining multiple Python versions, and it’s better to have your own opinion about it.
Use pyenv to install multiple python versions, and set the python version on your project’s root directory.
Use venv, setup.py, and vex to manage dependencies and your virtual environment
I’ve grown out of love with pipenv, it’s more effort than it is worth.
So here’s what you should be doing. Everything should be written as a python package, even applications, just package them already and thank yourself later.
1. Manage your packages in setup.py
- Dependencies go into setup.py
- Development dependencies go into
Here’s a nice skeleton for setup.py.
2. Manage your virtual environment with venv, and vex
- Create it in your project folder
python3 -m venv .venv
- Run a shell with it
vex --path .venv
- Install your package
pip3 install -e '.[dev]'(where
devis an EXTRAS dictionary of development dependencies)
Version your packages
Unit Tests, and Integration Tests
Write two tests, Unit Tests and Integration Tests. Where:
- Unit Tests are just the ol' reliable testing, and
- Write Integration Tests such that they are sample use-cases of your API as a consumer, this will also provide a nice set of examples on how to use your APIs for your colleagues
Use the Mock class a lot more in your tests, separate test responsibilities.