techtonik / python-patch Goto Github PK

To enable logging when used as a library, you have to:

  import logging
  logger = logging.getLogger('patch')
  logger.setLevel(logging.DEBUG)
  loghandler = logging.StreamHandler()
  logger.addHandler(loghandler)

This suxx. The proposed change is to track logging system state and configure 
it with easier calls.

Hiho..  I wanted to use this as a library in a Python 3.x application, so I 
went ahead and made the necessary modifications to make it run under both 2.x 
and 3.x (patch is attached)

It passes all the provided tests, and works nicely for my project with the 
patch applied, but I do note that one of the things I had to fiddle with a bit 
is the different way that file IO is handled (particularly with respect to 
newlines) in Py3.  I think the changes I made should result in similar behavior 
in both versions, but I haven't done really extensive testing...

Tracker issue to monitor when Mercurial patch format will be parsed and applied 
correctly.

The attached patch does a few things related to how/when messages are printed:

1. Changes the default loglevel when used as a library to WARN.  This is 
because since there's currently no other way for the caller to get any feedback 
about success/failure, it should at least default to a setting where somebody 
might notice if there's problems.  (Better to have the app developer have to 
explicitly turn off errors than have things fail silently by default)

2. Changes the "successfully patched..." message to INFO instead of WARN, since 
it's actually normal, not an error.

3. Adds a '--quiet' option to the command line, to suppress normal info 
messages if desired.

4. Changes the run_tests.py code to use the 'quiet' flag when invoking the 
patch.py program.  This is mainly just a cosmetic thing, but it gets rid of all 
the spammy messages from patch.py when running the test suite.

@ r158 , xstrip does not return a file, resulting in anything that relies on 
the Path.target to be a string to fail (such as diffstat)

I have attached a patch (of course) with a test and a fix.

Thanks for this great tool!

I'm using patch in an app that needs to accept patch files and apply them 
safely contained within a certain directory. Namely, it needs to vet each file 
that is to be modified and fail if a patch attempts to modify any file outside 
the base directory that the patch is to be applied to - this could be due to 
symlinks, relative or absolute paths.

To enable this, I've split up the `apply` function into two parts:

patchset.file_patches()
 - returns a generator of (filename, patch) pairs - note that this is the filename that will be modified (so it may be either the source or target)

patchset.apply_patch(filename, i, p):
 - applies an inidivual patch to the given filename. I've left the variable names as-is for the sake of a minimal patch, but `fileno` and `patch` may be better names.

This makes `patchset.apply` a very simple piece of code that just hooks these 
two functions together. My app can now do the same thing, but insert some 
file-checking code before each patch gets applied. Previously it would have to 
duplicate the logic in `apply`, which is quite a huge undertaking.

Other bits:

 - I did have to move the `errors` count into a field on PatchSet, because there's no longer any shared scope between `apply` and `pply_patch`.

 - fixed `xstrip` function which never actually returned anything but `None`.

 - Added "normalize_filenames" params to `parse` (and init) function defaulting to True, to optionally prevent path normalization (which just confuses the matter for my application).


`patch` is the actual patch - I'm also attaching `patch_whitespace_indifferent` 
just for your information (since the change alters a lot of whitespace).

a
b
c

--- file.txt
+++ file.txt
@@ -1,3 +1,4 @@
 a
 b
+b1
 d

a
b
b1
d

$ python -m patch find_in_files_feature.diff 
file 1/1:    spyderlib/widgets/explorer.py
 hunk no.1 doesn't match source file at line 299
  expected:                                triggered=lambda fnames=fnames:
  actual  :         

diff --git a/spyderlib/widgets/explorer.py b/spyderlib/widgets/explorer.py
index c4081df..dfe8623 100644
--- a/spyderlib/widgets/explorer.py
+++ b/spyderlib/widgets/explorer.py
@@ -300,6 +300,11 @@ class DirView(QTreeView):
                                triggered=lambda fnames=fnames:
                                self.open_interpreter(fnames))
         actions.append(action)
+        _title = _("Find from here...")
+        action = create_action(self, _title, icon="find.png",
+                               triggered=lambda:
+                               self.find_from_here(fnames))
+        actions.append(action)
         return actions

     def create_context_menu_actions(self):

What version of the product are you using?  HEAD r158

What steps will reproduce the problem?

1.Use this patch (attached too):

See how the first context line is on the hunk header line
{{{
Index: linux-2.6.23/fs/Makefile
===================================================================
--- linux-2.6.23.orig/fs/Makefile
+++ linux-2.6.23/fs/Makefile
@@ -72,7 +72,6 @@ obj-$(CONFIG_JBD)     += jbd/
 obj-$(CONFIG_JBD2)     += jbd2/
 obj-$(CONFIG_EXT2_FS)      += ext2/
 obj-$(CONFIG_CRAMFS)       += cramfs/
-obj-$(CONFIG_SQUASHFS)     += squashfs/
 obj-$(CONFIG_RAMFS)        += ramfs/
 obj-$(CONFIG_HUGETLBFS)        += hugetlbfs/
 obj-$(CONFIG_CODA_FS)      += coda/

}}}

2. Then run this:
{{{
# python -c "import patch;p=patch.fromfile('sample.patch');from pprint import 
pprint as pp;pp( p.items[0].hunks[0].text)"
[' obj-$(CONFIG_JBD2)\t\t+= jbd2/\r\n',
 ' obj-$(CONFIG_EXT2_FS)\t\t+= ext2/\r\n',
 ' obj-$(CONFIG_CRAMFS)\t\t+= cramfs/\r\n',
 '-obj-$(CONFIG_SQUASHFS)\t\t+= squashfs/\r\n',
 ' obj-$(CONFIG_RAMFS)\t\t+= ramfs/\r\n',
 ' obj-$(CONFIG_HUGETLBFS)\t\t+= hugetlbfs/\r\n',
 ' obj-$(CONFIG_CODA_FS)\t\t+= coda/']
}}}

3. The expected results here should be:
{{{
[' obj-$(CONFIG_JBD)\t\t+= jbd/\r\n',
 ' obj-$(CONFIG_JBD2)\t\t+= jbd2/\r\n',
 ' obj-$(CONFIG_EXT2_FS)\t\t+= ext2/\r\n',
 ' obj-$(CONFIG_CRAMFS)\t\t+= cramfs/\r\n',
 '-obj-$(CONFIG_SQUASHFS)\t\t+= squashfs/\r\n',
 ' obj-$(CONFIG_RAMFS)\t\t+= ramfs/\r\n',
 ' obj-$(CONFIG_HUGETLBFS)\t\t+= hugetlbfs/\r\n',
 ' obj-$(CONFIG_CODA_FS)\t\t+= coda/']

}}}
Note that I have no idea how the patch was originally produced. It could have 
been manually edited and could be incorrect. I do not know either if that extra 
line would be used by GNU patch as context line or also discarded.

What steps will reproduce the problem?
1.Produce patches for files named with spaces using "diff", "hg" and "svn"
2.Try patch.py on these

What steps will reproduce the problem?
1.create a patch for an executable shell script
2.apply patch

What is the expected output? What do you see instead?
Target script must stay executable. Actually, its mode changes and executable 
permission

What version of the product are you using? On what operating system?
@146, python 2.6, Win and Mac

Anatoly: a release on Pypi would be quite nice....

Just as a minor cleanup issue, I also have a patch (attached) to move the 
imports which are only used when running as an application inside the __main__ 
test so they don't get imported if you're just using it as a library.

Not a major issue, but no reason to load them if they're not going to be used..

What steps will reproduce the problem?
1. attempt to run a patch where some of the hunks are non-existing files on the 
target

What is the expected output? What do you see instead?
patch should create these files - as does the linux patch utility, possibly 
creating directories as well

What version of the product are you using? On what operating system?


Please provide any additional information below.

INFO  hunk no.1 doesn't match source file at line 275

What steps will reproduce the problem?
1. Add new or change existing binary file in svn repository.
2. Create svn diff.
3. Try to parse/apply patch with patch.py 

What is the expected output? What do you see instead?
I would expect binary file to be copied over; at the very least - some warning 
that this case cannot be processed.
I actually get AttributeError: 'NoneType' object has no attribute 'hunks'" in 
either line 440 or 444, depending on debugmode setting value.


What version of the product are you using? On what operating system?
@146, python 2.6, Win and Mac.

Please provide any additional information below.
The issue is due to incorrect processing of header in this case - code after 
line 220 ("if headscan:") doesn't stop and treats this whole thing as a header 
without any additional parsing:

Index: bin.png

===================================================================
Cannot display: file marked as a binary type.
svn:mime-type = application/octet-stream

Property changes on: bin.png


___________________________________________________________________
Added: svn:mime-type
   + application/octet-stream

What do you want to do?

Print the representation of a parsed patch, for instance to split a large 
patchset in one patch per patch file.

How to test if it works as expected? Please describe step by step.

Given a PatchSet object, repr(PatchSet) should return a string that should be 
the same  (or almost the same) as the original parsed file.
Then for each Patch in the patchset, repr(Patch) should return a string that 
should be the same (or almost the same) as the original Patch in the parsed 
file.
Then for each Hunk in a patch, repr(Hunk) should return a string that should be 
the same  (or almost the same) as the original Hunk in the Patch in the parsed 
file.

It is OK if the line endings do not match exactly (i.e. hunkends may be 
ignored) and default to Posix, and it is OK if the repr is not exactly the same 
as the original one, but a good enough one.

Attached is a proposed patch with some tests, based on the latest HEAD @ r196

Hi Anatoly:
I know that "inside" you still use the high density two spaces indentation, but 
I was wondering if the updated public style guide could make sense 
indentation-wise?
http://google-styleguide.googlecode.com/svn/trunk/pyguide.html#Indentation

I know this is a silly request... ignore and close asap if you feel so.

In svn HEAD (r90), on line 22 of patch.py, StringIO is imported using "from 
StringIO import StringIO".  But on line 70 (in fromstring()), the code tries to 
instantiate "StringIO.StringIO", which fails with an AttributeError.

This can be fixed by either changing the import to just "import StringIO" or by 
removing the initial "StringIO." from the place where StringIO is instantiated.

<?php[LF]
[LF]
echo "<html><title>asdf</title><body>asdf</body></html>";[LF]
[LF]
?>[EOF]

--- old/test.php	2017-03-29 11:19:36.103349100 +0200
+++ new/test.php	2017-03-29 11:20:16.270349100 +0200
@@ -1,5 +1,5 @@
 <?php
 
-echo "<html><title>asdf</title><body>asdf</body></html>";
+echo "<html><title>A real title</title><body>A real body</body></html>";
 
 ?>
\ No newline at end of file

<?php[LF]
[LF]
echo "<html><title>A real title</title><body>A real body</body></html>";[LF]
[LF]
?>[LF][EOF]

<?php[LF]
[LF]
echo "<html><title>A real title</title><body>A real body</body></html>";[LF]
[LF]
?>[EOF]

What steps will reproduce the problem?
1.python diff.py -u patch.py.merge-left.r40 patch.py.merge-right.r41 >
portfix.diff

What is the expected output? What do you see instead?
filenames in diff header are not separated from timestamp by tab

--- patch.py.merge-left.r40 Sat Dec 26 11:39:47 2009
+++ patch.py.merge-right.r41 Sat Dec 26 11:39:47 2009
@@ -8,7 +8,7 @@
 """


patch.py fails:
reading patch from file portfix.diff
total files: 1  total hunks: 2
source/target file does not exist
--- patch.py.merge-left.r40 Sat Dec 26 11:39:47 2009
+++ patch.py.merge-right.r41 Sat Dec 26 11:39:47 2009


Need to detect all possible timestamp formats.

What do you want to do?
I want to be able to enter URL of the patch or id of the issue on Rietveld to   
apply patch from it in current directory.

How to test if it works as expected? Please describe step by step.
python patch.py http://codereview.appspot.com/download/issue577041_2001.diff

At the moment, only file patching is implemented.  Refactor to allow string
patching.

I'm using python-patch in one of my projects, so to return the favor here are 
my changes:

1. Support -p<num> like GNU patch, to strip path components

2. Set exit code to 0 or 1 depending on errors occured (like GNU patch)

3. Support creating new files (source=/dev/null), like GNU patch

4. Don't touch global logging configuration on module load, unless used as 
__main__  (useful when embedding in a larger project)

A patch is attached (applies cleanly to SVN r111)

I noticed that patch.py does not support patches that add or remove files.
Following patch against v245 adds support for this.

What steps will reproduce the problem?
1. run patch.py two times

What is the expected output? What do you see instead?
file 4/4:    templates/issue.html
 hunk no.2 doesn't match source file at line 203
  expected:       <input type="hidden" name="subject" value="{{issue.subject}}" />
  actual  :       <input type="hidden" name="in_reply_to" value="" />
already patched  templates/issue.html

this can be replaced with something like

file 4/4:    templates/issue.html
already patched  templates/issue.html

or even

file 4/4 already patched:    templates/issue.html

invalid hunk header in patch

Revise documentation on unified diff format and include diagrams for at least 
classic, svn and hg diff.

Actions class will allow customization of python-patch behavior like 
interactive/automatic mode, create/remove files, readonly check if the tree is 
patchable, show patch plan for confirmation by user.

python-patch does't understand Mercurial diff renames. It should.

-d option is useful specify patch root directory.

    lst->InsertColumn(1, _("Version"));
    lst->InsertColumn(2, _("Installed"));
    lst->InsertColumn(3, _("Size"), wxLIST_FORMAT_RIGHT);

    lst->SetColumnWidth(0, lst->GetSize().x - (64 * 3) - 2); // 1st column takes all remaining space
    lst->SetColumnWidth(1, 64);
    lst->SetColumnWidth(2, 64);
    lst->SetColumnWidth(3, 64);
}

void UpdateDlg::AddRecordToList(UpdateRec* rec)

What steps will reproduce the problem?
1. test.py file as follows:

import patch
patch.apply_patch(patch.read_patch('my.patch'))

2. Run script with "C:\python26\python.exe test.py"

What is the expected output? What do you see instead?

Expected: 

WARNING:root:successfully patched htdocs/index.php

Received:

WARNING:root:source/target file does not exist
--- htdocs/index.php

+++ htdocs/index.php


What version of the product are you using? On what operating system?
Using patch-8.06-2, Python 2.6.2, Win XP SP3.


Fix seems to be simple, change line 133 from:

          files["source"].append(match.group(1))

to:

          files["source"].append(match.group(1).strip())

Not sure why this hasn't affected anyone before now.

Hi Anatoly:

the code in 
http://code.google.com/p/python-patch/source/browse/trunk/patch.py#89 is not 
cross platform and will yield different results when running on posix or 
windows.

What steps will reproduce the problem?
Using a patch like this: http://drupal.org/files/issues/drupal_upload.patch

diff -Nup C:\Documents and Settings\Boki\Desktop\head\patches\drupal6/drupal.js 
C:\Documents and Settings\Boki\Desktop\head\patches\parallel uploads/drupal.js
--- C:\Documents and 
Settings\Boki\Desktop\head\patches\drupal6/drupal.js    2007-06-08 
14:52:00.000000000 +0200
+++ C:\Documents and Settings\Boki\Desktop\head\patches\parallel 
uploads/drupal.js   2007-06-16 19:27:20.953125000 +0200


We will get on posix after parsing the patch:

source: Documents and Settings\Boki\Desktop\head\patches\drupal6/drupal.js
target: Documents and Settings\Boki\Desktop\head\patches\parallel 
uploads/drupal.js


And on Windows:

source: Documents and Settings/Boki/Desktop/head/patches/drupal6/drupal.js
target: Documents and Settings/Boki/Desktop/head/patches/parallel 
uploads/drupal.js


What is the expected output? What do you see instead?
=>The output should be the same on all OS



Actual output on win:

Python 2.6.6 (r266:84297, Aug 24 2010, 18:46:32) [MSC v.1500 32 bit (Intel)] on 
win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import patch
>>> p=patch.fromurl('http://drupal.org/files/issues/drupal_upload.patch')
>>> p.items[0].source
'Documents and Settings/Boki/Desktop/head/patches/drupal6/drupal.js'
>>> p.items[0].target
'Documents and Settings/Boki/Desktop/head/patches/parallel uploads/drupal.js'


Actual output on posix (here with cugwin, but the same behavior has been 
verified on Linux and Macosx):
Python 2.6.5 (r265:79063, Jun 12 2010, 17:07:01)
[GCC 4.3.4 20090804 (release) 1] on cygwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import patch
>>> p=patch.fromurl('http://drupal.org/files/issues/drupal_upload.patch')
>>> p.items[0].source
'Documents and Settings\\Boki\\Desktop\\head\\patches\\drupal6/drupal.js'
>>> p.items[0].target
'Documents and Settings\\Boki\\Desktop\\head\\patches\\parallel 
uploads/drupal.js'


Tell me if you want a patch... The strategy I use in general for cross-os path 
handling is to convert at the boundaries any path to posix, and use internally 
the posixpath module for all path handling, converting back to os.path-specific 
path on demand for thing that require actual IOs to os files.

--
Cordially
Philippe