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

Sublime​Linter-pep​8

by SublimeLinter ST3

SublimeLinter plugin for python, using pep8.

Details

Installs

  • Total 50K
  • Win 15K
  • OS X 19K
  • Linux 15K
Apr 23 Apr 22 Apr 21 Apr 20 Apr 19 Apr 18 Apr 17 Apr 16 Apr 15 Apr 14 Apr 13 Apr 12 Apr 11 Apr 10 Apr 9 Apr 8 Apr 7 Apr 6 Apr 5 Apr 4 Apr 3 Apr 2 Apr 1 Mar 31 Mar 30 Mar 29 Mar 28 Mar 27 Mar 26 Mar 25 Mar 24 Mar 23 Mar 22 Mar 21 Mar 20 Mar 19 Mar 18 Mar 17 Mar 16 Mar 15 Mar 14 Mar 13 Mar 12 Mar 11 Mar 10 Mar 9
Windows 20 21 24 26 25 27 18 14 6 20 30 24 16 19 17 19 31 27 22 30 23 17 20 26 29 25 17 19 17 15 33 33 28 24 29 12 30 27 17 29 23 18 12 16 23 26
OS X 14 13 27 31 27 25 37 16 11 21 29 38 29 29 14 15 30 23 31 30 42 10 12 26 34 39 31 29 12 16 29 43 25 24 39 18 15 29 24 22 16 26 21 24 24 20
Linux 16 15 18 28 24 24 16 11 10 15 26 24 28 23 11 8 15 18 21 28 27 18 9 24 26 25 27 24 15 13 16 33 30 26 14 14 16 23 16 26 18 24 15 13 20 25

Readme

Source
raw.​githubusercontent.​com

SublimeLinter-pep8

This linter plugin for SublimeLinter provides an interface to pep8. It will be used with files that have the “Python” syntax.

Installation

SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.

Linter installation

Before installing this plugin, you must ensure that pep8 is installed on your system. To install pep8, do the following:

  1. For best performance, install Python 3 and pip.

  2. Install pep8 by typing the following in a terminal, replacing '3.x' with the available version of pip:

[sudo] pip-3.x install pep8

Note: This plugin requires pep8 1.4.6 or later.

Linter configuration

In order for pep8 to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in “Finding a linter executable” through “Validating your PATH” in the documentation.

Once pep8 is installed and configured, you can proceed to install the SublimeLinter-pep8 plugin if it is not yet installed.

Plugin installation

Please use Package Control to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won’t cover that here.

To install via Package Control, do the following:

  1. Within Sublime Text, bring up the Command Palette and type install. Among the commands you should see Package Control: Install Package. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.

  2. When the plugin list appears, type pep8. Among the entries you should see SublimeLinter-pep8. If that entry is not highlighted, use the keyboard or mouse to select it.

Settings

For general information on how SublimeLinter works with settings, please see Settings. For information on generic linter settings, please see Linter Settings.

In addition to the standard SublimeLinter settings, SublimeLinter-pep8 provides its own settings. Those marked as “Inline Setting” or “Inline Override” may also be used inline.

Setting Description Inline Setting Inline Override
ignore A comma-separated list of error codes to ignore
select A comma-separated list of error codes to select, overrides ignore
max-line-length The maximum allowed line length. null uses the PEP8 default of 79.

Implementing per-project settings

Typically you will want to configure pep8 on a per-project basis to conform to the coding style for all files in that project. Usually you want to ignore certain pep8 warnings. First you need to find the pep8 error codes from the pep8 documentation. Then you need to configure the pep8 linter to ignore those warnings.

For example, let’s say your project requires python 2.7+, you want the maximum line length to be 512, and you want to ignore warnings about visual indents (pep8 errors E127 and E128):

  • If you have not already created a project in Sublime Text, select Project -> Save Project As....

  • Select Project -> Edit Project.

  • At the top level of the project’s JSON data, add the following:

    "SublimeLinter":
    {
        "@python": 2.7,
        "linters":
        {
            "pep8":
            {
                "@disable": false,
                "ignore": "E127,E128",
                "max-line-length": 512
            }
        }
    }
    
  • Save the file.

Any time you edit the project and change a linter’s settings, all open files that use that linter will be re-linted to reflect the new settings.

Contributing

If you would like to contribute enhancements or fixes, please do the following:

  1. Fork the plugin repository.
  2. Hack on a separate topic branch created from the latest master.
  3. Commit and push the topic branch.
  4. Make a pull request.
  5. Be patient. ;-)

Please note that modications should follow these coding guidelines:

  • Indent is 4 spaces.
  • Code should pass flake8 and pep257 linters.
  • Vertical whitespace helps readability, don’t be afraid to use it.

Thank you for helping out!