Updated info plugin to exclude guessed venv paths

[kamilkrzyskow]

Hi 👋,
since the amount of cases with minimal reproduction containing an inactive Virtual Environment reached a comfortable threshold I decided to update it and detect/guess possible venv paths.

To guess the paths I use the pyvenv.cfg file, which is added in the default python -m venv call:

• https://github.com/python/cpython/blob/76dd0eee056fbb2a6dc5c3dbb52568ba61d04994/Lib/venv/__init__.py#L220

Perhaps other "venv" solutions don't do that, and a better alternative would be to use site-packages or look for "python" executables, but Linux might not use python but specifically some python3.12 name variant, so I picked the simplest solution for now with the pyvenv.cfg ✌️

9.6.14-guess.zip

$ mkdocs build
INFO    -  Started archive creation for bug report

Please name your bug report (2-4 words): guess
Possible inactive venv: C:\Users\...\material-info-venv-test\venv2
INFO    -  Archive successfully created:

  9.6.14-guess/docs/index.md 287.0 B
  9.6.14-guess/mkdocs.yml 61.0 B
  9.6.14-guess/platform.json 352.0 B
  9.6.14-guess/requirements.lock.txt 332.0 B

  9.6.14-guess.zip 1.6 kB

In the final platform.json I decided to hide the username as it's a potential breach of privacy, a bit late after months but better late than never ✌️
... - in this case I obfuscated the username in the text here, however it would display for the user in the terminal.

Additionally, I added the output of the VIRTUAL_ENV environmental variable to make sure we see the activated venv and don't have to guess based on the sys.path

Ref:

• [Bug]: Content tabs component rendering exception on narrow screen #8284 (comment)
• When the `nav` section is added to `mkdocs.yml`, the rendering of the `navigation.path` is broken #8198 (reply in thread)

[squidfunk]

Thanks for the PR. As always, I trust you on this one, since you're the one championing most of the improvements and bug fixes in the plugin. We can fast track this by our feature freeze, since it's not a feature.

[kamilkrzyskow]

Thanks, I did test on Windows and WSL, and it's working as I would expect. 🙂
It should work on macOS as well, but I didn't go the extra mile to test it on GitHub Actions this time around.

Minor bug was on WSL, with the username substitution, as WSL loads the name as lowercase and Windows itself uses uppercase for the directory. So I would have to replace it with regex to make it work in this scenario of mixed case between Windows and WSL, however I think that's a very rare scenario, so I didn't optimise for it. If somebody uses Docker with WSL they likely don't put files in any personal path either 🤔

[squidfunk]

Released as part of 9.6.15.