Summary

Improve the default summaries and logic for licenses.

Review Request #14508 — Created July 15, 2025 and submitted Sept. 17, 2025, 1:31 a.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-7.1.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

The default summaries for a license are now computed in
LicenseInfo.get_summary(), and now state information such as the
number of days left in a trial or a grace period. The plan name is no
longer wrapped in parentheses by default, but License Providers can
override LicenseInfo.format_plan_name() to set this however they need.

The default summary-building makes use of strings stored in a map, which
helps keep the strings maintainable and avoids a bunch of nested logic.
This is purely internal as a helper.

There are a few other small fixes for typos and types, and
LicenseInfo.__repr__() has been added.

Testing Done

Unit tests pass.

Verified the different states on the Licenses page.

Made use of the summary in the Power Pack work.

Commits

Summary	ID
Improve the default summaries and logic for licenses. The default summaries for a license are now computed in `LicenseInfo.get_summary()`, and now state information such as the number of days left in a trial or a grace period. The plan name is no longer wrapped in parentheses by default, but License Providers can override `LicenseInfo.format_plan_name()` to set this however they need. The default summary-building makes use of strings stored in a map, which helps keep the strings maintainable and avoids a bunch of nested logic. This is purely internal as a helper. There are a few other small fixes for typos and types, and `LicenseInfo.__repr__()` has been added.	502ac6bf41f3d50a27a2d86866f636e1c19cfd82

Summary

Improve the default summaries and logic for licenses.

The default summaries for a license are now computed in `LicenseInfo.get_summary()`, and now state information such as the number of days left in a trial or a grace period. The plan name is no longer wrapped in parentheses by default, but License Providers can override `LicenseInfo.format_plan_name()` to set this however they need. The default summary-building makes use of strings stored in a map, which helps keep the strings maintainable and avoids a bunch of nested logic. This is purely internal as a helper. There are a few other small fixes for typos and types, and `LicenseInfo.__repr__()` has been added.

502ac6bf41f3d50a27a2d86866f636e1c19cfd82

Issues

Description	From	Last Updated
'typing_extensions.TypeAlias' imported but unused Column: 5 Error code: F401	reviewbot	July 15, 2025, 9:14 p.m.
'os.unlink' imported but unused Column: 1 Error code: F401	reviewbot	July 15, 2025, 9:14 p.m.
Should this be object or Any?	david	July 21, 2025, 1:50 p.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/licensing/license.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'typing_extensions.TypeAlias' imported but unused

Column: 5
Error code: F401
```
reviewboard/licensing/tests/test_license_info.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'os.unlink' imported but unused

Column: 1
Error code: F401
```

Change Summary:

Removed unused imports.

Commits:

	Summary	ID
	Improve the default summaries and logic for licenses. The default summaries for a license are now computed in `LicenseInfo.get_summary()`, and now state information such as the number of days left in a trial or a grace period. The plan name is no longer wrapped in parentheses by default, but License Providers can override `LicenseInfo.format_plan_name()` to set this however they need. The default summary-building makes use of strings stored in a map, which helps keep the strings maintainable and avoids a bunch of nested logic. This is purely internal as a helper. There are a few other small fixes for typos and types, and `LicenseInfo.__repr__()` has been added.	b2f9b69ba1d63e3021d810792d3d5a2d580b0d6e
	Improve the default summaries and logic for licenses. The default summaries for a license are now computed in `LicenseInfo.get_summary()`, and now state information such as the number of days left in a trial or a grace period. The plan name is no longer wrapped in parentheses by default, but License Providers can override `LicenseInfo.format_plan_name()` to set this however they need. The default summary-building makes use of strings stored in a map, which helps keep the strings maintainable and avoids a bunch of nested logic. This is purely internal as a helper. There are a few other small fixes for typos and types, and `LicenseInfo.__repr__()` has been added.	4bfb55f84c757823aec1c99295b446153230dcd5

Diff:

Revision 2 (+1168 -112)

Show changes

	reviewboard/licensing/license.py
	reviewboard/licensing/provider.py
	reviewboard/licensing/tests/providers.py
	reviewboard/licensing/tests/test_license_info.py
	reviewboard/licensing/tests/test_license_provider.py
	reviewboard/licensing/tests/test_licenses_view.py
	reviewboard/static/rb/css/ui/admin/license.less

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

Corrected a version number in a docstring.

Commits:

	Summary	ID
	Improve the default summaries and logic for licenses. The default summaries for a license are now computed in `LicenseInfo.get_summary()`, and now state information such as the number of days left in a trial or a grace period. The plan name is no longer wrapped in parentheses by default, but License Providers can override `LicenseInfo.format_plan_name()` to set this however they need. The default summary-building makes use of strings stored in a map, which helps keep the strings maintainable and avoids a bunch of nested logic. This is purely internal as a helper. There are a few other small fixes for typos and types, and `LicenseInfo.__repr__()` has been added.	4bfb55f84c757823aec1c99295b446153230dcd5
	Improve the default summaries and logic for licenses. The default summaries for a license are now computed in `LicenseInfo.get_summary()`, and now state information such as the number of days left in a trial or a grace period. The plan name is no longer wrapped in parentheses by default, but License Providers can override `LicenseInfo.format_plan_name()` to set this however they need. The default summary-building makes use of strings stored in a map, which helps keep the strings maintainable and avoids a bunch of nested logic. This is purely internal as a helper. There are a few other small fixes for typos and types, and `LicenseInfo.__repr__()` has been added.	502ac6bf41f3d50a27a2d86866f636e1c19cfd82

Diff:

Revision 3 (+1168 -112)

Show changes

	reviewboard/licensing/license.py
	reviewboard/licensing/provider.py
	reviewboard/licensing/tests/providers.py
	reviewboard/licensing/tests/test_license_info.py
	reviewboard/licensing/tests/test_license_provider.py
	reviewboard/licensing/tests/test_licenses_view.py
	reviewboard/static/rb/css/ui/admin/license.less

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Ship it!

reviewboard/licensing/license.py (Diff revision 3)

The issue has been dropped. Show all issues

Should this be object or Any?

chipx86 July 18, 2025, 12:48 p.m.

For format, either would be fine. It accepts Any. I've generally seen that collapsing to object is a good move when possible so that you opt back into type checking for that variable (since Any basically opts out). In this case, it doesn't matter so much, but since it's more specific and accepted by format(), I think it's technically the better one to use.

Status:: Completed
Change Summary:: Pushed to release-7.1.x (0ea4010)