pylsp-rope

Extended refactoring capabilities for Python LSP Server using Rope.

This is a plugin for Python LSP Server, so you also need to have it installed.

python-lsp-server already has basic built-in support for using Rope, but it's currently limited to just renaming and completion. Installing this plugin adds more refactoring functionality to python-lsp-server.

Installation

To use this plugin, you need to install this plugin in the same virtualenv as python-lsp-server itself.

pip install pylsp-rope

Then run pylsp as usual, the plugin will be auto-discovered by python-lsp-server if you've installed it to the right environment. On Vim, refer to Rope in Vim or Neovim. For other editors, refer to your IDE/text editor's documentation on how to setup a language server.

Configuration

There is no configuration yet.

Features

This plugin adds the following features to python-lsp-server:

• extract method (codeAction)
• extract variable (codeAction)
• inline method/variable/parameter (codeAction)
• use function (codeAction)
• method to method object (codeAction)
• convert local variable to field (codeAction)
• organize imports (codeAction)
• more to come...

Refer to Rope documentation for more details on how these refactoring works.

Usage

Extract method

Variants:

• Extract method
• Extract global method
• Extract method including similar statements
• Extract global method including similar statements

This refactoring works by triggering CodeAction when selecting a block of code. Optionally, similar statements can also be extracted.

Extract variable

• Extract variable
• Extract global variable
• Extract variable including similar statements
• Extract global variable including similar statements

This refactoring works by triggering CodeAction when selecting a Python expression. Optionally, similar statements can also be extracted.

Inline

This refactoring works by triggering CodeAction when the cursor is on a resolvable Python identifier.

Use function

This refactoring works by triggering CodeAction when the cursor is on the function name of a def statement.

Method to method object

This refactoring works by triggering CodeAction when the cursor is on the function name of a def statement.

Convert local variable to field

This refactoring works by triggering CodeAction when the cursor is on a local variable.

Organize import

This refactoring works by triggering CodeAction anywhere.

Caveat

Support for working on unsaved document is currently experimental.

This plugin is in early development, so expect some bugs. Please report in Github issue tracker if you had any issues with the plugin.

Developing

See CONTRIBUTING.md.

Credits

This package was created with Cookiecutter from lieryan/cookiecutter-pylsp-plugin project template.