linked-data-python 0.2.0__tar.gz → 0.5.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/PKG-INFO +23 -23
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/README.md +22 -22
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/ldpy/__init__.py +13 -1
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/ldpy/debug.py +6 -2
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/ldpy/lsp/backend.py +14 -0
- linked_data_python-0.5.1/ldpy/lsp/hover.py +62 -0
- linked_data_python-0.5.1/ldpy/lsp/islanddoc.py +215 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/ldpy/lsp/server.py +79 -30
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/ldpy/lsp/translate.py +31 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/ldpy/runtime.py +72 -2
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/ldpy/transpiler/core.py +148 -5
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/ldpy/transpiler/linemap.py +21 -6
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/linked_data_python.egg-info/PKG-INFO +23 -23
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/linked_data_python.egg-info/SOURCES.txt +4 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/pyproject.toml +1 -1
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_bindings.py +101 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_current_graph.py +53 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_debug.py +5 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_disambiguation.py +32 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_docstrings.py +15 -0
- linked_data_python-0.5.1/tests/test_hover_parts.py +137 -0
- linked_data_python-0.5.1/tests/test_islanddoc.py +90 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_lsp_server.py +99 -11
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/LICENSE.md +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/ldpy/__main__.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/ldpy/build.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/ldpy/console.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/ldpy/formatter.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/ldpy/importer.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/ldpy/lsp/__init__.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/ldpy/lsp/__main__.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/ldpy/lsp/rpc.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/ldpy/pygments_lexer.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/ldpy/sparql.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/ldpy/transpiler/__init__.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/ldpy/transpiler/errors.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/linked_data_python.egg-info/dependency_links.txt +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/linked_data_python.egg-info/entry_points.txt +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/linked_data_python.egg-info/requires.txt +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/linked_data_python.egg-info/top_level.txt +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/setup.cfg +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_bench.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_build.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_call_suffix.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_charsets.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_coercion.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_console.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_debug_stepping.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_docs.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_examples.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_formatter.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_generator.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_graphs.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_identity.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_import_hook.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_islands_terms.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_linemap.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_lsp_rpc.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_lsp_translate.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_match_island.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_micropython_subset.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_prefix_import.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_prefix_scoping.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_pygments_lexer.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_scope_modifiers.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_semantics.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_sourcemap_v3.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_sparql_expr.py +0 -0
- {linked_data_python-0.2.0 → linked_data_python-0.5.1}/tests/test_sparql_island.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: linked-data-python
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.5.1
|
|
4
4
|
Summary: Python extended with Semantic Web primitives: IRIs, RDF literals and Turtle-notation graphs as expressions, transpiled by island parsing.
|
|
5
5
|
Author-email: Maxime Lefrançois <maxime.lefrancois@emse.fr>
|
|
6
6
|
License: MIT
|
|
@@ -96,31 +96,31 @@ From Python: `import ldpy; ldpy.install()` then `import yourmodule` finds
|
|
|
96
96
|
|
|
97
97
|
## Documentation
|
|
98
98
|
|
|
99
|
-
Read it at
|
|
100
|
-
|
|
99
|
+
Read it at **<https://linked-data-python.readthedocs.io/>** — start with the
|
|
100
|
+
home page for an overview, then:
|
|
101
101
|
|
|
102
|
-
- **Tutorials** — [first steps](
|
|
103
|
-
[build a knowledge graph](
|
|
102
|
+
- **Tutorials** — [first steps](https://linked-data-python.readthedocs.io/en/latest/tutorials/getting-started/), then
|
|
103
|
+
[build a knowledge graph](https://linked-data-python.readthedocs.io/en/latest/tutorials/build-a-knowledge-graph/) from
|
|
104
104
|
tabular data.
|
|
105
|
-
- **How-to guides** — [run & import](
|
|
106
|
-
[build graphs from tables](
|
|
107
|
-
[read and query](
|
|
108
|
-
[migrate from rdflib](
|
|
109
|
-
[VS Code](
|
|
110
|
-
[language server](
|
|
111
|
-
[highlighting](
|
|
112
|
-
- **Reference** — [the language](
|
|
113
|
-
per island family; [SPARQL expressions](
|
|
114
|
-
[CLI](
|
|
115
|
-
[language map formats](
|
|
116
|
-
- **Explanation** — [why](
|
|
117
|
-
[what real RDF code does](
|
|
105
|
+
- **How-to guides** — [run & import](https://linked-data-python.readthedocs.io/en/latest/how-to/run-and-import/),
|
|
106
|
+
[build graphs from tables](https://linked-data-python.readthedocs.io/en/latest/how-to/build-graphs-from-tables/),
|
|
107
|
+
[read and query](https://linked-data-python.readthedocs.io/en/latest/how-to/query-a-graph/),
|
|
108
|
+
[migrate from rdflib](https://linked-data-python.readthedocs.io/en/latest/how-to/migrate-from-rdflib/),
|
|
109
|
+
[VS Code](https://linked-data-python.readthedocs.io/en/latest/how-to/use-vscode/), [debugging](https://linked-data-python.readthedocs.io/en/latest/how-to/debug/),
|
|
110
|
+
[language server](https://linked-data-python.readthedocs.io/en/latest/how-to/language-server/),
|
|
111
|
+
[highlighting](https://linked-data-python.readthedocs.io/en/latest/how-to/highlight-ldpy/).
|
|
112
|
+
- **Reference** — [the language](https://linked-data-python.readthedocs.io/en/latest/reference/language/), one page
|
|
113
|
+
per island family; [SPARQL expressions](https://linked-data-python.readthedocs.io/en/latest/reference/sparql-expressions/);
|
|
114
|
+
[CLI](https://linked-data-python.readthedocs.io/en/latest/reference/cli/); [Python API](https://linked-data-python.readthedocs.io/en/latest/reference/api/);
|
|
115
|
+
[language map formats](https://linked-data-python.readthedocs.io/en/latest/reference/language-map/).
|
|
116
|
+
- **Explanation** — [why](https://linked-data-python.readthedocs.io/en/latest/explanation/why/),
|
|
117
|
+
[what real RDF code does](https://linked-data-python.readthedocs.io/en/latest/explanation/what-real-code-does/) (the
|
|
118
118
|
corpus study that drove the language's second wave),
|
|
119
|
-
[designing the syntax](
|
|
120
|
-
[island parsing](
|
|
121
|
-
[emission & semantics](
|
|
122
|
-
[tooling](
|
|
123
|
-
[how this is tested](
|
|
119
|
+
[designing the syntax](https://linked-data-python.readthedocs.io/en/latest/explanation/designing-the-syntax/),
|
|
120
|
+
[island parsing](https://linked-data-python.readthedocs.io/en/latest/explanation/island-parsing/),
|
|
121
|
+
[emission & semantics](https://linked-data-python.readthedocs.io/en/latest/explanation/emission-and-semantics/),
|
|
122
|
+
[tooling](https://linked-data-python.readthedocs.io/en/latest/explanation/tooling/),
|
|
123
|
+
[how this is tested](https://linked-data-python.readthedocs.io/en/latest/explanation/how-it-is-tested/).
|
|
124
124
|
|
|
125
125
|
Every `ldpy` and `python` block in the documentation is executed by the test
|
|
126
126
|
suite, and its assertions are the test.
|
|
@@ -54,31 +54,31 @@ From Python: `import ldpy; ldpy.install()` then `import yourmodule` finds
|
|
|
54
54
|
|
|
55
55
|
## Documentation
|
|
56
56
|
|
|
57
|
-
Read it at
|
|
58
|
-
|
|
57
|
+
Read it at **<https://linked-data-python.readthedocs.io/>** — start with the
|
|
58
|
+
home page for an overview, then:
|
|
59
59
|
|
|
60
|
-
- **Tutorials** — [first steps](
|
|
61
|
-
[build a knowledge graph](
|
|
60
|
+
- **Tutorials** — [first steps](https://linked-data-python.readthedocs.io/en/latest/tutorials/getting-started/), then
|
|
61
|
+
[build a knowledge graph](https://linked-data-python.readthedocs.io/en/latest/tutorials/build-a-knowledge-graph/) from
|
|
62
62
|
tabular data.
|
|
63
|
-
- **How-to guides** — [run & import](
|
|
64
|
-
[build graphs from tables](
|
|
65
|
-
[read and query](
|
|
66
|
-
[migrate from rdflib](
|
|
67
|
-
[VS Code](
|
|
68
|
-
[language server](
|
|
69
|
-
[highlighting](
|
|
70
|
-
- **Reference** — [the language](
|
|
71
|
-
per island family; [SPARQL expressions](
|
|
72
|
-
[CLI](
|
|
73
|
-
[language map formats](
|
|
74
|
-
- **Explanation** — [why](
|
|
75
|
-
[what real RDF code does](
|
|
63
|
+
- **How-to guides** — [run & import](https://linked-data-python.readthedocs.io/en/latest/how-to/run-and-import/),
|
|
64
|
+
[build graphs from tables](https://linked-data-python.readthedocs.io/en/latest/how-to/build-graphs-from-tables/),
|
|
65
|
+
[read and query](https://linked-data-python.readthedocs.io/en/latest/how-to/query-a-graph/),
|
|
66
|
+
[migrate from rdflib](https://linked-data-python.readthedocs.io/en/latest/how-to/migrate-from-rdflib/),
|
|
67
|
+
[VS Code](https://linked-data-python.readthedocs.io/en/latest/how-to/use-vscode/), [debugging](https://linked-data-python.readthedocs.io/en/latest/how-to/debug/),
|
|
68
|
+
[language server](https://linked-data-python.readthedocs.io/en/latest/how-to/language-server/),
|
|
69
|
+
[highlighting](https://linked-data-python.readthedocs.io/en/latest/how-to/highlight-ldpy/).
|
|
70
|
+
- **Reference** — [the language](https://linked-data-python.readthedocs.io/en/latest/reference/language/), one page
|
|
71
|
+
per island family; [SPARQL expressions](https://linked-data-python.readthedocs.io/en/latest/reference/sparql-expressions/);
|
|
72
|
+
[CLI](https://linked-data-python.readthedocs.io/en/latest/reference/cli/); [Python API](https://linked-data-python.readthedocs.io/en/latest/reference/api/);
|
|
73
|
+
[language map formats](https://linked-data-python.readthedocs.io/en/latest/reference/language-map/).
|
|
74
|
+
- **Explanation** — [why](https://linked-data-python.readthedocs.io/en/latest/explanation/why/),
|
|
75
|
+
[what real RDF code does](https://linked-data-python.readthedocs.io/en/latest/explanation/what-real-code-does/) (the
|
|
76
76
|
corpus study that drove the language's second wave),
|
|
77
|
-
[designing the syntax](
|
|
78
|
-
[island parsing](
|
|
79
|
-
[emission & semantics](
|
|
80
|
-
[tooling](
|
|
81
|
-
[how this is tested](
|
|
77
|
+
[designing the syntax](https://linked-data-python.readthedocs.io/en/latest/explanation/designing-the-syntax/),
|
|
78
|
+
[island parsing](https://linked-data-python.readthedocs.io/en/latest/explanation/island-parsing/),
|
|
79
|
+
[emission & semantics](https://linked-data-python.readthedocs.io/en/latest/explanation/emission-and-semantics/),
|
|
80
|
+
[tooling](https://linked-data-python.readthedocs.io/en/latest/explanation/tooling/),
|
|
81
|
+
[how this is tested](https://linked-data-python.readthedocs.io/en/latest/explanation/how-it-is-tested/).
|
|
82
82
|
|
|
83
83
|
Every `ldpy` and `python` block in the documentation is executed by the test
|
|
84
84
|
suite, and its assertions are the test.
|
|
@@ -11,7 +11,19 @@ package but is no longer imported by default.
|
|
|
11
11
|
from ldpy.transpiler import transpile, LdpySyntaxError, LdpyWarning
|
|
12
12
|
from ldpy.importer import install, uninstall, install_excepthook
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
#: Read from the installed distribution rather than written here: two copies
|
|
15
|
+
#: of a version number drift, and this one had — a 0.2.0 install announced
|
|
16
|
+
#: itself as 0.1.0.dev0 in the editor status bar. The fallback covers a source
|
|
17
|
+
#: tree that was never installed.
|
|
18
|
+
try:
|
|
19
|
+
from importlib.metadata import PackageNotFoundError, version as _version
|
|
20
|
+
try:
|
|
21
|
+
__version__ = _version("linked-data-python")
|
|
22
|
+
except PackageNotFoundError: # pragma: no cover
|
|
23
|
+
__version__ = "0.0.0+unknown"
|
|
24
|
+
del _version, PackageNotFoundError
|
|
25
|
+
except ImportError: # pragma: no cover
|
|
26
|
+
__version__ = "0.0.0+unknown"
|
|
15
27
|
__date__ = "2026-08-26"
|
|
16
28
|
|
|
17
29
|
|
|
@@ -211,9 +211,13 @@ def main(argv=None):
|
|
|
211
211
|
|
|
212
212
|
if args.breakpoints:
|
|
213
213
|
lines = [int(x) for x in args.breakpoints.split(",") if x.strip()]
|
|
214
|
+
# ABSOLUTE paths: this output crosses a process boundary, and a
|
|
215
|
+
# relative path means nothing to a reader that does not share our
|
|
216
|
+
# working directory. An editor turning ".ldpy-build/x.py" into a URI
|
|
217
|
+
# gets "/.ldpy-build/x.py", rooted at the filesystem root.
|
|
214
218
|
print(json.dumps({
|
|
215
|
-
"shadow": py_path,
|
|
216
|
-
"map": map_path,
|
|
219
|
+
"shadow": os.path.abspath(py_path),
|
|
220
|
+
"map": os.path.abspath(map_path),
|
|
217
221
|
"breakpoints": dict(zip(
|
|
218
222
|
lines, translate_breakpoints(result.map, lines)))}))
|
|
219
223
|
return 0
|
|
@@ -12,6 +12,18 @@ import threading
|
|
|
12
12
|
|
|
13
13
|
from ldpy.lsp.rpc import Endpoint, read_message, RpcClosed
|
|
14
14
|
|
|
15
|
+
#: The backend judges GENERATED code. Style findings (line length, blank
|
|
16
|
+
#: lines, continuation indents, semicolons…) describe the transpiler's
|
|
17
|
+
#: output, not the user's source; re-projected onto the .ldpy they underline
|
|
18
|
+
#: whole islands (record vscode/107). The shadow therefore opts out of every
|
|
19
|
+
#: style plugin; semantic analyses (pyflakes' undefined names, unused
|
|
20
|
+
#: imports) stay on.
|
|
21
|
+
STYLE_PLUGINS = ("autopep8", "flake8", "mccabe", "pycodestyle",
|
|
22
|
+
"pydocstyle", "pylint", "yapf")
|
|
23
|
+
|
|
24
|
+
SHADOW_SETTINGS = {"pylsp": {"plugins": {
|
|
25
|
+
name: {"enabled": False} for name in STYLE_PLUGINS}}}
|
|
26
|
+
|
|
15
27
|
|
|
16
28
|
class PythonBackend:
|
|
17
29
|
"""Lifecycle and delegation to `python -m pylsp` (or another argv)."""
|
|
@@ -45,6 +57,8 @@ class PythonBackend:
|
|
|
45
57
|
}},
|
|
46
58
|
}, timeout=30.0)
|
|
47
59
|
self.endpoint.notify("initialized", {})
|
|
60
|
+
self.endpoint.notify("workspace/didChangeConfiguration",
|
|
61
|
+
{"settings": SHADOW_SETTINGS})
|
|
48
62
|
return self
|
|
49
63
|
|
|
50
64
|
def _pump(self):
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
"""Rendering the hover panel — record vscode/108.
|
|
2
|
+
|
|
3
|
+
Three blocks separated by rules, in the shape Python tooling has taught
|
|
4
|
+
people to read: a signature line, the description with a link to the
|
|
5
|
+
documentation, and the Python the transpiler produced. The translation can
|
|
6
|
+
be turned off (`ldpy.hover.showTranslation`); the first two blocks are what
|
|
7
|
+
tells you *what you are looking at*, so they always show.
|
|
8
|
+
|
|
9
|
+
Kept apart from `server.py`: rendering is a function of strings, and it is
|
|
10
|
+
tested as one.
|
|
11
|
+
"""
|
|
12
|
+
|
|
13
|
+
from ldpy.lsp import islanddoc
|
|
14
|
+
|
|
15
|
+
RULE = "\n\n---\n\n"
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
def format_python(code, line_length=88):
|
|
19
|
+
"""`code` through black, or unchanged when black cannot take it.
|
|
20
|
+
|
|
21
|
+
What a hover shows is a FRAGMENT: the expression one term became, or the
|
|
22
|
+
head of a statement the source splits in two (`for @bindings in`). Those
|
|
23
|
+
are not modules, and black rightly refuses them. Showing the generated
|
|
24
|
+
text as it stands beats showing nothing, so a refusal is silent.
|
|
25
|
+
|
|
26
|
+
black normalises what it accepts — quotes above all — so the block is the
|
|
27
|
+
translation *formatted*, not a byte-for-byte extract of the generated
|
|
28
|
+
file. `ldpy -t` remains the place to read that.
|
|
29
|
+
"""
|
|
30
|
+
code = code.strip()
|
|
31
|
+
if not code:
|
|
32
|
+
return code
|
|
33
|
+
try:
|
|
34
|
+
import black
|
|
35
|
+
except ImportError: # pragma: no cover
|
|
36
|
+
return code
|
|
37
|
+
try:
|
|
38
|
+
return black.format_str(
|
|
39
|
+
code, mode=black.Mode(line_length=line_length)).rstrip("\n")
|
|
40
|
+
except Exception:
|
|
41
|
+
return code
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
def render(kind, code, line_length=88, show_translation=True):
|
|
45
|
+
"""The markdown of a hover over an island element.
|
|
46
|
+
|
|
47
|
+
`kind` is an island kind (with or without the `island:` prefix), `code`
|
|
48
|
+
the Python it became. An unknown kind still renders: the table can lag
|
|
49
|
+
the transpiler by a commit, and a hover must degrade rather than vanish.
|
|
50
|
+
"""
|
|
51
|
+
doc = islanddoc.get(kind)
|
|
52
|
+
blocks = []
|
|
53
|
+
if doc is None:
|
|
54
|
+
short = kind[len("island:"):] if kind.startswith("island:") else kind
|
|
55
|
+
blocks.append("```ldpy\n(%s island)\n```" % short)
|
|
56
|
+
else:
|
|
57
|
+
blocks.append("```ldpy\n%s\n```" % doc.signature)
|
|
58
|
+
blocks.append("%s [Documentation](%s)" % (doc.summary, doc.url))
|
|
59
|
+
if show_translation and code and code.strip():
|
|
60
|
+
blocks.append("```python\n%s\n```"
|
|
61
|
+
% format_python(code, line_length))
|
|
62
|
+
return RULE.join(blocks)
|
|
@@ -0,0 +1,215 @@
|
|
|
1
|
+
"""What each island IS, in the three lines a hover shows — record vscode/108.
|
|
2
|
+
|
|
3
|
+
Per island kind: a signature line in the shape Python tooling uses, a short
|
|
4
|
+
prose description, and the documentation page (with anchor) that explains it.
|
|
5
|
+
Nothing here knows about LSP; `server.py` renders it, `pygments_lexer.py` and
|
|
6
|
+
the semantic tokens name the same kinds.
|
|
7
|
+
|
|
8
|
+
The table is CLOSED: `tests/test_islanddoc.py` fails when the transpiler grows
|
|
9
|
+
a kind with no entry here, and when an anchor no longer exists under `docs/`.
|
|
10
|
+
That second test is what keeps the links from rotting silently — a dead link
|
|
11
|
+
in a hover is worse than no link, because nothing ever reports it.
|
|
12
|
+
"""
|
|
13
|
+
|
|
14
|
+
DOCS = "https://linked-data-python.readthedocs.io/en/latest/"
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
class IslandDoc:
|
|
18
|
+
"""Signature, description and documentation target of one island kind."""
|
|
19
|
+
|
|
20
|
+
__slots__ = ("signature", "summary", "page", "anchor")
|
|
21
|
+
|
|
22
|
+
def __init__(self, signature, summary, page, anchor):
|
|
23
|
+
self.signature = signature
|
|
24
|
+
self.summary = summary
|
|
25
|
+
self.page = page # path under docs/, with the .md suffix
|
|
26
|
+
self.anchor = anchor
|
|
27
|
+
|
|
28
|
+
@property
|
|
29
|
+
def url(self):
|
|
30
|
+
"""The published URL — mkdocs serves `x/y.md` as `x/y/`."""
|
|
31
|
+
return "%s%s/#%s" % (DOCS, self.page[:-len(".md")], self.anchor)
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
_TERMS = "reference/language/terms.md"
|
|
35
|
+
_DECLS = "reference/language/declarations.md"
|
|
36
|
+
_GRAPHS = "reference/language/graphs.md"
|
|
37
|
+
_CURRENT = "reference/language/current-graph.md"
|
|
38
|
+
_QUERY = "reference/language/querying.md"
|
|
39
|
+
_BINDINGS = "reference/language/bindings.md"
|
|
40
|
+
_SPARQL_EXPR = "reference/sparql-expressions.md"
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
ISLANDS = {
|
|
44
|
+
|
|
45
|
+
# -- declarations -------------------------------------------------------
|
|
46
|
+
|
|
47
|
+
"prefix": IslandDoc(
|
|
48
|
+
"(declaration) @prefix ex: <IRI> .",
|
|
49
|
+
"Binds `ex:` to a namespace IRI for the rest of the enclosing block. "
|
|
50
|
+
"A prefix is lexical: it has no run-time object, and `ex:` on its own "
|
|
51
|
+
"is never a value. Declaring it again in a deeper block shadows it, "
|
|
52
|
+
"the way a Python name would.",
|
|
53
|
+
_DECLS, "prefix-bind-a-prefix"),
|
|
54
|
+
|
|
55
|
+
"base": IslandDoc(
|
|
56
|
+
"(declaration) @base <IRI> .",
|
|
57
|
+
"Sets the base against which relative IRIs are resolved for the rest "
|
|
58
|
+
"of the block, so that `<sensor/1>` means `<IRI>sensor/1`.",
|
|
59
|
+
_DECLS, "base-set-the-base-iri"),
|
|
60
|
+
|
|
61
|
+
"import": IslandDoc(
|
|
62
|
+
"(declaration) from MODULE import ex:, unit: as u:",
|
|
63
|
+
"Imports prefixes declared by another module, optionally renaming "
|
|
64
|
+
"them. The module is imported as usual; what travels is the prefix "
|
|
65
|
+
"bindings, which have no value to import by ordinary means.",
|
|
66
|
+
_DECLS, "prefixes-across-modules"),
|
|
67
|
+
|
|
68
|
+
"graph-decl": IslandDoc(
|
|
69
|
+
"(declaration) @graph EXPR | @graph as NAME -> Graph",
|
|
70
|
+
"Designates the current graph for the block — the one `+{ }`, `-{ }` "
|
|
71
|
+
"and a receiver-less `m{ }` act on. `as NAME` creates a fresh graph "
|
|
72
|
+
"and binds it to NAME; `global` and `nonlocal` widen the scope.",
|
|
73
|
+
_CURRENT, "graph-designate-or-create"),
|
|
74
|
+
|
|
75
|
+
"bindings-decl": IslandDoc(
|
|
76
|
+
"(declaration) @bindings EXPR | @bindings as NAME -> Bindings",
|
|
77
|
+
"Designates the current bindings: the mapping that gives `?name` its "
|
|
78
|
+
"value in the enclosing block. Any mapping will do, and `as NAME` "
|
|
79
|
+
"creates an empty one.",
|
|
80
|
+
_BINDINGS, "bindings-the-current-bindings"),
|
|
81
|
+
|
|
82
|
+
"for-bindings": IslandDoc(
|
|
83
|
+
"(statement) for @bindings [as NAME] in ITER:",
|
|
84
|
+
"Loops over an iterable of mappings, making each row the current "
|
|
85
|
+
"bindings for the body. A `csv.DictReader` and the solutions of "
|
|
86
|
+
"`m{ }` are both iterables of mappings, so both drive this loop.",
|
|
87
|
+
_BINDINGS, "for-bindings-in-iter-the-loop-that-carries-them"),
|
|
88
|
+
|
|
89
|
+
"for-bindings-close": IslandDoc(
|
|
90
|
+
"(statement) the ':' closing a for @bindings header",
|
|
91
|
+
"The end of a `for @bindings` header. It is mapped on its own "
|
|
92
|
+
"because the header is rewritten in two pieces, around the iterable "
|
|
93
|
+
"that stays verbatim Python.",
|
|
94
|
+
_BINDINGS, "for-bindings-in-iter-the-loop-that-carries-them"),
|
|
95
|
+
|
|
96
|
+
# -- graphs and the current graph ---------------------------------------
|
|
97
|
+
|
|
98
|
+
"graph": IslandDoc(
|
|
99
|
+
"(expression) g{ ... } -> Graph",
|
|
100
|
+
"Builds an RDF graph from Turtle written in place. `{expr}` "
|
|
101
|
+
"interpolates a Python value in term position, and each occurrence "
|
|
102
|
+
"is evaluated once. The braces are an expression, so a `g{ }` goes "
|
|
103
|
+
"anywhere a value goes — a default argument, a comprehension, a "
|
|
104
|
+
"return.",
|
|
105
|
+
_GRAPHS, "turtle-inside-the-braces"),
|
|
106
|
+
|
|
107
|
+
"addto": IslandDoc(
|
|
108
|
+
"(statement) +{ ... } [ (GRAPH) ]",
|
|
109
|
+
"Adds the triples to the current graph. `?name` takes its value from "
|
|
110
|
+
"the current bindings, and a triple with an unbound variable is "
|
|
111
|
+
"dropped rather than written half-way. A trailing `(g)` names "
|
|
112
|
+
"another receiver.",
|
|
113
|
+
_CURRENT, "and-write-to-it"),
|
|
114
|
+
|
|
115
|
+
"removefrom": IslandDoc(
|
|
116
|
+
"(statement) -{ ... } [ (GRAPH) ]",
|
|
117
|
+
"Removes from the current graph every triple matching the pattern. "
|
|
118
|
+
"An unbound variable is a wildcard here, not a hole: this is a "
|
|
119
|
+
"SPARQL `DELETE WHERE`, not a list of triples to subtract.",
|
|
120
|
+
_CURRENT, "and-write-to-it"),
|
|
121
|
+
|
|
122
|
+
# -- reading ------------------------------------------------------------
|
|
123
|
+
|
|
124
|
+
"match": IslandDoc(
|
|
125
|
+
"(expression) m{ ... } -> Solutions",
|
|
126
|
+
"Matches a basic graph pattern against the current graph, lazily. "
|
|
127
|
+
"Iterating yields a bare term when one variable is projected and a "
|
|
128
|
+
"tuple otherwise; `.one()`, `.first()`, `.count()` and `bool()` are "
|
|
129
|
+
"the usual reductions. A `(graph)` suffix names another source.",
|
|
130
|
+
_QUERY, "m-match-a-basic-graph-pattern"),
|
|
131
|
+
|
|
132
|
+
"sparql": IslandDoc(
|
|
133
|
+
"(expression) s{ ... } -> Query",
|
|
134
|
+
"A SPARQL query or update, parsed when the file is transpiled rather "
|
|
135
|
+
"than at run time. `{expr}` in term position becomes an initial "
|
|
136
|
+
"binding — never string pasting, so nothing here can be injected. "
|
|
137
|
+
"Call it on a graph to run it; `.execute()` runs an update.",
|
|
138
|
+
_QUERY, "s-a-sparql-query"),
|
|
139
|
+
|
|
140
|
+
# -- terms --------------------------------------------------------------
|
|
141
|
+
|
|
142
|
+
"iri": IslandDoc(
|
|
143
|
+
"(term) <IRI> -> URIRef",
|
|
144
|
+
"An absolute IRI, or a relative one resolved against the `@base` in "
|
|
145
|
+
"scope.",
|
|
146
|
+
_TERMS, "iris"),
|
|
147
|
+
|
|
148
|
+
"pname": IslandDoc(
|
|
149
|
+
"(term) ex:local -> URIRef",
|
|
150
|
+
"A prefixed name: the local part is appended to the IRI bound to "
|
|
151
|
+
"`ex:`. Turtle's character set applies inside an island, so "
|
|
152
|
+
"`o-pizza:topping` and `ex:café` are names here although neither is "
|
|
153
|
+
"a legal Python expression. `ex:{expr}` computes the local part.",
|
|
154
|
+
_TERMS, "prefixed-names-exlocal"),
|
|
155
|
+
|
|
156
|
+
"literal": IslandDoc(
|
|
157
|
+
"(term) \"...\"@lang | \"...\"^^dt -> Literal",
|
|
158
|
+
"An RDF literal carrying a language tag or a datatype. The quoted "
|
|
159
|
+
"part may be an f-string, and `{expr}` may supply the datatype "
|
|
160
|
+
"itself.",
|
|
161
|
+
_TERMS, "rdf-literals-lang-dt"),
|
|
162
|
+
|
|
163
|
+
"var": IslandDoc(
|
|
164
|
+
"(term) ?name | $name -> Variable",
|
|
165
|
+
"A SPARQL variable. In a pattern it is what gets matched and "
|
|
166
|
+
"projected; in `g{ }` or `+{ }` it takes its value from the current "
|
|
167
|
+
"bindings, and leaves the triple out when it has none.",
|
|
168
|
+
_TERMS, "variables-name-name"),
|
|
169
|
+
|
|
170
|
+
"firi": IslandDoc(
|
|
171
|
+
"(term) f<...{expr}...> -> URIRef",
|
|
172
|
+
"A formatted IRI: the braces interpolate as in an f-string, the "
|
|
173
|
+
"result is percent-encoded and then resolved against `@base`. "
|
|
174
|
+
"Encoding first is what keeps a space or a slash in a value from "
|
|
175
|
+
"changing the IRI's structure.",
|
|
176
|
+
_TERMS, "formatted-iris-f"),
|
|
177
|
+
|
|
178
|
+
"fnode": IslandDoc(
|
|
179
|
+
"(term) f{expr} | ?{expr} -> Node",
|
|
180
|
+
"Coerces any Python value into an RDF term, by the coercion policy "
|
|
181
|
+
"in scope. Two spellings of one operation: `?{ }` reads better in "
|
|
182
|
+
"term position, `f{ }` beside `f<...>`.",
|
|
183
|
+
_TERMS, "formatted-nodes-fexpr-expr"),
|
|
184
|
+
|
|
185
|
+
"bnode": IslandDoc(
|
|
186
|
+
"(term) _:{expr} -> BNode",
|
|
187
|
+
"A blank node whose identity is its data: the same value gives the "
|
|
188
|
+
"same node anywhere in the program, so two rows that share a key "
|
|
189
|
+
"join without inventing an IRI for them.",
|
|
190
|
+
_GRAPHS, "data-keyed-blank-nodes-_expr"),
|
|
191
|
+
|
|
192
|
+
# -- deferred evaluation ------------------------------------------------
|
|
193
|
+
|
|
194
|
+
"enode": IslandDoc(
|
|
195
|
+
"(expression) e{ ... } -> Expr",
|
|
196
|
+
"A deferred SPARQL expression. It is not evaluated where it is "
|
|
197
|
+
"written, but against the bindings in force when the island holding "
|
|
198
|
+
"it is instantiated — once per row of a `for @bindings` loop. "
|
|
199
|
+
"`{python}` holes are evaluated where they are written.",
|
|
200
|
+
_BINDINGS, "e-in-term-position"),
|
|
201
|
+
|
|
202
|
+
"eiri": IslandDoc(
|
|
203
|
+
"(expression) e<...{?var}...> -> Expr",
|
|
204
|
+
"A deferred IRI: `f<...>`'s interpolation, except that the holes are "
|
|
205
|
+
"SPARQL expressions re-evaluated for each set of bindings.",
|
|
206
|
+
_SPARQL_EXPR, "deferred-iris-e"),
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
def get(kind):
|
|
211
|
+
"""The entry for an island kind, `island:` prefix optional; None if the
|
|
212
|
+
kind is unknown — a hover must degrade, never raise."""
|
|
213
|
+
if kind.startswith("island:"):
|
|
214
|
+
kind = kind[len("island:"):]
|
|
215
|
+
return ISLANDS.get(kind)
|
|
@@ -21,6 +21,7 @@ import sys
|
|
|
21
21
|
from ldpy.transpiler import transpile, LdpySyntaxError
|
|
22
22
|
from ldpy.lsp.rpc import Endpoint, read_message, RpcClosed
|
|
23
23
|
from ldpy.lsp import translate as tr
|
|
24
|
+
from ldpy.lsp import hover as hv
|
|
24
25
|
from ldpy.transpiler.linemap import snap_breakpoint_lines
|
|
25
26
|
|
|
26
27
|
|
|
@@ -29,6 +30,28 @@ def fmt_default():
|
|
|
29
30
|
from ldpy.formatter import DEFAULT_LINE_LENGTH
|
|
30
31
|
return DEFAULT_LINE_LENGTH
|
|
31
32
|
|
|
33
|
+
|
|
34
|
+
def _ldpy_version():
|
|
35
|
+
"""The installed package version — never duplicated here."""
|
|
36
|
+
from ldpy import __version__
|
|
37
|
+
return __version__
|
|
38
|
+
|
|
39
|
+
def _setting(settings, *path, default=None):
|
|
40
|
+
"""Read a nested setting, whether the client sends the whole tree
|
|
41
|
+
(`{"ldpy": {"hover": ...}}`) or just our section (`{"hover": ...}`).
|
|
42
|
+
Clients differ on this and both spellings are legitimate."""
|
|
43
|
+
for root in (settings, (settings or {}).get("ldpy")):
|
|
44
|
+
node = root
|
|
45
|
+
for key in path:
|
|
46
|
+
if not isinstance(node, dict) or key not in node:
|
|
47
|
+
node = None
|
|
48
|
+
break
|
|
49
|
+
node = node[key]
|
|
50
|
+
if node is not None:
|
|
51
|
+
return node
|
|
52
|
+
return default
|
|
53
|
+
|
|
54
|
+
|
|
32
55
|
FORWARDED = {
|
|
33
56
|
"textDocument/completion",
|
|
34
57
|
"textDocument/definition",
|
|
@@ -64,6 +87,9 @@ class LdpyServer:
|
|
|
64
87
|
self.backend_argv = backend_argv
|
|
65
88
|
self.backend = None
|
|
66
89
|
self.line_length = line_length
|
|
90
|
+
# `ldpy.hover.showTranslation` — the generated Python in the hover.
|
|
91
|
+
# On by default: it is the point of the feature (record vscode/108).
|
|
92
|
+
self.hover_translation = True
|
|
67
93
|
self._shutdown = False
|
|
68
94
|
|
|
69
95
|
# ------------------------------------------------------------ backend
|
|
@@ -123,13 +149,20 @@ class LdpyServer:
|
|
|
123
149
|
|
|
124
150
|
def _on_backend_diags(self, shadow, diags):
|
|
125
151
|
"""The backend's Python diagnostics, re-projected onto the .ldpy.
|
|
126
|
-
Those landing on synthetic text (the prelude) are dropped
|
|
152
|
+
Those landing on synthetic text (the prelude) are dropped, and so is
|
|
153
|
+
everything a style linter says about the shadow: it judges GENERATED
|
|
154
|
+
code (record vscode/107). The backend is asked not to compute style
|
|
155
|
+
at all (SHADOW_SETTINGS); this filter covers a backend that does not
|
|
156
|
+
honour the configuration."""
|
|
157
|
+
from ldpy.lsp.backend import STYLE_PLUGINS
|
|
127
158
|
doc = self.docs.get(tr.unshadow_uri(shadow))
|
|
128
159
|
if doc is None or doc.result is None:
|
|
129
160
|
return
|
|
130
161
|
lmap = doc.result.map
|
|
131
162
|
kept = []
|
|
132
163
|
for d in diags:
|
|
164
|
+
if d.get("source") in STYLE_PLUGINS:
|
|
165
|
+
continue
|
|
133
166
|
rng = d.get("range", {})
|
|
134
167
|
start = tr.pos_to_ldpy(lmap, rng.get("start", {}))
|
|
135
168
|
if start is None:
|
|
@@ -173,6 +206,7 @@ class LdpyServer:
|
|
|
173
206
|
|
|
174
207
|
def _dispatch(self, method, params, rid):
|
|
175
208
|
if method == "initialize":
|
|
209
|
+
self._apply_settings(params.get("initializationOptions"))
|
|
176
210
|
self._ensure_backend(params.get("rootUri"))
|
|
177
211
|
return {
|
|
178
212
|
"capabilities": {
|
|
@@ -185,18 +219,18 @@ class LdpyServer:
|
|
|
185
219
|
"referencesProvider": True,
|
|
186
220
|
"signatureHelpProvider": {
|
|
187
221
|
"triggerCharacters": ["(", ","]},
|
|
188
|
-
"semanticTokensProvider": {
|
|
189
|
-
"legend": {"tokenTypes": tr.TOKEN_TYPES,
|
|
190
|
-
"tokenModifiers": []},
|
|
191
|
-
"full": True},
|
|
192
222
|
# our own extension, announced so the client can detect
|
|
193
223
|
# it instead of assuming it (record vscode/103)
|
|
194
224
|
"experimental": {"ldpyBreakpointLines": True},
|
|
195
225
|
},
|
|
196
|
-
"serverInfo": {"name": "ldpy-lsp", "version":
|
|
226
|
+
"serverInfo": {"name": "ldpy-lsp", "version": _ldpy_version()},
|
|
197
227
|
}
|
|
198
|
-
if method
|
|
199
|
-
|
|
228
|
+
if method == "workspace/didChangeConfiguration":
|
|
229
|
+
# a live toggle: no restart, and no re-transpilation either —
|
|
230
|
+
# only the rendering of the next hover changes
|
|
231
|
+
self._apply_settings(params.get("settings"))
|
|
232
|
+
return None
|
|
233
|
+
if method in ("initialized", "$/setTrace", "$/cancelRequest"):
|
|
200
234
|
return None
|
|
201
235
|
if method == "shutdown":
|
|
202
236
|
self._shutdown = True
|
|
@@ -240,12 +274,6 @@ class LdpyServer:
|
|
|
240
274
|
return {"lines": lines}
|
|
241
275
|
return {"lines": snap_breakpoint_lines(doc.result.map, lines)}
|
|
242
276
|
|
|
243
|
-
if method == "textDocument/semanticTokens/full":
|
|
244
|
-
doc = self.docs.get(params["textDocument"]["uri"])
|
|
245
|
-
if doc is None or doc.result is None:
|
|
246
|
-
return {"data": []}
|
|
247
|
-
return {"data": tr.semantic_tokens(doc.result.map)}
|
|
248
|
-
|
|
249
277
|
if method == "textDocument/hover":
|
|
250
278
|
return self._hover(params)
|
|
251
279
|
|
|
@@ -292,28 +320,49 @@ class LdpyServer:
|
|
|
292
320
|
return [{"range": {"start": {"line": 0, "character": 0}, "end": end},
|
|
293
321
|
"newText": new}]
|
|
294
322
|
|
|
323
|
+
def _apply_settings(self, settings):
|
|
324
|
+
"""Client configuration, from `initialize` or a later change."""
|
|
325
|
+
value = _setting(settings, "hover", "showTranslation")
|
|
326
|
+
if isinstance(value, bool):
|
|
327
|
+
self.hover_translation = value
|
|
328
|
+
|
|
329
|
+
def _gen_text(self, doc, gen):
|
|
330
|
+
"""The generated Python covered by a map range."""
|
|
331
|
+
gl0, gc0, gl1, gc1 = gen
|
|
332
|
+
lines = doc.result.code.split("\n")[gl0:gl1 + 1]
|
|
333
|
+
if not lines:
|
|
334
|
+
return ""
|
|
335
|
+
if len(lines) == 1:
|
|
336
|
+
return lines[0][gc0:gc1]
|
|
337
|
+
lines[0] = lines[0][gc0:]
|
|
338
|
+
lines[-1] = lines[-1][:gc1]
|
|
339
|
+
return "\n".join(lines)
|
|
340
|
+
|
|
295
341
|
def _hover(self, params):
|
|
342
|
+
"""Native on an island, delegated on the Python around it.
|
|
343
|
+
|
|
344
|
+
Inside an island we answer on the SMALLEST described element under
|
|
345
|
+
the cursor (record vscode/108): hovering a prefixed name in a
|
|
346
|
+
forty-line `g{ }` should explain that name, not dump the whole
|
|
347
|
+
translated block."""
|
|
296
348
|
doc = self.docs.get(params["textDocument"]["uri"])
|
|
297
349
|
if doc is None or doc.result is None:
|
|
298
350
|
return None
|
|
299
351
|
pos = params["position"]
|
|
300
352
|
seg = tr.island_at(doc.result.map, pos["line"], pos["character"])
|
|
301
|
-
if seg is
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
"range": {"start": {"line": sl0, "character": sc0},
|
|
315
|
-
"end": {"line": sl1, "character": sc1}}}
|
|
316
|
-
return self._forward("textDocument/hover", params)
|
|
353
|
+
if seg is None:
|
|
354
|
+
return self._forward("textDocument/hover", params)
|
|
355
|
+
kind, src, code = tr.island_target(seg, pos["line"],
|
|
356
|
+
pos["character"])
|
|
357
|
+
if code is None:
|
|
358
|
+
code = self._gen_text(doc, seg.gen)
|
|
359
|
+
width = self.line_length or fmt_default()
|
|
360
|
+
sl0, sc0, sl1, sc1 = src
|
|
361
|
+
return {"contents": {"kind": "markdown",
|
|
362
|
+
"value": hv.render(kind, code, width,
|
|
363
|
+
self.hover_translation)},
|
|
364
|
+
"range": {"start": {"line": sl0, "character": sc0},
|
|
365
|
+
"end": {"line": sl1, "character": sc1}}}
|
|
317
366
|
|
|
318
367
|
# --------------------------------------------------------- delegation
|
|
319
368
|
|