Avoid forgetting about stacklevel in warnings (#2594)

Author: Avasam

CHANGES.txt

@@ -13,6 +13,7 @@ https://mhammond.github.io/pywin32_installers.html .
 
 Coming in build 311, as yet unreleased
 --------------------------------------
+* pywin32's own warnings will now refer to the caller, rather than to the internal source of warning itself (#2594, @Avasam)
 * Fixed a regression that broke special __dunder__ methods with CoClass. (#1870, #2493, @Avasam, @geppi)
 * Fixed `TypeError: cannot unpack non-iterable NoneType object` when registering an axscript client ScriptItem (#2513, @Avasam)
 * Fixed a memory leak when SafeArrays are used as out parameters (@the-snork)

Pythonwin/pywin/framework/app.py

@@ -354,7 +354,9 @@ def OnInitDialog(self):
         except OSError:
             ver = None
         if not ver:
-            warnings.warn(f"Could not read pywin32's version from '{version_path}'")
+            warnings.warn(
+                f"Could not read pywin32's version from '{version_path}'", stacklevel=1
+            )
         self.SetDlgItemText(win32ui.IDC_ABOUT_VERSION, ver)
         self.HookCommand(self.OnButHomePage, win32ui.IDC_BUTTON1)
 

Pythonwin/pywin/framework/dbgcommands.py

@@ -105,7 +105,9 @@ def OnAdd(self, msg, code):
             ## for the toolbar button IDC_DBG_ADD fails, since MFC falls back to
             ## sending a normal command if the UI update command fails.
             ## win32ui.MessageBox('There is no active window - no breakpoint can be added')
-            warnings.warn("There is no active window - no breakpoint can be added")
+            warnings.warn(
+                "There is no active window - no breakpoint can be added", stacklevel=1
+            )
             return None
         pathName = doc.GetPathName()
         lineNo = view.LineFromChar(view.GetSel()[0]) + 1

adodbapi/adodbapi.py

@@ -52,7 +52,7 @@
 except ImportError:
     import warnings
 
-    warnings.warn("pywin32 package required for adodbapi.", ImportWarning)
+    warnings.warn("pywin32 package required for adodbapi.", ImportWarning, stacklevel=2)
 
 
 def getIndexedValue(obj, index):

com/win32comext/axscript/client/error.py

@@ -101,6 +101,7 @@ def __init__(
             warnings.warn(
                 "`exc_type` and `exc_traceback` were redundant and are now unused.",
                 category=DeprecationWarning,
+                stacklevel=2,
             )
 
         # And my other values...

ruff.toml

@@ -7,6 +7,7 @@ line-ending = "cr-lf"
 
 [lint]
 select = [
+  "B028", # no-explicit-stacklevel
   "C4", # flake8-comprehensions
   "F811", # redefined-while-unused
   "I", # isort

win32/Lib/afxres.py

@@ -5,4 +5,5 @@
 warnings.warn(
     "Importing the global `afxres` module is deprecated. Import from `pywin.mfc.afxres` instead.",
     category=DeprecationWarning,
+    stacklevel=2,
 )

win32/Lib/regcheck.py

@@ -6,6 +6,7 @@
 warnings.warn(
     "The regcheck module has been deprecated and pending removal since build 210",
     category=DeprecationWarning,
+    stacklevel=2,
 )
 
 import os

win32/Lib/win2kras.py

@@ -11,4 +11,4 @@
 
 from win32ras import *  # nopycln: import
 
-warnings.warn(str(__doc__), category=DeprecationWarning)
+warnings.warn(str(__doc__), category=DeprecationWarning, stacklevel=2)

win32/Lib/win32serviceutil.py

@@ -261,7 +261,9 @@ def InstallService(
                 )
             except (win32service.error, NotImplementedError):
                 ## delayed start only exists on Vista and later - warn only when trying to set delayed to True
-                warnings.warn("Delayed Start not available on this system")
+                warnings.warn(
+                    "Delayed Start not available on this system", stacklevel=2
+                )
         win32service.CloseServiceHandle(hs)
     finally:
         win32service.CloseServiceHandle(hscm)
@@ -345,7 +347,9 @@ def ChangeServiceConfig(
                     ## doensn't exist.  On Win2k and XP, will fail with ERROR_INVALID_LEVEL
                     ## Warn only if trying to set delayed to True
                     if delayedstart:
-                        warnings.warn("Delayed Start not available on this system")
+                        warnings.warn(
+                            "Delayed Start not available on this system", stacklevel=2
+                        )
         finally:
             win32service.CloseServiceHandle(hs)
     finally: