Summary

Mark proxy properties on scmtools.models.Tool as deprecated.

Review Request #12331 — Created June 3, 2022 and submitted June 13, 2022, 3:16 p.m.

Information

Owner

david

Repository

Review Board

Branch

release-5.0.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

The Tool model has a handful of properties which proxy things which

are provided by the SCMTool subclass. This was used a long time ago to

make it easier to render things in templates (since trying to access the

class in the template would end up instantiating it). We haven't used

templates for this stuff in a long time, and all our code accesses these

via the scmtool_class property rather than these proxies.
This change adds a wrapper which will raise a deprecation warning if any

of these properties are accessed via the tool.

Testing Done


Opened a shell, enabled all warnings, and then accessed properties via

  the tool instance. Saw that I got the correct results, and that the

  deprecation warning was raised.
Ran unit tests.

Commits

Summary	ID
Mark proxy properties on scmtools.models.Tool as deprecated. The Tool model has a handful of properties which proxy things which are provided by the SCMTool subclass. This was used a long time ago to make it easier to render things in templates (since trying to access the class in the template would end up instantiating it). We haven't used templates for this stuff in a long time, and all our code accesses these via the `scmtool_class` property rather than these proxies. This change adds a wrapper which will raise a deprecation warning if any of these properties are accessed via the tool. Testing Done: - Opened a shell, enabled all warnings, and then accessed properties via the tool instance. Saw that I got the correct results, and that the deprecation warning was raised. - Ran unit tests.	2be21b1f7fefb87908fad246f7abe6d5947dc0ff

Summary

Mark proxy properties on scmtools.models.Tool as deprecated.

The Tool model has a handful of properties which proxy things which are provided by the SCMTool subclass. This was used a long time ago to make it easier to render things in templates (since trying to access the class in the template would end up instantiating it). We haven't used templates for this stuff in a long time, and all our code accesses these via the `scmtool_class` property rather than these proxies. This change adds a wrapper which will raise a deprecation warning if any of these properties are accessed via the tool. Testing Done: - Opened a shell, enabled all warnings, and then accessed properties via the tool instance. Saw that I got the correct results, and that the deprecation warning was raised. - Ran unit tests.

2be21b1f7fefb87908fad246f7abe6d5947dc0ff

Issues

Description	From	Last Updated
I've landed my deprecation updates change, so this can go.	chipx86	June 8, 2022, 9:11 a.m.
Can you add a Version Added?	chipx86	June 8, 2022, 9:11 a.m.
We should probably use functools.wraps to ensure all the function attributes are set right.	chipx86	June 8, 2022, 9:15 a.m.
You don't need warnings anymore. You can just call RemovedInReviewBoard60Warning.warn(...) with the string.	chipx86	June 8, 2022, 9:15 a.m.

flake8 passed.

JSHint passed.

reviewboard/deprecation.py (Diff revision 1)
The issue has been resolved. Show all issues
```
I've landed my deprecation updates change, so this can go.
```
reviewboard/scmtools/models.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Can you add a Version Added?
```

reviewboard/scmtools/models.py (Diff revision 1)

The issue has been resolved. Show all issues

We should probably use functools.wraps to ensure all the function attributes are set right.

reviewboard/scmtools/models.py (Diff revision 1)

The issue has been resolved. Show all issues

You don't need warnings anymore. You can just call RemovedInReviewBoard60Warning.warn(...) with the string.

Commits:

	Summary	ID
	Mark proxy properties on scmtools.models.Tool as deprecated. The Tool model has a handful of properties which proxy things which are provided by the SCMTool subclass. This was used a long time ago to make it easier to render things in templates (since trying to access the class in the template would end up instantiating it). We haven't used templates for this stuff in a long time, and all our code accesses these via the `scmtool_class` property rather than these proxies. This change adds a wrapper which will raise a deprecation warning if any of these properties are accessed via the tool. Testing Done: - Opened a shell, enabled all warnings, and then accessed properties via the tool instance. Saw that I got the correct results, and that the deprecation warning was raised. - Ran unit tests.	704086ea09abf6f4493d0cb489e433ff52d6fa7a
	Mark proxy properties on scmtools.models.Tool as deprecated. The Tool model has a handful of properties which proxy things which are provided by the SCMTool subclass. This was used a long time ago to make it easier to render things in templates (since trying to access the class in the template would end up instantiating it). We haven't used templates for this stuff in a long time, and all our code accesses these via the `scmtool_class` property rather than these proxies. This change adds a wrapper which will raise a deprecation warning if any of these properties are accessed via the tool. Testing Done: - Opened a shell, enabled all warnings, and then accessed properties via the tool instance. Saw that I got the correct results, and that the deprecation warning was raised. - Ran unit tests.	2be21b1f7fefb87908fad246f7abe6d5947dc0ff

Diff:

Revision 2 (+74 -16)

Show changes

reviewboard/scmtools/models.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

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