Skip to content

Latest commit

 

History

History
80 lines (51 loc) · 2.99 KB

PYTHON.md

File metadata and controls

80 lines (51 loc) · 2.99 KB
Raw

Python Style Guide

Packaging

See the official [Python packaging projects guide]](https://packaging.python.org/en/latest/tutorials/packaging-projects/) to get started.

If you cannot run your Python project directly as a module python -m app, it is not packaged correctly.

If you rely on data outside of your package, you must to handle considerations for when that data is not present when your package is run. Do not rely on hard coding paths, make them configurable.

Arguments

Do not roll your own options parser. Use argparse from the stdlib.

Python conventions

  • class names should use UpperCamelCase
  • constant names should be CAPITALIZED_WITH_UNDERSCORES
  • other names should use lowercase_separated_by_underscores
  • private variables/methods should start with an undescore: _myvar
  • some special class methods are surrounded by two underscores: __init__

CamelCase

When using abbreviations with CamelCase, capitalize all the letters of the abbreviation. For example, Dot11FT is better than Dot11Ft.

Python Version Guidelines

To ensure compatibility across WLAN Pi OS environments, please adhere to the following Python version requirements in development:

  • Primary Version: Use [Python 3.9](https://docs.python.org/3.9/ for all development. This aligns with the system Python version in Debian Bullseye, which relies on Python 3.9 as the default. WLAN Pi applications written in Python rely on dh-virtualenv which uses the system python version.
  • Future Transition: Once we fully transition to supporting only systems based on Debian Bookworm, which uses Python 3.11 as the default, we will evaluate shifting development to Python 3.11 after some time of overlap. Until that point, Python 3.9 will remain the standard version used by WLAN Pi for compatibility.

In other words, do not use Python features introduced in versions later than 3.9 until WLAN Pi is no longer supporting the Bullseye images. By maintaining this guideline, we can ensure consistent functionality and minimize compatibility issues across supported versions of WLAN Pi OS.

Tests

The Python testing framework of choice should be pytest.

Tox for standardized testing, linting, and formatting

To familiarize yourself with tox, read the tox documentation here.

Install tox:

python3 -m pip install tox

You can now invoke tox in the directory where tox.ini resides.

These are some things you should before submitting a PR:

To initiate testing:

tox

These assume your tox.ini support these options. See wlanpi-profiler/tox.ini for example.

We should lint our code. Example:

tox -e lint

We should format our code. Example:

tox -e format