Autowrapt

Common errors

• Monkey patch specified in AUTOWRAPT_BOOTSTRAP is not applied or has no effect.

  cause The most common causes are an incorrect installation of `autowrapt` (not using pip), a misspelled or incorrect entry point name in the `AUTOWRAPT_BOOTSTRAP` environment variable, or the target module being imported before `autowrapt`'s bootstrap mechanism can activate.
  fix Ensure `autowrapt` was installed with `pip`. Verify that the `AUTOWRAPT_BOOTSTRAP` environment variable exactly matches the `setuptools` entry point name for your patch. Check the timing of module imports in your application; autowrapt aims to run early, but explicit `from module import function` statements before bootstrap can prevent patches from taking effect on those specific references.

• Error: 'No module named autowrapt.bootstrap' or similar during Python interpreter startup.

  cause This error can occur if the `autowrapt-init.pth` file is not correctly placed or processed by the Python interpreter, which is often a symptom of `autowrapt` not being installed via `pip`.
  fix Reinstall `autowrapt` using `pip` (`pip install autowrapt`). Avoid `python setup.py install` or `easy_install`. Confirm that `autowrapt-init.pth` exists in your Python's `site-packages` directory.

Warnings

• breaking Incorrect installation method can prevent autowrapt from working. Using `python setup.py install` or `easy_install` can cause the critical `.pth` file to be installed incorrectly (e.g., inside an egg directory), preventing activation.
  Fix: Always install `autowrapt` using `pip` (e.g., `pip install autowrapt` or `pip install -e .` for development).
• gotcha Monkey patching, especially using `.pth` files, is a powerful technique that runs code early in the Python interpreter's startup. This can introduce hard-to-debug issues related to import order, unexpected side effects, and security concerns as code runs implicitly.
  Fix: Thoroughly test patched applications. Be aware of the 'ordering problem' where other code might import a module before the patch can be applied. Consider explicit patching with `wrapt` if implicit global patching is not strictly necessary. For security, be cautious about installing packages that leverage `.pth` files.
• gotcha The `autowrapt` project itself has not been updated since 2015 (version 1.0). While its core dependency `wrapt` is actively maintained, `autowrapt` may not fully leverage the latest features or address edge cases in newer Python versions or `wrapt` versions beyond what was available in 2015.
  Fix: Review the GitHub repository for any open issues or discussions related to compatibility with modern Python versions (e.g., Python 3.9+). Consider whether its specific approach is still the best fit for current project needs or if manual `wrapt` usage or other patching techniques are more appropriate.

Install

• pip install autowrapt Install with pip

Imports

• autowrapt.bootstrap

  N/A (activated via env var)

  Autowrapt's primary function is activated via the AUTOWRAPT_BOOTSTRAP environment variable, not by direct import into user application code. Internally, `autowrapt.bootstrap` contains the core logic.

Quickstart

Autowrapt applies patches via environment variables and setuptools entry points. To quickly test, first define a patch in a module (e.g., `my_patch.py` with `def add_zen_line(module): print('The wrapt package is absolutely amazing and you should use it.')`). Then, in a `setup.py` in the same directory, register this as an entry point: `entry_points={'autowrapt.examples': ['my_patch = my_patch:add_zen_line']}`. Install your package in editable mode (`pip install -e .`). Finally, run your Python script with the `AUTOWRAPT_BOOTSTRAP` environment variable set to activate your patch. This example demonstrates patching Python's `this` module to add an extra line to the Zen of Python.

import this