DOC: fixes classes decorated with set_module not showing its source on numpy's documentation (numpy#28629) (numpy#28645)

aureliobarbosa · web-flow · commit e151f0daf611 · 2025-04-15T16:07:47.000-06:00
* DOC: store file with set_module in classes

avoid calling stdlib module inspect

TST: adds tests for set_module decorator

DOC: adds __file__ attribute to classes decorated with set_module

simplify set_module and change attribute name

DOC : sets __module_file__ when overriding a __module__ in classes

Specity Exceptions

fix lint error

* rename variable

* fix variable name

* fix path
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -507,8 +507,7 @@ def _get_c_source_file(obj):
         # todo: come up with a better way to generate these
         return None
 
-
-def linkcode_resolve(domain, info):
+def linkcode_resolve(domain, info):   
     """
     Determine the URL corresponding to Python object
     """
@@ -545,6 +544,11 @@ def linkcode_resolve(domain, info):
     if isinstance(obj, type) and obj.__module__ == 'numpy':
         fn = _get_c_source_file(obj)
 
+    # This can be removed when removing the decorator set_module. Fix issue #28629
+    if hasattr(obj, '_module_file'):
+        fn = obj._module_file
+        fn = relpath(fn, start=dirname(numpy.__file__))
+
     if fn is None:
         try:
             fn = inspect.getsourcefile(obj)
diff --git a/numpy/_utils/__init__.py b/numpy/_utils/__init__.py
@@ -9,6 +9,7 @@
 """
 
 import functools
+import sys
 import warnings
 from ._convertions import asunicode, asbytes
 
@@ -26,6 +27,12 @@ def example():
     """
     def decorator(func):
         if module is not None:
+            if isinstance(func, type):
+                try:
+                    func._module_file = sys.modules.get(func.__module__).__file__
+                except (AttributeError, KeyError):
+                    pass
+                
             func.__module__ = module
         return func
     return decorator
