Why does Visual Studio Code/Python not show the docstring for functions from my PyPI package?

Question

I have recently created my own PyPI package with a bunch of useful functions. It works great, and when I import it in any project, the functions work, but my Visual Studio Code doesn't show the docstrings when I hover over the functions, and the functions stay white.

Are there Python Visual Studio Code settings I need to change or things I need to change in my PyPI package?

The GitHub place for jeffutils.

I have tried setting the "python.analysis.packageIndexDepths" depth for "jeffutils" to 4, and I added from .utils import * into the __init__.py file in the package.

Other than that, I am kind of lost, since Pylance and the Python interpreter will pop up docstrings for all of the other pip-installed packages I have.

Can't reproduce. Try using another machine (e.g. a GitHub codespace), then compare that with your current environment. — InSync
– InSync, Commented Jun 3, 2024 at 20:20
@InSync I appreciate that advice. In GitHub codespace, it pops up everything like normal. What things can I do to look at the codespace environment and compare it with mine? — Jeff Hansen
– Jeff Hansen, Commented Jun 4, 2024 at 14:46
Try turning on settings sync and start from there. Other than that, I have no idea. — InSync
– InSync, Commented Jun 4, 2024 at 14:50
@InSync Thanks for your help! Going through item by item and making sure Python and Pylance settings matched seemed to fix it! — Jeff Hansen
– Jeff Hansen, Commented Jun 4, 2024 at 15:05

Peter Mortensen · Accepted Answer · 2024-06-04 15:29:10Z

1

Following InSync's advice, I compared my Pylance and Python extensions settings with the settings in GitHub Codespaces.

I made sure everything matched up the same. The things I recall changing was getting rid of my Python → Analysis:Extra Paths (I had paths to a couple of Python binary files on my CPU), and then pip uninstalling and reinstalling the jeffutils package.

I wish I knew what fixed the problem, but following InSync's advice worked!

edited Jun 4, 2024 at 15:29

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered Jun 4, 2024 at 15:02

Jeff Hansen

1071 silver badge8 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Why does Visual Studio Code/Python not show the docstring for functions from my PyPI package?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related