`inspect.formatannotationrelativeto` is not tested

[sobolevn]

cpython/Lib/inspect.py

Lines 1354 to 1358 in d6d0548

	def formatannotationrelativeto(object):
	module = getattr(object, '__module__', None)
	def _formatannotation(annotation):
	return formatannotation(annotation, module)
	return _formatannotation

It is completely untested and unused in CPython's code base:

I will send a PR with some tests.

Linked PRs

• gh-138729: Cover inspect.formatannotationrelativeto with tests #138730
• [3.14] gh-138729: Cover inspect.formatannotationrelativeto with tests (GH-138730) #138747
• [3.13] gh-138729: Cover inspect.formatannotationrelativeto with tests (GH-138730) #138748

[serhiy-storchaka]

Should not it be removed then?

[sobolevn]

We can't remove it, is a public name defined in __all__. We can deprecate it. But, to do so I need to inspect if it is actually used somewhere in other packages.

[serhiy-storchaka]

formatannotation and formatannotationrelativeto are not documented and poorly tested. formatannotation is only used internally in formatting Parameter and Signature. I wonder if they should be in the public API. The base_module argument is never passed.

It seems that after adding more comprehensive tests we will need to fix formatannotation to make its results more consistent.