Pre-process parsed docstrings to add hints on how to resolve names #723

tristanlatr · 2023-07-11T05:10:31Z

Fixes #295.

We're running a docutils transformer on the parsed docstrings to resolve locally existing names early, it sets a refuri attribute on reference nodes. This means all parsed docstrings must be cached as a Documentable attribute: so I’ve create a little memoize function for that. The transform is ran at the time we're leaving the module (but it should run in post-processing when something like #724 is merged - that moves the reparenting to the post processing step).

The linker also got updated to be able to link to an object with it's outdated (before reparenting) fullname, which could be what we stored in therefuri attribute earlier by our transformer.

There are a couple of blind spot:

FIXED decorator, attribute values and function annotations within the parameter table do not have their parsed_* attribute to store ParsedDocstring instance, so no transformation is possible at the moment. These ParsedDocstring are create at the time of the stan generation, it's worthless to apply the transformation at this step of processing since we already loose the original code model structure. So we really need to have the ParsedDocstring stored in Documentable attributes.
FIXED names that are both defined in a class level and at the module level will not be expanded because of ambiguity. Basically that would require to mimic the logic implemented in Fix name resolving issues #663 into the _ReferenceTransform.
It does not really addresses Use docutils transformer to resolve links #421 since we're not actually resolving the links, we're only adding a kind of hint to the reference. But it's a good step into that direction.
FIXED ~~we loose the formatting detail of the reference, we don't know anymore at the time of resolving the link if the developer wrote L{split} or L{split <os.path.split>}~~.
FIXED ~~links to builtins are broken in reparented class inside a module that shadows some of the builtins~~
Some objects don't have their parsed_docstring attribute set at the time we're transforming links, because the docstring can come from inherited members. To fix this situation all the reparenting should be taking place in post-processing (Rework reparenting and allobjects attribute #725) and link transformation as well (after MRO computing and before reparenting).
The warning message for the builtins links should not include the « builtins » module except if it has been explicitly mentioned.This might turn out to require more refactor than expected.

This PR does not cover all improvements cited in #295. Especially a new issue should be created to actually separate our code model VS our view model. The view model would be initiated in post-processing. The separation between the two models could firstly be done with Protocol classes (so we keep a unique structure at first) defining all required attributes by astbuilder and templatewriter. Classes that would be used to annotate Documentable to restrict the attributes that can be accessed. Then we could look at creating two sets of concrete classes.

The main challenge of that operation (and probably the reason it has not been done a long time ago) is that the code model is strongly couple with the docstring parsing. Namely:

the parsing of @ivar-like fields which creates model instance with parsed_docstring attribute already populated.
the creation of Function.signature attribute which stores ast values as ParsedDocstring in _ValueFormatter.
the handling of property definitions which creates model instance with parsed_docstring attribute already populated.
The main goal being not perform docstring parsing until we have the final state for all objects.

codecov · 2023-07-11T05:13:47Z

Codecov Report

Attention: Patch coverage is 94.67213% with 13 lines in your changes missing coverage. Please review.

Project coverage is 93.37%. Comparing base (93f83e8) to head (784d069).

Files with missing lines	Patch %	Lines
pydoctor/epydoc2stan.py	91.79%	3 Missing and 8 partials ⚠️
pydoctor/linker.py	88.88%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #723      +/-   ##
==========================================
+ Coverage   93.22%   93.37%   +0.14%     
==========================================
  Files          47       47              
  Lines        8743     8908     +165     
  Branches     1601     1639      +38     
==========================================
+ Hits         8151     8318     +167     
+ Misses        335      331       -4     
- Partials      257      259       +2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

tristanlatr · 2023-07-11T15:36:46Z

pydoctor/epydoc2stan.py

+    else:
+        _ReferenceTransform(document, ctx).apply()
+
+def transform_parsed_names(node:'model.Module') -> None:


This should not be re-run on nodes that have been reparented. Meaning we must keep track of reparented nodes for every modules.

This issue will be fixed if we move the reparenting in post process and call transform_parsed_names() before.

Also enamble msg(once=True) when using report().

…as well.

…rsed_annotations, FunctionOverload.parsed_decorators, Attribute.parsed_decorators, Attribute.parsed_value. Fixes links in presentation of these components.

tristanlatr · 2023-07-14T15:06:30Z

pydoctor/epydoc2stan.py

+    Fixing "Lookup of name in annotation fails on reparented object #295".
+    The fix is not 100% complete at the moment: attribute values and decorators
+    are not handled.


Suggested change

Fixing "Lookup of name in annotation fails on reparented object #295".

The fix is not 100% complete at the moment: attribute values and decorators

are not handled.

Fixing "Lookup of name in annotation fails on reparented object #295".

pydoctor/epydoc2stan.py

tristanlatr · 2023-07-14T15:10:06Z

pydoctor/epydoc2stan.py

+        if ob.parsed_docstring:
+            _apply_reference_transform(ob.parsed_docstring, ob)
+            for f in ob.parsed_docstring.fields:
+                _apply_reference_transform(f.body(), ob)


Since we're not using ensure_parsed_docstring, we might miss some docs

Calling ensure_parsed_docstring at this stage of the processing can have unintended side effects related to the docformat handling. More specifically, if a docformat is specified in a __docformat__ variable in a parent package tht has not been processed yet at the time we call ensure_parsed_docstring, then it will be parsed with the system's docformat instead. While this is a very niche bug, it's still a bug that should be considered.

pydoctor/astbuilder.py

pydoctor/epydoc/markup/_types.py

pydoctor/epydoc2stan.py

tristanlatr · 2023-09-30T23:45:51Z

pydoctor/model.py

            f'{self.description}:{linenumber}: {descr}',
-            thresh=thresh)
+            # some warnings can be reported more that once.
+            thresh=thresh, once=True)


Should probably not change this behaviour.

Let’s revert that.

pydoctor/epydoc2stan.py

tristanlatr · 2025-01-31T03:11:14Z

pydoctor/epydoc2stan.py

+                # transform bare builtin name into builtins.<name>
+                attribs['refuri'] = '.'.join(('builtins', name, *rest))


This might not be necessary

tristanlatr · 2025-05-22T20:34:54Z

pydoctor/model.py

+            # some warnings can be reported more that once.
+            thresh=thresh, once=True)


Suggested change

# some warnings can be reported more that once.

thresh=thresh, once=True)

thresh=thresh)

tristanlatr · 2025-06-28T15:59:33Z

That PR was wrongly closed

tristanlatr

This is looking good, I have still a bit of work to do...

tristanlatr · 2025-07-19T16:01:50Z

pydoctor/epydoc2stan.py

-    if isinstance(obj, model.Function):
-        fh.set_param_types_from_annotations(obj.annotations)
+    fh.set_param_types_from_annotations()


i don't see why this change is necessary

tristanlatr · 2025-07-19T16:04:47Z

pydoctor/epydoc2stan.py

-    # Report eventual warnings. It warns when a regex failed to parse.
-    reportWarnings(obj, doc.warnings, section='colorize constant')
-


the warnings are now triggered in get_parsed_value

tristanlatr · 2025-07-19T16:05:43Z

pydoctor/epydoc2stan.py

+        # per title_reference element.
+        attribs = node.attributes
+        if target == attribs.get('refuri', target) and 'rawtarget' not in attribs: 
+            is_annotation = node.attributes.get('is_annotation')               


Suggested change

is_annotation = node.attributes.get('is_annotation')

is_annotation = attribs.get('is_annotation')

tristanlatr · 2025-07-19T16:06:43Z

pydoctor/epydoc2stan.py

+                # transform bare builtin name into builtins.<name>
+                attribs['refuri'] = '.'.join(('builtins', name, *rest))


…e code.

…ing happens in order to be sure we're using the right docformat.

tristanlatr · 2025-07-20T12:18:11Z

There is something problematic with the diff from pydoctor_primer. I'll try to hack a reproducer...

github-actions · 2025-08-07T00:08:30Z

Diff from pydoctor_primer, showing the effect of this PR on open source code:

pycma (https://github.com/CMA-ES/pycma)
- /projects/pycma/cma/boundary_handler.py:15: Cannot find link target for "list"
- /projects/pycma/cma/boundary_handler.py:15: Cannot find link target for "None"
+ /projects/pycma/cma/boundary_handler.py:15: Cannot find link target for "builtins.list", resolved from "list" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/boundary_handler.py:15: Cannot find link target for "builtins.None", resolved from "None" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/boundary_handler.py:19: Cannot find link target for "builtins.list", resolved from "list" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/boundary_handler.py:68: Cannot find link target for "builtins.callable", resolved from "callable" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/boundary_handler.py:71: Cannot find link target for "builtins.callable", resolved from "callable" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/boundary_handler.py:79: Cannot find link target for "builtins.None", resolved from "None" (you can link to external docs with --intersphinx)
- /projects/pycma/cma/boundary_handler.py:19: Cannot find link target for "list"
- /projects/pycma/cma/boundary_handler.py:68: Cannot find link target for "callable"
- /projects/pycma/cma/boundary_handler.py:71: Cannot find link target for "callable"
- /projects/pycma/cma/boundary_handler.py:79: Cannot find link target for "None"
- /projects/pycma/cma/boundary_handler.py:79: Cannot find link target for "None"
- /projects/pycma/cma/boundary_handler.py:282: Cannot find link target for "True"
+ /projects/pycma/cma/boundary_handler.py:282: Cannot find link target for "builtins.True", resolved from "True" (you can link to external docs with --intersphinx)
- /projects/pycma/cma/boundary_handler.py:377: Cannot find link target for "True"
+ /projects/pycma/cma/boundary_handler.py:377: Cannot find link target for "builtins.True", resolved from "True" (you can link to external docs with --intersphinx)
- /projects/pycma/cma/boundary_handler.py:303: Cannot find link target for "True"
+ /projects/pycma/cma/boundary_handler.py:303: Cannot find link target for "builtins.True", resolved from "True" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/boundary_handler.py:502: Cannot find link target for "builtins.None", resolved from "None" (you can link to external docs with --intersphinx)
- /projects/pycma/cma/boundary_handler.py:303: Cannot find link target for "True"
- /projects/pycma/cma/boundary_handler.py:303: Cannot find link target for "x"
- /projects/pycma/cma/boundary_handler.py:502: Cannot find link target for "None"
- /projects/pycma/cma/boundary_handler.py:502: Cannot find link target for "None"
+ /projects/pycma/cma/boundary_handler.py:576: Cannot find link target for "builtins.None", resolved from "None" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/boundary_handler.py:578: Cannot find link target for "builtins.list", resolved from "list" (you can link to external docs with --intersphinx)
- /projects/pycma/cma/boundary_handler.py:624: Cannot find link target for "x"
- /projects/pycma/cma/boundary_handler.py:576: Cannot find link target for "None"
- /projects/pycma/cma/boundary_handler.py:576: Cannot find link target for "None"
- /projects/pycma/cma/boundary_handler.py:578: Cannot find link target for "list"
- /projects/pycma/cma/constraints_handler.py:136: Cannot find link target for "list"
+ /projects/pycma/cma/constraints_handler.py:136: Cannot find link target for "builtins.list", resolved from "list" (you can link to external docs with --intersphinx)
- /projects/pycma/cma/constraints_handler.py:556: Cannot find link target for "list"
- /projects/pycma/cma/constraints_handler.py:589: Cannot find link target for "True"
- /projects/pycma/cma/constraints_handler.py:613: Cannot find link target for "True"
- /projects/pycma/cma/constraints_handler.py:613: Cannot find link target for "False"
- /projects/pycma/cma/constraints_handler.py:646: Cannot find link target for "True"
- /projects/pycma/cma/constraints_handler.py:646: Cannot find link target for "False"
- /projects/pycma/cma/constraints_handler.py:583: Cannot find link target for "True"
- /projects/pycma/cma/constraints_handler.py:595: Cannot find link target for "True"
- /projects/pycma/cma/constraints_handler.py:595: Cannot find link target for "False"
- /projects/pycma/cma/constraints_handler.py:634: Cannot find link target for "True"
- /projects/pycma/cma/constraints_handler.py:634: Cannot find link target for "False"
- /projects/pycma/cma/constraints_handler.py:395: Cannot find link target for "None"
- /projects/pycma/cma/constraints_handler.py:457: Cannot find link target for "None"
- /projects/pycma/cma/constraints_handler.py:548: Cannot find link target for "True"
+ /projects/pycma/cma/constraints_handler.py:556: Cannot find link target for "builtins.list", resolved from "list" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/constraints_handler.py:589: Cannot find link target for "builtins.True", resolved from "True" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/constraints_handler.py:613: Cannot find link target for "builtins.True", resolved from "True" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/constraints_handler.py:613: Cannot find link target for "builtins.False", resolved from "False" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/constraints_handler.py:646: Cannot find link target for "builtins.True", resolved from "True" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/constraints_handler.py:646: Cannot find link target for "builtins.False", resolved from "False" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/constraints_handler.py:583: Cannot find link target for "builtins.True", resolved from "True" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/constraints_handler.py:595: Cannot find link target for "builtins.True", resolved from "True" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/constraints_handler.py:595: Cannot find link target for "builtins.False", resolved from "False" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/constraints_handler.py:634: Cannot find link target for "builtins.True", resolved from "True" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/constraints_handler.py:634: Cannot find link target for "builtins.False", resolved from "False" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/constraints_handler.py:395: Cannot find link target for "builtins.None", resolved from "None" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/constraints_handler.py:457: Cannot find link target for "builtins.None", resolved from "None" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/constraints_handler.py:548: Cannot find link target for "builtins.True", resolved from "True" (you can link to external docs with --intersphinx)
- /projects/pycma/cma/constraints_handler.py:434: Cannot find link target for "TypeError"
+ /projects/pycma/cma/constraints_handler.py:434: Cannot find link target for "builtins.TypeError", resolved from "TypeError" (you can link to external docs with --intersphinx)
- /projects/pycma/cma/constraints_handler.py:773: Cannot find link target for "False"
+ /projects/pycma/cma/constraints_handler.py:773: Cannot find link target for "builtins.False", resolved from "False" (you can link to external docs with --intersphinx)
- /projects/pycma/cma/constraints_handler.py:822: Cannot find link target for "False"
+ /projects/pycma/cma/constraints_handler.py:822: Cannot find link target for "builtins.False", resolved from "False" (you can link to external docs with --intersphinx)
- /projects/pycma/cma/evolution_strategy.py:3933: Cannot find link target for "tuple"
+ /projects/pycma/cma/evolution_strategy.py:3933: Cannot find link target for "builtins.tuple", resolved from "tuple" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/evolution_strategy.py:4001: Cannot find link target for "builtins.dict", resolved from "dict" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/evolution_strategy.py:4010: Cannot find link target for "builtins.callable", resolved from "callable" (you can link to external docs with --intersphinx)
- /projects/pycma/cma/evolution_strategy.py:4001: Cannot find link target for "dict"
- /projects/pycma/cma/evolution_strategy.py:4001: Cannot find link target for "dict"
- /projects/pycma/cma/evolution_strategy.py:4010: Cannot find link target for "callable"
- /projects/pycma/cma/evolution_strategy.py:4018: Cannot find link target for "list"
- /projects/pycma/cma/evolution_strategy.py:4027: Cannot find link target for "True"
+ /projects/pycma/cma/evolution_strategy.py:4018: Cannot find link target for "builtins.list", resolved from "list" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/evolution_strategy.py:4027: Cannot find link target for "builtins.True", resolved from "True" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/evolution_strategy.py:4049: Cannot find link target for "builtins.callable", resolved from "callable" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/evolution_strategy.py:4053: Cannot find link target for "builtins.callable", resolved from "callable" (you can link to external docs with --intersphinx)
+ /projects/pycma/cma/evolution_strategy.py:4057: Cannot find link target for "builtins.callable", resolved from "callable" (you can link to external docs with --intersphinx)

... (truncated 303 lines) ...

attrs (https://github.com/python-attrs/attrs)
- /projects/attrs/src/attr/_make.py:390: bad docstring: Inline interpreted text or phrase reference start-string without end-string.
- /projects/attrs/src/attr/_next_gen.py:50: bad docstring: No role entry for "term" in module "docutils.parsers.rst.languages.en".
- Trying "term" as canonical role name.
- /projects/attrs/src/attr/_next_gen.py:50: bad docstring: Unknown interpreted text role "term".
- /projects/attrs/src/attr/_next_gen.py:62: bad docstring: No role entry for "term" in module "docutils.parsers.rst.languages.en".
- Trying "term" as canonical role name.
- /projects/attrs/src/attr/_next_gen.py:62: bad docstring: Unknown interpreted text role "term".
- /projects/attrs/src/attr/_next_gen.py:456: bad docstring: No role entry for "term" in module "docutils.parsers.rst.languages.en".
- Trying "term" as canonical role name.
- /projects/attrs/src/attr/_next_gen.py:456: bad docstring: Unknown interpreted text role "term".
+ /projects/attrs/src/attr/_funcs.py:31: Cannot find link target for "builtins.True", resolved from "True" (you can link to external docs with --intersphinx)
+ /projects/attrs/src/attr/_funcs.py:31: Cannot find link target for "builtins.False", resolved from "False" (you can link to external docs with --intersphinx)
+ /projects/attrs/src/attr/_funcs.py:41: Cannot find link target for "builtins.list", resolved from "list" (you can link to external docs with --intersphinx)
+ /projects/attrs/src/attr/_funcs.py:42: Cannot find link target for "builtins.tuple", resolved from "tuple" (you can link to external docs with --intersphinx)
+ /projects/attrs/src/attr/_funcs.py:42: Cannot find link target for "builtins.set", resolved from "set" (you can link to external docs with --intersphinx)
+ /projects/attrs/src/attr/_funcs.py:42: Cannot find link target for "builtins.True", resolved from "True" (you can link to external docs with --intersphinx)
+ /projects/attrs/src/attr/_funcs.py:227: Cannot find link target for "builtins.True", resolved from "True" (you can link to external docs with --intersphinx)
+ /projects/attrs/src/attr/_funcs.py:227: Cannot find link target for "builtins.False", resolved from "False" (you can link to external docs with --intersphinx)
+ /projects/attrs/src/attr/_funcs.py:236: Cannot find link target for "builtins.list", resolved from "list" (you can link to external docs with --intersphinx)
+ /projects/attrs/src/attr/_funcs.py:236: Cannot find link target for "builtins.dict", resolved from "dict" (you can link to external docs with --intersphinx)
+ /projects/attrs/src/attr/_funcs.py:237: Cannot find link target for "builtins.tuple", resolved from "tuple" (you can link to external docs with --intersphinx)
+ /projects/attrs/src/attr/_funcs.py:237: Cannot find link target for "builtins.set", resolved from "set" (you can link to external docs with --intersphinx)
+ /projects/attrs/src/attr/_funcs.py:238: Cannot find link target for "builtins.True", resolved from "True" (you can link to external docs with --intersphinx)
+ /projects/attrs/src/attr/_make.py:141: Cannot find link target for "builtins.None", resolved from "None" (you can link to external docs with --intersphinx)
+ /projects/attrs/src/attr/_make.py:1387: Cannot find link target for "builtins.None", resolved from "None" (you can link to external docs with --intersphinx)
+ /projects/attrs/src/attr/_make.py:1394: Cannot find link target for "builtins.None", resolved from "None" (you can link to external docs with --intersphinx)
+ /projects/attrs/src/attr/_make.py:1405: Cannot find link target for "builtins.DeprecationWarning", resolved from "DeprecationWarning" (you can link to external docs with --intersphinx)
- /projects/attrs/src/attr/_funcs.py:31: Cannot find link target for "True"
- /projects/attrs/src/attr/_funcs.py:31: Cannot find link target for "False"
- /projects/attrs/src/attr/_funcs.py:41: Cannot find link target for "list"
- /projects/attrs/src/attr/_funcs.py:42: Cannot find link target for "tuple"
- /projects/attrs/src/attr/_funcs.py:42: Cannot find link target for "set"
- /projects/attrs/src/attr/_funcs.py:42: Cannot find link target for "True"
- /projects/attrs/src/attr/_funcs.py:227: Cannot find link target for "True"
- /projects/attrs/src/attr/_funcs.py:227: Cannot find link target for "False"
- /projects/attrs/src/attr/_funcs.py:236: Cannot find link target for "list"
- /projects/attrs/src/attr/_funcs.py:236: Cannot find link target for "dict"
- /projects/attrs/src/attr/_funcs.py:237: Cannot find link target for "tuple"
- /projects/attrs/src/attr/_funcs.py:236: Cannot find link target for "dict"
- /projects/attrs/src/attr/_funcs.py:237: Cannot find link target for "set"
- /projects/attrs/src/attr/_funcs.py:238: Cannot find link target for "True"
- /projects/attrs/src/attr/_make.py:141: Cannot find link target for "None"
- /projects/attrs/src/attr/_make.py:1387: Cannot find link target for "None"
- /projects/attrs/src/attr/_make.py:1394: Cannot find link target for "None"
- /projects/attrs/src/attr/_make.py:1405: Cannot find link target for "DeprecationWarning"
- /projects/attrs/src/attr/_cmp.py:50: Cannot find link target for "True"
- /projects/attrs/src/attr/_cmp.py:51: Cannot find link target for "NotImplemented"
+ /projects/attrs/src/attr/_cmp.py:50: Cannot find link target for "builtins.True", resolved from "True" (you can link to external docs with --intersphinx)
+ /projects/attrs/src/attr/_cmp.py:51: Cannot find link target for "builtins.NotImplemented", resolved from "NotImplemented" (you can link to external docs with --intersphinx)
- /projects/attrs/src/attr/_next_gen.py:54: Cannot find link target for "object.__init_subclass__" (you can link to external docs with --intersphinx)
+ /projects/attrs/src/attr/_next_gen.py:54: Cannot find link target for "builtins.object.__init_subclass__", resolved from "object.__init_subclass__" (you can link to external docs with --intersphinx)
- /projects/attrs/src/attr/_next_gen.py:80: Cannot find link target for "True"
- /projects/attrs/src/attr/_next_gen.py:80: Cannot find link target for "False"
- /projects/attrs/src/attr/_next_gen.py:84: Cannot find link target for "BaseException"
- /projects/attrs/src/attr/_next_gen.py:104: Cannot find link target for "setattr"
+ /projects/attrs/src/attr/_next_gen.py:80: Cannot find link target for "builtins.True", resolved from "True" (you can link to external docs with --intersphinx)
+ /projects/attrs/src/attr/_next_gen.py:80: Cannot find link target for "builtins.False", resolved from "False" (you can link to external docs with --intersphinx)
+ /projects/attrs/src/attr/_next_gen.py:84: Cannot find link target for "builtins.BaseException", resolved from "BaseException" (you can link to external docs with --intersphinx)
+ /projects/attrs/src/attr/_next_gen.py:104: Cannot find link target for "builtins.setattr", resolved from "setattr" (you can link to external docs with --intersphinx)
- /projects/attrs/src/attr/_next_gen.py:132: Cannot find link target for "Exception"
+ /projects/attrs/src/attr/_next_gen.py:132: Cannot find link target for "builtins.Exception", resolved from "Exception" (you can link to external docs with --intersphinx)
- /projects/attrs/src/attr/_next_gen.py:151: Cannot find link target for "None"
+ /projects/attrs/src/attr/_next_gen.py:151: Cannot find link target for "builtins.None", resolved from "None" (you can link to external docs with --intersphinx)
- /projects/attrs/src/attr/_next_gen.py:165: Cannot find link target for "object"
+ /projects/attrs/src/attr/_next_gen.py:165: Cannot find link target for "builtins.object", resolved from "object" (you can link to external docs with --intersphinx)
- /projects/attrs/src/attr/_next_gen.py:177: Cannot find link target for "object.__hash__" (you can link to external docs with --intersphinx)
+ /projects/attrs/src/attr/_next_gen.py:177: Cannot find link target for "builtins.object.__hash__", resolved from "object.__hash__" (you can link to external docs with --intersphinx)
- /projects/attrs/src/attr/_next_gen.py:313: Cannot find link target for "None"
+ /projects/attrs/src/attr/_next_gen.py:313: Cannot find link target for "builtins.None", resolved from "None" (you can link to external docs with --intersphinx)
- /projects/attrs/src/attr/_next_gen.py:346: Cannot find link target for "True"
- /projects/attrs/src/attr/_next_gen.py:349: Cannot find link target for "False"
+ /projects/attrs/src/attr/_next_gen.py:346: Cannot find link target for "builtins.True", resolved from "True" (you can link to external docs with --intersphinx)
+ /projects/attrs/src/attr/_next_gen.py:349: Cannot find link target for "builtins.False", resolved from "False" (you can link to external docs with --intersphinx)
- /projects/attrs/src/attr/_next_gen.py:474: Cannot find link target for "TypeError"
+ /projects/attrs/src/attr/_next_gen.py:474: Cannot find link target for "builtins.TypeError", resolved from "TypeError" (you can link to external docs with --intersphinx)
- /projects/attrs/src/attr/_next_gen.py:490: Cannot find link target for "list"
+ /projects/attrs/src/attr/_next_gen.py:490: Cannot find link target for "builtins.list", resolved from "list" (you can link to external docs with --intersphinx)
- /projects/attrs/src/attr/_next_gen.py:582: Cannot find link target for "setattr"
+ /projects/attrs/src/attr/_next_gen.py:582: Cannot find link target for "builtins.setattr", resolved from "setattr" (you can link to external docs with --intersphinx)
- /projects/attrs/src/attr/_make.py:64: Cannot find link target for "None"
- /projects/attrs/src/attr/_make.py:95: Cannot find link target for "None"
+ /projects/attrs/src/attr/_make.py:64: Cannot find link target for "builtins.None", resolved from "None" (you can link to external docs with --intersphinx)
+ /projects/attrs/src/attr/_make.py:95: Cannot find link target for "builtins.None", resolved from "None" (you can link to external docs with --intersphinx)

... (truncated 78 lines) ...

astroid (https://github.com/pylint-dev/astroid)
- /projects/astroid/astroid/brain/brain_builtin_inference.py:738: Cannot find link target for "issubclass"
+ /projects/astroid/astroid/brain/brain_builtin_inference.py:738: Cannot find link target for "builtins.issubclass", resolved from "issubclass" (you can link to external docs with --intersphinx)
- /projects/astroid/astroid/brain/brain_builtin_inference.py:740: Cannot find link target for "issubclass"
+ /projects/astroid/astroid/brain/brain_builtin_inference.py:740: Cannot find link target for "builtins.issubclass", resolved from "issubclass" (you can link to external docs with --intersphinx)
- /projects/astroid/astroid/brain/brain_builtin_inference.py:613: Cannot find link target for "property"
- /projects/astroid/astroid/brain/brain_builtin_inference.py:615: Cannot find link target for "property"
- /projects/astroid/astroid/brain/brain_builtin_inference.py:682: Cannot find link target for "slice"
+ /projects/astroid/astroid/brain/brain_builtin_inference.py:613: Cannot find link target for "builtins.property", resolved from "property" (you can link to external docs with --intersphinx)
+ /projects/astroid/astroid/brain/brain_builtin_inference.py:615: Cannot find link target for "builtins.property", resolved from "property" (you can link to external docs with --intersphinx)
+ /projects/astroid/astroid/brain/brain_builtin_inference.py:682: Cannot find link target for "builtins.slice", resolved from "slice" (you can link to external docs with --intersphinx)
- /projects/astroid/astroid/brain/brain_namedtuple_enum.py:576: Cannot find link target for "type"
+ /projects/astroid/astroid/brain/brain_namedtuple_enum.py:576: Cannot find link target for "builtins.type", resolved from "type" (you can link to external docs with --intersphinx)
- /projects/astroid/astroid/manager.py:413: Cannot find link target for "hook"
- /projects/astroid/astroid/manager.py:415: Cannot find link target for "astroid.nodes.Module", resolved from "astroid.Module"
- /projects/astroid/astroid/nodes/_base_nodes.py:141: Cannot find link target for "tuple"
+ /projects/astroid/astroid/nodes/_base_nodes.py:141: Cannot find link target for "builtins.tuple", resolved from "tuple" (you can link to external docs with --intersphinx)
- /projects/astroid/astroid/nodes/node_classes.py:3170: Cannot find link target for "tuple"
+ /projects/astroid/astroid/nodes/node_classes.py:3170: Cannot find link target for "builtins.tuple", resolved from "tuple" (you can link to external docs with --intersphinx)
- /projects/astroid/astroid/nodes/node_classes.py:2831: Cannot find link target for "tuple"
+ /projects/astroid/astroid/nodes/node_classes.py:2831: Cannot find link target for "builtins.tuple", resolved from "tuple" (you can link to external docs with --intersphinx)
- /projects/astroid/astroid/nodes/node_classes.py:3457: Cannot find link target for "NotImplementedError"
- /projects/astroid/astroid/nodes/node_classes.py:3459: Cannot find link target for "NotImplementedError"
+ /projects/astroid/astroid/nodes/node_classes.py:3457: Cannot find link target for "builtins.NotImplementedError", resolved from "NotImplementedError" (you can link to external docs with --intersphinx)
+ /projects/astroid/astroid/nodes/node_classes.py:3459: Cannot find link target for "builtins.NotImplementedError", resolved from "NotImplementedError" (you can link to external docs with --intersphinx)
- /projects/astroid/astroid/protocols.py:48: Cannot find link target for "NotImplemented"
+ /projects/astroid/astroid/protocols.py:48: Cannot find link target for "builtins.NotImplemented", resolved from "NotImplemented" (you can link to external docs with --intersphinx)
-     astroid.nodes.Dict._update_with_replacement
-     astroid.nodes.NodeNG.infer
-     astroid.nodes.NodeNG.inferred
+     astroid.nodes.node_classes.Dict._update_with_replacement
+     astroid.nodes.node_ng.NodeNG.infer
+     astroid.nodes.node_ng.NodeNG.inferred

pylint (https://github.com/pylint-dev/pylint)
- /projects/pylint/pylint/pyreverse/utils.py:239: bad docstring: Inline emphasis start-string without end-string.
- /projects/pylint/pylint/checkers/base/basic_checker.py:824: Cannot find link target for "reversed"
+ /projects/pylint/pylint/checkers/base/basic_checker.py:824: Cannot find link target for "builtins.reversed", resolved from "reversed" (you can link to external docs with --intersphinx)
+ /projects/pylint/pylint/checkers/classes/class_checker.py:451: Cannot find link target for "builtins.property", resolved from "property" (you can link to external docs with --intersphinx)
- /projects/pylint/pylint/checkers/classes/class_checker.py:451: Cannot find link target for "property"
- /projects/pylint/pylint/checkers/classes/class_checker.py:451: Cannot find link target for "property"
- /projects/pylint/pylint/checkers/classes/class_checker.py:451: Cannot find link target for "property"
- /projects/pylint/pylint/checkers/exceptions.py:361: Cannot find link target for "None"
+ /projects/pylint/pylint/checkers/exceptions.py:361: Cannot find link target for "builtins.None", resolved from "None" (you can link to external docs with --intersphinx)
- /projects/pylint/pylint/checkers/refactoring/implicit_booleaness_checker.py:353: Cannot find link target for "all"
- /projects/pylint/pylint/checkers/refactoring/implicit_booleaness_checker.py:353: Cannot find link target for "any"
- /projects/pylint/pylint/checkers/refactoring/implicit_booleaness_checker.py:354: Cannot find link target for "filter"
- /projects/pylint/pylint/checkers/refactoring/implicit_booleaness_checker.py:355: Cannot find link target for "bool"
+ /projects/pylint/pylint/checkers/refactoring/implicit_booleaness_checker.py:353: Cannot find link target for "builtins.all", resolved from "all" (you can link to external docs with --intersphinx)
+ /projects/pylint/pylint/checkers/refactoring/implicit_booleaness_checker.py:353: Cannot find link target for "builtins.any", resolved from "any" (you can link to external docs with --intersphinx)
+ /projects/pylint/pylint/checkers/refactoring/implicit_booleaness_checker.py:354: Cannot find link target for "builtins.filter", resolved from "filter" (you can link to external docs with --intersphinx)
+ /projects/pylint/pylint/checkers/refactoring/implicit_booleaness_checker.py:355: Cannot find link target for "builtins.bool", resolved from "bool" (you can link to external docs with --intersphinx)
- /projects/pylint/pylint/checkers/refactoring/refactoring_checker.py:1229: Cannot find link target for "nodes.Call" (you can link to external docs with --intersphinx)
+ /projects/pylint/pylint/checkers/refactoring/refactoring_checker.py:1229: Cannot find link target for "astroid.nodes.Call", resolved from "nodes.Call" (you can link to external docs with --intersphinx)
- /projects/pylint/pylint/checkers/refactoring/refactoring_checker.py:2429: Cannot find link target for "enumerate"
+ /projects/pylint/pylint/checkers/refactoring/refactoring_checker.py:2429: Cannot find link target for "builtins.enumerate", resolved from "enumerate" (you can link to external docs with --intersphinx)
- /projects/pylint/pylint/checkers/typecheck.py:2026: Cannot find link target for "type"
+ /projects/pylint/pylint/checkers/typecheck.py:2026: Cannot find link target for "builtins.type", resolved from "type" (you can link to external docs with --intersphinx)
- /projects/pylint/pylint/checkers/utils.py:2330: Cannot find link target for "True"
+ /projects/pylint/pylint/checkers/utils.py:2330: Cannot find link target for "pylint.checkers.utils.builtins.True", resolved from "True"
- /projects/pylint/pylint/checkers/utils.py:673: Cannot find link target for "None"
+ /projects/pylint/pylint/checkers/utils.py:673: Cannot find link target for "pylint.checkers.utils.builtins.None", resolved from "None"
- /projects/pylint/pylint/checkers/deprecated.py:190: Cannot find link target for "arg2"
- /projects/pylint/pylint/checkers/deprecated.py:190: Cannot find link target for "arg4"
- /projects/pylint/pylint/checkers/deprecated.py:103: Cannot find link target for "nodes.Call" (you can link to external docs with --intersphinx)
+ /projects/pylint/pylint/checkers/deprecated.py:103: Cannot find link target for "astroid.nodes.Call", resolved from "nodes.Call" (you can link to external docs with --intersphinx)
- these 29 objects' docstrings contain syntax errors:
+ these 30 objects' docstrings contain syntax errors:
-     pylint.checkers.BaseChecker.check_consistency
+     pylint.checkers.base_checker.BaseChecker.check_consistency
+     pylint.checkers.deprecated.DeprecatedMixin.deprecated_arguments
-     pylint.checkers.refactoring.RefactoringChecker._apply_boolean_simplification_rules
+     pylint.checkers.refactoring.refactoring_checker.RefactoringChecker._apply_boolean_simplification_rules
-     pylint.checkers.refactoring.RefactoringChecker._check_consider_using_join
+     pylint.checkers.refactoring.refactoring_checker.RefactoringChecker._check_consider_using_join
-     pylint.lint.PyLinter._check_file
+     pylint.lint.pylinter.PyLinter._check_file
-     pylint.lint.PyLinter._lint_file
+     pylint.lint.pylinter.PyLinter._lint_file
-     pylint.lint.PyLinter.load_plugin_configuration
+     pylint.lint.pylinter.PyLinter.load_plugin_configuration
-     pylint.testutils._get_tests_info
+     pylint.testutils.get_test_info._get_tests_info

coco (https://github.com/numbbo/coco)
- /projects/coco/code-postprocessing/cocopp/findfiles.py:8: bad docstring: No role entry for "file" in module "docutils.parsers.rst.languages.en".
- /projects/coco/code-postprocessing/cocopp/findfiles.py:8: bad docstring: Unknown interpreted text role "file".
- /projects/coco/code-postprocessing/cocopp/findfiles.py:56: bad docstring: No role entry for "file" in module "docutils.parsers.rst.languages.en".
- Trying "file" as canonical role name.
- /projects/coco/code-postprocessing/cocopp/findfiles.py:56: bad docstring: Unknown interpreted text role "file".

... (truncated 663 lines) ...```

Fix #295

96b9e05

tristanlatr commented Jul 11, 2023

View reviewed changes

tristanlatr added 11 commits July 11, 2023 17:40

Fix the _ReferenceTransform for annotations.

6550919

Also enamble msg(once=True) when using report().

Fix mypy

34e2c54

fix pyflakes

ef41a2f

fix ref

bd8af40

Fix issue regarding builtin names. Introduce the rawtarget attribute …

bd69087

…as well.

Fix big loop issue

0fd9982

Better test coverage for the linker

b84f24c

Introduce Class.parsed_bases, Function.parsed_decorators, Function.pa…

31144e5

…rsed_annotations, FunctionOverload.parsed_decorators, Attribute.parsed_decorators, Attribute.parsed_value. Fixes links in presentation of these components.

Add tests

e39b771

Fix mypy

f0f694d

fix static checks

dd2cf17

tristanlatr mentioned this pull request Jul 13, 2023

Rework reparenting and allobjects attribute #725

Closed

tristanlatr commented Jul 14, 2023

View reviewed changes

pydoctor/epydoc2stan.py Show resolved Hide resolved

tristanlatr commented Jul 14, 2023

View reviewed changes

tristanlatr mentioned this pull request Jul 14, 2023

Post processors priority #726

Merged

tristanlatr commented Jul 16, 2023

View reviewed changes

pydoctor/astbuilder.py Show resolved Hide resolved

tristanlatr commented Jul 16, 2023

View reviewed changes

pydoctor/epydoc/markup/_types.py Outdated Show resolved Hide resolved

tristanlatr mentioned this pull request Sep 28, 2023

Lookup of name in annotation fails on reparented object #295

Open

tristanlatr commented Sep 28, 2023

View reviewed changes

pydoctor/epydoc2stan.py Outdated Show resolved Hide resolved

tristanlatr mentioned this pull request Sep 30, 2023

Rework reparenting #737

Closed

tristanlatr commented Sep 30, 2023

View reviewed changes

Merge branch 'master' into 280-295-rework-names-in-type-annotations

6221144

This comment has been minimized.

Sign in to view

Merge branch 'master' into 280-295-rework-names-in-type-annotations

6626405

This comment has been minimized.

Sign in to view

tristanlatr mentioned this pull request Apr 3, 2024

Rework reparenting + pre process docstrings #773

Closed

Merge branch 'master' into 280-295-rework-names-in-type-annotations

52d550b

tristanlatr commented Jan 30, 2025

View reviewed changes

pydoctor/epydoc2stan.py Outdated Show resolved Hide resolved

This comment has been minimized.

Sign in to view

tristanlatr commented Jan 31, 2025

View reviewed changes

tristanlatr added the to revive label Jan 31, 2025

tristanlatr mentioned this pull request Feb 1, 2025

Implement ParsedTypeDocstring.to_node() #873

Closed

tristanlatr added 2 commits January 31, 2025 21:49

Stop warning about annotation, pydoctor is not a checker.

a1a72a7

Create an actual Reference object

972993d

This comment has been minimized.

Sign in to view

tristanlatr added a commit that referenced this pull request Feb 2, 2025

Fix #723 and #581

f06cd12

tristanlatr mentioned this pull request Feb 2, 2025

Refactor the the ParsedTypeDocstring #874

Merged

tristanlatr commented May 22, 2025

View reviewed changes

tristanlatr closed this in 1f146a9 May 22, 2025

tristanlatr reopened this Jun 28, 2025

Merge branch 'master' into 280-295-rework-names-in-type-annotations

74e8154

This comment has been minimized.

Sign in to view

tristanlatr commented Jul 19, 2025

View reviewed changes

tristanlatr added 3 commits July 19, 2025 18:28

Ensure the link not found warnings always show the text written in th…

1654b6d

…e code.

Preprocess modules to gather meta variables before any docstring pars…

066242c

…ing happens in order to be sure we're using the right docformat.

Add missing future import

784d069

This comment has been minimized.

Sign in to view

tristanlatr added 3 commits July 20, 2025 09:25

Ensure hidden objects doesn't gets their docstring parsed.

9674845

wip testing

792d278

Add another unfinished test

fa75e65

This comment has been minimized.

Sign in to view

		# transform bare builtin name into builtins.<name>
		attribs['refuri'] = '.'.join(('builtins', name, *rest))

		# some warnings can be reported more that once.
		thresh=thresh, once=True)

	# some warnings can be reported more that once.
	thresh=thresh, once=True)
	thresh=thresh)

		# Report eventual warnings. It warns when a regex failed to parse.
		reportWarnings(obj, doc.warnings, section='colorize constant')

	is_annotation = node.attributes.get('is_annotation')
	is_annotation = attribs.get('is_annotation')

Pre-process parsed docstrings to add hints on how to resolve names #723

Are you sure you want to change the base?

Pre-process parsed docstrings to add hints on how to resolve names #723

Uh oh!

Conversation

tristanlatr commented Jul 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Jul 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tristanlatr Sep 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

This comment has been minimized.

Uh oh!

This comment has been minimized.

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

Choose a reason for hiding this comment

Uh oh!

tristanlatr commented Jun 28, 2025

Uh oh!

This comment has been minimized.

tristanlatr left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

This comment has been minimized.

tristanlatr commented Jul 20, 2025

Uh oh!

This comment has been minimized.

github-actions bot commented Aug 7, 2025

Uh oh!

Uh oh!

tristanlatr commented Jul 11, 2023 •

edited

Loading

codecov bot commented Jul 11, 2023 •

edited

Loading

tristanlatr Sep 28, 2023 •

edited

Loading