Summary

Update decorators to more correctly set function metadata.

Review Request #13378 — Created Oct. 25, 2023 and submitted Oct. 27, 2023, 3:18 p.m.

Information

Owner

chipx86

Repository

Djblets

Branch

release-3.x

Bugs

Depends On

Reviewers

Groups

djblets

People

Description

Our API decorators and @augment_method_from attempted to set their own

function metadata (__name__, __doc__, etc.), rather than utilizing

Python's @wraps/update_wrapper functions. This meant that we weren't

keeping up with all the latest attributes, such as __annotations__ and

__qualname__.
This change switches some of our decorators over to this. It also

simplifies @webapi_response_errors to not require an inner function

call, modifying state on the original function instead, reducing API

overhead.

Testing Done

Unit tests pass.
Verified I could access the original function state (__qualname__ in

particular) when working with these functions.

Commits

Summary	ID
Update decorators to more correctly set function metadata. Our API decorators and `@augment_method_from` attempted to set their own function metadata (`__name__`, `__doc__`, etc.), rather than utilizing Python's `@wraps`/`update_wrapper` functions. This meant that we weren't keeping up with all the latest attributes, such as `__annotations__` and `__qualname__`. This change switches some of our decorators over to this. It also simplifies `@webapi_response_errors` to not require an inner function call, modifying state on the original function instead, reducing API overhead.	4f22c3b380da164b586880263b4e5e46c34820ab

Summary

Update decorators to more correctly set function metadata.

Our API decorators and `@augment_method_from` attempted to set their own function metadata (`__name__`, `__doc__`, etc.), rather than utilizing Python's `@wraps`/`update_wrapper` functions. This meant that we weren't keeping up with all the latest attributes, such as `__annotations__` and `__qualname__`. This change switches some of our decorators over to this. It also simplifies `@webapi_response_errors` to not require an inner function call, modifying state on the original function instead, reducing API overhead.

4f22c3b380da164b586880263b4e5e46c34820ab

Issues

Description	From	Last Updated
'functools.wraps' imported but unused Column: 1 Error code: F401	reviewbot	Oct. 25, 2023, 9:17 p.m.

flake8 failed.

JSHint passed.

flake8

djblets/webapi/decorators.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'functools.wraps' imported but unused

Column: 1
Error code: F401
```

Change Summary:

Removed an unused import.

Commits:

	Summary	ID
	Update decorators to more correctly set function metadata. Our API decorators and `@augment_method_from` attempted to set their own function metadata (`__name__`, `__doc__`, etc.), rather than utilizing Python's `@wraps`/`update_wrapper` functions. This meant that we weren't keeping up with all the latest attributes, such as `__annotations__` and `__qualname__`. This change switches some of our decorators over to this. It also simplifies `@webapi_response_errors` to not require an inner function call, modifying state on the original function instead, reducing API overhead.	c006c2c7dac9ce4ae7aa7b5eb48805aa7ba20836
	Update decorators to more correctly set function metadata. Our API decorators and `@augment_method_from` attempted to set their own function metadata (`__name__`, `__doc__`, etc.), rather than utilizing Python's `@wraps`/`update_wrapper` functions. This meant that we weren't keeping up with all the latest attributes, such as `__annotations__` and `__qualname__`. This change switches some of our decorators over to this. It also simplifies `@webapi_response_errors` to not require an inner function call, modifying state on the original function instead, reducing API overhead.	4f22c3b380da164b586880263b4e5e46c34820ab