recipe for patching eggs
Project description
Code repository: http://github.com/garbas/collective.recipe.patch
Report bugs at http://github.com/garbas/collective.recipe.patch/issues
Detailed Documentation
Supported options
The recipe supports the following options:
- path
Define a directory in which the patch should be applied. For example:
path = src/some/directory/
- egg
Define which egg should be patched. You can also pin to a specific version. For example:
egg = some.egg<=1.1.1
- patches
Paths to patch files. These patches are applied in order. For example:
patches = patches/my_very_sprecial.patch patches/another_loverly.patch
Example usage
Our demo package which we will patch:
>>> mkdir(sample_buildout, 'demo') >>> write(sample_buildout, 'demo', 'README.txt', " ") >>> write(sample_buildout, 'demo', 'demo.py', ... """# demo egg ... """) >>> write(sample_buildout, 'demo', 'setup.py', ... """ ... from setuptools import setup ... ... setup( ... name = "demo", ... version='1.0', ... py_modules=['demo'] ... ) ... """) >>> print system(buildout+' setup demo bdist_egg'), # doctest: +ELLIPSIS Running setup script 'demo/setup.py'. ...
Create our patch:
>>> write(sample_buildout, 'demo.patch', ... """diff --git demo.py demo.py ... --- demo.py ... +++ demo.py ... @@ -1 +1,2 @@ ... # demo egg ... +# patching ... """)
Let’s write out buildout.cfg to patch our demo package:
>>> write(sample_buildout, 'buildout.cfg', ... """ ... [buildout] ... parts = demo-patch ... index = demo/dist/ ... ... [demo-patch] ... recipe = collective.recipe.patch ... egg = demo==1.0 ... patches = demo.patch ... """)
Our final egg name depends on current python version:
>>> import sys >>> demoegg = 'demo-1.0-py%d.%d.egg' % sys.version_info[:2]
Running the buildout gives us:
>>> print system(buildout) Not found: demo/dist/... ... Installing demo-patch. ... Getting distribution for 'demo==1.0'. Got demo 1.0. patch: reading patch .../demo.patch ... patch: successfully patched ...develop-eggs/demo-1.0-py...egg/demo.py>>> ls(sample_buildout, 'develop-eggs', demoegg) d EGG-INFO - demo.py - demo.pyc - demo.pyo >>> cat(sample_buildout, 'demo', 'demo.py') # demo egg >>> cat(sample_buildout, 'develop-eggs', demoegg, 'demo.py') # demo egg # patching
Multiple patches
If you have more than one patch to apply:
>>> write(sample_buildout, 'another.patch', ... """diff --git demo.py demo.py ... --- demo.py ... +++ demo.py ... @@ -1,2 +1 @@ ... -# demo egg ... # patching ... """)
Update your buildout.cfg to list the new patch. In this case, another.patch should be applied after demo.patch:
>>> write(sample_buildout, 'buildout.cfg', ... """ ... [buildout] ... parts = demo-patch ... index = demo/dist/ ... ... [demo-patch] ... recipe = collective.recipe.patch ... egg = demo==1.0 ... patches = demo.patch ... another.patch ... """)
Running the buildout gives us:
>>> print system(buildout) Not found: demo/dist/... ... Installing demo-patch. ... Getting distribution for 'demo==1.0'. Got demo 1.0. patch: reading patch .../demo.patch ... patch: successfully patched ...develop-eggs/demo-1.0-py...egg/demo.py patch: reading patch .../another.patch ... patch: successfully patched ...develop-eggs/demo-1.0-py...egg/demo.py>>> cat(sample_buildout, 'develop-eggs', demoegg, 'demo.py') # patching
External binaries
We can also set an external binary to use for patching:
>>> write(sample_buildout, 'buildout.cfg', ... """ ... [buildout] ... parts = demo-patch ... index = demo/dist/ ... ... [demo-patch] ... recipe = collective.recipe.patch ... patch-binary = patch ... egg = demo==1.0 ... patches = demo.patch ... """)
Running the buildout gives us:
>>> print system(buildout) Not found: demo/dist/... ... Installing demo-patch. ... Getting distribution for 'demo==1.0'. Got demo 1.0. patch: reading patch .../demo.patch ... patch: patching file demo.py>>> ls(sample_buildout, 'develop-eggs', demoegg) d EGG-INFO - demo.py - demo.pyc - demo.pyo >>> cat(sample_buildout, 'demo', 'demo.py') # demo egg >>> cat(sample_buildout, 'develop-eggs', demoegg, 'demo.py') # demo egg # patching
Patching an egg installed in another part
Another possibility is to install an egg with zc.recipe.egg (or probably any other recipe) and patch it afterwards. However, it is necessary to install the egg unzipped, and the egg may end up in the eggs-folder instead the develop-eggs folder.
>>> write(sample_buildout, 'buildout.cfg', ... """ ... [buildout] ... parts = demo-egg demo-patch ... index = demo/dist/ ... ... [demo-egg] ... recipe = zc.recipe.egg ... eggs = demo==1.0 ... unzip = true ... ... [demo-patch] ... recipe = collective.recipe.patch ... egg = ${demo-egg:eggs} ... patches = demo.patch ... """)
Running the buildout gives us:
>>> print system(buildout) Not found: demo/dist/... ... Installing demo-egg. ... Getting distribution for 'demo==1.0'. Got demo 1.0. Installing demo-patch. ... patch: successfully patched ...eggs/demo-1.0-py...egg/demo.py>>> ls(sample_buildout, 'eggs', demoegg) d EGG-INFO - demo.py - demo.pyc - demo.pyo >>> cat(sample_buildout, 'demo', 'demo.py') # demo egg >>> cat(sample_buildout, 'eggs', demoegg, 'demo.py') # demo egg # patching
Broken patches
If one of the patches is broken:
>>> write(sample_buildout, 'missing-file.patch', ... """diff --git missing-file.py missing-file.py ... --- missing-file.py ... +++ missing-file.py ... @@ -1,2 +0 @@ ... -# BROKEN ... -# PATCH ... """)
When you try to apply multiple patches, it will fail to apply any subsequent patches, letting you fix the problem:
>>> write(sample_buildout, 'buildout.cfg', ... """ ... [buildout] ... parts = demo-patch ... index = demo/dist/ ... ... [demo-patch] ... recipe = collective.recipe.patch ... egg = demo==1.0 ... patches = missing-file.patch ... demo.patch ... """)
Running the buildout gives us:
>>> print system(buildout) Not found: demo/dist/... ... Installing demo-patch. ... Getting distribution for 'demo==1.0'. Got demo 1.0. patch: reading patch .../missing-file.patch ... patch: source/target file does not exist --- .../missing-file.py +++ .../missing-file.py While: Installing demo-patch. Error: could not apply .../missing-file.patch>>> cat(sample_buildout, 'develop-eggs', demoegg, 'demo.py') # demo egg
Or when using an external binary:
>>> write(sample_buildout, 'buildout.cfg', ... """ ... [buildout] ... parts = demo-patch ... index = demo/dist/ ... ... [demo-patch] ... recipe = collective.recipe.patch ... patch-binary = patch ... egg = demo==1.0 ... patches = missing-file.patch ... demo.patch ... """) >>> print system(buildout) Not found: demo/dist/... ... Installing demo-patch. patch: reading patch .../missing-file.patch ... patch: patch: **** malformed patch at line 6: While: Installing demo-patch. Error: could not apply .../missing-file.patch>>> cat(sample_buildout, 'develop-eggs', demoegg, 'demo.py') # demo egg
Contributors
Rok Garbas, Author
Dylan Jay
Gerhard Weis
Simon Law
Change history
0.2.2 (2009-12-14)
make tests pass again [garbas]
0.2.1 (2009-12-14)
made tests independent of python version
bring back python2.4 compatibility
0.2 (2009-11-20)
Added option to use external patch binary instead of bundled python-patch
Lets you specify multiple patches.
Reapplies patches if any of them have changed.
Aborts if any of the patches are broken.
0.1 (2008-10-27)
Created recipe with ZopeSkel [garbas]
Download
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for collective.recipe.patch-0.2.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 262498a92d57a1dd658c7794ca6cb0b61cb52411aa765c0e527fa8380700733d |
|
MD5 | 0cde3c249daa05fc4479e06880f22744 |
|
BLAKE2b-256 | 9f2ed89753b9c70d2f7c905df8ee2ace059b782d7b8711e9ef319bdff08ad48d |