Summary

Allow skipping warnings on subclasses and deferring warning classes.

Review Request #13123 — Created June 22, 2023 and submitted June 23, 2023, 2:35 p.m.

Information

Owner

chipx86

Repository

housekeeping

Branch

master

Bugs

Depends On

Reviewers

Groups

beanbag-misc

People

Description

While converting Djblets to housekeeping, we hit an interesting case

where we needed to allow a deprecated base class to remain a base class

for now, but to warn when otherwise used. Furthermore, the base class

was for deprecation warnings, and needed to use a versioned warning

class when otherwise subclassed.
To handle that, two additions were made:


Subclasses of a ClassDeprecatedMixin or ClassMovedMixin can now

   set housekeeping_skip_warning = True to avoid a warning being

   emitted.


All warning_cls parameters can now take a callable that returns a

   warning class when it's time to emit. This can help avoid circular

   reference issues in this particular type of case.

Testing Done

Unit tests pass.

Tested this with upcoming work on moving Djblets to housekeeping.

Commits

Summary	ID
Allow skipping warnings on subclasses and deferring warning classes. While converting Djblets to housekeeping, we hit an interesting case where we needed to allow a deprecated base class to remain a base class for now, but to warn when otherwise used. Furthermore, the base class was for deprecation warnings, and needed to use a versioned warning class when otherwise subclassed. To handle that, two additions were made: 1. Subclasses of a `ClassDeprecatedMixin` or `ClassMovedMixin` can now set `housekeeping_skip_warning = True` to avoid a warning being emitted. 2. All `warning_cls` parameters can now take a callable that returns a warning class when it's time to emit. This can help avoid circular reference issues in this particular type of case.	a598dc60efd24f2d03c0941283381ef339cb6d7f

Summary

Allow skipping warnings on subclasses and deferring warning classes.

While converting Djblets to housekeeping, we hit an interesting case where we needed to allow a deprecated base class to remain a base class for now, but to warn when otherwise used. Furthermore, the base class was for deprecation warnings, and needed to use a versioned warning class when otherwise subclassed. To handle that, two additions were made: 1. Subclasses of a `ClassDeprecatedMixin` or `ClassMovedMixin` can now set `housekeeping_skip_warning = True` to avoid a warning being emitted. 2. All `warning_cls` parameters can now take a callable that returns a warning class when it's time to emit. This can help avoid circular reference issues in this particular type of case.

a598dc60efd24f2d03c0941283381ef339cb6d7f

Issues

Description	From	Last Updated
'housekeeping.base.BaseDeprecationWarningMixin' imported but unused Column: 1 Error code: F401	reviewbot	June 22, 2023, 11:47 p.m.

flake8 failed.

JSHint passed.

flake8

housekeeping/helpers.py (Diff revision 1)

The issue has been resolved. Show all issues

'housekeeping.base.BaseDeprecationWarningMixin' imported but unused

Column: 1
Error code: F401

Change Summary:

Removed an unused import.

Commits:

	Summary	ID
	Allow skipping warnings on subclasses and deferring warning classes. While converting Djblets to housekeeping, we hit an interesting case where we needed to allow a deprecated base class to remain a base class for now, but to warn when otherwise used. Furthermore, the base class was for deprecation warnings, and needed to use a versioned warning class when otherwise subclassed. To handle that, two additions were made: 1. Subclasses of a `ClassDeprecatedMixin` or `ClassMovedMixin` can now set `housekeeping_skip_warning = True` to avoid a warning being emitted. 2. All `warning_cls` parameters can now take a callable that returns a warning class when it's time to emit. This can help avoid circular reference issues in this particular type of case.	f6d813a9f982290b7a5ee05cbadac88577eda725
	Allow skipping warnings on subclasses and deferring warning classes. While converting Djblets to housekeeping, we hit an interesting case where we needed to allow a deprecated base class to remain a base class for now, but to warn when otherwise used. Furthermore, the base class was for deprecation warnings, and needed to use a versioned warning class when otherwise subclassed. To handle that, two additions were made: 1. Subclasses of a `ClassDeprecatedMixin` or `ClassMovedMixin` can now set `housekeeping_skip_warning = True` to avoid a warning being emitted. 2. All `warning_cls` parameters can now take a callable that returns a warning class when it's time to emit. This can help avoid circular reference issues in this particular type of case.	a598dc60efd24f2d03c0941283381ef339cb6d7f

Diff:

Revision 2 (+518 -68)

Show changes

	housekeeping/base.py
	housekeeping/classes.py
	housekeeping/functions.py
	housekeeping/helpers.py
	housekeeping/modules.py
	housekeeping/tests/test_classes.py
	housekeeping/tests/test_functions.py
	housekeeping/tests/test_modules.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to master (9f24a4a)