ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Py​Yapf Python Formatter

by jason-kane ST2/ST3

Sublime Text plugin to run YAPF Python formatter

Labels python, formatting

Details

Installs

  • Total 5K
  • Win 2K
  • OS X 2K
  • Linux 1K
Aug 22 Aug 21 Aug 20 Aug 19 Aug 18 Aug 17 Aug 16 Aug 15 Aug 14 Aug 13 Aug 12 Aug 11 Aug 10 Aug 9 Aug 8 Aug 7 Aug 6 Aug 5 Aug 4 Aug 3 Aug 2 Aug 1 Jul 31 Jul 30 Jul 29 Jul 28 Jul 27 Jul 26 Jul 25 Jul 24 Jul 23 Jul 22 Jul 21 Jul 20 Jul 19 Jul 18 Jul 17 Jul 16 Jul 15 Jul 14 Jul 13 Jul 12 Jul 11 Jul 10 Jul 9 Jul 8
Windows 3 2 1 3 4 2 3 8 3 4 3 4 6 3 8 3 4 2 6 8 3 1 3 3 3 3 3 4 5 0 6 1 2 3 2 4 3 0 3 3 4 5 3 7 2 2
OS X 5 2 2 1 1 2 1 2 1 1 3 2 4 2 3 9 4 1 2 4 3 4 3 1 3 7 4 9 3 4 1 1 8 10 8 2 4 5 1 5 4 2 5 6 0 2
Linux 3 1 2 2 1 4 1 2 1 3 1 2 0 1 2 3 2 1 1 4 5 2 1 0 0 7 2 2 3 3 1 2 2 1 1 2 1 1 2 2 2 5 2 0 1 2

Readme

Source
raw.​githubusercontent.​com

PyYapf

Sublime Text 2-3 plugin to run the YAPF Python formatter

Usage

By default, press Ctrl-Alt-F to format the current selection (or the entire document if nothing is selected). You can also Ctrl-Shift-P (Mac: Cmd-Shift-P) and select “PyYapf: Format Selection” or “PyYapf: Format Document”. To automatically run YAPF on the current document before saving, use the on_save setting.

Installation

  1. Install YAPF (if you haven't already):
pip install yapf
  1. Install Sublime Package Control by following the instructions here (if you haven't already).

  2. Ctrl-Shift-P (Mac: Cmd-Shift-P) and choose “Package Control: Install Package”.

  3. Find “PyYapf Python Formatter” in the list (type in a few characters and you should see it).

Alternatively, install manually by navigating to Sublime's Packages folder and cloning this repository:

git clone https://github.com/jason-kane/PyYapf.git "PyYapf Python Formatter"

Problems?

This makes it pretty easy to find valid python code that makes Yapf choke or give bad formatting. Please try to reduce any problems to a minimal example and let the YAPF folks know. If there is something wrong with this plugin, add an issue on GitHub and I'll try to address it.

LICENSE

Apache v2 per LICENSE. Do what you want; if you fix something please share it.