Make sure all deprecated items in importlib raise `DeprecationWarning` · Issue #121604 · python/cpython · GitHub

Linked PRs

I will try this one at europython :)

To add deprecation warnings to module-level constants like DEBUG_BYTECODE_SUFFIXES I think you can use something like this:

cpython/Lib/calendar.py

Lines 44 to 54 in 4e36dd7

    
           def __getattr__(name): 
        
               if name in ('January', 'February'): 
        
                   import warnings 
        
                   warnings.warn(f"The '{name}' attribute is deprecated, use '{name.upper()}' instead", 
        
                                 DeprecationWarning, stacklevel=2) 
        
                   if name == 'January': 
        
                       return 1 
        
                   else: 
        
                       return 2 
        
               raise AttributeError(f"module '{__name__}' has no attribute '{name}'")

@tomasr8 thanks, I've been looking at this exact file as a reference! Can you confirm which of the tasks are already done? For example in _abc.py, in the load_module() function I can already see a "# Warning implemented in _load_module_shim()." message.

Hi @brettcannon, I'm sitting at Europython sprints and working with @rashansmith. If you know if any of these have already been done, please let us know. Going to check the history :D

GH-121765 is a backport of this pull request to the 3.14 branch.

@brettcannon @willingc @tomasr8 I've created a PR for this issue. Please let me know if it looks good or any issues I should resolve. It is based on validating which deprecationwarnings have already been implemented from the list, and therefore working on the remainders:

importlib.abc.Loader
- importlib.abc.InspectLoader.load_module() - already done
- importlib.abc.FileLoader.load_module() - already done
- importlib.abc.SourceLoader.load_module() - already done
- importlib.machinery.SourceFileLoader.load_module() - already done
- imortlib.machinery.SourcelessFileLoader - PR
  importlib.abc.ResourceLoader PR
  importlib.abc.SourceLoader.path_mtime() PR
  importlib.machinery.DEBUG_BYTECODE_SUFFIXES PR
  importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES PR
  importlib.machinery.WindowsRegistryFinder PR
  debug_override parameter of importlib.util.cache_from_source() - already done

@willingc @rashansmith I made the list from the docs based on a comment on another issue that made it sound like SourceFileLoader.load_module() wasn't raising an exception. I had not taken the time to verify anything. So thanks to @rashansmith for checking! I'll update the list based on what you found.

Do we have it documented somewhere that importlib.abc.Loader is deprecated? The current importlib docs only say that importlib.abc.Loader.load_module is deprecated.

I don't think it is. At least there are no deprecation warnings in the code, just for load_module.

That's what I thought, but I was thinking maybe I missed something given the warnings that the linked MR is adding. I'll bring the conversation over there.

gh-121604: Make sure all deprecated items in importlib raise Deprecat…

gh-121604: fix ResourceLoader deprecation warning message (GH-128859)

gh-121604: fix warnings in test_importlib.test_abc and test_importlib…

All of the items mentioned in the issue now raise warnings, I think we can close this issue?

@brettcannon Since you opened the original issue, do you want to close this as completed? Thanks!

Thanks to everyone who worked on this (especially @tomasr8 for pushing it over the finish line)!

Make sure all deprecated items in importlib raise `DeprecationWarning` · Issue #121604 · python/cpython · GitHub

Repository navigation

Make sure all deprecated items in importlib raise DeprecationWarning #121604

Linked PRs

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

	def __getattr__(name):
	if name in ('January', 'February'):
	import warnings
	warnings.warn(f"The '{name}' attribute is deprecated, use '{name.upper()}' instead",
	DeprecationWarning, stacklevel=2)
	if name == 'January':
	return 1
	else:
	return 2

	raise AttributeError(f"module '{__name__}' has no attribute '{name}'")

Make sure all deprecated items in importlib raise `DeprecationWarning` · Issue #121604 · python/cpython · GitHub

Repository navigation

Make sure all deprecated items in importlib raise DeprecationWarning #121604

Description

Linked PRs

Activity

rashansmith commented on Jul 13, 2024

tomasr8 commented on Jul 13, 2024

rashansmith commented on Jul 13, 2024

willingc commented on Jul 13, 2024

bedevere-app commented on Jul 14, 2024

rashansmith commented on Jul 14, 2024

brettcannon commented on Jul 15, 2024

tungol commented on Dec 16, 2024

tomasr8 commented on Dec 16, 2024

tungol commented on Dec 16, 2024

tomasr8 commented on Feb 8, 2025

willingc commented on Feb 10, 2025

brettcannon commented on Feb 11, 2025

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions