Summary:

Add helpers for deprecating functions, arguments, and values.

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

Information
Owner:	chipx86
Repository:	housekeeping
Branch:	master
Bugs:
Depends On:	~~13011~~
Reviewers
Groups:	beanbag-misc
People:

Description

This introduces four functions for helping deprecate function-related

code:


@deprecate_non_keyword_only_args takes a function with keyword-only

  arguments and allows them to be called with positional arguments while

  emitting a deprecation warning. This is a port of the code used in

  RBTools and Djblets today.


@func_deprecated takes a function and emits a deprecation warning

  when called.


@func_moved takes a function and emits a deprecation warning

  when called, pointing to a new function elsewhere.


deprecated_arg_value wraps a value and emits a deprecation warning

  if it's used in any way. It's useful for passing old arguments to

  callbacks. This is a port of the code used in Djblets today.


Unit tests have been added for all of these functions.

Testing Done

All unit tests pass for all supported versions of Python.

Viewed the README in a GitHub-compatible Markdown viewer.

Commits

Summary
	Add helpers for deprecating functions, arguments, and values.

Screenshots

Issues

Description	From	Last Updated
'warnings' imported but unused Column: 1 Error code: F401	reviewbot	May 4, 2023, 4:07 p.m.
'typing.Type' imported but unused Column: 1 Error code: F401	reviewbot	May 4, 2023, 4:07 p.m.
line too long (80 > 79 characters) Column: 80 Error code: E501	reviewbot	May 4, 2023, 4:07 p.m.
'typing.Optional' imported but unused Column: 1 Error code: F401	reviewbot	May 4, 2023, 4:07 p.m.
'housekeeping.base.DEFAULT_STACK_LEVEL' imported but unused Column: 1 Error code: F401	reviewbot	May 4, 2023, 4:07 p.m.
'inspect' imported but unused Column: 1 Error code: F401	reviewbot	May 4, 2023, 10:17 p.m.

flake8 failed.

JSHint passed.

flake8

housekeeping/functions.py (Diff revision 1)

Show all issues

'warnings' imported but unused

Column: 1
Error code: F401

housekeeping/functions.py (Diff revision 1)

Show all issues

'typing.Type' imported but unused

Column: 1
Error code: F401

housekeeping/functions.py (Diff revision 1)

Show all issues

line too long (80 > 79 characters)

Column: 80
Error code: E501

housekeeping/helpers.py (Diff revision 1)

Show all issues

'typing.Optional' imported but unused

Column: 1
Error code: F401

housekeeping/helpers.py (Diff revision 1)

Show all issues

'housekeeping.base.DEFAULT_STACK_LEVEL' imported but unused

Column: 1
Error code: F401

Change Summary:


Removed unused imports.
Fixed a line length issue.

Commits:

	Summary
-		Add helpers for deprecating functions, arguments, and values.
+		Add helpers for deprecating functions, arguments, and values.

Diff:

Revision 2 (+2508)

Show changes

	README.md
	housekeeping/__init__.py
	housekeeping/functions.py
	housekeeping/helpers.py
	housekeeping/tests/__init__.py
	housekeeping/tests/test_functions.py
	housekeeping/tests/testcases.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:


Added a helper for standardizing formatting of class and function names.
Fixed decorators to preserve state like names and docs.
Removed the func_moved() assignment form from docs, since we can't get the name.
Standardized some function arguments.
Added stack level arguments to everything, adjusting it for the internal functions to ensure proper stack levels.
Added testing of stack levels as a standard part of all warning checks.

Commits:

	Summary
-		Add helpers for deprecating functions, arguments, and values.
+		Add helpers for deprecating functions, arguments, and values.

Diff:

Revision 3 (+2786)

Show changes

	README.md
	housekeeping/__init__.py
	housekeeping/functions.py
	housekeeping/helpers.py
	housekeeping/tests/__init__.py
	housekeeping/tests/test_functions.py
	housekeeping/tests/testcases.py

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

housekeeping/tests/testcases.py (Diff revision 3)

Show all issues

'inspect' imported but unused

Column: 1
Error code: F401

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to master (f1e1b7f), master (1b18522)