μsort – sorts import statements

μsort (usort) is a Python import sorting utility designed to make minimal, predictable changes to source code. Its primary objective is to organise imports without introducing potentially unsafe transformations or unnecessarily altering existing formatting.

Unlike import sorters that may reorganise entire import sections, μsort identifies blocks of statements that can be safely reordered. Imports separated by executable statements or certain comments are treated as independent blocks, reducing the possibility of changing program behaviour.

The utility is particularly suitable for projects where preserving source layout and avoiding unnecessary changes are important. It is designed to work alongside general-purpose code formatters and linters rather than replace them.

μsort provides command-line operations for formatting imports, checking their order and reviewing proposed changes.

This is free and open source software.

Key Features

  • Automatically sorts Python imports using a safety-first approach.
  • Identifies independent blocks of imports that can be safely reordered.
  • Avoids moving imports across executable statements and other block boundaries.
  • Groups imports into standard library, third-party, first-party and relative categories.
  • Sorts imports lexicographically within their respective groups.
  • Preserves existing formatting wherever possible rather than rewriting import layouts.
  • Supports sorting imports in individual source files and directories.
  • Provides a format command to apply import ordering changes.
  • Offers diff mode for reviewing proposed changes without modifying files.
  • Includes check mode for validating import order in automated workflows.
  • Recognises #usort:skip directives for excluding specific imports from sorting.
  • Supports #isort:skip directives for compatibility with existing projects.
  • Allows configuration of import categories and sorting behaviour.
  • Integrates with pre-commit for automatic import checking and organisation.
  • Works alongside other Python code formatting and linting tools.

Website: github.com/facebook/usort
Support:
Developer: Meta
License: MIT License

usort is written in Python. Learn Python with our recommended free books and free tutorials.


Related Software

Python Code Formatters
RuffExtremely fast Python linter and code formatter
YAPFPython formatter based on clang-format
BlackUncompromising Python code formatter
isortPython utility and library to sort imports
autopep8Formats Python code to conform to the PEP 8 style guide
DarkerApply black reformatting to Python files
PyinkPython code formatter
blueSomewhat less uncompromising code formatter than black
μsortSorts import statements
eradicateRemove commented-out code from Python files

Read our verdict in the software roundup.


Best Free and Open Source Software Explore our carefully curated directory of recommended free and open source software, covering every major software category.

The directory forms part of our extensive collection of articles for Linux enthusiasts. It includes hundreds of detailed reviews, together with free and open source alternatives to proprietary software from companies such as Google, Microsoft, Apple, Adobe, IBM, Cisco, Oracle, and Autodesk.

LinuxLinks also covers interesting projects worth exploring, Linux-compatible hardware, free programming books and tutorials, and much more.

Know a useful free and open source Linux application that we haven’t covered? Tell us about it using our submission form.
Subscribe

Please read our Comment Policy before commenting.

Notify of
guest
0 Comments
Oldest
Newest Most Voted