Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (55 loc) · 3.35 KB

CONTRIBUTING.md

File metadata and controls

71 lines (55 loc) · 3.35 KB

Contributing to Microsoft Python Language Server

[Contributing to Microsoft Python Language Server]

Contributing a pull request

Prerequisites

  1. .NET Core 2.1 SDK
  2. C# Extension to VS Code (all platforms)
  3. Python 2.7
  4. Python 3.6

Alternative: Visual Studio 2017 (Windows only) with .NET Core and C# Workloads. Community Edition is free and is fully functional.

Setup

git clone https://github.com/Microsoft/python-language-server.git
cd src/LanguageServer/Impl
dotnet build

Visual Studio 2017:

  1. Open PLS.sln solution in src
  2. Build Microsoft.Python.LanguageServer project
  3. Binaries arrive in output/bin
  4. Clone Python Extension to VS Code source: https://github.com/Microsoft/vscode-python
  5. Open Python extension sources folder in VS Code
  6. Create languageServer folder in the extension sources folder.
  7. Copy everything from output/bin to languageServer
  8. In VS Code set setting python.downloadLanguageServer to false
  9. In VS Code set setting python.jediEnabled to false

Debugging code in Python Extension to VS Code

Folow regular TypeScript debugging steps

Debugging C# code in Microsoft Python Language Server

  1. Launch another instance of VS Code
  2. Open src folder
  3. In primary VS Code instance launch Python extension (F5)
  4. In the instance with Microsoft Python Language Server C# code select Dotnet Attach launch task.
  5. Attach to dotnet process running Microsoft.Python.languageServer.dll

On Windows you can also attach from Visual Studio 2017 (Debug | Attach To Process).

Validate your changes

  1. Build C# code
  2. Copy binaries to languageServer folder
  3. Use the Launch Extension launch option.

Unit Tests

To run unit tests, do one of the following:

  • Run the Unit Tests in the VS Code Python Extension project via the Launch Language Server Tests.
  • On Windows: open PLS.sln solution in Visual Studio 2017 and run tests from the Test Explorer.
  • Run dotnet test from Terminal in the src directory or from src/Analysis/Engine/Test if you prefer not to see messages about projects that do not contain test code.
  • Install C# extension and .NET Core Test Explorer for VS Code, open src folder in VS Code and run tests.

NOTE: Language Server does not automatically discover Python installations on various operating systems. At run time path to the Python interpreter is provided by the client application. Test environment does make an attempt to discover Python installation, but in case it is unable to find Python you will not be able to run tests. Refer to the Python interpreter discovery code for Windows and *nix

Coding Standards

Import Formatting.vssettings into Visual Studio or use .editorconfig.