uralbash / pythonVSCode

Python support for Visual Studio Code

Python

An extension with rich support for the Python language, with features including the following and more:

• Linting (Prospector, Pylint, pycodestyle/Pep8, Flake8, pydocstyle with config files and plugins)
• Intellisense (autocompletion)
• Auto indenting
• Code formatting (autopep8, yapf, with config files)
• Code refactoring (Rename, Extract Variable, Extract Method, Sort Imports)
• Renaming, Viewing references, and code navigation
• View signature and similar by hovering over a function or method
• Excellent debugging support (variables, arguments, expressions, watch window, stack information, break points, remote debugging, mutliple threads)
• Unit testing (unittest, pytest, nosetests, with config files)
• Snippets

Quick Start

• Install the extension
• If Python is in the current path
  • You're ready to use it.
• If using a custom Python Version or a Virtual Environment
  • Configure the path to the python executable in python.pythonPath of the settings.json file (further details here)

Documentation

For further information and details continue through to the documentation.

Issues, Feature Requests and Contributions

• Contributions are always welcome. Fork it, modify it and create a pull request.
  • Details on contributing can be found here
• Any and all feedback is appreciated and welcome.
  • Please feel free to add suggestions here

Feature Details

• IDE Features

• Auto indenting
• Code navigation (Go to, Find all references)
• Code definition (Peek and hover definition, View Signature)
• Rename refactoring
• Sorting Import statements (use "Python: Sort Imports" command)

• Intellisense and Autocomplete

• Ability to include custom module paths (e.g. include paths for libraries like Google App Engine, etc.)
• Use the setting python.autoComplete.extraPaths = []
• For instance getting autocomplete/intellisense for Google App Engine, add the following to your settings file:

"python.autoComplete.extraPaths": [
    "C:/Program Files (x86)/Google/google_appengine",
    "C:/Program Files (x86)/Google/google_appengine/lib" ]

• Code formatting

• Auto formatting of code upon saving changes (default to 'Off')
• Use either yapf or autopep8 for code formatting (defaults to autopep8)

• Linting

• It can be turned off (default is to be turned on and use pylint)
• Multiple linters supported (along with support for configuration files for each linter)
• Supported linters include pylit, pep8, flake8, pydocstyle, prospector
• Paths to each of the linters can be optionally configured
• Custom plugins such as pylint plugin for Django can be easily used by modifying the settings as follows:

"python.linting.pylintArgs": ["--load-plugins", "pylint_django"]

• Debugging

• Watch window
• Evaluate Expressions
• Step through code (Step in, Step out, Continue)
• Add/remove break points
• Local variables and arguments
• Multiple Threads and Web Applications (such as Flask) (Windows and Mac)
• Expanding values (viewing children, properties, etc) (Windows and Mac)
• Conditional break points
• Remote debugging
• Google App Engine

• Unit Testing

• Support for unittests, nosetests and pytest
• Test results are displayed in the "Python" output window

• Snippets
• Refactoring

• Rename Refactorings
• Extract Variable Refactorings
• Extract Method Refactorings
• Sort Imports

Roadmap

Please note, not all of these feature may be developed.
Your feedback is crucial in prioritizing the items and in determining whether we shift focus our attention to some other feature request(s).

• Intellisense and Linting
  • Context actions for some linter messages
  • Remote Interpretter
• Miscellaneous IDE enhancements
  • Auto-generate docstring
  • Documentation viewer
  • Improved integration of Unit Tests
  • Complex code refactoring (alogn with UI to preview)
• Integration
  • Code coverage
  • Profiler
  • Integrating IPython
• Debugging enhancements
  • Integration with VS Code Terminal window
  • Securely debugging Python applications in the cloud (Azure, AWS or Google Cloud)
  • Remote debugging over SSH

Change Log

Current Version 0.3.21

• Sharing python.pythonPath value with debug configuration #214 and #183
• Support extract variable and method refactoring #220
• Support environment variables in settings #148
• Support formatting of selected text #197 and #183
• Support autocompletion of parameters #71
• Support launching terminal (for debugging console apps) on Linux #152
• Display name of linter along with diagnostic messages #199
• Auto indenting of except and async functions #205 and #215
• Support changes to pythonPath without having to restart VS Code #216
• Resolved issue to support large debug outputs #52 and #52
• Handling instances when debugging with invalid paths to the python interpreter #229
• Fixed refactoring on Python 3.5 #244
• Fixed parsing errors when refactoring #244

Source

GitHub

License

MIT