locutor 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
locutor-0.1.0/LICENCE ADDED
@@ -0,0 +1,287 @@
1
+ EUROPEAN UNION PUBLIC LICENCE v. 1.2
2
+ EUPL © the European Union 2007, 2016
3
+
4
+ This European Union Public Licence (the ‘EUPL’) applies to the Work (as defined
5
+ below) which is provided under the terms of this Licence. Any use of the Work,
6
+ other than as authorised under this Licence is prohibited (to the extent such
7
+ use is covered by a right of the copyright holder of the Work).
8
+
9
+ The Work is provided under the terms of this Licence when the Licensor (as
10
+ defined below) has placed the following notice immediately following the
11
+ copyright notice for the Work:
12
+
13
+ Licensed under the EUPL
14
+
15
+ or has expressed by any other means his willingness to license under the EUPL.
16
+
17
+ 1. Definitions
18
+
19
+ In this Licence, the following terms have the following meaning:
20
+
21
+ - ‘The Licence’: this Licence.
22
+
23
+ - ‘The Original Work’: the work or software distributed or communicated by the
24
+ Licensor under this Licence, available as Source Code and also as Executable
25
+ Code as the case may be.
26
+
27
+ - ‘Derivative Works’: the works or software that could be created by the
28
+ Licensee, based upon the Original Work or modifications thereof. This Licence
29
+ does not define the extent of modification or dependence on the Original Work
30
+ required in order to classify a work as a Derivative Work; this extent is
31
+ determined by copyright law applicable in the country mentioned in Article 15.
32
+
33
+ - ‘The Work’: the Original Work or its Derivative Works.
34
+
35
+ - ‘The Source Code’: the human-readable form of the Work which is the most
36
+ convenient for people to study and modify.
37
+
38
+ - ‘The Executable Code’: any code which has generally been compiled and which is
39
+ meant to be interpreted by a computer as a program.
40
+
41
+ - ‘The Licensor’: the natural or legal person that distributes or communicates
42
+ the Work under the Licence.
43
+
44
+ - ‘Contributor(s)’: any natural or legal person who modifies the Work under the
45
+ Licence, or otherwise contributes to the creation of a Derivative Work.
46
+
47
+ - ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of
48
+ the Work under the terms of the Licence.
49
+
50
+ - ‘Distribution’ or ‘Communication’: any act of selling, giving, lending,
51
+ renting, distributing, communicating, transmitting, or otherwise making
52
+ available, online or offline, copies of the Work or providing access to its
53
+ essential functionalities at the disposal of any other natural or legal
54
+ person.
55
+
56
+ 2. Scope of the rights granted by the Licence
57
+
58
+ The Licensor hereby grants You a worldwide, royalty-free, non-exclusive,
59
+ sublicensable licence to do the following, for the duration of copyright vested
60
+ in the Original Work:
61
+
62
+ - use the Work in any circumstance and for all usage,
63
+ - reproduce the Work,
64
+ - modify the Work, and make Derivative Works based upon the Work,
65
+ - communicate to the public, including the right to make available or display
66
+ the Work or copies thereof to the public and perform publicly, as the case may
67
+ be, the Work,
68
+ - distribute the Work or copies thereof,
69
+ - lend and rent the Work or copies thereof,
70
+ - sublicense rights in the Work or copies thereof.
71
+
72
+ Those rights can be exercised on any media, supports and formats, whether now
73
+ known or later invented, as far as the applicable law permits so.
74
+
75
+ In the countries where moral rights apply, the Licensor waives his right to
76
+ exercise his moral right to the extent allowed by law in order to make effective
77
+ the licence of the economic rights here above listed.
78
+
79
+ The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to
80
+ any patents held by the Licensor, to the extent necessary to make use of the
81
+ rights granted on the Work under this Licence.
82
+
83
+ 3. Communication of the Source Code
84
+
85
+ The Licensor may provide the Work either in its Source Code form, or as
86
+ Executable Code. If the Work is provided as Executable Code, the Licensor
87
+ provides in addition a machine-readable copy of the Source Code of the Work
88
+ along with each copy of the Work that the Licensor distributes or indicates, in
89
+ a notice following the copyright notice attached to the Work, a repository where
90
+ the Source Code is easily and freely accessible for as long as the Licensor
91
+ continues to distribute or communicate the Work.
92
+
93
+ 4. Limitations on copyright
94
+
95
+ Nothing in this Licence is intended to deprive the Licensee of the benefits from
96
+ any exception or limitation to the exclusive rights of the rights owners in the
97
+ Work, of the exhaustion of those rights or of other applicable limitations
98
+ thereto.
99
+
100
+ 5. Obligations of the Licensee
101
+
102
+ The grant of the rights mentioned above is subject to some restrictions and
103
+ obligations imposed on the Licensee. Those obligations are the following:
104
+
105
+ Attribution right: The Licensee shall keep intact all copyright, patent or
106
+ trademarks notices and all notices that refer to the Licence and to the
107
+ disclaimer of warranties. The Licensee must include a copy of such notices and a
108
+ copy of the Licence with every copy of the Work he/she distributes or
109
+ communicates. The Licensee must cause any Derivative Work to carry prominent
110
+ notices stating that the Work has been modified and the date of modification.
111
+
112
+ Copyleft clause: If the Licensee distributes or communicates copies of the
113
+ Original Works or Derivative Works, this Distribution or Communication will be
114
+ done under the terms of this Licence or of a later version of this Licence
115
+ unless the Original Work is expressly distributed only under this version of the
116
+ Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee
117
+ (becoming Licensor) cannot offer or impose any additional terms or conditions on
118
+ the Work or Derivative Work that alter or restrict the terms of the Licence.
119
+
120
+ Compatibility clause: If the Licensee Distributes or Communicates Derivative
121
+ Works or copies thereof based upon both the Work and another work licensed under
122
+ a Compatible Licence, this Distribution or Communication can be done under the
123
+ terms of this Compatible Licence. For the sake of this clause, ‘Compatible
124
+ Licence’ refers to the licences listed in the appendix attached to this Licence.
125
+ Should the Licensee's obligations under the Compatible Licence conflict with
126
+ his/her obligations under this Licence, the obligations of the Compatible
127
+ Licence shall prevail.
128
+
129
+ Provision of Source Code: When distributing or communicating copies of the Work,
130
+ the Licensee will provide a machine-readable copy of the Source Code or indicate
131
+ a repository where this Source will be easily and freely available for as long
132
+ as the Licensee continues to distribute or communicate the Work.
133
+
134
+ Legal Protection: This Licence does not grant permission to use the trade names,
135
+ trademarks, service marks, or names of the Licensor, except as required for
136
+ reasonable and customary use in describing the origin of the Work and
137
+ reproducing the content of the copyright notice.
138
+
139
+ 6. Chain of Authorship
140
+
141
+ The original Licensor warrants that the copyright in the Original Work granted
142
+ hereunder is owned by him/her or licensed to him/her and that he/she has the
143
+ power and authority to grant the Licence.
144
+
145
+ Each Contributor warrants that the copyright in the modifications he/she brings
146
+ to the Work are owned by him/her or licensed to him/her and that he/she has the
147
+ power and authority to grant the Licence.
148
+
149
+ Each time You accept the Licence, the original Licensor and subsequent
150
+ Contributors grant You a licence to their contributions to the Work, under the
151
+ terms of this Licence.
152
+
153
+ 7. Disclaimer of Warranty
154
+
155
+ The Work is a work in progress, which is continuously improved by numerous
156
+ Contributors. It is not a finished work and may therefore contain defects or
157
+ ‘bugs’ inherent to this type of development.
158
+
159
+ For the above reason, the Work is provided under the Licence on an ‘as is’ basis
160
+ and without warranties of any kind concerning the Work, including without
161
+ limitation merchantability, fitness for a particular purpose, absence of defects
162
+ or errors, accuracy, non-infringement of intellectual property rights other than
163
+ copyright as stated in Article 6 of this Licence.
164
+
165
+ This disclaimer of warranty is an essential part of the Licence and a condition
166
+ for the grant of any rights to the Work.
167
+
168
+ 8. Disclaimer of Liability
169
+
170
+ Except in the cases of wilful misconduct or damages directly caused to natural
171
+ persons, the Licensor will in no event be liable for any direct or indirect,
172
+ material or moral, damages of any kind, arising out of the Licence or of the use
173
+ of the Work, including without limitation, damages for loss of goodwill, work
174
+ stoppage, computer failure or malfunction, loss of data or any commercial
175
+ damage, even if the Licensor has been advised of the possibility of such damage.
176
+ However, the Licensor will be liable under statutory product liability laws as
177
+ far such laws apply to the Work.
178
+
179
+ 9. Additional agreements
180
+
181
+ While distributing the Work, You may choose to conclude an additional agreement,
182
+ defining obligations or services consistent with this Licence. However, if
183
+ accepting obligations, You may act only on your own behalf and on your sole
184
+ responsibility, not on behalf of the original Licensor or any other Contributor,
185
+ and only if You agree to indemnify, defend, and hold each Contributor harmless
186
+ for any liability incurred by, or claims asserted against such Contributor by
187
+ the fact You have accepted any warranty or additional liability.
188
+
189
+ 10. Acceptance of the Licence
190
+
191
+ The provisions of this Licence can be accepted by clicking on an icon ‘I agree’
192
+ placed under the bottom of a window displaying the text of this Licence or by
193
+ affirming consent in any other similar way, in accordance with the rules of
194
+ applicable law. Clicking on that icon indicates your clear and irrevocable
195
+ acceptance of this Licence and all of its terms and conditions.
196
+
197
+ Similarly, you irrevocably accept this Licence and all of its terms and
198
+ conditions by exercising any rights granted to You by Article 2 of this Licence,
199
+ such as the use of the Work, the creation by You of a Derivative Work or the
200
+ Distribution or Communication by You of the Work or copies thereof.
201
+
202
+ 11. Information to the public
203
+
204
+ In case of any Distribution or Communication of the Work by means of electronic
205
+ communication by You (for example, by offering to download the Work from a
206
+ remote location) the distribution channel or media (for example, a website) must
207
+ at least provide to the public the information requested by the applicable law
208
+ regarding the Licensor, the Licence and the way it may be accessible, concluded,
209
+ stored and reproduced by the Licensee.
210
+
211
+ 12. Termination of the Licence
212
+
213
+ The Licence and the rights granted hereunder will terminate automatically upon
214
+ any breach by the Licensee of the terms of the Licence.
215
+
216
+ Such a termination will not terminate the licences of any person who has
217
+ received the Work from the Licensee under the Licence, provided such persons
218
+ remain in full compliance with the Licence.
219
+
220
+ 13. Miscellaneous
221
+
222
+ Without prejudice of Article 9 above, the Licence represents the complete
223
+ agreement between the Parties as to the Work.
224
+
225
+ If any provision of the Licence is invalid or unenforceable under applicable
226
+ law, this will not affect the validity or enforceability of the Licence as a
227
+ whole. Such provision will be construed or reformed so as necessary to make it
228
+ valid and enforceable.
229
+
230
+ The European Commission may publish other linguistic versions or new versions of
231
+ this Licence or updated versions of the Appendix, so far this is required and
232
+ reasonable, without reducing the scope of the rights granted by the Licence. New
233
+ versions of the Licence will be published with a unique version number.
234
+
235
+ All linguistic versions of this Licence, approved by the European Commission,
236
+ have identical value. Parties can take advantage of the linguistic version of
237
+ their choice.
238
+
239
+ 14. Jurisdiction
240
+
241
+ Without prejudice to specific agreement between parties,
242
+
243
+ - any litigation resulting from the interpretation of this License, arising
244
+ between the European Union institutions, bodies, offices or agencies, as a
245
+ Licensor, and any Licensee, will be subject to the jurisdiction of the Court
246
+ of Justice of the European Union, as laid down in article 272 of the Treaty on
247
+ the Functioning of the European Union,
248
+
249
+ - any litigation arising between other parties and resulting from the
250
+ interpretation of this License, will be subject to the exclusive jurisdiction
251
+ of the competent court where the Licensor resides or conducts its primary
252
+ business.
253
+
254
+ 15. Applicable Law
255
+
256
+ Without prejudice to specific agreement between parties,
257
+
258
+ - this Licence shall be governed by the law of the European Union Member State
259
+ where the Licensor has his seat, resides or has his registered office,
260
+
261
+ - this licence shall be governed by Belgian law if the Licensor has no seat,
262
+ residence or registered office inside a European Union Member State.
263
+
264
+ Appendix
265
+
266
+ ‘Compatible Licences’ according to Article 5 EUPL are:
267
+
268
+ - GNU General Public License (GPL) v. 2, v. 3
269
+ - GNU Affero General Public License (AGPL) v. 3
270
+ - Open Software License (OSL) v. 2.1, v. 3.0
271
+ - Eclipse Public License (EPL) v. 1.0
272
+ - CeCILL v. 2.0, v. 2.1
273
+ - Mozilla Public Licence (MPL) v. 2
274
+ - GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
275
+ - Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for
276
+ works other than software
277
+ - European Union Public Licence (EUPL) v. 1.1, v. 1.2
278
+ - Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong
279
+ Reciprocity (LiLiQ-R+).
280
+
281
+ The European Commission may update this Appendix to later versions of the above
282
+ licences without producing a new version of the EUPL, as long as they provide
283
+ the rights granted in Article 2 of this Licence and protect the covered Source
284
+ Code from exclusive appropriation.
285
+
286
+ All other changes or additions to this Appendix require the production of a new
287
+ EUPL version.
locutor-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,201 @@
1
+ Metadata-Version: 2.4
2
+ Name: locutor
3
+ Version: 0.1.0
4
+ Summary: Call R and Julia from Python, as a function in memory or as a script.
5
+ Author-email: Pedro Henrique Coimbra <pedro-henrique.herig-coimbra@inrae.fr>
6
+ License-Expression: EUPL-1.2
7
+ Keywords: R,Julia,interop,runner,subprocess
8
+ Classifier: Development Status :: 3 - Alpha
9
+ Classifier: Intended Audience :: Science/Research
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: Programming Language :: R
12
+ Requires-Python: >=3.9
13
+ Description-Content-Type: text/markdown
14
+ License-File: LICENCE
15
+ Requires-Dist: numpy>=1.24
16
+ Provides-Extra: test
17
+ Requires-Dist: pytest>=7.0; extra == "test"
18
+ Dynamic: license-file
19
+
20
+ # locutor
21
+
22
+ Call R and Julia from Python: a function in memory, or a script in a process.
23
+
24
+ ```python
25
+ import locutor
26
+
27
+ # a function: one persistent child per language, nothing written to disk
28
+ rotated = locutor.call("methods/rotation.R:double_rotation", u, v, w)
29
+ total = locutor.call("stats.jl:total", series, skip_missing=True)
30
+
31
+ # a script: a process of its own, arguments on its command line
32
+ locutor.run("fetch.R", "2026-11-13", out="data/raw.csv")
33
+ ```
34
+
35
+ The name is the Latin for *one who speaks*. It is the sibling of
36
+ [`regorator`](https://pypi.org/project/regorator/), which
37
+ registers, and of `ordinator`, which orders: this one speaks to the languages
38
+ the other two are not written in.
39
+
40
+ ## What it is for
41
+
42
+ A function written in R or Julia that you want to call from Python **many
43
+ times, with arrays, and get the same numbers back** — without embedding the
44
+ other language in the Python process.
45
+
46
+ - **In memory.** One child per language is started at the first call and kept.
47
+ No file is written and no process started for a call.
48
+ - **Exact.** A double is never printed and parsed. Every float crosses as its
49
+ 64 bits, so a NaN arrives as it left, payload included, and R's `NA` is still
50
+ `NA` going back.
51
+ - **Separate.** The other language runs in its own process. A crash there is an
52
+ exception here, and its threads, signal handlers and C libraries never meet
53
+ Python's.
54
+ - **No dependency on either language.** `numpy` is the only requirement. R
55
+ needs the `jsonlite` package; Julia needs nothing. A language that is not
56
+ installed is refused at its first call, with what to install.
57
+
58
+ And the plain case beside it: a script that takes a command line and exits.
59
+
60
+ ## Install
61
+
62
+ ```
63
+ pip install locutor
64
+ ```
65
+
66
+ or, from a checkout, `pip install -e .`.
67
+
68
+ Python >= 3.9 and `numpy`. `Rscript` and `julia` are looked for on PATH.
69
+
70
+ ## Calling a function
71
+
72
+ `locutor.call("path/file.ext:function", *args, **kwargs)` picks the language by
73
+ the file's extension and uses that language's shared session.
74
+
75
+ ```python
76
+ import numpy as np, locutor
77
+
78
+ x = np.arange(4.0)
79
+ locutor.call("lib.R:twice", x, by=3) # array([0., 3., 6., 9.])
80
+ locutor.call("lib.jl:twice", x, by=3) # the same, from Julia
81
+ locutor.call("lib.py:twice", x, by=3) # the same, imported in this process
82
+ ```
83
+
84
+ The child reads a file once, into a namespace of its own, so two files may
85
+ define a function of one name. Keyword arguments are keyword arguments in
86
+ Julia and named arguments in R.
87
+
88
+ For a package's function, a file of helpers, or another interpreter than the
89
+ one on PATH, configure the language and call that:
90
+
91
+ ```python
92
+ with locutor.R(packages=["stats"], include="helpers.R") as r:
93
+ r.call("stats::median", x) # a package's function
94
+ r.call("my_helper", x, window=5) # a function helpers.R defines
95
+
96
+ jl = locutor.Julia(program="/opt/julia-1.11/bin/julia", packages=["Statistics"])
97
+ jl.call("Statistics.mean", x)
98
+ jl.close()
99
+ ```
100
+
101
+ Building one starts nothing; its child starts at the first call and ends at
102
+ `close()`, at the end of the `with`, or when Python exits.
103
+
104
+ ### What crosses
105
+
106
+ | Python | R | Julia |
107
+ | --- | --- | --- |
108
+ | a float | a numeric vector of one | a `Float64` |
109
+ | a numeric array | a numeric vector | a `Vector{Float64}` |
110
+ | an N-d array | a matrix or array | a `Matrix` / `Array` |
111
+ | an int, a bool, a str | an integer, a logical, a character | an `Int`, a `Bool`, a `String` |
112
+ | `None` | `NULL` | `nothing` |
113
+ | a list of one kind of those | the vector of that kind | the vector of that kind |
114
+ | a dict | a named list | a named tuple |
115
+ | any other list | a list | a `Vector{Any}` |
116
+
117
+ Coming back, a named list or named tuple is a Python list that carries
118
+ `.names`; a matrix keeps its shape; `NA`, `NaN` and Julia's `missing` in a
119
+ float array are all NaN. Anything else — a function, a struct, a DataFrame, an
120
+ xarray object going the other way — is refused by name rather than converted
121
+ to whatever its values happen to coerce to.
122
+
123
+ ### Errors and output
124
+
125
+ - `stop()` in R or an exception in Julia is a `RuntimeError` here with the
126
+ other side's message, and the session answers the next call.
127
+ - A child that *ends* — a crash, a `quit()` — is a `ChildProcessError`, and the
128
+ next call starts another.
129
+ - What the called code prints, on either stream, goes to the `locutor` logger
130
+ at `INFO`, and never into an answer.
131
+
132
+ ## Running a script
133
+
134
+ `locutor.run(script, *arguments, **options)` runs it with the interpreter its
135
+ extension names and waits. Positional arguments go on the command line as they
136
+ are; keyword options go as `--key value` (`True` is the bare flag, a list is
137
+ the key followed by its values).
138
+
139
+ ```python
140
+ done = locutor.run("report.jl", "FR-Gri", year=2022, sites=["a", "b"])
141
+ done.returncode, done.stdout, done.stderr
142
+ ```
143
+
144
+ A status other than zero raises `RuntimeError` with the end of the script's
145
+ error stream; `check=False` returns the `Result` instead. `capture=False`
146
+ leaves the script's output on this process's streams. `cwd`, `env` and
147
+ `timeout` are passed through.
148
+
149
+ ## From a shell
150
+
151
+ ```
152
+ locutor languages
153
+ locutor run script.R 2026-11-13 --out data/raw.csv
154
+ locutor call stats.jl:total "[1, 2.5, 4]" --skip_missing true
155
+ ```
156
+
157
+ `run` hands everything after the script to the script, untouched, and exits
158
+ with its status. `call` reads each value as JSON where it is JSON and as text
159
+ where it is not, and prints the answer as JSON.
160
+
161
+ ## How it works
162
+
163
+ A session is one child process (`Rscript`, `julia`) running
164
+ `locutor/servers/session.R` or `session.jl`. A request is one JSON line on its
165
+ input and the answer one JSON line on its output; the doubles of both travel as
166
+ raw little-endian float64 on one loopback TCP connection the child opens back
167
+ when it starts. The lines and the doubles go separate ways because the child's
168
+ output is also where the called code prints: an answer line is marked, and raw
169
+ doubles on that stream would be corrupted by the first `print`. The connection
170
+ is `127.0.0.1` only, and is taken only from the child that repeats a token it
171
+ was handed on its input.
172
+
173
+ Measured on Linux (R 4.5.3, Julia 1.11.7), one 36 000-sample series there and
174
+ back: 0.16 ms for R and 0.09 ms for Julia, against 0.17–0.25 ms for rpy2 and
175
+ 0.05 ms for juliacall embedded in the interpreter. Starting the child takes
176
+ about 0.1 s for R and about 1 s for Julia including its first compilation.
177
+
178
+ Adding a language is one module in `locutor/languages/` (what it is called, how
179
+ it is started, how a package is installed) and one file in `locutor/servers/`
180
+ that holds its end of the conversation.
181
+
182
+ ## What it is not
183
+
184
+ - **Not a workflow tool.** It does not order steps, read a configuration, or
185
+ record what ran. `ordinator` does that, and is meant to call this.
186
+ - **Not an embedding.** For sharing objects between languages without copying,
187
+ or calling back into Python from R or Julia, use rpy2 or juliacall.
188
+ - **Not tested on Windows or macOS yet.** Everything here was run on Linux.
189
+
190
+ ## Tests
191
+
192
+ ```
193
+ python -m pytest
194
+ ```
195
+
196
+ The tests that need R or Julia run once per language installed and skip the
197
+ other, saying what to install.
198
+
199
+ ## Licence
200
+
201
+ EUPL-1.2. See [`LICENCE`](LICENCE).
@@ -0,0 +1,182 @@
1
+ # locutor
2
+
3
+ Call R and Julia from Python: a function in memory, or a script in a process.
4
+
5
+ ```python
6
+ import locutor
7
+
8
+ # a function: one persistent child per language, nothing written to disk
9
+ rotated = locutor.call("methods/rotation.R:double_rotation", u, v, w)
10
+ total = locutor.call("stats.jl:total", series, skip_missing=True)
11
+
12
+ # a script: a process of its own, arguments on its command line
13
+ locutor.run("fetch.R", "2026-11-13", out="data/raw.csv")
14
+ ```
15
+
16
+ The name is the Latin for *one who speaks*. It is the sibling of
17
+ [`regorator`](https://pypi.org/project/regorator/), which
18
+ registers, and of `ordinator`, which orders: this one speaks to the languages
19
+ the other two are not written in.
20
+
21
+ ## What it is for
22
+
23
+ A function written in R or Julia that you want to call from Python **many
24
+ times, with arrays, and get the same numbers back** — without embedding the
25
+ other language in the Python process.
26
+
27
+ - **In memory.** One child per language is started at the first call and kept.
28
+ No file is written and no process started for a call.
29
+ - **Exact.** A double is never printed and parsed. Every float crosses as its
30
+ 64 bits, so a NaN arrives as it left, payload included, and R's `NA` is still
31
+ `NA` going back.
32
+ - **Separate.** The other language runs in its own process. A crash there is an
33
+ exception here, and its threads, signal handlers and C libraries never meet
34
+ Python's.
35
+ - **No dependency on either language.** `numpy` is the only requirement. R
36
+ needs the `jsonlite` package; Julia needs nothing. A language that is not
37
+ installed is refused at its first call, with what to install.
38
+
39
+ And the plain case beside it: a script that takes a command line and exits.
40
+
41
+ ## Install
42
+
43
+ ```
44
+ pip install locutor
45
+ ```
46
+
47
+ or, from a checkout, `pip install -e .`.
48
+
49
+ Python >= 3.9 and `numpy`. `Rscript` and `julia` are looked for on PATH.
50
+
51
+ ## Calling a function
52
+
53
+ `locutor.call("path/file.ext:function", *args, **kwargs)` picks the language by
54
+ the file's extension and uses that language's shared session.
55
+
56
+ ```python
57
+ import numpy as np, locutor
58
+
59
+ x = np.arange(4.0)
60
+ locutor.call("lib.R:twice", x, by=3) # array([0., 3., 6., 9.])
61
+ locutor.call("lib.jl:twice", x, by=3) # the same, from Julia
62
+ locutor.call("lib.py:twice", x, by=3) # the same, imported in this process
63
+ ```
64
+
65
+ The child reads a file once, into a namespace of its own, so two files may
66
+ define a function of one name. Keyword arguments are keyword arguments in
67
+ Julia and named arguments in R.
68
+
69
+ For a package's function, a file of helpers, or another interpreter than the
70
+ one on PATH, configure the language and call that:
71
+
72
+ ```python
73
+ with locutor.R(packages=["stats"], include="helpers.R") as r:
74
+ r.call("stats::median", x) # a package's function
75
+ r.call("my_helper", x, window=5) # a function helpers.R defines
76
+
77
+ jl = locutor.Julia(program="/opt/julia-1.11/bin/julia", packages=["Statistics"])
78
+ jl.call("Statistics.mean", x)
79
+ jl.close()
80
+ ```
81
+
82
+ Building one starts nothing; its child starts at the first call and ends at
83
+ `close()`, at the end of the `with`, or when Python exits.
84
+
85
+ ### What crosses
86
+
87
+ | Python | R | Julia |
88
+ | --- | --- | --- |
89
+ | a float | a numeric vector of one | a `Float64` |
90
+ | a numeric array | a numeric vector | a `Vector{Float64}` |
91
+ | an N-d array | a matrix or array | a `Matrix` / `Array` |
92
+ | an int, a bool, a str | an integer, a logical, a character | an `Int`, a `Bool`, a `String` |
93
+ | `None` | `NULL` | `nothing` |
94
+ | a list of one kind of those | the vector of that kind | the vector of that kind |
95
+ | a dict | a named list | a named tuple |
96
+ | any other list | a list | a `Vector{Any}` |
97
+
98
+ Coming back, a named list or named tuple is a Python list that carries
99
+ `.names`; a matrix keeps its shape; `NA`, `NaN` and Julia's `missing` in a
100
+ float array are all NaN. Anything else — a function, a struct, a DataFrame, an
101
+ xarray object going the other way — is refused by name rather than converted
102
+ to whatever its values happen to coerce to.
103
+
104
+ ### Errors and output
105
+
106
+ - `stop()` in R or an exception in Julia is a `RuntimeError` here with the
107
+ other side's message, and the session answers the next call.
108
+ - A child that *ends* — a crash, a `quit()` — is a `ChildProcessError`, and the
109
+ next call starts another.
110
+ - What the called code prints, on either stream, goes to the `locutor` logger
111
+ at `INFO`, and never into an answer.
112
+
113
+ ## Running a script
114
+
115
+ `locutor.run(script, *arguments, **options)` runs it with the interpreter its
116
+ extension names and waits. Positional arguments go on the command line as they
117
+ are; keyword options go as `--key value` (`True` is the bare flag, a list is
118
+ the key followed by its values).
119
+
120
+ ```python
121
+ done = locutor.run("report.jl", "FR-Gri", year=2022, sites=["a", "b"])
122
+ done.returncode, done.stdout, done.stderr
123
+ ```
124
+
125
+ A status other than zero raises `RuntimeError` with the end of the script's
126
+ error stream; `check=False` returns the `Result` instead. `capture=False`
127
+ leaves the script's output on this process's streams. `cwd`, `env` and
128
+ `timeout` are passed through.
129
+
130
+ ## From a shell
131
+
132
+ ```
133
+ locutor languages
134
+ locutor run script.R 2026-11-13 --out data/raw.csv
135
+ locutor call stats.jl:total "[1, 2.5, 4]" --skip_missing true
136
+ ```
137
+
138
+ `run` hands everything after the script to the script, untouched, and exits
139
+ with its status. `call` reads each value as JSON where it is JSON and as text
140
+ where it is not, and prints the answer as JSON.
141
+
142
+ ## How it works
143
+
144
+ A session is one child process (`Rscript`, `julia`) running
145
+ `locutor/servers/session.R` or `session.jl`. A request is one JSON line on its
146
+ input and the answer one JSON line on its output; the doubles of both travel as
147
+ raw little-endian float64 on one loopback TCP connection the child opens back
148
+ when it starts. The lines and the doubles go separate ways because the child's
149
+ output is also where the called code prints: an answer line is marked, and raw
150
+ doubles on that stream would be corrupted by the first `print`. The connection
151
+ is `127.0.0.1` only, and is taken only from the child that repeats a token it
152
+ was handed on its input.
153
+
154
+ Measured on Linux (R 4.5.3, Julia 1.11.7), one 36 000-sample series there and
155
+ back: 0.16 ms for R and 0.09 ms for Julia, against 0.17–0.25 ms for rpy2 and
156
+ 0.05 ms for juliacall embedded in the interpreter. Starting the child takes
157
+ about 0.1 s for R and about 1 s for Julia including its first compilation.
158
+
159
+ Adding a language is one module in `locutor/languages/` (what it is called, how
160
+ it is started, how a package is installed) and one file in `locutor/servers/`
161
+ that holds its end of the conversation.
162
+
163
+ ## What it is not
164
+
165
+ - **Not a workflow tool.** It does not order steps, read a configuration, or
166
+ record what ran. `ordinator` does that, and is meant to call this.
167
+ - **Not an embedding.** For sharing objects between languages without copying,
168
+ or calling back into Python from R or Julia, use rpy2 or juliacall.
169
+ - **Not tested on Windows or macOS yet.** Everything here was run on Linux.
170
+
171
+ ## Tests
172
+
173
+ ```
174
+ python -m pytest
175
+ ```
176
+
177
+ The tests that need R or Julia run once per language installed and skip the
178
+ other, saying what to install.
179
+
180
+ ## Licence
181
+
182
+ EUPL-1.2. See [`LICENCE`](LICENCE).