Summary

Split up reviews/views.py

Review Request #12684 — Created Oct. 14, 2022 and submitted Nov. 17, 2022, 8:37 a.m.

Information

Owner

david

Repository

Review Board

Branch

release-6.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

The main reviews/views.py file was pretty huge, and was very difficult
to navigate. This change splits it up into a bunch of smaller files.

There are a couple trivial changes (adding some asserts, defining a
name attribute on BugTracker) in order to make type checkers a
bit happier, but otherwise this is purely moving things around.

Testing Done

Ran unit tests.

Commits

Summary	ID
Split up reviews/views.py The main reviews/views.py file was pretty huge, and was very difficult to navigate. This change splits it up into a bunch of smaller files. There are a couple trivial changes (adding some asserts, defining a `name` attribute on `BugTracker`) in order to make type checkers a bit happier, but otherwise this is purely moving things around. Testing Done: Ran unit tests.	bf41aad340ac3bb2ab1ccb79f69a1fa8b814200c

Issues

Description	From	Last Updated
Nice cleanup. Do we want to add these individual modules to the Python docs, or just keep the existing views.py? …	chipx86	Oct. 28, 2022, 12:41 p.m.
too many blank lines (3) Column: 1 Error code: E303	reviewbot	Oct. 14, 2022, 12:32 p.m.
blank line at end of file Column: 1 Error code: W391	reviewbot	Oct. 14, 2022, 12:32 p.m.
line too long (83 > 79 characters) Column: 80 Error code: E501	reviewbot	Oct. 14, 2022, 12:33 p.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/reviews/views/diff_fragments.py (Diff revision 1)
The issue has been dropped. Show all issues
```
too many blank lines (3)

Column: 1
Error code: E303
```
reviewboard/reviews/views/email.py (Diff revision 1)
The issue has been dropped. Show all issues
```
blank line at end of file

Column: 1
Error code: W391
```

Commits:

	Summary	ID
	Split up reviews/views.py The main reviews/views.py file was pretty huge, and was very difficult to navigate. This change splits it up into a bunch of smaller files. There are a couple trivial changes (adding some asserts, etc) in order to make type checkers a bit more happy, but otherwise this is purely moving things around. Testing Done: Ran unit tests.	b853e24db14702cc0266e0eba4b6a01119eb1a7c
	Split up reviews/views.py The main reviews/views.py file was pretty huge, and was very difficult to navigate. This change splits it up into a bunch of smaller files. There are a couple trivial changes (adding some asserts, defining a `name` attribute on `BugTracker`) in order to make type checkers a bit happier, but otherwise this is purely moving things around. Testing Done: Ran unit tests.	8ff2c48a93239f260898c7e5ecf5982d4b3e73d6

Diff:

Revision 2 (+5304 -4950)

Show changes

	reviewboard/hostingsvcs/bugtracker.py
	reviewboard/reviews/views.py
	reviewboard/reviews/views/__init__.py
	reviewboard/reviews/views/attachments.py
	reviewboard/reviews/views/bug_trackers.py
	reviewboard/reviews/views/diff_fragments.py
	reviewboard/reviews/views/diffviewer.py
	reviewboard/reviews/views/download_diff.py
	7 more

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

reviewboard/reviews/views/__init__.py (Diff revision 2)
The issue has been dropped. Show all issues
```
line too long (83 > 79 characters)

Column: 80
Error code: E501
```

Commits:

	Summary	ID
	Split up reviews/views.py The main reviews/views.py file was pretty huge, and was very difficult to navigate. This change splits it up into a bunch of smaller files. There are a couple trivial changes (adding some asserts, defining a `name` attribute on `BugTracker`) in order to make type checkers a bit happier, but otherwise this is purely moving things around. Testing Done: Ran unit tests.	8ff2c48a93239f260898c7e5ecf5982d4b3e73d6
	Split up reviews/views.py The main reviews/views.py file was pretty huge, and was very difficult to navigate. This change splits it up into a bunch of smaller files. There are a couple trivial changes (adding some asserts, defining a `name` attribute on `BugTracker`) in order to make type checkers a bit happier, but otherwise this is purely moving things around. Testing Done: Ran unit tests.	e6edaf78ad3ac01217b7150cf92b165940385aaf

Diff:

Revision 3 (+5306 -4950)

Show changes

	reviewboard/hostingsvcs/bugtracker.py
	reviewboard/reviews/views.py
	reviewboard/reviews/views/__init__.py
	reviewboard/reviews/views/attachments.py
	reviewboard/reviews/views/bug_trackers.py
	reviewboard/reviews/views/diff_fragments.py
	reviewboard/reviews/views/diffviewer.py
	reviewboard/reviews/views/download_diff.py
	7 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

The issue has been resolved. Show all issues

Nice cleanup.

Do we want to add these individual modules to the Python docs, or just keep the existing views.py? Probably the former.

If the former, then the views.py needs to do __autodoc_excludes__ = __all__ or it'll end up duplicating definitions for all these.

Change Summary:

Add modules to docs, set __autodoc_excludes__ for forwarding module.

Commits:

	Summary	ID
	Split up reviews/views.py The main reviews/views.py file was pretty huge, and was very difficult to navigate. This change splits it up into a bunch of smaller files. There are a couple trivial changes (adding some asserts, defining a `name` attribute on `BugTracker`) in order to make type checkers a bit happier, but otherwise this is purely moving things around. Testing Done: Ran unit tests.	e6edaf78ad3ac01217b7150cf92b165940385aaf
	Split up reviews/views.py The main reviews/views.py file was pretty huge, and was very difficult to navigate. This change splits it up into a bunch of smaller files. There are a couple trivial changes (adding some asserts, defining a `name` attribute on `BugTracker`) in order to make type checkers a bit happier, but otherwise this is purely moving things around. Testing Done: Ran unit tests.	bf41aad340ac3bb2ab1ccb79f69a1fa8b814200c

Diff:

Revision 4 (+5334 -4950)

Show changes

	docs/manual/extending/coderef/index.rst
	reviewboard/hostingsvcs/bugtracker.py
	reviewboard/reviews/views.py
	reviewboard/reviews/views/__init__.py
	reviewboard/reviews/views/attachments.py
	reviewboard/reviews/views/bug_trackers.py
	reviewboard/reviews/views/diff_fragments.py
	reviewboard/reviews/views/diffviewer.py
	8 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-6.x (8612482)