Integrate autopep8, supports formatting on save.

Find a file

Campbell Barton 3b103f2a99 Use important-return-value for functions		2024-04-21 18:40:24 +10:00
tests	Cleanup: emacs native format	2023-01-07 15:24:20 +11:00
.elisp-autofmt	use elisp-autofmt for auto-formatting	2022-04-25 09:26:19 +10:00
changelog.rst	Add changelog.rst	2022-11-29 15:13:08 +11:00
LICENSE	Use GPLv3	2014-09-06 13:47:57 +02:00
Makefile	Cleanup: move test script under tests/	2022-05-02 11:57:29 +10:00
py-autopep8.el	Use important-return-value for functions	2024-04-21 18:40:24 +10:00
readme.rst	Note that py-autopep8-mode is a minor mode.	2022-05-04 10:10:19 +10:00

py-autopep8

Provides commands, which use the external autopep8 tool to tidy up the current buffer according to Python's PEP8.

Usage

Use the package (available in MELPA) and activate py-autopep8-mode in Python mode from your init file, e.g.

(use-package py-autopep8
  :hook ((python-mode) . py-autopep8-mode))

Now every time you save your Python file autopep8 will be executed on the current buffer.

Note

If you don't want to enable this automatically on save, you can run M-x py-autopep8-buffer manually.
To conditionally format on save, see py-autopep8-on-save-p.

py-autopep8-mode: Enable auto-formatting when saving (a minor mode that can be toggled).
py-autopep8-buffer: Format the entire buffer.
py-autopep8-region: Format the selected region (clamped to line bounds).

To customize the behavior of autopep8 you can set the command and options it's called with:

py-autopep8-options: (list of strings, defaults to ())

Use these options to set the default options.

Note autopep8 will use pyproject.toml when found, so it's typically best to configure project wide options there.

py-autopep8-command (string defaults to "autopep8")

Can be used to point to the location of the autopep8 command (otherwise autopep8 from the PATH will be used).

py-autopep8-on-save-p (defaults to 'always)

This function is called before formatting on save, if it returns non-nil, auto-formatting will be performed.

Since you may want to only reformat on saving for projects that use autopep8, preset functions have been included:

'always always reformat on save.
'py-autopep8-check-pyproject-exists only reformat when pyproject.toml exists in the current directory or any of it's parents.
'py-autopep8-check-pyproject-exists-with-autopep8 only reformat when pyproject.toml exists in the current directory or any of it's parents and contains a [tool.autopep8] entry.

Otherwise you can set this to a user defined function.

To install autopep8:

pip install autopep8

An example of this package being used with use-package.

(use-package py-autopep8
  :config
  (setq py-autopep8-options '("--max-line-length=100" "--aggressive"))
  :hook ((python-mode) . py-autopep8-mode))

Feel free to open tickets or send pull requests with improvements.