Cannot find reference 'v4' in '__init__.py' ? :/

[stdedos]

I'm trying to add some type hints to my functions, e.g. project: gitlab.v4.objects.Project.

However, I am getting this pesky warning from IDEA:

Am I doing something wrong? 😓 What am I missing?

[nejch]

This would be perfectly fine for mypy. I guess you're hitting a pycharm/IDEA bug where it expects that package exposed via __all__:

https://stackoverflow.com/questions/23248017/cannot-find-reference-xxx-in-init-py

You can probably work around it by importing it directly. Dummy code:

from gitlab.v4.objects import Project

def get_project(project: Project) -> None
    pass

[stdedos]

I wanted to avoid from gitlab.v4.objects import Project, because then, I had to import everything:

Project, jobs.ProjectJob, ProjectMergeRequest, etc

And doing from gitlab.v4 import objects sounds ... atrocious (seeing it randomly in the code, would make me ask "object.? What "object"??"

But I solved my problem with from gitlab.v4 import objects as gobjects

Thank you for the suggestion / digging 🙃

[nejch]

Glad you got it to work! Yes, the exact level at which you import is up to you, as long as you trick your IDE's type checker around the __all__ bug. 🙂

[stdedos]

... truth be told though, it's impossible to write:

$ ipython
Python 3.9.18 (main, Aug 25 2023, 13:20:04) 
Type 'copyright', 'credits' or 'license' for more information
IPython 8.14.0 -- An enhanced Interactive Python. Type '?' for help.

*** `ipython-autoimport` not found ***

In [1]: import gitlab.v4.objects.Project
---------------------------------------------------------------------------
ModuleNotFoundError                       Traceback (most recent call last)
Cell In[1], line 1
----> 1 import gitlab.v4.objects.Project

ModuleNotFoundError: No module named 'gitlab.v4.objects.Project'

In [2]: import gitlab.v4.objects.projects.Project
---------------------------------------------------------------------------
ModuleNotFoundError                       Traceback (most recent call last)
Cell In[2], line 1
----> 1 import gitlab.v4.objects.projects.Project

ModuleNotFoundError: No module named 'gitlab.v4.objects.projects.Project'; 'gitlab.v4.objects.projects' is not a package

In [3]: import gitlab.v4.objects.Project
---------------------------------------------------------------------------
ModuleNotFoundError                       Traceback (most recent call last)
Cell In[3], line 1
----> 1 import gitlab.v4.objects.Project

ModuleNotFoundError: No module named 'gitlab.v4.objects.Project'

In [4]: import gitlab.objects.Project
---------------------------------------------------------------------------
ModuleNotFoundError                       Traceback (most recent call last)
Cell In[4], line 1
----> 1 import gitlab.objects.Project

ModuleNotFoundError: No module named 'gitlab.objects'

In [5]: import gitlab.Project
---------------------------------------------------------------------------
ModuleNotFoundError                       Traceback (most recent call last)
Cell In[5], line 1
----> 1 import gitlab.Project

ModuleNotFoundError: No module named 'gitlab.Project'

In [6]: import gitlab

In [7]: import gitlab.v4.objects.Project
---------------------------------------------------------------------------
ModuleNotFoundError                       Traceback (most recent call last)
Cell In[7], line 1
----> 1 import gitlab.v4.objects.Project

ModuleNotFoundError: No module named 'gitlab.v4.objects.Project'

In [8]: import gitlab.v4.objects.projects.
  Cell In[8], line 1
    import gitlab.v4.objects.projects.
                                      ^
SyntaxError: invalid syntax


In [9]: import gitlab.v4.objects.projects

In [10]: import gitlab.v4.objects.projects.Project
---------------------------------------------------------------------------
ModuleNotFoundError                       Traceback (most recent call last)
Cell In[10], line 1
----> 1 import gitlab.v4.objects.projects.Project

ModuleNotFoundError: No module named 'gitlab.v4.objects.projects.Project'; 'gitlab.v4.objects.projects' is not a package

In [11]: 

I am very much missing the point in Python imports, namespaces, and packaging though, so - I could very well be wrong.

[nejch]

You might be mixing up class import (from abc import xyz) with module/package imports (import abc). It's up to you how you want to import them but you should use the right way to access them then - don't try to import a class without a from syntax.

>>> import gitlab.v4.objects
>>> gitlab.v4.objects.Project
<class 'gitlab.v4.objects.projects.Project'>

>>> import gitlab.v4.objects.projects
>>> gitlab.v4.objects.projects.Project
<class 'gitlab.v4.objects.projects.Project'>

>>> from gitlab.v4.objects import Project
>>> Project
<class 'gitlab.v4.objects.projects.Project'>