Appendix B: Style#
authors = [
{ name = "Matt Hyatt", email = "mhyatt@luc.edu" },
{ name = "Nicholas M. Synovic", email = "nsynovic@luc.edu" }
]
[cite_start][cite: 4, 8, 9, 11, 12]
[cite_start]PEP 20 - The Zen of Python | peps.python.org [cite: 14]
[cite_start]Long time Pythoneer Tim Peters succinctly channels the BDFL’s guiding principles for Python’s design into 20 aphorisms. [cite: 15] [cite_start][https://peps.python.org/pep-0020/#the-zen-of-python](https://peps.python.org/pep-0020/#the-zen-of-python) [cite: 15]
The Zen of Python
1 Beautiful is better than ugly.
2 Explicit is better than implicit.
3 Simple is better than complex.
4 Complex is better than complicated.
5 Flat is better than nested.
6 Sparse is better than dense.
7 Readability counts.
8 Special cases aren't special enough to break the
rules.
9 Although practicality beats purity.
10 Errors should never pass silently.
11 Unless explicitly silenced.
12 In the face of ambiguity, refuse the temptation to
guess.
[cite_start][cite: 16, 17, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32]
[cite_start]GitHub - google/yapf: A formatter for Python files… [cite: 47] A formatter for Python files. [cite_start]Contribute to google/yapf development by creating an account on GitHub. [cite: 48] [cite_start][google/yapf](https:) [cite: 48]
[cite_start]Worse Is Better: [cite: 36]#
[cite_start]Worse Is Better [cite: 37] [cite_start][https://dreamsongs.com/WIB.html](https://dreamsongs.com/WIB.html) [cite: 38]
[cite_start]Tooling [cite: 39]#
[cite_start]Pick one and stick to it! [cite: 40]
[cite_start]Ruff [cite: 41] [cite_start]An extremely fast Python linter and code formatter, written in Rust. [cite: 42] [cite_start][https://docs.astral.sh/ruff/](https://docs.astral.sh/ruff/) [cite: 43]
[cite_start]Gstyleguide [cite: 44] [cite_start]Style guides for Google-originated open-source projects [cite: 45] [cite_start][https://google.github.io/styleguide/pyguide.html](https://google.github.io/styleguide/pyguide.html) [cite: 46]
[cite_start]GitHub - google/yapf: A formatter for Python files… [cite: 47] A formatter for Python files. [cite_start]Contribute to google/yapf development by creating an account on GitHub. [cite: 48] [cite_start][google/yapf](https:) [cite: 48]
[cite_start]GitHub - psf/black: The uncompromising Python code formatter… [cite: 54] The uncompromising Python code formatter. [cite_start]Contribute to psf/black development by creating an account on GitHub. [cite: 54] [cite_start][psf/black](https:) [cite: 54]
[cite_start]ANY CODE STYLE YOU LIKE AS LONG AS IT’S Black [cite: 55, 56]
[cite_start]Docstrings [cite: 57]#
[cite_start]Pick one and stick to it! [cite: 58]
[cite_start]Style guide - numpydoc v1.10.0rc0.dev0 Manual [cite: 59] [cite_start][https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard](https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard) [cite: 59]
[cite_start]G styleguide [cite: 60] [cite_start]Style guides for Google-originated open-source projects [cite: 61] [cite_start][https://google.github.io/styleguide/pyguide.html#s3.8.1-comments-in-doc-strings](https://google.github.io/styleguide/pyguide.html#s3.8.1-comments-in-doc-strings) [cite: 62]