Skip to main content

A patch parsing library.

Project description

What The Patch!?

What The Patch!? is a library for both parsing and applying patch files.


  • Parsing of almost all diff formats (except forwarded ed):
    • normal (default, –normal)
    • copied context (-c, –context)
    • unified context (-u, –unified)
    • ed script (-e, –ed)
    • rcs ed script (-n, –rcs)
  • Parsing of several SCM patches:
    • CVS
    • SVN
    • Git


To install What The Patch!?, simply:

$ pip install whatthepatch


Let us say we have a patch file containing some changes, aptly named ‘somechanges.patch’:

--- lao     2012-12-26 23:16:54.000000000 -0600
+++ tzu     2012-12-26 23:16:50.000000000 -0600
@@ -1,7 +1,6 @@
-The Way that can be told of is not the eternal Way;
-The name that can be named is not the eternal name.
 The Nameless is the origin of Heaven and Earth;
-The Named is the mother of all things.
+The named is the mother of all things.
 Therefore let there always be non-being,
   so we may see their subtlety,
  And let there always be being,
@@ -9,3 +8,6 @@
 The two are the same,
 But after they are produced,
   they have different names.
+They both may be called deep and profound.
+Deeper and more profound,
+The door of all subtleties!


Here is how we would use What The Patch!? in Python to get the changeset for each diff in the patch:

>>> import whatthepatch
>>> import pprint
>>> with open('tests/casefiles/diff-unified.diff') as f:
...     text =
>>> for diff in whatthepatch.parse_patch(text):
...     print(diff) # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
                   old_version='2013-01-05 16:56:19.000000000 -0600',
                   new_version='2013-01-05 16:56:35.000000000 -0600'),
     changes=[Change(old=1, new=None, hunk=1, line='The Way that can be told of is not the eternal Way;'),
              Change(old=2, new=None, hunk=1, line='The name that can be named is not the eternal name.'),
              Change(old=3, new=1, hunk=1, line='The Nameless is the origin of Heaven and Earth;'),
              Change(old=4, new=None, hunk=1, line='The Named is the mother of all things.'),
              Change(old=None, new=2, hunk=1, line='The named is the mother of all things.'),
              Change(old=None, new=3, hunk=1, line=''), Change(old=5, new=4, hunk=1, line='Therefore let there always be non-being,'),
              Change(old=6, new=5, hunk=1, line='  so we may see their subtlety,'),
              Change(old=7, new=6, hunk=1, line='And let there always be being,'),
              Change(old=9, new=8, hunk=2, line='The two are the same,'),
              Change(old=10, new=9, hunk=2, line='But after they are produced,'),
              Change(old=11, new=10, hunk=2, line='  they have different names.'),
              Change(old=None, new=11, hunk=2, line='They both may be called deep and profound.'),
              Change(old=None, new=12, hunk=2, line='Deeper and more profound,'),
              Change(old=None, new=13, hunk=2, line='The door of all subtleties!')],

The changes are listed as they are in the patch, but instead of the +/- syntax of the patch, we get a tuple of two numbers and the text of the line. What these numbers indicate are as follows:

  1. ( old=1, new=None, ... ) indicates line 1 of the file lao was removed.
  2. ( old=None, new=2, ... ) indicates line 2 of the file tzu was inserted.
  3. ( old=5, new=4, ... ) indicates that line 5 of lao and line 4 of tzu are equal.

Please note that not all patch formats provide the actual lines modified, so some results will have the text portion of the tuple set to None.


To apply a diff to some lines of text, first read the patch and parse it.

>>> import whatthepatch
>>> with open('tests/casefiles/diff-default.diff') as f:
...     text =
>>> with open('tests/casefiles/lao') as f:
...     lao =
>>> diff = [x for x in whatthepatch.parse_patch(text)]
>>> diff = diff[0]
>>> tzu = whatthepatch.apply_diff(diff, lao)
>>> tzu  # doctest: +NORMALIZE_WHITESPACE
['The Nameless is the origin of Heaven and Earth;',
 'The named is the mother of all things.',
 'Therefore let there always be non-being,',
 '  so we may see their subtlety,',
 'And let there always be being,',
 '  so we may see their outcome.',
 'The two are the same,',
 'But after they are produced,',
 '  they have different names.',
 'They both may be called deep and profound.',
 'Deeper and more profound,',
 'The door of all subtleties!']


  1. Fork this repository
  2. Create a new branch to work on
  3. Commit your tests and/or changes
  4. Push and create a pull request here!

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for whatthepatch-graingert, version 0.0.6
Filename, size File type Python version Upload date Hashes
Filename, size whatthepatch_graingert-0.0.6-py2.py3-none-any.whl (12.9 kB) File type Wheel Python version 3.5 Upload date Hashes View
Filename, size whatthepatch-graingert-0.0.6.tar.gz (10.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page