Add documentation for cyclic-import

[Pierre-Sassoulas]

Type of Changes

	Type
✓	📜 Docs

Description

Work in progress for cyclic-import documentation. Right now it's not triggered. Refs #7897

[codecov]

Codecov Report

Merging #8322 (8e5f746) into main (81917bc) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #8322   +/-   ##
=======================================
  Coverage   95.84%   95.84%           
=======================================
  Files         173      173           
  Lines       18492    18492           
=======================================
  Hits        17724    17724           
  Misses        768      768           

[ollie-iterators]

I decided to check out your documentation for cyclic import. I was able to fix some things by adding import sys and then sys.path.append('...') (That fixed the relative-beyond-top-level error), but I keep getting an error saying that:

"/messages/c/cyclic-import/bad/bad2.py:2: in
from bad import count_to_one
doc/data/messages/c/cyclic-import/bad/bad.py:2: in
from bad2 import count_to_two # [cyclic-import]
E ImportError: cannot import name 'count_to_two' from partially initialized module 'bad2' (most likely due to a circular import)"

[Pierre-Sassoulas]

Ha right, cyclic-import is a python error we need to import inside the function in Bad.py. thank you for investigating

[ollie-iterators]

You're welcome

[ollie-iterators]

It also means you can document relative-beyond-top-level, which is not documented.

[Pierre-Sassoulas]

Seem like it work when using the parent directory. The recursive option does not help.

$ pylint /home/pierre/pylint/doc/data/messages/c/cyclic-import/bad --disable=all --enable=F,cyclic-import,astroid-error,syntax-error  
--------------------------------------------------------------------
Your code has been rated at 10.00/10 (previous run: 0.00/10, +10.00)

$  pylint /home/pierre/pylint/doc/data/messages/c/cyclic-import --disable=all --enable=F,cyclic-import,astroid-error,syntax-error 

************* Module bad.bad
doc/data/messages/c/cyclic-import/bad/bad.py:1:0: R0401: Cyclic import (bad.bad -> bad.bad2) (cyclic-import)
------------------------------------------------------------------
Your code has been rated at 9.29/10 (previous run: 8.57/10, +0.71)

[jacobtylerwalls]

Resolved this with an __init__.py to make /bad a package. Similar to #8772.

[Pierre-Sassoulas]

Thank you so much @jacobtylerwalls !