SublimeLinter plugin for python, using pylint.
- Total 45K
- Win 16K
- OS X 16K
- Linux 13K
|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||Jul 7||Jul 6|
SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.
Before using this plugin, you must ensure that
pylint is installed on your system. To install
pylint, do the following:
pylintby typing the following in a terminal, replacing ‘x’ with the minor version installed on your system:
# For python 2.x [sudo] pip-2.x install pylint # For python 3.x [sudo] pip-3.x install pylint # On Windows, for python 2.x c:\Python2x\Scripts\pip.exe install pylint # On Windows, for python 3.x c:\Python3x\Scripts\pip.exe install pylint
Note: This plugin requires
pylint 1.0 or later.
In order for
pylint 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 you have installed and configured
pylint, you can proceed to install the SublimeLinter-pylint plugin if it is not yet installed.
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:
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.
When the plugin list appears, type
pylint. Among the entries you should see
SublimeLinter-pylint. If that entry is not highlighted, use the keyboard or mouse to select it.
In addition to the standard SublimeLinter settings, SublimeLinter-pylint provides its own settings. Those marked as “Inline Setting” or “Inline Override” may also be used inline.
|Setting||Description||Inline Setting||Inline Override|
|@python||A meta setting that indicates the python version of your source files. Use this inline or at the global level, not within the linter’s settings.||✓|
|disable||Disable the message, report, category or checker with the given comma-separated id(s)||✓|
|enable||Enable the message, report, category or checker with the given comma-separated id(s)||✓|
|rcfile||Absolute path to a pylint configuration file|
|paths||A list of paths to be added to sys.path for pylint to find modules|
|show-codes||Boolean that indicates whether you want the pylint code to be displayed in the status bar|
Notes on Pylint and errors
Remember that you can locally disable errors by putting a comment similar to
# pylint: disable=R0903 at the end of the offending lines.
By doing so, you will generate a new error called
I0011, that you may want to globally ignore through your settings.
If you would like to contribute enhancements or fixes, please do the following:
- Fork the plugin repository.
- Hack on a separate topic branch created from the latest
- Commit and push the topic branch.
- Make a pull request.
- 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.
- Please use descriptive variable names, no abbrevations unless they are very well known.
Thank you for helping out!