Source code for pain001_lsp._csv
# SPDX-FileCopyrightText: 2026 Sebastien Rousseau <sebastian.rousseau@gmail.com>
# SPDX-License-Identifier: Apache-2.0 OR MIT
"""Lint a payment CSV document into the server's plain-dict diagnostics.
The core's :func:`pain001.lsp.diagnostics.diagnostics_for_csv` reads the
text with the ``csv`` module, which raises ``csv.Error`` on text it cannot
read: a bare carriage return inside an unquoted field, or, before Python
3.11, a NUL byte. Editor text can hold either, so that ends as one
diagnostic, never as an exception escaping a keystroke.
"""
from __future__ import annotations
import csv
from pain001.lsp.diagnostics import Severity, diagnostics_for_csv
from pain001_lsp._parsing import _diagnostic
from pain001_lsp._schema import DEFAULT_MESSAGE_TYPE
_CSV_SEVERITY_TO_STR = {
Severity.ERROR: "error",
Severity.WARNING: "warning",
Severity.INFORMATION: "information",
Severity.HINT: "hint",
}
[docs]
def csv_diagnostics(text: str, message_type: str) -> list[dict]:
"""Return the core's CSV diagnostics as plain dicts, or one read error."""
try:
found = diagnostics_for_csv(text, message_type)
except csv.Error as exc:
return [_diagnostic(0, f"Invalid CSV: {exc}")]
return [
{
"line": diag.line,
"character": diag.col_start,
"col_start": diag.col_start,
"col_end": diag.col_end,
"severity": _CSV_SEVERITY_TO_STR.get(diag.severity, "error"),
"message": diag.message,
"code": diag.code,
}
for diag in found
]
[docs]
def compute_diagnostics_csv(
text: str, message_type: str = DEFAULT_MESSAGE_TYPE
) -> list[dict]:
"""Compute diagnostics for a pain.001 payment-data CSV document.
Wraps :func:`pain001.lsp.diagnostics.diagnostics_for_csv` and returns
the same plain-dict shape as :func:`compute_diagnostics` so the LSP
handlers can route by URI suffix without caring which engine ran.
Args:
text: The raw CSV document text.
message_type: The pain message type to validate against.
Returns:
A list of plain dicts shaped like the JSON-mode output, with
``col_start`` / ``col_end`` keys retained so editors can paint
per-cell ranges. Text the ``csv`` module cannot read gets one
``Invalid CSV`` error at the top instead.
"""
return csv_diagnostics(text, message_type)