basho-erlastic


Namebasho-erlastic JSON
Version 2.1.1 PyPI version JSON
download
home_pagehttp://github.com/basho/python-erlastic
SummaryErlastic
upload_time2016-05-03 03:41:42
maintainerNone
docs_urlNone
authorSamuel Stauffer, Basho Technologies
requires_pythonNone
licenseUNKNOWN
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Erlastic
========

Usage
-----

Erlastic allows you to serialize/deserialize python objects into `erlang
binary term <http://erlang.org/doc/apps/erts/erl_ext_dist.html>`__.

Basic usage is :

::

    import erlastic
    py_struct = erlastic.decode(binary_term)
    binary = erlastic.encode(py_struct)

Erlang Port communication usage
-------------------------------

The library contains also a function to use python with erlastic in an
erlang port to communicate erlang binary term : ``port_communication()``
which return ``(mailbox,port)``. They are both python coroutines
(executed generator) so you can communicate with erlang coroutine using
python abstractions :

-  ``mailbox`` waits for port message in stdin, iterating over messages
   decoded from binary erlang term format.
-  ``port`` waits for ``send(python_struct)``
   (http://docs.python.org/3.3/reference/expressions.html#generator.send)
   then encode ``python_struct`` into binary term format and send it to
   the erlang port via stdout.

So for instance, if you want to create a Python server which receives
the tuple {A,B} and return {ok,A/B} of {error,divisionbyzero} you can
use at the python side :

::

    from erlastic import port_connection,Atom as A
    mailbox,port = port_connection()

    for (a,b) in mailbox:
      port.send((A("ok"),a/b) if b!=0 else (A("error"),A("divisionbyzero")))

and at the erlang side, use ``-u`` python parameter to prevent python
output buffering, use 4 bytes packet length because it is the
configuration used by the python generators.

::

    Port = open_port({spawn,"python3 -u add_server.py"},[binary,{packet,4}]),
    Div = fun(A,B)->
      Port ! {self(),{command,term_to_binary({A,B})}},
      receive {Port,{data,Bin}}->binary_to_term(Bin) after 1000->{error,timeout} end
    end,
    io:format("send {A,B}=~p, python result : ~p~n",[{32,10},Div(32,10)]),
    io:format("send {A,B}=~p, python result : ~p~n",[{2,0},Div(2,0)]),
    io:format("send {A,B}=~p, python result : ~p~n",[{1,1},Div(1,1)])

or in elixir :

::

    port = Port.open({:spawn,'python3 -u add_server.py'},[:binary|[packet: 4]])
    div = fn(a,b)->
      port <- {self,{:command,term_to_binary({a,b})}}
      receive do {_,{:data,b}} -> binary_to_term(b) after 100->{:error,:timeout} end
    end
    IO.puts "send {a,b}={32,10}, python result : #{inspect div.(32,10)}"
    IO.puts "send {a,b}={2,0}, python result : #{inspect div.(2,0)}"
    IO.puts "send {a,b}={1,1}, python result : #{inspect div.(1,1)}"
            

Raw data

            {
    "_id": null,
    "home_page": "http://github.com/basho/python-erlastic",
    "name": "basho-erlastic",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "Samuel Stauffer, Basho Technologies",
    "author_email": "clients@basho.com",
    "download_url": "https://files.pythonhosted.org/packages/f1/2a/f1c47fa0f03f5c7ef7550d23631fe4dc904259e3a2fe8b56fa9d79be9629/basho-erlastic-2.1.1.tar.gz",
    "platform": "UNKNOWN",
    "description": "Erlastic\n========\n\nUsage\n-----\n\nErlastic allows you to serialize/deserialize python objects into `erlang\nbinary term <http://erlang.org/doc/apps/erts/erl_ext_dist.html>`__.\n\nBasic usage is :\n\n::\n\n    import erlastic\n    py_struct = erlastic.decode(binary_term)\n    binary = erlastic.encode(py_struct)\n\nErlang Port communication usage\n-------------------------------\n\nThe library contains also a function to use python with erlastic in an\nerlang port to communicate erlang binary term : ``port_communication()``\nwhich return ``(mailbox,port)``. They are both python coroutines\n(executed generator) so you can communicate with erlang coroutine using\npython abstractions :\n\n-  ``mailbox`` waits for port message in stdin, iterating over messages\n   decoded from binary erlang term format.\n-  ``port`` waits for ``send(python_struct)``\n   (http://docs.python.org/3.3/reference/expressions.html#generator.send)\n   then encode ``python_struct`` into binary term format and send it to\n   the erlang port via stdout.\n\nSo for instance, if you want to create a Python server which receives\nthe tuple {A,B} and return {ok,A/B} of {error,divisionbyzero} you can\nuse at the python side :\n\n::\n\n    from erlastic import port_connection,Atom as A\n    mailbox,port = port_connection()\n\n    for (a,b) in mailbox:\n      port.send((A(\"ok\"),a/b) if b!=0 else (A(\"error\"),A(\"divisionbyzero\")))\n\nand at the erlang side, use ``-u`` python parameter to prevent python\noutput buffering, use 4 bytes packet length because it is the\nconfiguration used by the python generators.\n\n::\n\n    Port = open_port({spawn,\"python3 -u add_server.py\"},[binary,{packet,4}]),\n    Div = fun(A,B)->\n      Port ! {self(),{command,term_to_binary({A,B})}},\n      receive {Port,{data,Bin}}->binary_to_term(Bin) after 1000->{error,timeout} end\n    end,\n    io:format(\"send {A,B}=~p, python result : ~p~n\",[{32,10},Div(32,10)]),\n    io:format(\"send {A,B}=~p, python result : ~p~n\",[{2,0},Div(2,0)]),\n    io:format(\"send {A,B}=~p, python result : ~p~n\",[{1,1},Div(1,1)])\n\nor in elixir :\n\n::\n\n    port = Port.open({:spawn,'python3 -u add_server.py'},[:binary|[packet: 4]])\n    div = fn(a,b)->\n      port <- {self,{:command,term_to_binary({a,b})}}\n      receive do {_,{:data,b}} -> binary_to_term(b) after 100->{:error,:timeout} end\n    end\n    IO.puts \"send {a,b}={32,10}, python result : #{inspect div.(32,10)}\"\n    IO.puts \"send {a,b}={2,0}, python result : #{inspect div.(2,0)}\"\n    IO.puts \"send {a,b}={1,1}, python result : #{inspect div.(1,1)}\"",
    "bugtrack_url": null,
    "license": "UNKNOWN",
    "summary": "Erlastic",
    "version": "2.1.1",
    "project_urls": {
        "Download": "UNKNOWN",
        "Homepage": "http://github.com/basho/python-erlastic"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f12af1c47fa0f03f5c7ef7550d23631fe4dc904259e3a2fe8b56fa9d79be9629",
                "md5": "25880fdae85b0bcf8c78fe41d2236c1d",
                "sha256": "d1596a881437f2be71a8426efed1566b7faefb97234cb21440700ecc8367c545"
            },
            "downloads": -1,
            "filename": "basho-erlastic-2.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "25880fdae85b0bcf8c78fe41d2236c1d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 9298,
            "upload_time": "2016-05-03T03:41:42",
            "upload_time_iso_8601": "2016-05-03T03:41:42.029557Z",
            "url": "https://files.pythonhosted.org/packages/f1/2a/f1c47fa0f03f5c7ef7550d23631fe4dc904259e3a2fe8b56fa9d79be9629/basho-erlastic-2.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2016-05-03 03:41:42",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "basho",
    "github_project": "python-erlastic",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "basho-erlastic"
}
        
Elapsed time: 0.15328s