Summary

Clean up the API extra data access hooks

Review Request #8084 — Created March 30, 2016 and submitted April 25, 2016, 11:21 a.m.

Information

Owner

brennie

Repository

Review Board

Branch

release-3.0.x

Bugs

Depends On

~~7674~~

Reviewers

Groups

reviewboard

People

Description

The APIExtraDataAccessHook has been rewritten to utilize registries
for registration and unregistration of callbacks. Tests have been
updated for these changes.

The documetnation has also been updated and reformatted for clarity.

Testing Done

Ran unit tests.

Issues

Description	From	Last Updated
The apostrophe in "field_set's" is incorrect.	david	April 4, 2016, 10:50 a.m.
Same here.	david	April 4, 2016, 10:50 a.m.
Col: 80 E501 line too long (86 > 79 characters)	reviewbot	March 30, 2016, 2:47 p.m.
Col: 80 E501 line too long (98 > 79 characters)	reviewbot	March 30, 2016, 2:47 p.m.
Description should be on the next line.	david	April 4, 2016, 10:51 a.m.
Can we say "GET" and "PUT" here and below?	david	April 4, 2016, 10:51 a.m.
Put this line back.	david	April 4, 2016, 10:52 a.m.
"extra_data key"	david	April 4, 2016, 10:52 a.m.
"extra_data key"	david	April 4, 2016, 10:52 a.m.
"extra_data key"	david	April 4, 2016, 10:52 a.m.
Can you indent this line one more level?	david	April 4, 2016, 10:53 a.m.
Description should be on the next line.	david	April 4, 2016, 10:54 a.m.
Can you indent this line one more level?	david	April 4, 2016, 10:54 a.m.
When it's just a single import, we do tend to use the continuation character rather than parens.	david	April 25, 2016, 11:20 a.m.

Tool: Pyflakes
Processed Files:
    reviewboard/webapi/base.py
    reviewboard/webapi/tests/mixins_extra_data.py
    reviewboard/extensions/hooks.py
    reviewboard/extensions/tests.py

Ignored Files:
    docs/manual/extending/extensions/hooks/index.rst
    docs/manual/extending/extensions/hooks/api-extra-data-access-hook.rst



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/webapi/base.py
    reviewboard/webapi/tests/mixins_extra_data.py
    reviewboard/extensions/hooks.py
    reviewboard/extensions/tests.py

Ignored Files:
    docs/manual/extending/extensions/hooks/index.rst
    docs/manual/extending/extensions/hooks/api-extra-data-access-hook.rst

reviewboard/extensions/hooks.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 80
 E501 line too long (86 > 79 characters)
```
reviewboard/extensions/hooks.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Col: 80
 E501 line too long (98 > 79 characters)
```

reviewboard/extensions/hooks.py (Diff revision 1)
The issue has been resolved. Show all issues
```
The apostrophe in "field_set's" is incorrect.
```
reviewboard/extensions/hooks.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Same here.
```
reviewboard/extensions/hooks.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Description should be on the next line.
```
reviewboard/extensions/tests.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Can we say "GET" and "PUT" here and below?
```
reviewboard/webapi/base.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Put this line back.
```
reviewboard/webapi/base.py (Diff revision 1)
The issue has been resolved. Show all issues
```
"extra_data key"
```
reviewboard/webapi/base.py (Diff revision 1)
The issue has been resolved. Show all issues
```
"extra_data key"
```
reviewboard/webapi/base.py (Diff revision 1)
The issue has been resolved. Show all issues
```
"extra_data key"
```
reviewboard/webapi/base.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Can you indent this line one more level?
```
1. brennie April 4, 2016, 10:55 a.m.
  This violates PEP8
reviewboard/webapi/base.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Description should be on the next line.
```
reviewboard/webapi/base.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Can you indent this line one more level?
```
1. brennie April 4, 2016, 10:55 a.m.
  This violates PEP8.

Change Summary:

Address David's issues

Diff:

Revision 2 (+145 -112)

Show changes

	docs/manual/extending/extensions/hooks/api-extra-data-access-hook.rst
	reviewboard/extensions/hooks.py
	reviewboard/extensions/tests.py
	reviewboard/webapi/base.py

Tool: Pyflakes
Processed Files:
    reviewboard/webapi/base.py
    reviewboard/extensions/hooks.py
    reviewboard/extensions/tests.py

Ignored Files:
    docs/manual/extending/extensions/hooks/api-extra-data-access-hook.rst



Tool: PEP8 Style Checker
Processed Files:
    reviewboard/webapi/base.py
    reviewboard/extensions/hooks.py
    reviewboard/extensions/tests.py

Ignored Files:
    docs/manual/extending/extensions/hooks/api-extra-data-access-hook.rst

Ship it!

docs/manual/extending/extensions/hooks/api-extra-data-access-hook.rst (Diff revision 2)
The issue has been resolved. Show all issues
```
When it's just a single import, we do tend to use the continuation character rather than parens.
```

Status: Closed (submitted)

Change Summary:

Pushed to feature/private-extra-data (f3af594)

reviewboard/webapi/base.py (Diff revision 1)

reviewboard/webapi/base.py (Diff revision 1)

reviewboard/webapi/base.py (Diff revision 1)

reviewboard/webapi/base.py (Diff revision 1)