Rants on the daily grind of building software. This has been moved to https://slott56.github.io. Fix your bookmarks.
A presentation I did recently.
https://github.com/slott56/bashing-the-bash
Folks were polite and didn't have too many questions. I guess they fundamentally agreed: the shell is awful, we can use it for a few things.
Safe Shell Scripts Stay Simple: Set the environment, Start the application.
The Seven S's of shell scripting.
Many many thanks to Code & Supply for hosting me.
This is the best part about Python -- you can build something quickly. And it really works.
But.
What are the next steps?
While there are a *lot* of possibilities, I'm focused on an "enterprise work group" application that involves a clever web service/RESTful API built in Flask. Maybe with NLP.
Let me catalog a bunch of things you might want to think about to "productionize" your great idea. Here's a short list to get started.
src -- your code is heretests -- your tests are heredocs -- your documentation will be hererequirements.txt -- the list of packages to install. Exact, pinned version numbersrequirements-dev.txt -- the list of packages used for maintenance and developmentenvironment.yml -- another list of packages in conda formatpyproject.toml -- this has your tox setup in itMakefile -- sometimes helpfulWhen you're developing in Python you may not even worry about virtual environments. You have Python. It works. You downloaded NLP and Flask. You put things together and they work.
The trick here is the Python ecosystem is vast, and you have (without really observing it closely) likely downloaded a lot of projects. Projects that depend on projects.
You can't trust your current environment to be reliable or repeatable. You'll need to use a virtual environment manager of some kind.
Python's built-in virtual environment manager venv is readily available and works nicely. See https://docs.python.org/3/library/venv.html It's my second choice.
My first choice is conda. Start with miniconda. https://docs.conda.io/en/latest/miniconda.html. Use this to assemble your environment and retest your application to be sure you've got everything.
You'll be creating (and destroying) virtual environments until you get it right. They're cheap. They don't impact your code in any way. Feel free to make mistakes.
When it works, build conda's environment.yml file and the requirements.txt files. This will rebuild the environment. You'll use them with tox for testing.
If you don't use conda, you'll omit the environment.yml. Nothing else will change.
Of course, you'll need automated unit tests. You'll want 100% code coverage. You *really* want 100% logic path coverage, but that's aspirational. 100% code coverage is a lot of work and uncovers enough problems that the extra testing for all logic paths seems unhelpful.
You have two built-in unit testing toolsets: doctest and unittest. I like doctest. https://docs.python.org/3/library/doctest.html
You'll want to get pytest and the pytest-cov add-on package. https://docs.pytest.org/en/6.2.x/contents.html https://pytest-cov.readthedocs.io/en/latest/.
Your test modules go in the tests directory. You know you've done it right when you can use the pytest command at the command line and it finds (and runs) all your tests.
This is part of your requirements-dev.txt file.
This is unit testing without so many mocks. I recommend using pytest for this, also. The difference is that your "fixtures" will be much more complex. Files. Databases. Flask Clients. Certificates. Maybe starting multiple services. All kinds of things that have a complex setup and perhaps a complex teardown, also.
See https://docs.pytest.org/en/6.2.x/fixture.html#yield-fixtures-recommended for good ways to handle this more complex setup and teardown.
Depending on the community of users, it may be necessary to provide automated acceptance tests. For this, I recommend behave. https://behave.readthedocs.io/en/stable/ You're can write the test cases in the Gherkin language. This language is open-ended, and many stakeholders can contribute to the test cases. It's not easy to get consensus sometimes, and a more formal Gherkin test case lets people debate, come to an agreement, and prioritize the features and scenarios they need to see.
This is part of your requirements-dev.txt file.
This is an extra layer of checking to be sure best practices are being followed. There are a variety of tools for this. You *always* want to process your code through black. https://black.readthedocs.io/en/stable/
Some folks love isort for putting the imports into a canonical order. https://pycqa.github.io/isort/
Flake8 should be used to be sure there's no obviously bad programming practices. https://flake8.pycqa.org/en/latest/
I'm a huge fan of type hints. I consider mypy to be essential. https://mypy.readthedocs.io/en/stable/ I prefer "--strict" mode, but that can be a high bar.
You can try to manage this with make. But don't.
Download tox, instead. https://tox.wiki/en/latest/index.html
The point of tox is to combine virtual environment setup with testing in that virtual environment. You can -- without too much pain -- define multiple virtual environments. You can then test the various releases of the various packages your project depends on in various combinations. This is how to manage a clean upgrade.
1. Figure out the new versions.
2. Setup tox to test existing and new.
3. Run tox.
I often set the tox commands to run black first, then unit testing, then static analysis, ending with mypy --strict.
When the code is reformatted by black, it's technically a build failure. (You should have run black manually before running tox.) When tox works cleanly, you're ready to commit and push and pull request and merge.
Not an after-thought.
For human documents, use Sphinx. https://www.sphinx-doc.org/en/master/
Put docstrings in every package, every module, every class, every method, and every function. Summarize *what* and *why*. (Don't explain *how*: people can read your code.)
Use the autodoc feature to create the API reference documentation from the code. Start with this.
Later, you can write a README, and some explanations, and installation instructions, and all the things other people expect to see.
For a RESTful API, be sure to write an OpenAPI specification and be sure to test against that spec. https://www.openapis.org. While a lot of the examples are complicated, you can easily use a small subset to describe your documents, the validation rules, and the transactions. You can add the security details later. They're part of your web server, but they don't need an extensive OpenAPI documentation at the beginning.
Some folks like to define a flask application that can be installed in the Python virtual environment. This means the components are on the default sys.path without any "extra" effort. (It's a fair amount of effort to begin with. I'm not sure it's worth it.)
When you run a flask app, you'll be using some kind of engine. NGINX, uWSGI, GUnicorn, etc. (GUnicorn is very nice. https://gunicorn.org).
See https://flask.palletsprojects.com/en/2.0.x/deploying/wsgi-standalone/.
In all cases, these engines will "wrap" your Flask application. You'll want to make your application visible by setting the PYTHONPATH environment variable, naming your src directory. Do not run from your project's directory.
You will have the engine running in some distinct /opt/the_app or /Users/the_app or /usr/home/the_app or some such directory, unrelated to where the code lives. You'll use GUnicorns command-line options to locate your app, wherever it lives on the filesystem. GUnicorn will use PYTHONPATH to find your app. Since web servers often run as nobody, you'll need to make sure your code base is readable. But. Not. Writable.
Enterprise COBOL is both a liability and an asset. There's tangible value hidden in the code.
See https://github.com/slott56/looking-at-cobol
I've tweaked the presentation a little.
The essential ingredients in coping with COBOL are these:
This is relatively low risk work. It's high value. The COBOL code encodes enterprise knowledge. Preserving this knowledge in a more modern language is a value-maintaining exercise. Indeed, the improved clarity may be a value-creating exercise.
My literate programming tool, pyWeb, has moved to version 3.1 -- supporting modern Python.
Next up, version 3.2. This is a massive reworking of the data structures involved. The rework lets me use Jinja2 for templates. There's a lot of fiddliness to getting the end-of-line spacing right. Jinja has the following:
{% for construct in container -%}
{{construct}}
{%- endfor %} The easy-to-overlook hyphens suppress spacing, allowing the construct to be spread onto multiple lines without introducing extra newlines into the output. This makes it a little easier to debug the templates.
It now works. But. Until I get past strict type checks, there's no reason for calling it done.
Found 94 errors in 1 file (checked 3 source files)
The bulk of the remaining problems seem to be new methods where I forgot to include a type hint. The more pernicious problems are places where I have inconsistent hints and Liskov substitution problems. The worst a places where I had a last-minute change change and switched from str to int and did not actually follow-through and make required changes.
The biggest issue?
When building an AST, it's common to have a union of a wide variety of types. This union often has a discriminator value to separate NamedChunk from OutputChunk. This is "type narrowing" and there are a variety of approaches. I think my best choice is a TypeGuard declaration. This is new to me, so I've got to do some learning before I can properly define the required type guard function(s). (See https://mypy.readthedocs.io/en/stable/type_narrowing.html#user-defined-type-guards)
I'm looking forward (eagerly) to finishing the cleanup.
The problem is that I'm -- also -- working on the updates to Functional Python Programming. The PyWeb project is a way to relax my brain from editing the book.
Which means the pyWeb updates have to wait for Chapter 4 and 5 edits. (Sigh.)