Summary

Add class-level customization and visibility control for TemplateHooks.

Review Request #14556 — Created Aug. 6, 2025 and submitted Sept. 19, 2025, 2:51 p.m.

Information

Owner

chipx86

Repository

Djblets

Branch

release-5.x

Bugs

Depends On

Reviewers

Groups

djblets

People

Description

TemplateHook has always required name, template_name, apply_to,

and extra_context to be passed into __init__(), even in a subclass.

This makes usage a bit verbose.
This change adds new class-level control of these options. Now, a

subclass can define these as class attributes and they'll be used if the

caller doesn't override any of them with a parameter.
Subclasses can also opt out of rendering by overriding

should_render(), which means they no longer need to handle this in a

template.

Testing Done

Unit tests pass.

Tested this with the banner component work in Review Board, utilizing
the new features.

Commits

Summary	ID
Add class-level customization and visibility control for TemplateHooks. `TemplateHook` has always required `name`, `template_name`, `apply_to`, and `extra_context` to be passed into `__init__()`, even in a subclass. This makes usage a bit verbose. This change adds new class-level control of these options. Now, a subclass can define these as class attributes and they'll be used if the caller doesn't override any of them with a parameter. Subclasses can also opt out of rendering by overriding `should_render()`, which means they no longer need to handle this in a template.	33373351585be57972d5c74fb9cee401d563f884

Summary

Add class-level customization and visibility control for TemplateHooks.

`TemplateHook` has always required `name`, `template_name`, `apply_to`, and `extra_context` to be passed into `__init__()`, even in a subclass. This makes usage a bit verbose. This change adds new class-level control of these options. Now, a subclass can define these as class attributes and they'll be used if the caller doesn't override any of them with a parameter. Subclasses can also opt out of rendering by overriding `should_render()`, which means they no longer need to handle this in a template.

33373351585be57972d5c74fb9cee401d563f884

Issues

Description	From	Last Updated
Testing done?	david	Aug. 21, 2025, 4:47 p.m.
Indentation doesn't match between TemplateHook and class MyTemplateHook	david	Aug. 21, 2025, 4:47 p.m.
typo: facored -> factored	david	Aug. 21, 2025, 4:49 p.m.
This list is missing the closing ]	maubin	Aug. 22, 2025, 2:04 a.m.
We don't actually enforce that apply_to has been provided like we do with the name attribute. If apply_to hasn't been …	maubin	Aug. 22, 2025, 2:05 a.m.
Same comment here, we're not actually enforcing that extra_content must be set or passed as an argument.	maubin	Aug. 22, 2025, 2:05 a.m.
Given that this is typed as Mapping, we should probably assert isinstance(extra_context, Mapping)	david	Sept. 14, 2025, 7:37 p.m.
Should be 5.3, not 7.1	david	Sept. 14, 2025, 7:38 p.m.

flake8 passed.

JSHint passed.

The issue has been resolved. Show all issues
```
Testing done?
```

djblets/extensions/hooks.py (Diff revision 1)

The issue has been resolved. Show all issues

Indentation doesn't match between TemplateHook and class MyTemplateHook

djblets/extensions/hooks.py (Diff revision 1)
The issue has been resolved. Show all issues
```
typo: facored -> factored
```

Change Summary:

Fixed typos and indentation in docs.

Testing Done:

	+	Unit tests pass.
	+
	+	Tested this with the banner component work in Review Board, utilizing
	+	the new features.

Commits:

	Summary	ID
	Add class-level customization and visibility control for TemplateHooks. `TemplateHook` has always required `name`, `template_name`, `apply_to`, and `extra_context` to be passed into `__init__()`, even in a subclass. This makes usage a bit verbose. This change adds new class-level control of these options. Now, a subclass can define these as class attributes and they'll be used if the caller doesn't override any of them with a parameter. Subclasses can also opt out of rendering by overriding `should_render()`, which means they no longer need to handle this in a template.	254835faee3415a0fb103ec5dcb04f6f6eae11c5
	Add class-level customization and visibility control for TemplateHooks. `TemplateHook` has always required `name`, `template_name`, `apply_to`, and `extra_context` to be passed into `__init__()`, even in a subclass. This makes usage a bit verbose. This change adds new class-level control of these options. Now, a subclass can define these as class attributes and they'll be used if the caller doesn't override any of them with a parameter. Subclasses can also opt out of rendering by overriding `should_render()`, which means they no longer need to handle this in a template.	ca415aff511e4a551ac5009105d9d86e585b0843

Diff:

Revision 2 (+398 -44)

Show changes

	djblets/extensions/hooks.py
	djblets/extensions/tests/test_template_hook.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

djblets/extensions/hooks.py (Diff revision 2)
The issue has been resolved. Show all issues
```
This list is missing the closing ]
```

djblets/extensions/hooks.py (Diff revision 2)

The issue has been resolved. Show all issues

We don't actually enforce that apply_to has been provided like we do with the name attribute. If apply_to hasn't been passed as an argument and hasn't been set as an attribute we default it to an empty list.

chipx86 Aug. 22, 2025, 2:06 a.m.
```
More of a docs issue. I'll fix that.
```

djblets/extensions/hooks.py (Diff revision 2)

The issue has been resolved. Show all issues

Same comment here, we're not actually enforcing that extra_content must be set or passed as an argument.

Change Summary:

Fixed a typo in the docs, and some misworded parts about parameter/attribute fallbacks.

Commits:

	Summary	ID
	Add class-level customization and visibility control for TemplateHooks. `TemplateHook` has always required `name`, `template_name`, `apply_to`, and `extra_context` to be passed into `__init__()`, even in a subclass. This makes usage a bit verbose. This change adds new class-level control of these options. Now, a subclass can define these as class attributes and they'll be used if the caller doesn't override any of them with a parameter. Subclasses can also opt out of rendering by overriding `should_render()`, which means they no longer need to handle this in a template.	ca415aff511e4a551ac5009105d9d86e585b0843
	Add class-level customization and visibility control for TemplateHooks. `TemplateHook` has always required `name`, `template_name`, `apply_to`, and `extra_context` to be passed into `__init__()`, even in a subclass. This makes usage a bit verbose. This change adds new class-level control of these options. Now, a subclass can define these as class attributes and they'll be used if the caller doesn't override any of them with a parameter. Subclasses can also opt out of rendering by overriding `should_render()`, which means they no longer need to handle this in a template.	080257623a3e3ebccdbb7a62fa21bf69afe232fd

Diff:

Revision 3 (+402 -44)

Show changes

	djblets/extensions/hooks.py
	djblets/extensions/tests/test_template_hook.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

djblets/extensions/hooks.py (Diff revision 3)

The issue has been resolved. Show all issues

Given that this is typed as Mapping, we should probably assert isinstance(extra_context, Mapping)

djblets/extensions/hooks.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Should be 5.3, not 7.1
```

Change Summary:


Switched to assert against a Mapping.
Fixed an incorrect version number.

Commits:

	Summary	ID
	Add class-level customization and visibility control for TemplateHooks. `TemplateHook` has always required `name`, `template_name`, `apply_to`, and `extra_context` to be passed into `__init__()`, even in a subclass. This makes usage a bit verbose. This change adds new class-level control of these options. Now, a subclass can define these as class attributes and they'll be used if the caller doesn't override any of them with a parameter. Subclasses can also opt out of rendering by overriding `should_render()`, which means they no longer need to handle this in a template.	080257623a3e3ebccdbb7a62fa21bf69afe232fd
	Add class-level customization and visibility control for TemplateHooks. `TemplateHook` has always required `name`, `template_name`, `apply_to`, and `extra_context` to be passed into `__init__()`, even in a subclass. This makes usage a bit verbose. This change adds new class-level control of these options. Now, a subclass can define these as class attributes and they'll be used if the caller doesn't override any of them with a parameter. Subclasses can also opt out of rendering by overriding `should_render()`, which means they no longer need to handle this in a template.	33373351585be57972d5c74fb9cee401d563f884

Diff:

Revision 4 (+406 -46)

Show changes

	djblets/extensions/hooks.py
	djblets/extensions/tests/test_template_hook.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-5.x (65d55a1)