Summary

Add pagination helpers to API ListResources

Review Request #7181 — Created April 7, 2015 and submitted April 7, 2015, 6:11 p.m.

Information

Owner

brennie

Repository

RBTools

Branch

master

Bugs

Depends On

Blocks

7175

Reviewers

Groups

rbtools

People

Description

Instances of API ListResource classes can easily iterate through all
pages or through all items of all pages easily via new helper methods.
These methods hide the pagination logic that was being used elsewhere
to manually go through all pages of ListResources.

All instances of this have been replaced with the new helpers to make
the logic cleaner.

Testing Done

Ran unit tests.

Issues

Description	From	Last Updated
Can we call this get_pages()?	david	April 7, 2015, 5:21 p.m.
Because this is a generator function, you don't need to catch StopIteration--you can just let it percolate up and whatever …	david	April 7, 2015, 5:21 p.m.
Can we call this get_all()?	david	April 7, 2015, 5:21 p.m.
Missing a trailing period.	chipx86	April 7, 2015, 5:33 p.m.
"of the same"	chipx86	April 7, 2015, 5:33 p.m.
Generally speaking, a list comprehension would be better here. Avoids the function call to the lambda and the ones to …	chipx86	April 7, 2015, 5:34 p.m.
getattr() requires the default parameter if the attribute may not be on the object (which is why we have this …	chipx86	April 7, 2015, 5:35 p.m.

Tool: Pyflakes
Processed Files:
    rbtools/commands/status.py
    rbtools/utils/review_request.py
    rbtools/api/resource.py
    rbtools/commands/setup_repo.py
    rbtools/clients/clearcase.py
    rbtools/commands/post.py
    rbtools/utils/repository.py
    rbtools/clients/svn.py



Tool: PEP8 Style Checker
Processed Files:
    rbtools/commands/status.py
    rbtools/utils/review_request.py
    rbtools/api/resource.py
    rbtools/commands/setup_repo.py
    rbtools/clients/clearcase.py
    rbtools/commands/post.py
    rbtools/utils/repository.py
    rbtools/clients/svn.py

rbtools/api/resource.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Can we call this get_pages()?
```

rbtools/api/resource.py (Diff revision 1)

The issue has been resolved. Show all issues

Because this is a generator function, you don't need to catch StopIteration--you can just let it percolate up and whatever is iterating it will stop.

rbtools/api/resource.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Can we call this get_all()?
```

Diff:

Revision 2 (+82 -109)

Show changes

	rbtools/api/resource.py
	rbtools/clients/clearcase.py
	rbtools/clients/svn.py
	rbtools/commands/post.py
	rbtools/commands/setup_repo.py
	rbtools/commands/status.py
	rbtools/utils/repository.py
	rbtools/utils/review_request.py

Tool: Pyflakes
Processed Files:
    rbtools/commands/status.py
    rbtools/utils/review_request.py
    rbtools/api/resource.py
    rbtools/commands/setup_repo.py
    rbtools/clients/clearcase.py
    rbtools/commands/post.py
    rbtools/utils/repository.py
    rbtools/clients/svn.py



Tool: PEP8 Style Checker
Processed Files:
    rbtools/commands/status.py
    rbtools/utils/review_request.py
    rbtools/api/resource.py
    rbtools/commands/setup_repo.py
    rbtools/clients/clearcase.py
    rbtools/commands/post.py
    rbtools/utils/repository.py
    rbtools/clients/svn.py

Ship it!

```
Ship It!
```

rbtools/api/resource.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Missing a trailing period.
```
rbtools/api/resource.py (Diff revision 2)
The issue has been resolved. Show all issues
```
"of the same"
```

rbtools/clients/svn.py (Diff revision 2)

The issue has been resolved. Show all issues

Generally speaking, a list comprehension would be better here. Avoids the function call to the lambda and the ones to list() and filter(), and is a little more readable:

repositories = [
    repo
    for repo in server.get_repositories().all_items
    if repo['tool'] == 'Subversion'
]

rbtools/utils/repository.py (Diff revision 2)

The issue has been resolved. Show all issues

getattr() requires the default parameter if the attribute may not be on the object (which is why we have this getattr() in the first place).

Diff:

Revision 3 (+84 -109)

Show changes

	rbtools/api/resource.py
	rbtools/clients/clearcase.py
	rbtools/clients/svn.py
	rbtools/commands/post.py
	rbtools/commands/setup_repo.py
	rbtools/commands/status.py
	rbtools/utils/repository.py
	rbtools/utils/review_request.py

Tool: Pyflakes
Processed Files:
    rbtools/commands/status.py
    rbtools/utils/review_request.py
    rbtools/api/resource.py
    rbtools/commands/setup_repo.py
    rbtools/clients/clearcase.py
    rbtools/commands/post.py
    rbtools/utils/repository.py
    rbtools/clients/svn.py



Tool: PEP8 Style Checker
Processed Files:
    rbtools/commands/status.py
    rbtools/utils/review_request.py
    rbtools/api/resource.py
    rbtools/commands/setup_repo.py
    rbtools/clients/clearcase.py
    rbtools/commands/post.py
    rbtools/utils/repository.py
    rbtools/clients/svn.py

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to master (90d36d9)