Summary

Add typing for all the TestCase functions.

Review Request #13413 — Created Nov. 14, 2023 and submitted Dec. 7, 2023, 1:33 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-5.0.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

This updates all the object creation functions and utility context
managers in TestCase to provide type hints. This helps to write better
type-safe unit tests, and resolves a lot of problems that currently
exist when passing in values that default to None or accept multiple
value types.

In the process, documentation has been updated to meet current standards.

There are a couple of fixes in here. For instance, create_visit()
ignored the timestamp field and didn't normalize user correctly, and
http_request() passed in bad empty arguments when constructing a
ResolverMatch. These have been addressed.

Testing Done

All unit tests pass.

Commits

Summary	ID
Add typing for all the TestCase functions. This updates all the object creation functions and utility context managers in `TestCase` to provide type hints. This helps to write better type-safe unit tests, and resolves a lot of problems that currently exist when passing in values that default to `None` or accept multiple value types. There are a couple of fixes in here. For instance, `create_visit()` ignored the `timestamp` field and didn't normalize `user` correctly, and `http_request()` passed in bad empty arguments when constructing a `ResolverMatch`. These have been addressed.	9387935ea0bda2c90813a8a76b66024ee2bf4857

Summary

Add typing for all the TestCase functions.

This updates all the object creation functions and utility context managers in `TestCase` to provide type hints. This helps to write better type-safe unit tests, and resolves a lot of problems that currently exist when passing in values that default to `None` or accept multiple value types. There are a couple of fixes in here. For instance, `create_visit()` ignored the `timestamp` field and didn't normalize `user` correctly, and `http_request()` passed in bad empty arguments when constructing a `ResolverMatch`. These have been addressed.

9387935ea0bda2c90813a8a76b66024ee2bf4857

Issues

Description	From	Last Updated
This doesn't seem like a valuable thing to include in the version changed documentation. Type hints don't change the signature …	david	Dec. 2, 2023, 5:30 p.m.

flake8 passed.

JSHint passed.

reviewboard/testing/testcase.py (Diff revision 1)

The issue has been resolved. Show all issues

This doesn't seem like a valuable thing to include in the version changed documentation. Type hints don't change the signature or behavior of the method at all.

Change Summary:

Removed all Version Changed blocks talking about type hints.

Commits:

	Summary	ID
	Add typing for all the TestCase functions. This updates all the object creation functions and utility context managers in `TestCase` to provide type hints. This helps to write better type-safe unit tests, and resolves a lot of problems that currently exist when passing in values that default to `None` or accept multiple value types. There are a couple of fixes in here. For instance, `create_visit()` ignored the `timestamp` field and didn't normalize `user` correctly, and `http_request()` passed in bad empty arguments when constructing a `ResolverMatch`. These have been addressed.	3e8c036bb2a47abe8b665e78c31794d4580912cf
	Add typing for all the TestCase functions. This updates all the object creation functions and utility context managers in `TestCase` to provide type hints. This helps to write better type-safe unit tests, and resolves a lot of problems that currently exist when passing in values that default to `None` or accept multiple value types. There are a couple of fixes in here. For instance, `create_visit()` ignored the `timestamp` field and didn't normalize `user` correctly, and `http_request()` passed in bad empty arguments when constructing a `ResolverMatch`. These have been addressed.	9387935ea0bda2c90813a8a76b66024ee2bf4857

Diff:

Revision 2 (+1042 -480)

Show changes

reviewboard/testing/testcase.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-5.0.x (f7832f8)