ensure-import 0.6.6

Auto install third part packages into virtual environment when import error.

ensure_import

Auto install third part packages by pip into virtual environment when import error.

Install

pip install ensure_import

Usage

• Simple case that package name is module name

from ensure_import import EnsureImport as _EI

while _ei := _EI():
    with _ei:
        import uvicorn
        from fastapi import FastAPI

• Package name is difference from module name

while _ei := _EI():
    with _ei(dotenv='python-dotenv', odbc='pyodbc'):
        import numpy as np
        import uvicorn
        import odbc  # who's package name is `pyodbc`
        from fastapi import FastAPI
        # package name of dotenv is `python-dotenv`
        from dotenv import load_dotenv

• Supply module path

while _ei := _EI('..'):
    with _ei:
        import gunicorn
        import uvicorn

This is equal to:

try:
    import gunicorn
    import uvicorn
except ImportError:
    import sys
    sys.path.append('..')

    import gunicorn
    import uvicorn

• Support __file__

while _ei := _EI(__file__):
    with _ei:
        import local_module

# is equal to:
try:
    import local_module
except ImportError:
    import sys
    from pathlib import Path
    dirpath: str = Path(__file__).parent.as_posix()
    if dirpath not in sys.path:
        sys.path.append(dirpath)

    import local_module

• Use with ipython

uvx --python=.venv/bin/python --with=ensure-import ipython

In IPython:

# Append '.venv/lib/python3.x/site-packages' to sys.path
# So that no need to install ipython into virtual environment
In [1]: from ensure_import import *;EnsureImport.activate(verbose=True);EnsureImport.show(verbose=True)