Report using column numbers starting with 1

Author: analog-cbarber

CHANGELOG.md

@@ -5,7 +5,8 @@ are compatible with.*
 
 ## 1.16.2
 
-* Improved source locations for errors in docstrings now including column offset.
+* Improved source locations for errors in docstrings now including column numbers
+  (starting at 1).
 
 ## 1.16.1
 

src/mkdocstrings_handlers/python_xref/crossref.py

@@ -343,7 +343,7 @@ def doc_value_offset_to_location(doc: Docstring, offset: int) -> tuple[int,int]:
         line and column or else (-1,-1) if it cannot be computed
     """
     linenum = -1
-    colnum = -1
+    colnum = -2
 
     if doc.lineno is not None:
         linenum = doc.lineno # start of the docstring source
@@ -359,8 +359,8 @@ def doc_value_offset_to_location(doc: Docstring, offset: int) -> tuple[int,int]:
             # adjust line offset by number of lines removed from front of docstring
             lineoffset += leading_space(rawvalue).count("\n")
 
-            if lineoffset == 0 and (m := re.match(r"(\s*['\"]{3}\s*)\S", source)):
-                # is on the same line as opening triple quote
+            if lineoffset == 0 and (m := re.match(r"(\s*['\"]{1,3}\s*)\S", source)):
+                # is on the same line as opening quote
                 colnum = offset + len(m.group(1))
             else:
                 # indentation of first non-empty line in raw and cleaned up strings
@@ -381,7 +381,7 @@ def doc_value_offset_to_location(doc: Docstring, offset: int) -> tuple[int,int]:
 
         linenum += lineoffset
 
-    return linenum, colnum
+    return linenum, colnum + 1
 
 
 def leading_space(s: str) -> str:

tests/test_crossref.py

@@ -223,10 +223,11 @@ def test_doc_value_offset_to_location() -> None:
         ).lstrip("\n"),
     )
 
-    assert doc_value_offset_to_location(doc1, 0) == (1, 3)
-    assert doc_value_offset_to_location(doc1, 3) == (1, 6)
-    assert doc_value_offset_to_location(doc1, 7) == (2, 1)
-    assert doc_value_offset_to_location(doc1, 15) == (3, 2)
+    # note columns start with 1
+    assert doc_value_offset_to_location(doc1, 0) == (1, 4)
+    assert doc_value_offset_to_location(doc1, 3) == (1, 7)
+    assert doc_value_offset_to_location(doc1, 7) == (2, 2)
+    assert doc_value_offset_to_location(doc1, 15) == (3, 3)
 
     doc2 = make_docstring_from_source(
         dedent(
@@ -242,9 +243,9 @@ def test_doc_value_offset_to_location() -> None:
         lineno=3,
     )
 
-    assert doc_value_offset_to_location(doc2, 0) == (3, 9)
-    assert doc_value_offset_to_location(doc2, 6) == (4, 6)
-    assert doc_value_offset_to_location(doc2, 15) == (5, 8)
+    assert doc_value_offset_to_location(doc2, 0) == (3, 10)
+    assert doc_value_offset_to_location(doc2, 6) == (4, 7)
+    assert doc_value_offset_to_location(doc2, 15) == (5, 9)
 
     # Remove parent so that source is not available
     doc2.parent = None
@@ -261,5 +262,5 @@ def test_doc_value_offset_to_location() -> None:
         ).lstrip("\n"),
     )
 
-    assert doc_value_offset_to_location(doc3, 0) == (2, 4)
-    assert doc_value_offset_to_location(doc3, 6) == (3, 2)
+    assert doc_value_offset_to_location(doc3, 0) == (2, 5)
+    assert doc_value_offset_to_location(doc3, 6) == (3, 3)

tests/test_integration.py

@@ -86,7 +86,7 @@ def test_integration(tmpdir: PathLike) -> None:
     assert m[4] == 'myproj.bar.bad'
     # Source location not accurate in python 3.7
     bad_linenum = int(m[2])
-    bad_col = int(m[3])
+    bad_col = int(m[3]) - 1 # 1-based indexing
     bar_lines = bar_src_file.read_text().splitlines()
     bad_line = bar_lines[bad_linenum - 1]
     assert '[bad]' in bad_line