Summary

Add a decorator for migrating to functions with keyword-only arguments.

Review Request #12555 — Created Aug. 19, 2022 and submitted Sept. 5, 2022, 2:01 p.m.

Information

Owner

chipx86

Repository

RBTools

Branch

release-4.x

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

Python 3 allows us to define keyword-only arguments, which can help us
clean things up, but as we aim to provide backwards-compatibility during
deprecation phases, we can't just simply use them.

This change introduces a decorator to help with this.

rbtools.deprecation.deprecate_non_keyword_only_args() can be used for
any function taking keyword-only arguments. Any call that supplies such
an argument via a positional argument value will trigger a deprecation
warning. The arguments will then be rewritten to pass those in as
keyword arguments.

We'll want this pattern for other codebases in time. Unfortunately, no
other packages we depend on provide a decorator like this, so we'll need
to maintain it ourselves. (Packages like debtcollector do not provide
anything for this.). For now, it will remain in RBTools.

Testing Done

Decorated some functions and tested calls with and without using
keyword arguments for the values. Verified the warnings only appeared
when passing values as positional arguments.

Verified that the warning's stack trace had the right stack level,
showing the call to the function.

Unit tests pass on Python 3.7-3.11.

Commits

Summary	ID
Add a decorator for migrating to functions with keyword-only arguments. The RBTools codebase is old, and we have a lot of code that doesn't quite follow best practices. These include functions that take a whole lot of keyword arguments, but with calls passing as positional arguments instead. Python 3 allows us to define keyword-only arguments, which can help us clean things up, but as we aim to provide backwards-compatibility during deprecation phases, we can't just simply use them. This change introduces a decorator to help with this. `rbtools.deprecation.deprecate_non_keyword_only_args()` can be used for any function taking keyword-only arguments. Any call that supplies such an argument via a positional argument value will trigger a deprecation warning. The arguments will then be rewritten to pass those in as keyword arguments. We'll want this pattern for other codebases in time. Unfortunately, no other packages we depend on provide a decorator like this, so we'll need to maintain it ourselves. (Packages like `debtcollector` do not provide anything for this.)	533994de031c53efcde528b5b5777c26534cc62f

Summary

Add a decorator for migrating to functions with keyword-only arguments.

The RBTools codebase is old, and we have a lot of code that doesn't quite follow best practices. These include functions that take a whole lot of keyword arguments, but with calls passing as positional arguments instead. Python 3 allows us to define keyword-only arguments, which can help us clean things up, but as we aim to provide backwards-compatibility during deprecation phases, we can't just simply use them. This change introduces a decorator to help with this. `rbtools.deprecation.deprecate_non_keyword_only_args()` can be used for any function taking keyword-only arguments. Any call that supplies such an argument via a positional argument value will trigger a deprecation warning. The arguments will then be rewritten to pass those in as keyword arguments. We'll want this pattern for other codebases in time. Unfortunately, no other packages we depend on provide a decorator like this, so we'll need to maintain it ourselves. (Packages like `debtcollector` do not provide anything for this.)

533994de031c53efcde528b5b5777c26534cc62f

Issues

Description	From	Last Updated
'itertools.islice' imported but unused Column: 1 Error code: F401	reviewbot	Aug. 19, 2022, 8:22 p.m.
'typing_extensions.Concatenate' imported but unused Column: 1 Error code: F401	reviewbot	Aug. 19, 2022, 8:22 p.m.
'typing_extensions.ParamSpecArgs' imported but unused Column: 1 Error code: F401	reviewbot	Aug. 19, 2022, 8:22 p.m.
'typing_extensions.ParamSpec' imported but unused Column: 1 Error code: F401	reviewbot	Aug. 19, 2022, 8:22 p.m.
'typing_extensions.ParamSpecKwargs' imported but unused Column: 1 Error code: F401	reviewbot	Aug. 19, 2022, 8:22 p.m.

flake8 failed.

JSHint passed.

flake8

rbtools/deprecation.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'itertools.islice' imported but unused

Column: 1
Error code: F401
```

rbtools/deprecation.py (Diff revision 1)

The issue has been resolved. Show all issues

'typing_extensions.Concatenate' imported but unused

Column: 1
Error code: F401

rbtools/deprecation.py (Diff revision 1)

The issue has been resolved. Show all issues

'typing_extensions.ParamSpecArgs' imported but unused

Column: 1
Error code: F401

rbtools/deprecation.py (Diff revision 1)

The issue has been resolved. Show all issues

'typing_extensions.ParamSpec' imported but unused

Column: 1
Error code: F401

rbtools/deprecation.py (Diff revision 1)

The issue has been resolved. Show all issues

'typing_extensions.ParamSpecKwargs' imported but unused

Column: 1
Error code: F401

Change Summary:

Removed unused imports.

Commits:

	Summary	ID
	Add a decorator for migrating to functions with keyword-only arguments. The RBTools codebase is old, and we have a lot of code that doesn't quite follow best practices. These include functions that take a whole lot of keyword arguments, but with calls passing as positional arguments instead. Python 3 allows us to define keyword-only arguments, which can help us clean things up, but as we aim to provide backwards-compatibility during deprecation phases, we can't just simply use them. This change introduces a decorator to help with this. `rbtools.deprecation.deprecate_non_keyword_only_args()` can be used for any function taking keyword-only arguments. Any call that supplies such an argument via a positional argument value will trigger a deprecation warning. The arguments will then be rewritten to pass those in as keyword arguments. We'll want this pattern for other codebases in time. Unfortunately, no other packages we depend on provide a decorator like this, so we'll need to maintain it ourselves. (Packages like `debtcollector` do not provide anything for this.)	ae589b14767e7bc364f77d9260898cbea6b5ecae
	Add a decorator for migrating to functions with keyword-only arguments. The RBTools codebase is old, and we have a lot of code that doesn't quite follow best practices. These include functions that take a whole lot of keyword arguments, but with calls passing as positional arguments instead. Python 3 allows us to define keyword-only arguments, which can help us clean things up, but as we aim to provide backwards-compatibility during deprecation phases, we can't just simply use them. This change introduces a decorator to help with this. `rbtools.deprecation.deprecate_non_keyword_only_args()` can be used for any function taking keyword-only arguments. Any call that supplies such an argument via a positional argument value will trigger a deprecation warning. The arguments will then be rewritten to pass those in as keyword arguments. We'll want this pattern for other codebases in time. Unfortunately, no other packages we depend on provide a decorator like this, so we'll need to maintain it ourselves. (Packages like `debtcollector` do not provide anything for this.)	533994de031c53efcde528b5b5777c26534cc62f

Diff:

Revision 2 (+444 -4)

Show changes

rbtools/deprecation.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-4.x (88f0504)