flake8-alphabetize 0.0.21

Installation

1. Create a virtual environment: python3 -m venv venv

2. Activate it: source venv/bin/activate

2. Install: pip install flake8-alphabetize

Examples

Say we have a Python file myfile.py:

from datetime import time, date

print(time(9, 39), date(2021, 4, 11))

by running the command flake8 we’ll get:

myfile.py:1:1: AZ200 Imported names are in the wrong order. Should be date, time

We can tell Alphabetize what the package name is, and then it’ll know that its imports should be in a group at the bottom of the imports. Here’s an example:

import uuid

from myapp import myfunc

print(uuid.UUID4(), myfunc())

by running the command flake8 --application-names myapp we won’t get any errors.

Usage

As you use Flake8 in the normal way, Alphabetize will report errors using the following codes:

Alphabetize follows the Black formatter’s uncompromising approach and so there’s only one configuration option which is application-names. This is a comma-separated list of top-level, package names that are to be treated as application imports, eg. ‘myapp’. Since Alphabetize is a Flake8 plugin, this configuration option is set using Flake8 configuration.

Rules Of Import Ordering

Here are the ordering rules that Alphabetize follows:

1. The special case from __future__ import comes first.

2. Imports from the standard library come next, followed by third party imports, followed by application imports.

3. Relative imports are assumed to be application imports.

4. The standard library group has import statements first (in alphabetical order), followed by from import statements (in alphabetical order).

5. The third party group is further grouped by library name. Then each library subgroup has import statements first (in alphabetical order), followed by from import statements (in alphabetical order).

6. The application group is further grouped by import level, with absolute imports first and then relative imports of increasing level. Within each level, the imports should be ordered by library name. Then each library subgroup has import statements first (in alphabetical order), followed by from import statements (in alphabetical order).

7. from import statements for the same library must be combined.

8. Alphabetize only looks at imports at the module level, any imports within the code are ignored.

Running Tests

Run tox to run the tests.

• Install tox: pip install tox

• Run tox: tox

OpenSSF Scorecard

It might be worth running the OpenSSF Scorecard:

sudo docker run -e GITHUB_AUTH_TOKEN=<auth_token> gcr.io/openssf/scorecard:stable \
--repo=github.com/tlocke/flake8-alphabetize

Doing A Release Of Alphabetize

Run tox to make sure all tests pass, then update the release notes, then do:

git tag -a x.y.z -m "version x.y.z"
rm -r dist
python -m build
twine upload --sign dist/*

Release Notes