Codecov Report

Merging#1882 (6ca9aa2) intomain (4cb7d92) willincrease coverage by0.02%.
The diff coverage is100.00%.

@@            Coverage Diff             @@##             main    #1882      +/-   ##==========================================+ Coverage   92.50%   92.52%   +0.02%==========================================  Files          78       78                Lines        4871     4885      +14     ==========================================+ Hits         4506     4520      +14  Misses        365      365

Flags with carried forward coverage won't be shown.Click here to find out more.

Test script:

$ cat show-warning.py#!/usr/bin/python3 -ttuimport gitlabx = gitlab.OWNER_ACCESS

With this PR, warning shows against the script:

/home/python-gitlab/./show-warning.py:4: DeprecationWarning:Direct access to 'gitlab.OWNER_ACCESS' is deprecated and will be removed in a future major python-gitlab release. Please use 'gitlab.const.OWNER_ACCESS' instead. (python-gitlab: /home/python-gitlab/gitlab/__init__.py:44)  x = gitlab.OWNER_ACCESS

Without this PR, warning shows againstgitlab/__init__.py:

/home/python-gitlab/gitlab/__init__.py:43:DeprecationWarning:Directaccessto'gitlab.OWNER_ACCESS'isdeprecatedandwillberemovedinafuturemajorpython-gitlabrelease.Pleaseuse'gitlab.const.OWNER_ACCESS'instead.warnings.warn(

Also tested the REPL with the PR:

$ pythonPython 3.10.2 (main, Jan 17 2022, 00:00:00) [GCC 11.2.1 20211203 (Red Hat 11.2.1-7)] on linuxType "help", "copyright", "credits" or "license" for more information.>>> import gitlab>>> x = gitlab.OWNER_ACCESS<stdin>:1: DeprecationWarning:Direct access to 'gitlab.OWNER_ACCESS' is deprecated and will be removed in a future major python-gitlab release. Please use 'gitlab.const.OWNER_ACCESS' instead.>>>

Thanks@JohnVillalovos. If I understand correctly you want to show the caller and not the source in our library when showing warnings. Wouldn't this achieve the goal without custom wrappers?

warnings.warn(f"\nDirect access to 'gitlab.{name}' is deprecated and will be "f"removed in a future major python-gitlab release. Please "f"use 'gitlab.const.{name}' instead.",DeprecationWarning,stacklevel=2,        )

Let me know if that works.

Thanks@JohnVillalovos. If I understand correctly you want to show the caller and not the source in our library when showing warnings. Wouldn't this achieve the goal without custom wrappers?

warnings.warn(f"\nDirect access to 'gitlab.{name}' is deprecated and will be "f"removed in a future major python-gitlab release. Please "f"use 'gitlab.const.{name}' instead.",DeprecationWarning,stacklevel=2,        )

Let me know if that works.

It works but have to determine whatstacklevel is for each function. And if somehow the function got moved it would change where in the stack it is and then need to update that value. That is why I went with the wrapper which determines it automatically. I figure better to let the computer keep track of it than us manually doing it.

Some of these requirestacklevel=2 and some requirestacklevel=3.

It works but have to determine whatstacklevel is for each function. And if somehow the function got moved it would change where in the stack it is and then need to update that value. That is why I went with the wrapper which determines it automatically. I figure better to let the computer keep track of it than us manually doing it.

Some of these requirestacklevel=2 and some requirestacklevel=3.

Ahh I see, ok, that wasn't clear to me at first glance. I was hoping it was a simpler one-time thing and we'd avoid having a heated debate about required keyword-only arguments but now we'll have to have it 😅