Summary

Add helpers for deprecating modules.

Review Request #13014 — Created May 4, 2023 and submitted May 12, 2023, 1:29 p.m.

Owner

Repository

housekeeping

Branch

master

Bugs

Depends On

Groups

People

Description

This introduces two new functions for deprecating modules:
module_deprecated() and module_moved().

module_deprecated() can be called in the body of a module to emit a
deprecation warning when the module is imported.

module_moved() is similar, but takes a destination module, and points
consumers to that module in the deprecation message.

Testing Done

Unit tests pass on all supported versions of Python.

Commits

Summary	ID
Add helpers for deprecating modules. This introduces two new functions for deprecating modules: `module_deprecated()` and `module_moved()`. `module_deprecated()` can be called in the body of a module to emit a deprecation warning when the module is imported. `module_moved()` is similar, but takes a destination module, and points consumers to that module in the deprecation message.	37c3603b44686de183e4cb1356375c4adf762940

flake8 passed.

JSHint passed.

Change Summary:

Updated to use standard display formatting, new unit test helpers, and stack levels.

Commits:

	Summary	ID
	Add helpers for deprecating modules. This introduces two new functions for deprecating modules: `module_deprecated()` and `module_moved()`. `module_deprecated()` can be called in the body of a module to emit a deprecation warning when the module is imported. `module_moved()` is similar, but takes a destination module, and points consumers to that module in the deprecation message.	8ef8231c19abf5928b525c164ce5451751a28115
	Add helpers for deprecating modules. This introduces two new functions for deprecating modules: `module_deprecated()` and `module_moved()`. `module_deprecated()` can be called in the body of a module to emit a deprecation warning when the module is imported. `module_moved()` is similar, but takes a destination module, and points consumers to that module in the deprecation message.	37c3603b44686de183e4cb1356375c4adf762940

Diff:

	README.md
	housekeeping/__init__.py
	housekeeping/modules.py
	housekeeping/tests/test_modules.py

flake8 passed.

JSHint passed.

Ship it!