Summary

Update doc8 for new tool support and more reliable output parsing.

Review Request #11562 — Created March 30, 2021 and submitted June 2, 2021, 7:15 p.m.

Information

Owner

chipx86

Repository

ReviewBot

Branch

release-3.0.x

Bugs

Depends On

Reviewers

Groups

reviewbot

People

Description

This updates Doc8Tool to subclass the newer BaseTool, and to use the
newer features it offers (dependencies, improved configurable file
extension handling, centralized base command building, and standardized
error code output).

The new version of the tool has safer report parsing, using a regex
rather than manual string splitting and parsing to match lines. This
simplifies things quite a bit and avoids possible errors, or crashes if
doc8 changes output someday.

Unit tests were added to cover the new doc8 parsing, and to provide
integration tests.

Testing Done

Unit tests pass on Python 2.7 and 3.x.

Commits

Summary	ID
Update doc8 for new tool support and more reliable output parsing. This updates `Doc8Tool` to subclass the newer `BaseTool`, and to use the newer features it offers (dependencies, improved configurable file extension handling, centralized base command building, and standardized error code output). The new version of the tool has safer report parsing, using a regex rather than manual string splitting and parsing to match lines. This simplifies things quite a bit and avoids possible errors, or crashes if doc8 changes output someday. Unit tests were added to cover the new doc8 parsing, and to provide integration tests.	5f4ed6d9035ee30738328a2e5f5e7259affa6789

Summary

Update doc8 for new tool support and more reliable output parsing.

This updates `Doc8Tool` to subclass the newer `BaseTool`, and to use the newer features it offers (dependencies, improved configurable file extension handling, centralized base command building, and standardized error code output). The new version of the tool has safer report parsing, using a regex rather than manual string splitting and parsing to match lines. This simplifies things quite a bit and avoids possible errors, or crashes if doc8 changes output someday. Unit tests were added to cover the new doc8 parsing, and to provide integration tests.

5f4ed6d9035ee30738328a2e5f5e7259affa6789

Issues

Description	From	Last Updated
E251 unexpected spaces around keyword / parameter equals	reviewbot	March 30, 2021, 2:34 a.m.
E251 unexpected spaces around keyword / parameter equals	reviewbot	March 30, 2021, 2:34 a.m.
E251 unexpected spaces around keyword / parameter equals	reviewbot	March 30, 2021, 2:34 a.m.
E251 unexpected spaces around keyword / parameter equals	reviewbot	March 30, 2021, 2:34 a.m.
E251 unexpected spaces around keyword / parameter equals	reviewbot	March 30, 2021, 2:34 a.m.
E251 unexpected spaces around keyword / parameter equals	reviewbot	March 30, 2021, 2:34 a.m.
E251 unexpected spaces around keyword / parameter equals	reviewbot	March 30, 2021, 2:34 a.m.
E251 unexpected spaces around keyword / parameter equals	reviewbot	March 30, 2021, 2:34 a.m.

flake8 failed.

JSHint passed.

flake8

bot/reviewbot/tools/tests/test_doc8.py (Diff revision 1)
The issue has been resolved. Show all issues
```
E251 unexpected spaces around keyword / parameter equals
```
bot/reviewbot/tools/tests/test_doc8.py (Diff revision 1)
The issue has been resolved. Show all issues
```
E251 unexpected spaces around keyword / parameter equals
```
bot/reviewbot/tools/tests/test_doc8.py (Diff revision 1)
The issue has been resolved. Show all issues
```
E251 unexpected spaces around keyword / parameter equals
```
bot/reviewbot/tools/tests/test_doc8.py (Diff revision 1)
The issue has been resolved. Show all issues
```
E251 unexpected spaces around keyword / parameter equals
```
bot/reviewbot/tools/tests/test_doc8.py (Diff revision 1)
The issue has been resolved. Show all issues
```
E251 unexpected spaces around keyword / parameter equals
```
bot/reviewbot/tools/tests/test_doc8.py (Diff revision 1)
The issue has been resolved. Show all issues
```
E251 unexpected spaces around keyword / parameter equals
```
bot/reviewbot/tools/tests/test_doc8.py (Diff revision 1)
The issue has been resolved. Show all issues
```
E251 unexpected spaces around keyword / parameter equals
```
bot/reviewbot/tools/tests/test_doc8.py (Diff revision 1)
The issue has been resolved. Show all issues
```
E251 unexpected spaces around keyword / parameter equals
```

Change Summary:

Fixed a bad copy/paste leading to a keyword argument in keyword = value form.

Commits:

	Summary	ID
	Update doc8 for new tool support and more reliable output parsing. This updates `Doc8Tool` to subclass the newer `BaseTool`, and to use the newer features it offers (dependencies, improved configurable file extension handling, centralized base command building, and standardized error code output). The new version of the tool has safer report parsing, using a regex rather than manual string splitting and parsing to match lines. This simplifies things quite a bit and avoids possible errors, or crashes if doc8 changes output someday. Unit tests were added to cover the new doc8 parsing, and to provide integration tests.	d232bea815a687e540f2b9abc8dce1b54cf4e1ab
	Update doc8 for new tool support and more reliable output parsing. This updates `Doc8Tool` to subclass the newer `BaseTool`, and to use the newer features it offers (dependencies, improved configurable file extension handling, centralized base command building, and standardized error code output). The new version of the tool has safer report parsing, using a regex rather than manual string splitting and parsing to match lines. This simplifies things quite a bit and avoids possible errors, or crashes if doc8 changes output someday. Unit tests were added to cover the new doc8 parsing, and to provide integration tests.	3c71932cb016c7fc41d26abf242dfd8b70dc31d0

Diff:

Revision 2 (+558 -74)

Show changes

	bot/reviewbot/tools/doc8.py
	bot/reviewbot/tools/tests/test_doc8.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

Fixed a couple issues in a unit test docstring.

Commits:

	Summary	ID
	Update doc8 for new tool support and more reliable output parsing. This updates `Doc8Tool` to subclass the newer `BaseTool`, and to use the newer features it offers (dependencies, improved configurable file extension handling, centralized base command building, and standardized error code output). The new version of the tool has safer report parsing, using a regex rather than manual string splitting and parsing to match lines. This simplifies things quite a bit and avoids possible errors, or crashes if doc8 changes output someday. Unit tests were added to cover the new doc8 parsing, and to provide integration tests.	3c71932cb016c7fc41d26abf242dfd8b70dc31d0
	Update doc8 for new tool support and more reliable output parsing. This updates `Doc8Tool` to subclass the newer `BaseTool`, and to use the newer features it offers (dependencies, improved configurable file extension handling, centralized base command building, and standardized error code output). The new version of the tool has safer report parsing, using a regex rather than manual string splitting and parsing to match lines. This simplifies things quite a bit and avoids possible errors, or crashes if doc8 changes output someday. Unit tests were added to cover the new doc8 parsing, and to provide integration tests.	5f4ed6d9035ee30738328a2e5f5e7259affa6789

Diff:

Revision 3 (+558 -74)

Show changes

	bot/reviewbot/tools/doc8.py
	bot/reviewbot/tools/tests/test_doc8.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-3.0.x (74e5024)