chipx86 got a fish trophy!

Summary

Add a Patcher class for handling the application of patches.

Review Request #14041 — Created July 14, 2024 and submitted Oct. 10, 2024, 3:50 p.m.

Information

Owner

chipx86

Repository

RBTools

Branch

release-5.x

Bugs

Depends On

~~14040~~

Reviewers

Groups

rbtools

People

Description

The new Patcher class is responsible for taking a list of patches and
applying or reverting them, optionally committing them as well.

Consumers of Patcher are expected to provide the list of patches to
apply (each being a Patch object), the destination path (optionally),
any information known about the repository, and flags to initiate a
revert or squash of the patches.

If the patches are to be committed, they're then expected to call
prepare_for_commit(). Then, patch() can be called.

Patcher.patch() is a generator, taking care to apply each patch in
order and yielding a successful result for each or raising an exception.
Consumers can use the generator nature of this tool to help with
progress reporting.

By default, this interfaces with the local patch tool, supporting both
GNU Patch and Apple/BSD Patch. It takes care to examine output for both
tools and convert them into suitable responses. Subclasses can override
the methods to instead interface with SCM-specific patching tools, and
to even take care to apply or commit multiple patches in one go instead
of individually (which is needed for Mercurial).

Follow-up changes will begin integrating Patcher into the SCMs and
into rbt patch and rbt land.

Testing Done

Unit tests pass.

Commits

Summary	ID
Add a Patcher class for handling the application of patches. The new `Patcher` class is responsible for taking a list of patches and applying or reverting them, optionally committing them as well. Consumers of `Patcher` are expected to provide the list of patches to apply (each being a `Patch` object), the destination path (optionally), any information known about the repository, and flags to initiate a revert or squash of the patches. If the patches are to be committed, they're then expected to call `prepare_for_commit()`. Then, `patch()` can be called. `Patcher.patch()` is a generator, taking care to apply each patch in order and yielding a successful result for each or raising an exception. Consumers can use the generator nature of this tool to help with progress reporting. By default, this interfaces with the local `patch` tool, supporting both GNU Patch and Apple/BSD Patch. It takes care to examine output for both tools and convert them into suitable responses. Subclasses can override the methods to instead interface with SCM-specific patching tools, and to even take care to apply or commit multiple patches in one go instead of individually (which is needed for Mercurial). Follow-up changes will begin integrating `Patcher` into the SCMs and into `rbt patch` and `rbt land`.	01e6e01543afe4fb5ce8d17b129b8202338e6da4

Summary

Add a Patcher class for handling the application of patches.

The new `Patcher` class is responsible for taking a list of patches and applying or reverting them, optionally committing them as well. Consumers of `Patcher` are expected to provide the list of patches to apply (each being a `Patch` object), the destination path (optionally), any information known about the repository, and flags to initiate a revert or squash of the patches. If the patches are to be committed, they're then expected to call `prepare_for_commit()`. Then, `patch()` can be called. `Patcher.patch()` is a generator, taking care to apply each patch in order and yielding a successful result for each or raising an exception. Consumers can use the generator nature of this tool to help with progress reporting. By default, this interfaces with the local `patch` tool, supporting both GNU Patch and Apple/BSD Patch. It takes care to examine output for both tools and convert them into suitable responses. Subclasses can override the methods to instead interface with SCM-specific patching tools, and to even take care to apply or commit multiple patches in one go instead of individually (which is needed for Mercurial). Follow-up changes will begin integrating `Patcher` into the SCMs and into `rbt patch` and `rbt land`.

01e6e01543afe4fb5ce8d17b129b8202338e6da4

Issues

Description	From	Last Updated
'rbtools.api.resource.Resource' imported but unused Column: 1 Error code: F401	reviewbot	July 14, 2024, 11:10 p.m.
'rbtools.utils.filesystem.make_tempfile' imported but unused Column: 1 Error code: F401	reviewbot	July 14, 2024, 11:10 p.m.
'rbtools.utils.filesystem.make_tempfile' imported but unused Column: 1 Error code: F401	reviewbot	July 14, 2024, 11:11 p.m.
undefined name 'make_tempdir' Column: 23 Error code: F821	reviewbot	July 14, 2024, 11:11 p.m.
undefined name 'make_tempdir' Column: 23 Error code: F821	reviewbot	July 14, 2024, 11:11 p.m.
undefined name 'make_tempdir' Column: 23 Error code: F821	reviewbot	July 14, 2024, 11:11 p.m.
undefined name 'make_tempdir' Column: 23 Error code: F821	reviewbot	July 14, 2024, 11:11 p.m.
undefined name 'make_tempdir' Column: 23 Error code: F821	reviewbot	July 14, 2024, 11:11 p.m.
undefined name 'make_tempdir' Column: 23 Error code: F821	reviewbot	July 14, 2024, 11:11 p.m.
undefined name 'make_tempdir' Column: 23 Error code: F821	reviewbot	July 14, 2024, 11:11 p.m.
undefined name 'make_tempdir' Column: 23 Error code: F821	reviewbot	July 14, 2024, 11:11 p.m.
undefined name 'make_tempdir' Column: 23 Error code: F821	reviewbot	July 14, 2024, 11:11 p.m.
undefined name 'make_tempdir' Column: 23 Error code: F821	reviewbot	July 14, 2024, 11:11 p.m.
undefined name 'make_tempdir' Column: 23 Error code: F821	reviewbot	July 14, 2024, 11:11 p.m.
undefined name 'make_tempdir' Column: 23 Error code: F821	reviewbot	July 14, 2024, 11:11 p.m.
undefined name 'make_tempdir' Column: 23 Error code: F821	reviewbot	July 14, 2024, 11:11 p.m.
undefined name 'make_tempdir' Column: 23 Error code: F821	reviewbot	July 14, 2024, 11:11 p.m.
undefined name 'make_tempdir' Column: 23 Error code: F821	reviewbot	July 14, 2024, 11:11 p.m.

flake8 failed.

JSHint passed.

flake8

rbtools/diffs/tests/test_patcher.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'rbtools.api.resource.Resource' imported but unused

Column: 1
Error code: F401
```

rbtools/diffs/tests/test_patcher.py (Diff revision 1)

The issue has been resolved. Show all issues

'rbtools.utils.filesystem.make_tempfile' imported but unused

Column: 1
Error code: F401

Change Summary:

Removed unused imports.

Commits:

	Summary	ID
	Add a Patcher class for handling the application of patches. The new `Patcher` class is responsible for taking a list of patches and applying or reverting them, optionally committing them as well. Consumers of `Patcher` are expected to provide the list of patches to apply (each being a `Patch` object), the destination path (optionally), any information known about the repository, and flags to initiate a revert or squash of the patches. If the patches are to be committed, they're then expected to call `prepare_for_commit()`. Then, `patch()` can be called. `Patcher.patch()` is a generator, taking care to apply each patch in order and yielding a successful result for each or raising an exception. Consumers can use the generator nature of this tool to help with progress reporting. By default, this interfaces with the local `patch` tool, supporting both GNU Patch and Apple/BSD Patch. It takes care to examine output for both tools and convert them into suitable responses. Subclasses can override the methods to instead interface with SCM-specific patching tools, and to even take care to apply or commit multiple patches in one go instead of individually (which is needed for Mercurial). Follow-up changes will begin integrating `Patcher` into the SCMs and into `rbt patch` and `rbt land`.	0e7015b5503d8d57917cd2356c492395452e0ca1
	Add a Patcher class for handling the application of patches. The new `Patcher` class is responsible for taking a list of patches and applying or reverting them, optionally committing them as well. Consumers of `Patcher` are expected to provide the list of patches to apply (each being a `Patch` object), the destination path (optionally), any information known about the repository, and flags to initiate a revert or squash of the patches. If the patches are to be committed, they're then expected to call `prepare_for_commit()`. Then, `patch()` can be called. `Patcher.patch()` is a generator, taking care to apply each patch in order and yielding a successful result for each or raising an exception. Consumers can use the generator nature of this tool to help with progress reporting. By default, this interfaces with the local `patch` tool, supporting both GNU Patch and Apple/BSD Patch. It takes care to examine output for both tools and convert them into suitable responses. Subclasses can override the methods to instead interface with SCM-specific patching tools, and to even take care to apply or commit multiple patches in one go instead of individually (which is needed for Mercurial). Follow-up changes will begin integrating `Patcher` into the SCMs and into `rbt patch` and `rbt land`.	b3848722303ff5757511497660d9d1530fa25e14

Diff:

Revision 2 (+4396)

Show changes

	rbtools/diffs/errors.py
	rbtools/diffs/patcher.py
	rbtools/diffs/tests/test_apply_patch_error.py
	rbtools/diffs/tests/test_patcher.py

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

rbtools/diffs/tests/test_patcher.py (Diff revision 2)

The issue has been resolved. Show all issues

'rbtools.utils.filesystem.make_tempfile' imported but unused

Column: 1
Error code: F401

rbtools/diffs/tests/test_patcher.py (Diff revision 2)
The issue has been resolved. Show all issues
```
undefined name 'make_tempdir'

Column: 23
Error code: F821
```
rbtools/diffs/tests/test_patcher.py (Diff revision 2)
The issue has been resolved. Show all issues
```
undefined name 'make_tempdir'

Column: 23
Error code: F821
```
rbtools/diffs/tests/test_patcher.py (Diff revision 2)
The issue has been resolved. Show all issues
```
undefined name 'make_tempdir'

Column: 23
Error code: F821
```
rbtools/diffs/tests/test_patcher.py (Diff revision 2)
The issue has been resolved. Show all issues
```
undefined name 'make_tempdir'

Column: 23
Error code: F821
```
rbtools/diffs/tests/test_patcher.py (Diff revision 2)
The issue has been resolved. Show all issues
```
undefined name 'make_tempdir'

Column: 23
Error code: F821
```
rbtools/diffs/tests/test_patcher.py (Diff revision 2)
The issue has been resolved. Show all issues
```
undefined name 'make_tempdir'

Column: 23
Error code: F821
```
rbtools/diffs/tests/test_patcher.py (Diff revision 2)
The issue has been resolved. Show all issues
```
undefined name 'make_tempdir'

Column: 23
Error code: F821
```
rbtools/diffs/tests/test_patcher.py (Diff revision 2)
The issue has been resolved. Show all issues
```
undefined name 'make_tempdir'

Column: 23
Error code: F821
```
rbtools/diffs/tests/test_patcher.py (Diff revision 2)
The issue has been resolved. Show all issues
```
undefined name 'make_tempdir'

Column: 23
Error code: F821
```
rbtools/diffs/tests/test_patcher.py (Diff revision 2)
The issue has been resolved. Show all issues
```
undefined name 'make_tempdir'

Column: 23
Error code: F821
```
rbtools/diffs/tests/test_patcher.py (Diff revision 2)
The issue has been resolved. Show all issues
```
undefined name 'make_tempdir'

Column: 23
Error code: F821
```
rbtools/diffs/tests/test_patcher.py (Diff revision 2)
The issue has been resolved. Show all issues
```
undefined name 'make_tempdir'

Column: 23
Error code: F821
```
rbtools/diffs/tests/test_patcher.py (Diff revision 2)
The issue has been resolved. Show all issues
```
undefined name 'make_tempdir'

Column: 23
Error code: F821
```
rbtools/diffs/tests/test_patcher.py (Diff revision 2)
The issue has been resolved. Show all issues
```
undefined name 'make_tempdir'

Column: 23
Error code: F821
```
rbtools/diffs/tests/test_patcher.py (Diff revision 2)
The issue has been resolved. Show all issues
```
undefined name 'make_tempdir'

Column: 23
Error code: F821
```

Change Summary:

Removed the correct unused import.

Commits:

	Summary	ID
	Add a Patcher class for handling the application of patches. The new `Patcher` class is responsible for taking a list of patches and applying or reverting them, optionally committing them as well. Consumers of `Patcher` are expected to provide the list of patches to apply (each being a `Patch` object), the destination path (optionally), any information known about the repository, and flags to initiate a revert or squash of the patches. If the patches are to be committed, they're then expected to call `prepare_for_commit()`. Then, `patch()` can be called. `Patcher.patch()` is a generator, taking care to apply each patch in order and yielding a successful result for each or raising an exception. Consumers can use the generator nature of this tool to help with progress reporting. By default, this interfaces with the local `patch` tool, supporting both GNU Patch and Apple/BSD Patch. It takes care to examine output for both tools and convert them into suitable responses. Subclasses can override the methods to instead interface with SCM-specific patching tools, and to even take care to apply or commit multiple patches in one go instead of individually (which is needed for Mercurial). Follow-up changes will begin integrating `Patcher` into the SCMs and into `rbt patch` and `rbt land`.	b3848722303ff5757511497660d9d1530fa25e14
	Add a Patcher class for handling the application of patches. The new `Patcher` class is responsible for taking a list of patches and applying or reverting them, optionally committing them as well. Consumers of `Patcher` are expected to provide the list of patches to apply (each being a `Patch` object), the destination path (optionally), any information known about the repository, and flags to initiate a revert or squash of the patches. If the patches are to be committed, they're then expected to call `prepare_for_commit()`. Then, `patch()` can be called. `Patcher.patch()` is a generator, taking care to apply each patch in order and yielding a successful result for each or raising an exception. Consumers can use the generator nature of this tool to help with progress reporting. By default, this interfaces with the local `patch` tool, supporting both GNU Patch and Apple/BSD Patch. It takes care to examine output for both tools and convert them into suitable responses. Subclasses can override the methods to instead interface with SCM-specific patching tools, and to even take care to apply or commit multiple patches in one go instead of individually (which is needed for Mercurial). Follow-up changes will begin integrating `Patcher` into the SCMs and into `rbt patch` and `rbt land`.	01e6e01543afe4fb5ce8d17b129b8202338e6da4

Diff:

Revision 3 (+4396)

Show changes

	rbtools/diffs/errors.py
	rbtools/diffs/patcher.py
	rbtools/diffs/tests/test_apply_patch_error.py
	rbtools/diffs/tests/test_patcher.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-5.x (6cf52b6)