ssort 0.5.0

The python statement sorter

The python statement sorter.

Enforces topological sorting of top level python statements. Groups class members by types and enforces topological sorting of methods.

Compatible with and intended to complement isort and black.

Installation

SSort can be installed manually using pip.

$ pip install ssort

Usage

To check that a file is correctly sorted use the –check flag. –diff can be passed to see what changes ssort would make.

$ ssort --check --diff path/to/python_module.py

To allow ssort to rearrange your file, simply invoke with no extra flags. If ssort needs to make changes to a black conformant file, the result will not necessarily be black conformant. The result of running black on an ssort conformant file will always be ssort conformant. We recommend that you reformat using isort and black immediately _after_ running ssort.

$ ssort src/ tests/ setup.py; isort src/ tests/ setup.py; black src/ tests/ setup.py

Output

ssort will sort top level statements and statements in classes.

When sorting top level statements, ssort follows three simple rules:

• Statements must always be moved after the statements that they depend on, unless there is a cycle.

• If there is a cycle, the order of statements within the cycle must not be changed.

• If there is no dependency between statements then, to the greatest extent possible, the original order should be kept.

ssort is more opinionated about the order of statements in classes:

• Class attributes should be moved to the top of the class and must always be kept in their original order.

• Lifecycle (__init__, __new__, etc) methods, and the methods they depend on, should go next.

• Regular methods follow, dependencies always ahead of the methods that depend on them.

• Other d’under methods should go at the end in a fixed order.

Links

• Source code: https://github.com/bwhmather/ssort

• Issue tracker: https://github.com/bwhmather/ssort/issues

• PyPI: https://pypi.python.org/pypi/ssort

License

The project is made available under the terms of the MIT license. See LICENSE for details.