pyml_bindgen

Generate pyml bindings from OCaml value specifications
README

Generate Python bindings with pyml directly from OCaml value specifications.

While you could write all your Python bindings by hand, it can be tedious and it gets old real quick. While pyml_bindgen can't yet auto-generate all the bindings you may need, it can definitely take care of a lot of the tedious and repetitive work you need to do when writing bindings for a big Python library!! 💖

Quick start

First, install pyml_bindgen. It is available on Opam.

$ opam install pyml_bindgen

Say you have a Python class you want to bind and use in OCaml. (Filename: adder.py)

class Adder:
    @staticmethod
    def add(x, y):
        return x + y

To do so, you write OCaml value specifications for the class and methods you want to bind. (Filename: val_specs.txt)

val add : x:int -> y:int -> unit -> int

Then, you run pyml_bindgen.

$ pyml_bindgen val_specs.txt adder Adder --caml-module Adder > lib.ml

Now you can use your generated functions in your OCaml code. (Filename: run.ml)

open Lib

let () = Py.initialize ()

let result = Adder.add ~x:1 ~y:2 ()

let () = assert (result = 3)

Finally, set up a dune file and run it.

(executable
 (name run)
 (libraries pyml))
$ dune exec ./run.exe

Documentation

For information on installing and using pyml_bindgen, check out the docs.

Additionally, you can find examples in the examples directory. One neat thing about these examples is that you can see how to write Dune rules to automatically generate your pyml bindings.

License

Copyright (c) 2021 - 2022 Ryan M. Moore.

Licensed under the Apache License, Version 2.0 or the MIT license, at your option. This program may not be copied, modified, or distributed except according to those terms.

Install
Published
23 Mar 2022
Maintainers
Sources
0.3.0.tar.gz
md5=d9e771921a4d253b6041d3a99408fa3e
sha512=9ec4aad1307505395154d1c64665be6392292ea9fba60580d3927869427c432502bf4bb4b9102f0fdb0f177bab2950ed1f2a91219ef2e577acc2a1971858cbed
Dependencies
odoc
with-doc
shexp
>= "v0.14" & with-test
pyml
with-test
ppx_expect
>= "v0.12" & with-test
ppx_inline_test
>= "v0.12" & with-test
ppx_assert
>= "v0.12" & with-test
ocamlformat
>= "0.20.0" & < "0.21.0" & with-test
core_kernel
>= "v0.12" & with-test
conf-python-3-dev
>= "1" & with-test
cmdliner
= "1.1.0" & with-test
ocaml
>= "4.08.0"
stdio
>= "v0.12"
re2
>= "v0.12"
ppx_string
>= "v0.12"
ppx_sexp_conv
>= "v0.12"
ppx_let
>= "v0.12"
cmdliner
>= "1.1.0"
base
>= "v0.12"
angstrom
>= "0.15.0"
dune
>= "3.0"
Reverse Dependencies