Summary

Split djblets.webapi.resources into sub-modules.

Review Request #7472 — Created July 1, 2015 and submitted July 2, 2015, 5:27 p.m.

Information

Owner

chipx86

Repository

Djblets

Branch

release-0.9.x

Bugs

Depends On

Commit

e2416b7...

Reviewers

Groups

djblets

People

Description

This is the second part of the djblets.webapi cleanup. This change takes
djblets.webapi.resources, which contained WebAPIResource, UserResource,
GroupResource, RootResource, and all the resource registration
functions, and moves them out into new submodules.

This will make it easier to bundle and maintain new built-in resources
for different purposes, and to keep the code more organized.

The old djblets.webapi.resources still works. It imports all the
original classes/functions, and triggers a deprecation warning when
imported.

Docstrings have been updated for most of this to conform with the new
codebase docs format we're using, but I didn't do this everywhere.
WebAPIResource is largely untouched, except for formatting errors for
lists.

Testing Done

Unit tests pass on both Djblets and Review Board.

Built the docs and looked through them. Not everything is perfect, but
all the new/fixed content looks correct.

Issues

Description	From	Last Updated
Col: 47 E128 continuation line under-indented for visual indent	reviewbot	July 1, 2015, 10:52 p.m.
Col: 47 E128 continuation line under-indented for visual indent	reviewbot	July 1, 2015, 10:52 p.m.
"An resource" isn't correct.	david	July 2, 2015, 3:40 p.m.
Should have an extra blank line here.	david	July 2, 2015, 3:40 p.m.
Should be "Retrieve"	david	July 2, 2015, 3:40 p.m.
Should be "Retrieve"	david	July 2, 2015, 3:40 p.m.

Tool: Pyflakes
Processed Files:
    djblets/webapi/resources/group.py
    djblets/webapi/resources/root.py
    djblets/webapi/resources/registry.py
    djblets/webapi/resources/base.py
    djblets/webapi/resources/user.py
    djblets/webapi/resources/__init__.py

Ignored Files:
    docs/djblets/coderef/index.rst



Tool: PEP8 Style Checker
Processed Files:
    djblets/webapi/resources/group.py
    djblets/webapi/resources/root.py
    djblets/webapi/resources/registry.py
    djblets/webapi/resources/base.py
    djblets/webapi/resources/user.py
    djblets/webapi/resources/__init__.py

Ignored Files:
    docs/djblets/coderef/index.rst

djblets/webapi/resources/base.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 47
 E128 continuation line under-indented for visual indent
```
djblets/webapi/resources/base.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 47
 E128 continuation line under-indented for visual indent
```

Change Summary:

Fixed alignment issues.

Commit:

f8177377c6b4edaf90e462d6f7596ad65b6fd7e7

5b516c7e34984c8d64dd29c2b7965e374cb4a9bd

Diff:

Revision 2 (+409 -276)

Show changes

	djblets/webapi/resources/__init__.py
	djblets/webapi/resources.py
	djblets/webapi/resources/group.py
	djblets/webapi/resources/registry.py
	djblets/webapi/resources/root.py
	djblets/webapi/resources/user.py
	docs/djblets/coderef/index.rst

Tool: Pyflakes
Processed Files:
    djblets/webapi/resources/group.py
    djblets/webapi/resources/root.py
    djblets/webapi/resources/registry.py
    djblets/webapi/resources/base.py
    djblets/webapi/resources/user.py
    djblets/webapi/resources/__init__.py

Ignored Files:
    docs/djblets/coderef/index.rst



Tool: PEP8 Style Checker
Processed Files:
    djblets/webapi/resources/group.py
    djblets/webapi/resources/root.py
    djblets/webapi/resources/registry.py
    djblets/webapi/resources/base.py
    djblets/webapi/resources/user.py
    djblets/webapi/resources/__init__.py

Ignored Files:
    docs/djblets/coderef/index.rst

The interdiff between r1 and r2 seems wrong.

chipx86 July 2, 2015, 12:49 p.m.

Yeah I dunno what's with that. The only change was an indentation-only change, and I bet we're doing something wrong there. Problem for another day.

djblets/webapi/resources/base.py (Diff revision 2)
The issue has been resolved. Show all issues
```
"An resource" isn't correct.
```
djblets/webapi/resources/group.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Should have an extra blank line here.
```
djblets/webapi/resources/root.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Should be "Retrieve"
```
djblets/webapi/resources/user.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Should be "Retrieve"
```

Change Summary:

Fixed blank line and doc issues.

Commit:

5b516c7e34984c8d64dd29c2b7965e374cb4a9bd

e2416b72f8802aa36d93d62ac2399996345a8de1

Diff:

Revision 3 (+410 -276)

Show changes

	djblets/webapi/resources/__init__.py
	djblets/webapi/resources.py
	djblets/webapi/resources/group.py
	djblets/webapi/resources/registry.py
	djblets/webapi/resources/root.py
	djblets/webapi/resources/user.py
	docs/djblets/coderef/index.rst

Tool: Pyflakes
Processed Files:
    djblets/webapi/resources/group.py
    djblets/webapi/resources/root.py
    djblets/webapi/resources/registry.py
    djblets/webapi/resources/base.py
    djblets/webapi/resources/user.py
    djblets/webapi/resources/__init__.py

Ignored Files:
    docs/djblets/coderef/index.rst



Tool: PEP8 Style Checker
Processed Files:
    djblets/webapi/resources/group.py
    djblets/webapi/resources/root.py
    djblets/webapi/resources/registry.py
    djblets/webapi/resources/base.py
    djblets/webapi/resources/user.py
    djblets/webapi/resources/__init__.py

Ignored Files:
    docs/djblets/coderef/index.rst

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-0.9.x (4f1c696)