Skip to content

Commit 8f8b27b

Browse files
cricalixcricalix
committed
Commit initial version of code, docs
1 parent 5f5a63a commit 8f8b27b

11 files changed

+1169
-0
lines changed

‎.pyre_configuration

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"site_package_search_strategy": "all",
3+
"source_directories": [
4+
"."
5+
],
6+
"exclude": [
7+
"/setup.py",
8+
".*/build/.*"
9+
]
10+
}

‎.watchmanconfig

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{}

‎README.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# python-lsp-pyre
2+
3+
Implements support for calling Meta's Pyre type checker via a subprocess.
4+
5+
This is a plugin for the [Python LSP Server](https://github.com/python-lsp/python-lsp-server).
6+
7+
It was written to scratch an itch, so may not be quite what you're looking for.
8+
9+
## Installation
10+
11+
To use this plugin, you need to install this plugin in the same virtualenv as `python-lsp-server` itself.
12+
13+
```bash
14+
pip install python-lsp-pyre
15+
```
16+
17+
or to make it a development requirement in Poetry
18+
19+
```bash
20+
poetry add -G dev python-lsp-pyre
21+
```
22+
23+
Then run `python-lsp-server` as usual, the plugin will be auto-discovered by
24+
`python-lsp-server` if you've installed it to the right environment. Refer to
25+
`python-lsp-server` and your IDE/text editor documentation on how to setup
26+
`python-lsp-server`. An example is provided for KDE's [Kate editor](/docs/kate.md).
27+
28+
## Configuration
29+
30+
Meta's Pyre uses `.pyre_configuration` files in your project to set up lint controls. It does not read `pyproject.toml`.
31+
32+
On first run of this plugin, it will detect a missing `.pyre_configuration`, and write out one for you. It relies on the workspace root passed to the language server for this write. This file is not immutable, and the [reference documentation](https://pyre-check.org/docs/configuration/) may be useful.
33+
34+
You can also use `pyre init` instead to set up the configuration.
35+
36+
The configuration written by this plugin is:
37+
38+
```json
39+
{
40+
"site_package_search_strategy": "all",
41+
"source_directories": [
42+
"."
43+
],
44+
"exclude": [
45+
"/setup.py",
46+
".*/build/.*"
47+
]
48+
}
49+
```
50+
51+
The noteable difference from `pyre init` is the change to the search strategy (pep561 to all).
52+
53+
## Features
54+
55+
This plugin adds the following features to `pylsp`:
56+
57+
- Type linting via Meta's Pyre (pyre-check)
58+
59+
## Developing
60+
61+
Install development dependencies with (you might want to create a virtualenv first):
62+
63+
```bash
64+
git clone https://github.com/cricalix/python-lsp-pyre python-lsp-pyre
65+
cd python-lsp-pyre
66+
pip install -e '.[dev]'
67+
```
68+
69+
Alterately, if you use Poetry,
70+
```
71+
poetry install
72+
```
73+
74+
will set up a virtualenv if necessary, install all dependencies, and then install this project in editable/development mode.

‎docs/kate.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Using Python LSP with Kate
2+
3+
## Poetry edition
4+
5+
If you're using Poetry to manage your Python virtualenvs, dependencies etcetera, then it's easiest to run the language server via poetry as well. This necessitates that every virtualenv has to be configured with `python-lsp-server`, `python-lsp-pyre`, and so on, but also means that each setup is independent of the others
6+
7+
In Settings > LSP Client > User Server Settings (normally found at `$USER/.config/kate/lspclient/settings.json`), the language server can be configured as
8+
9+
```json
10+
{
11+
"servers": {
12+
"python": {
13+
"command": ["poetry", "run", "pylsp", "--check-parent-process" ],
14+
"rootIndicationFileNames": ["poetry.lock", "pyproject.toml"],
15+
"url": "https://github.com/python-lsp/python-lsp-server",
16+
"highlightingModeRegex": "^Python$"
17+
}
18+
}
19+
}
20+
```
21+
22+
This is very similar to the default Python LSP setup for Kate, just putting `poetry run` in front of the normal command.
23+
24+
If you want verbose debug logs, then add `, --verbose` after `--check-parent-process`; these will render in Kate's **Output** view.
25+
26+
If you wish to have a log file then add `, "--log-file", "/tmp/pylsp"` after `--check-parent-process`; change the log file path to suit.
27+
28+
The Python Language Server documentation supercedes the above instructions.
29+
30+
The **rootIndicationFileNames** entry is used to ensure that the correct root directory is passed to the language server on requests for linting etcetera, assuming that the project has a **pyproject.toml** file.

‎poetry.lock

+847
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎pylsp_pyre/__init__.py

Whitespace-only changes.

‎pylsp_pyre/plugin.py

+149
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
import json
2+
import logging
3+
import subprocess
4+
from pathlib import Path
5+
from typing import Any, Dict, List
6+
7+
import lsprotocol.converters as lsp_con
8+
import lsprotocol.types as lsp_types
9+
import pyre_check.client.language_server.protocol as pyre_proto
10+
from pylsp import hookimpl
11+
from pylsp.config.config import Config
12+
from pylsp.workspace import Document, Workspace
13+
14+
logger: logging.Logger = logging.getLogger(__name__)
15+
16+
17+
@hookimpl
18+
def pylsp_settings() -> Dict[str, Dict[str, Dict[str, bool]]]:
19+
return {
20+
"plugins": {
21+
"pyre": {
22+
"enabled": True,
23+
"auto-config": True,
24+
}
25+
}
26+
}
27+
28+
29+
@hookimpl
30+
def pylsp_initialize(config: Config, workspace: Workspace) -> None:
31+
"""
32+
Checks for a Pyre configuration existence.
33+
34+
Runs on plugin init, relies on the workspace document root to know where to look for
35+
the config file.
36+
"""
37+
default_config = json.loads(
38+
"""
39+
{
40+
"site_package_search_strategy": "all",
41+
"source_directories": [
42+
"."
43+
],
44+
"exclude": [
45+
"\/setup.py",
46+
".*\/build\/.*"
47+
]
48+
}
49+
"""
50+
)
51+
settings = config.plugin_settings("pyre")
52+
if settings["auto-config"]:
53+
docroot = workspace.root_path
54+
path = Path(docroot).joinpath(".pyre_configuration")
55+
if not path.exists():
56+
logger.info(f"Initializing {path}")
57+
with path.open(mode="w") as f:
58+
f.write(json.dumps(default_config, indent=4))
59+
f.write("\n")
60+
61+
62+
@hookimpl
63+
def pylsp_lint(
64+
config: Config, workspace: Workspace, document: Document, is_saved: bool
65+
) -> List[Dict[str, Any]]:
66+
"""
67+
Lints files (saved, not in-progress) and returns found problems.
68+
"""
69+
logger.debug(f"Working with {document.path}, {is_saved=}")
70+
if is_saved:
71+
with workspace.report_progress("lint: pyre check", "running"):
72+
settings = config.plugin_settings("pyre")
73+
diagnostics = run_pyre(
74+
root_path=workspace.root_path, document=document, settings=settings
75+
)
76+
workspace.show_message(message=f"Pyre reported {len(diagnostics)} issue(s).")
77+
# Deal with location stuff by using unstructure() for now.
78+
return lsp_con.get_converter().unstructure(diagnostics)
79+
else:
80+
return []
81+
82+
83+
def add_pyre_config(root_path: str) -> None:
84+
"""
85+
{
86+
"site_package_search_strategy": "all",
87+
"source_directories": [
88+
"."
89+
],
90+
"exclude": [
91+
"\/setup.py",
92+
".*\/build\/.*"
93+
]
94+
}
95+
"""
96+
97+
98+
def run_pyre(root_path: str, document: Document, settings: Dict) -> List[Dict[str, Any]]:
99+
"""
100+
Calls Pyre, converts output to internal structs
101+
"""
102+
try:
103+
data = really_run_pyre(root_path=root_path)
104+
data = json.loads(data.decode("utf-8"))
105+
checks = [
106+
{
107+
"source": "pyre",
108+
"severity": lsp_types.DiagnosticSeverity.Error,
109+
"code": x["code"],
110+
"message": x["long_description"],
111+
"range": pyre_proto.LspRange(
112+
start=pyre_proto.LspPosition(line=(x["line"] - 1), character=x["column"]),
113+
end=pyre_proto.LspPosition(
114+
line=(x["stop_line"] - 1), character=x["stop_column"]
115+
),
116+
),
117+
# "filename": x["path"],
118+
}
119+
for x in data
120+
if document.path == f"{root_path}/{x['path']}"
121+
]
122+
except Exception as e:
123+
logger.exception(f"ABEND: Pyre call raised {type(e)} - {str(e)}")
124+
checks = []
125+
126+
return checks
127+
128+
129+
def really_run_pyre(root_path: str) -> bytes:
130+
"""
131+
Runs pyre directly via subprocess.
132+
133+
Pyre has a language server mode, but it's easier to just get the binary to run instead,
134+
and avoid any need for watchman.
135+
"""
136+
logger.debug(f"Running pyre at {root_path=}")
137+
try:
138+
return subprocess.run(
139+
args=["pyre", "--output", "json", "check"],
140+
capture_output=True,
141+
check=True,
142+
).stdout
143+
except subprocess.CalledProcessError as e:
144+
# If there are no typing errors, pyre exits with returncode 0
145+
# If there are typing errors, pyre exits with returncode 1
146+
# If there are configuration errors, pyre exits with returncode 6
147+
if e.returncode in (0, 1):
148+
return e.output
149+
raise

‎pylsp_pyre/pyre.py

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
import dataclasses as dc
2+
3+
import lsprotocol.types as lsp_types
4+
5+
6+
@dc.dataclass
7+
class Location:
8+
row: int
9+
column: int
10+
11+
12+
@dc.dataclass
13+
class Check:
14+
severity: lsp_types.DiagnosticSeverity
15+
code: str
16+
message: str
17+
filename: str
18+
location: Location
19+
end_location: Location
20+

‎pyproject.toml

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
[tool.poetry]
2+
name = "python-lsp-pyre"
3+
version = "0.1.0"
4+
description = "Pyre linting plugin for pylsp"
5+
authors = ["Duncan Hill <[email protected]>"]
6+
license = "MIT"
7+
readme = "README.md"
8+
packages = [{include = "pylsp_pyre"}]
9+
10+
[tool.poetry.dependencies]
11+
python = "^3.9"
12+
pyre-check = "^0.9.18"
13+
python-lsp-server = "^1.7.3"
14+
15+
[tool.poetry.group.dev.dependencies]
16+
python-lsp-ruff = "^1.4.0"
17+
ruff = "^0.0.269"
18+
python-lsp-black = "^1.3.0"
19+
isort = "^5.12.0"
20+
21+
[tool.poetry.plugins."pylsp"]
22+
pyre = "pylsp_pyre.plugin"
23+
24+
[tool.black]
25+
target-version = ['py36', 'py37', 'py38', 'py39', 'py310', 'py311']
26+
line-length = 94
27+
28+
[tool.ruff]
29+
line-length = 94
30+
extend-select = ["I"]
31+
32+
[build-system]
33+
requires = ["poetry-core"]
34+
build-backend = "poetry.core.masonry.api"

‎setup.py

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
from setuptools import setup
2+
3+
if __name__ == "__main__":
4+
setup()

‎tests/__init__.py

Whitespace-only changes.

0 commit comments

Comments
 (0)