Import hook to load rust projects built with maturin

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for mbway from gravatar.com mbway Avatar for messense from gravatar.com messense

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache Software License, MIT License
  • Author: Matthew Broadway
  • Requires: Python >=3.9
Classifiers
Report project as malware

Project description

Maturin Import Hook

A python import hook to automatically rebuild maturin projects and import stand-alone rust files.

Using this import hook reduces friction when developing mixed python/rust codebases because changes made to rust components take effect automatically like changes to python components do.

The import hook also provides conveniences such as importlib.reload() support for maturin projects.

Documentation can be found at maturin.rs.

Usage

After installing maturin, install the import hook into a python virtual environment with:

pip install maturin_import_hook

Then, optionally make the hook activate automatically with:

python -m maturin_import_hook site install

This only has to be run once for each virtual environment.

Alternatively, put the following at the top of each python script where you want to use the hook:

import maturin_import_hook

# install the import hook with default settings.
# this call must be before any imports that you want the hook to be active for.
maturin_import_hook.install()

# when a rust package that is installed in editable mode is imported,
# that package will be automatically recompiled if necessary.
import example_maturin_package

# when a .rs file is imported a project will be created for it in the
# maturin build cache and the resulting library will be loaded.
#
# assuming subpackage/my_rust_script.rs defines a pyo3 module:
import subpackage.my_rust_script

Once the hook is active, any import statement that imports an editable-installed maturin project will be automatically rebuilt if necessary before it is imported.

CLI

The package provides a CLI interface for getting information such as the location and size of the build cache and managing the installation into sitecustomize.py. For details, run:

python -m maturin_import_hook --help

Debugging

If you encounter a problem, a good way to learn more about what is going on is to enable the debug logging for the import hook. This can be done by putting the following lines above the import that is causing an issue:

# configure logging if you haven't already (make sure DEBUG level is visible)
logging.basicConfig(format="%(name)s [%(levelname)s] %(message)s", level=logging.DEBUG)
maturin_import_hook.reset_logger()

import some_package

License

Licensed under either of:

at your option.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for mbway from gravatar.com mbway Avatar for messense from gravatar.com messense

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache Software License, MIT License
  • Author: Matthew Broadway
  • Requires: Python >=3.9
Classifiers

Release history Release notifications | RSS feed

This version

0.3.0

0.2.0

0.1.0

Download files

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

Source Distribution

maturin_import_hook-0.3.0.tar.gz (30.8 kB view details)

Uploaded Source

Built Distribution

maturin_import_hook-0.3.0-py3-none-any.whl (30.8 kB view details)

Uploaded Python 3

File details

Details for the file maturin_import_hook-0.3.0.tar.gz.

File metadata

  • Download URL: maturin_import_hook-0.3.0.tar.gz
  • Upload date:
  • Size: 30.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for maturin_import_hook-0.3.0.tar.gz
Algorithm Hash digest
SHA256 cdd51ce267663c437c4aea1bfd5f7ee5884b54a9d866ea924227d68d758bbba2
MD5 1ef733fc5375996f54f1c0876baef2cf
BLAKE2b-256 75a13b007a4132265d5da19096d6835cd4c7e9908afb9156afb96d19ff190f39

See more details on using hashes here.

Provenance

The following attestation bundles were made for maturin_import_hook-0.3.0.tar.gz:

Publisher: release.yml on PyO3/maturin-import-hook

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file maturin_import_hook-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for maturin_import_hook-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f5d20b4bc3056d84170dc08fe655160421b28d2b5128b48f55312315cdbb2cfe
MD5 11fa56446f29fc3cbd2aef0985dcaec1
BLAKE2b-256 9f550c17a1fccec90dffbb1d904d7ddb7971e4e95f994c6264637e8fe66a5b86

See more details on using hashes here.

Provenance

The following attestation bundles were made for maturin_import_hook-0.3.0-py3-none-any.whl:

Publisher: release.yml on PyO3/maturin-import-hook

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page