Summary

Allow specifying a function name for spying on bad decorators.

Review Request #11932 — Created Jan. 18, 2022 and submitted Jan. 20, 2022, 2:57 p.m.

Information

Owner

chipx86

Repository

kgb

Branch

master

Bugs

Depends On

Reviewers

Groups

kgb

People

Description

If a decorator fails to copy over the function name from the wrapped

function, spying on the decorator can fail, due to the inability to

locate the correct function for the slippery function check.
This situation is now detected and a warning logged. It advises using

a new parameter, func_name=, which enables a spy to specify an

explicit function name. This is rarely needed, but useful when

encountering this sort of situation.

Testing Done

All unit tests pass on all supported versions of Python.

Commits

Summary	ID
Allow specifying a function name for spying on bad decorators. If a decorator fails to copy over the function name from the wrapped function, spying on the decorator can fail, due to the inability to locate the correct function for the slippery function check. This situation is now detected and a warning logged. It advises using a new parameter, `func_name=`, which enables a spy to specify an explicit function name. This is rarely needed, but useful when encountering this sort of situation.	073fbce725224d8948e4a627f4a194987deb9d83

Summary

Allow specifying a function name for spying on bad decorators.

If a decorator fails to copy over the function name from the wrapped function, spying on the decorator can fail, due to the inability to locate the correct function for the slippery function check. This situation is now detected and a warning logged. It advises using a new parameter, `func_name=`, which enables a spy to specify an explicit function name. This is rarely needed, but useful when encountering this sort of situation.

073fbce725224d8948e4a627f4a194987deb9d83

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Change Summary:

Updated the version numbers in the docstrings from 6.2 to 7.0.

Commits:

	Summary	ID
	Allow specifying a function name for spying on bad decorators. If a decorator fails to copy over the function name from the wrapped function, spying on the decorator can fail, due to the inability to locate the correct function for the slippery function check. This situation is now detected and a warning logged. It advises using a new parameter, `func_name=`, which enables a spy to specify an explicit function name. This is rarely needed, but useful when encountering this sort of situation.	f45ed994d06107e38186d69120a5c6671ee5dda7
	Allow specifying a function name for spying on bad decorators. If a decorator fails to copy over the function name from the wrapped function, spying on the decorator can fail, due to the inability to locate the correct function for the slippery function check. This situation is now detected and a warning logged. It advises using a new parameter, `func_name=`, which enables a spy to specify an explicit function name. This is rarely needed, but useful when encountering this sort of situation.	073fbce725224d8948e4a627f4a194987deb9d83

Diff:

Revision 2 (+252 -20)

Show changes

	kgb/signature.py
	kgb/spies.py
	kgb/tests/py3/test_function_spy.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to master (8c2008e)