Skip to main content

Seamless Nim extension modules for Python

Project description

Nython

Build Python Extension Modules for Nim libraries.

Synopsis

This is using Nim's compileToC command to generate C code that Python can then package as an extension module and compile natively when your package is installed elsewhere.

System Reqs

Install

Using your favorite Python package manager, this library lives on pypi

pip install nython

Usage

See the example folder of a working project that uses nython (and runs all the tests).

Poetry

  • Add nython as package dependency
  • In the [tool.poetry] section of the pyproject.toml, add `build = "build.py"
  • Create the file build.py in top level of your project. This will be called by poetry when creating the package, essentially it just needs to have a build function that takes a dict of setup kwargs and adds to it.
  • Add your Nim modules, nythonize them, and pass them back
  • Note: you must pass in nimbase.h
  • Note: your Nim code must live in a directory that is included in your package build process. It can live side by side with your python.
# Example build.py script
from nython import nythonize
from os.path import expanduser


def build(setup_kwargs):
    """Called by poetry, the args are added to the kwargs for setup."""
    nimbase = expanduser("~") + "/.choosenim/toolchains/nim-1.0.4/lib/nimbase.h"
    setup_kwargs.update(
        {
            "ext_modules": nythonize(
                nimbase, [{"name": "adder", "path": "ponim/adder.nim"}]
            ),
        }
    )
  • Please see the example project for one method of merging your namespaces.
    • The tests directory shows how the functions can be run (nothing special)

Setuptools

Todo - but basically just add ext_modules = nythonize(nimbase, [{"name": "adder", "path": "ponim/adder.nim"}]) to your setup call

Acknowledgements

  • nimpy: this is an amazing project that 'just works' and makes working with Nim and Python easy. nython is just the last 5% in getting the packaging to work. nimpy is the fir 95% of the work.
  • faster-than-requests, I looked a lot at how the build system for this package was set up. Essentially, nython is just a streamlined version of the setup used in faster-than-requests.

Development

Goals

Create a seamless development experience for integrating Nim code with Python. Nim should be so easy to use that eventually you just end up writing Nim-only modules for Python, and then realize you don't really need Python and migrate to just Nim. This package should enable Nim in places and companies where it can't be selected as the primary language for a project, but it can be reached for when performance is needed. This should be easier to use than Cython.

Tests

Currently this is tested by running the code in the example project. I would like to find a better way to do this, so if you have a good idea, feel free to contribute!

Currently:

cd example
poetry shell
poetry install
poetry run py_test

And that is it.

TODOs

  • Support Nimble / full Nim projects with dependancies
  • Allow for fine-grained compiler option tuning
  • Remove the spurious .so file that ends up in your project root dir.
  • Remove the dep fo passing in nimbase.h and find it on the system somehow
  • Possibly create a Nim install in your local virtualenv somehow, with nimpy
  • Generate some performance tests, although that is more on nimpy than this package

Ponim

If you are interested in this, and want to see a nice local dev way of doing things, check out this example I put together: https://github.com/sstadick/ponim

Project details


Download files

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

Source Distribution

nython-0.1.1.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

nython-0.1.1-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file nython-0.1.1.tar.gz.

File metadata

  • Download URL: nython-0.1.1.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.2 CPython/3.7.5 Darwin/18.7.0

File hashes

Hashes for nython-0.1.1.tar.gz
Algorithm Hash digest
SHA256 af891253538959f6e4d30f5dbc8463119a70f336d5b3778db21184c21b5038fd
MD5 fbe72f6e42241afa6ce52b2cbcfd1983
BLAKE2b-256 902054ac212899cb67699b80c170ebdad7e198ac1ff4454e10dd9b079770f3a3

See more details on using hashes here.

File details

Details for the file nython-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: nython-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.2 CPython/3.7.5 Darwin/18.7.0

File hashes

Hashes for nython-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d868ef5769e979f9533c20ec6eb57515e3d7e3862979a531c5637b429c852077
MD5 3c3081bbfcc3c85474b8031f8294c2a1
BLAKE2b-256 7f2159b813b453db07b1ab74549ef5f09bbc0978b5f86df4993535df9c5bef8b

See more details on using hashes here.

Supported by

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