IPython Generic Utilities

0.2.0 · deprecated · verified Sat Apr 11

ipython-genutils (version 0.2.0) is a collection of IPython-specific utility functions and modules that were extracted from the main IPython project. It served as a dependency for older IPython components and related projects during the Python 2 to 3 transition. It is considered vestigial, no longer actively developed, with its last release in 2017. New projects should avoid direct reliance on it.

Common errors

```
ModuleNotFoundError: No module named 'ipython_genutils'
```
cause The 'ipython-genutils' package, or a higher-level dependency like Jupyter that relies on it, is not installed in the active Python 3 environment.

fix Install the package using `pip install ipython-genutils`. If this package is a dependency of another tool (like Jupyter), ensure that tool is installed correctly, as it should pull 'ipython-genutils' as a dependency.
```
ImportError: No module named ipython_genutils
```
cause This error is the Python 2 equivalent of 'ModuleNotFoundError' and occurs when the 'ipython-genutils' package is a missing dependency for older versions of IPython or Jupyter components in a Python 2 environment.

fix Install the package using `pip install ipython-genutils`. Verify that you are using the correct Python 2 environment and its associated `pip` for installation.
```
ModuleNotFoundError: No module named 'ipython_genutils.py3compat'
```
cause An older library or a specific version of a Jupyter component, particularly from the Python 2 to Python 3 transition period, is attempting to import the 'py3compat' module from 'ipython_genutils', but it is either missing, inaccessible, or incompatible in the current Python environment.

fix Ensure 'ipython-genutils' is installed (`pip install ipython-genutils`). If the error persists, it often indicates a dependency conflict; consider upgrading the main package that triggers this import or isolating the environment to resolve the problematic dependency.

Warnings

deprecated This library is considered vestigial and is no longer actively maintained. Its utilities have largely been superseded by modern Python standard library features (e.g., `pathlib`, `tempfile`) or integrated into other active projects (e.g., `jupyter_core.paths` for path utilities).
Fix: New projects should avoid using `ipython-genutils` directly. Migrate to `pathlib`, `tempfile`, or `jupyter_core.paths` as appropriate for similar functionality.
gotcha Due to its lack of maintenance, `ipython-genutils` does not receive updates for new Python versions. While it currently works on recent Python 3, future Python versions may introduce incompatibilities that will not be addressed.
Fix: Rely on standard library features or actively maintained third-party libraries for similar functionality to ensure long-term compatibility and security patches.
gotcha The utilities within `ipython-genutils` were extracted from IPython's internal codebase and are generally low-level. They are not intended for direct end-user application development in most cases and may have unexpected edge cases or limited scope.
Fix: Review the source code of specific utilities before use to understand their purpose and limitations. Prefer higher-level abstractions or actively maintained libraries where available.

Install

pip install ipython-genutils Install stable version

Imports

version_info
```
from ipython_genutils.version import version_info
```
Provides version details for ipython-genutils itself.
PY3
```
from ipython_genutils.py3compat import PY3
```
A boolean indicating if running on Python 3. Part of the Python 2/3 compatibility layer, largely irrelevant for modern Python development.
get_ipython_dir
```
from ipython_genutils.path import get_ipython_dir
```
Retrieves the IPython configuration directory. For modern Jupyter/IPython installations, consider `jupyter_core.paths` instead.
TemporaryDirectory
```
from ipython_genutils.tempdir import TemporaryDirectory
```
Provides a context manager for temporary directories. Python's standard library `tempfile.TemporaryDirectory` should be preferred.

Quickstart

This quickstart demonstrates importing and using a few common utilities from ipython-genutils, such as checking its version, verifying Python 3 compatibility, and retrieving the IPython directory path. It highlights that the library's functions are typically low-level or superseded.

from ipython_genutils.version import version_info
from ipython_genutils.py3compat import PY3
from ipython_genutils.path import get_ipython_dir

print(f"ipython-genutils version: {'.'.join(map(str, version_info))}")
print(f"Running on Python 3: {PY3}")

# Note: This path utility is largely internal to IPython/Jupyter now.
# For new projects, consider `jupyter_core.paths` or `pathlib`.
ipython_dir = get_ipython_dir()
print(f"Detected IPython directory (if configured): {ipython_dir}")

view raw JSON →