mkdocstrings-python-xref 1.6.0.1__tar.gz → 1.6.2__tar.gz

{mkdocstrings_python_xref-1.6.0.1 → mkdocstrings_python_xref-1.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: mkdocstrings-python-xref
-Version: 1.6.0.1
+Version: 1.6.2
 Summary: Enhanced mkdocstrings python handler
 Project-URL: Repository, https://github.com/analog-garage/mkdocstrings-python-xref
 Project-URL: Documentation, https://analog-garage.github.io/mkdocstrings-python-xref/
@@ -16,6 +16,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Documentation
 Requires-Python: >=3.8
+Requires-Dist: griffe>=1.0
 Requires-Dist: mkdocstrings-python<2.0,>=1.6.2
 Description-Content-Type: text/markdown
 

mkdocstrings_python_xref-1.6.2/mkdocstrings_handlers/python_xref/VERSION

@@ -0,0 +1 @@
+1.6.2

{mkdocstrings_python_xref-1.6.0.1/src → mkdocstrings_python_xref-1.6.2}/mkdocstrings_handlers/python_xref/crossref.py

@@ -1,4 +1,4 @@
-#  Copyright (c) 2022-2023.   Analog Devices Inc.
+#  Copyright (c) 2022-2024.   Analog Devices Inc.
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -16,10 +16,9 @@
 from __future__ import annotations
 
 import re
-import sys
 from typing import Callable, List, Optional, cast
 
-from griffe.dataclasses import Docstring, Object
+from griffe import Docstring, Object
 from mkdocstrings.loggers import get_logger
 
 __all__ = [
@@ -28,9 +27,6 @@ __all__ = [
 
 logger = get_logger(__name__)
 
-# line numbers from griffe are not reliable before python 3.8; this may eventually be fixed...
-_supports_linenums = sys.version_info >= (3,8)
-
 def _re_or(*exps: str) -> str:
     """Construct an "or" regular expression from a sequence of regular expressions.
 
@@ -150,6 +146,8 @@ class _RelativeCrossrefProcessor:
 
         new_ref = ""
 
+        # TODO support special syntax to turn off checking
+
         if not _RE_REL_CROSSREF.fullmatch(match.group(0)):
             # Just a regular cross reference
             new_ref = ref if ref else title
@@ -307,10 +305,9 @@ class _RelativeCrossrefProcessor:
             prefix = f"file://{parent.filepath}:"
             line = doc.lineno
             if line is not None:  # pragma: no branch
-                if _supports_linenums:  # pragma: no branch
-                    # Add line offset to match in docstring. This can still be
-                    # short if the doc string has leading newlines.
-                    line += doc.value.count("\n", 0, self._cur_offset)
+                # Add line offset to match in docstring. This can still be
+                # short if the doc string has leading newlines.
+                line += doc.value.count("\n", 0, self._cur_offset)
                 prefix += f"{line}:"
                 # It would be nice to add the column as well, but we cannot determine
                 # that without knowing how much the doc string was unindented.
@@ -325,7 +322,7 @@ def substitute_relative_crossrefs(obj: Object, checkref: Optional[Callable[[str]
     """Recursively expand relative cross-references in all docstrings in tree.
 
     Arguments:
-        obj: a Griffe [Object][griffe.dataclasses.] whose docstrings should be modified
+        obj: a Griffe [Object][griffe.] whose docstrings should be modified
         checkref: optional function to check whether computed cross-reference is valid.
             Should return True if valid, False if not valid.
     """

{mkdocstrings_python_xref-1.6.0.1/src → mkdocstrings_python_xref-1.6.2}/mkdocstrings_handlers/python_xref/handler.py

@@ -21,7 +21,7 @@ from collections import ChainMap
 from pathlib import Path
 from typing import Any, List, Mapping, Optional
 
-from griffe.dataclasses import Object
+from griffe import Object
 from mkdocstrings.loggers import get_logger
 from mkdocstrings_handlers.python.handler import PythonHandler
 

{mkdocstrings_python_xref-1.6.0.1 → mkdocstrings_python_xref-1.6.2}/pyproject.toml

@@ -25,7 +25,8 @@ keywords = [
 dynamic = ["version"]
 requires-python = ">=3.8"
 dependencies = [
-    "mkdocstrings-python >=1.6.2,<2.0"
+    "mkdocstrings-python >=1.6.2,<2.0",
+    "griffe >=1.0"
 ]
 
 [project.urls]
@@ -43,11 +44,11 @@ include = [
     "src/mkdocstrings_handlers/python_xref/py.typed",
 ]
 
-#[tool.hatch.build.targets.sdist]
-#packages = [
-#    "src/mkdocstrings_handlers",
-#    "src/mkdocstrings_handlers/python_xref",
-#]
+[tool.hatch.build.targets.sdist]
+packages = [
+    "src/mkdocstrings_handlers",
+    "src/mkdocstrings_handlers/python_xref",
+]
 
 [tool.hatch.build.targets.wheel]
 packages = [
@@ -74,6 +75,66 @@ module = [
 ]
 ignore_missing_imports = true
 
+[tool.ruff.lint]
+# TODO add "I" (isort)
+# TODO add "RUF"
+# TODO add "ARG"
+# TODO add "SIM"
+# TODO add "S" (bandit)
+# TODO add "PT" (pytest style)
+# TODO add "CPY101"
+select = ["E", "F", "PL", "D", "R", "T10", "EXE"]
+ignore = [
+    "D105", # missing doc string for dunder methods
+    "D200", # one line doc string
+    "D202", # blank lines after function docstring
+    "D205", # doc on first line
+    "D212", # doc on first line
+    "D410", # blank line after doc section
+    "D411", # blank line before doc section
+    "D412", # no blank lines after section header
+    "D415", # doc title punctuation
+    "E501", # line too long
+    "PLC0105", # covariant metatype names
+    "PLR0913", # too-many-argument
+    "PLR2004", # magic value
+    "PT001", # allow @pytest.fixture without parens
+    "RET504", # unnecessary assignment to variable before return
+    "S101", # use of assert - do we care?
+    # TODO: fix the ones below
+    "D403", # capitalize first word of doc string
+    "D102", # undocumented public method
+    "D104", # missing docstring in public package
+    "D107", # __init__ docstring
+    "D417", # missing argument description
+]
+preview = true
+explicit-preview-rules = true # only preview explicitly selected rules (E.g. CPY001)
+
+[tool.ruff.lint.per-file-ignores]
+# Ignore some issues in tests
+"tests/**" = [
+    "F401", # unused import (pytest fixture)
+    "F403", # wildcard import (for fixtures)
+    "F405", # defined from star imports (typicallky a pytest fixture)
+    "F811", # redefinition of unused (typically a pytest fixture)
+    "PLR0912", # too many branches
+    "PLR0915", # too many statements
+    "S", # bandit rules
+]
+
+[tool.ruff.lint.pylint]
+#max-locals = 30
+max-branches = 15
+#max-attributes = 30
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[too.ruff.format]
+skip-magic-trailing-comma = false
+line-ending = "lf"
+
 [tool.pylint.main]
 jobs = 0
 # Minimum Python version to use for version dependent checks.

mkdocstrings_python_xref-1.6.0.1/src/mkdocstrings_handlers/python_xref/VERSION

@@ -1 +0,0 @@
-1.6.0.1