pycall 1.2.1 → 1.4.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/ci.yml +150 -0
- data/.github/workflows/windows.yml +127 -0
- data/.gitignore +2 -0
- data/CHANGES.md +39 -0
- data/README.md +153 -7
- data/Rakefile +81 -19
- data/ci/travis_install.sh +30 -9
- data/examples/classifier_comparison.rb +1 -1
- data/examples/hist.rb +1 -1
- data/examples/notebooks/classifier_comparison.ipynb +1 -1
- data/examples/notebooks/leaflet.ipynb +77 -0
- data/ext/pycall/gc.c +84 -5
- data/ext/pycall/libpython.c +7 -1
- data/ext/pycall/pycall.c +60 -6
- data/ext/pycall/pycall_internal.h +27 -1
- data/ext/pycall/ruby_wrapper.c +11 -2
- data/ext/pycall/thread.c +36 -0
- data/lib/pycall.rb +16 -0
- data/lib/pycall/dict.rb +2 -2
- data/lib/pycall/init.rb +3 -8
- data/lib/pycall/iterable_wrapper.rb +32 -0
- data/lib/pycall/libpython/finder.rb +131 -84
- data/lib/pycall/list.rb +2 -2
- data/lib/pycall/pyobject_wrapper.rb +1 -1
- data/lib/pycall/python/investigator.py +82 -9
- data/lib/pycall/pytypeobject_wrapper.rb +10 -0
- data/lib/pycall/version.rb +7 -1
- data/lib/pycall/wrapper_object_cache.rb +56 -25
- data/pycall.gemspec +9 -2
- metadata +24 -7
- data/.travis.yml +0 -56
- data/appveyor.yml +0 -104
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b016b6c9b12867d113713238ecc171cc4fde8965197c79c59abf66d8bb3b252e
|
4
|
+
data.tar.gz: abb36597376d37744972f7bb537ab61032387c73947d7846b9947bb622bf04ac
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 18bc020ef0c1f1d82e3796ae023170ee287bbf966c3efd12dd48f730eec585b7b70e00352d316e8e524e608c70bff0348937c1afc434ba7d6ae634223f0e1fa6
|
7
|
+
data.tar.gz: 9ea69bb090386a7a280be6a7c779b406f49a3de2da5b406c64529be6a462535cbe9eefaad404e3dd1dab6bc98a5840e2825708f8d1602e1404ab4dbd83ce43b2
|
@@ -0,0 +1,150 @@
|
|
1
|
+
name: CI
|
2
|
+
|
3
|
+
on:
|
4
|
+
push:
|
5
|
+
branches:
|
6
|
+
- master
|
7
|
+
- "check/ci/**"
|
8
|
+
- "check/unix/**"
|
9
|
+
pull_request:
|
10
|
+
types:
|
11
|
+
- opened
|
12
|
+
- synchronize
|
13
|
+
- reopened
|
14
|
+
|
15
|
+
jobs:
|
16
|
+
test:
|
17
|
+
name: ${{ matrix.venv }}${{ matrix.os }}/${{ matrix.ruby }}/${{ matrix.python }}-${{ matrix.python_architecture }}
|
18
|
+
runs-on: ${{ matrix.os }}
|
19
|
+
|
20
|
+
strategy:
|
21
|
+
fail-fast: false
|
22
|
+
matrix:
|
23
|
+
os:
|
24
|
+
- ubuntu-20.04
|
25
|
+
- macos-latest
|
26
|
+
ruby:
|
27
|
+
- "3.0"
|
28
|
+
- 2.7
|
29
|
+
- 2.6
|
30
|
+
python:
|
31
|
+
- 3.x
|
32
|
+
- 2.x
|
33
|
+
python_architecture:
|
34
|
+
- x64
|
35
|
+
venv:
|
36
|
+
- ""
|
37
|
+
include:
|
38
|
+
- { os: ubuntu-20.04 , ruby: 2.5 , python: 3.x , python_architecture: x64 , venv: "" }
|
39
|
+
- { os: ubuntu-20.04 , ruby: 2.4 , python: 3.x , python_architecture: x64 , venv: "" }
|
40
|
+
- { os: ubuntu-20.04 , ruby: 2.5 , python: 2.x , python_architecture: x64 , venv: "" }
|
41
|
+
- { os: ubuntu-20.04 , ruby: 2.4 , python: 2.x , python_architecture: x64 , venv: "" }
|
42
|
+
- { os: ubuntu-20.04 , ruby: 2.7 , python: 3.8 , python_architecture: x64 , venv: "" }
|
43
|
+
- { os: ubuntu-20.04 , ruby: 2.7 , python: 3.7 , python_architecture: x64 , venv: "" }
|
44
|
+
- { os: ubuntu-20.04 , ruby: 2.7 , python: 3.6 , python_architecture: x64 , venv: "" }
|
45
|
+
- { os: ubuntu-18.04 , ruby: 2.7 , python: 3.8 , python_architecture: x64 , venv: "" }
|
46
|
+
- { os: ubuntu-20.04 , ruby: debug , python: 3.x , python_architecture: x64 , venv: "" }
|
47
|
+
- { os: ubuntu-20.04 , ruby: "3.0" , python: 3.x , python_architecture: x64 , venv: "venv:" }
|
48
|
+
- { os: ubuntu-18.04 , ruby: "3.0" , python: 3.x , python_architecture: x64 , venv: "venv:" }
|
49
|
+
- { os: ubuntu-18.04 , ruby: "3.0" , python: 3.8 , python_architecture: x64 , venv: "venv:" }
|
50
|
+
- { os: macos-latest , ruby: "3.0" , python: 3.x , python_architecture: x64 , venv: "venv:" }
|
51
|
+
- { os: macos-latest , ruby: "3.0" , python: 3.8 , python_architecture: x64 , venv: "venv:" }
|
52
|
+
#- { os: macos-latest , ruby: debug , python: 3.x , python_architecture: x64 , venv: "" }
|
53
|
+
|
54
|
+
steps:
|
55
|
+
- uses: actions/checkout@v2
|
56
|
+
with:
|
57
|
+
fetch-depth: 1
|
58
|
+
|
59
|
+
- uses: ruby/setup-ruby@v1
|
60
|
+
if: matrix.ruby_version != 'master-nightly'
|
61
|
+
with:
|
62
|
+
ruby-version: ${{ matrix.ruby }}
|
63
|
+
|
64
|
+
- uses: actions/setup-python@v2
|
65
|
+
with:
|
66
|
+
python-version: ${{ matrix.python }}
|
67
|
+
architecture: ${{ matrix.python_architecture }}
|
68
|
+
|
69
|
+
- run: pip install --user numpy
|
70
|
+
|
71
|
+
- run: bundle install
|
72
|
+
|
73
|
+
- run: rake compile
|
74
|
+
|
75
|
+
- run: python lib/pycall/python/investigator.py
|
76
|
+
|
77
|
+
- name: venv examination
|
78
|
+
run: |
|
79
|
+
python -m venv ~/test-venv
|
80
|
+
source ~/test-venv/bin/activate
|
81
|
+
ruby -Ilib -Iext/pycall -rpycall -ePyCall.builtins
|
82
|
+
env:
|
83
|
+
PYCALL_DEBUG_FIND_LIBPYTHON: 1
|
84
|
+
if: ${{ matrix.venv != '' }}
|
85
|
+
|
86
|
+
- run: rake
|
87
|
+
env:
|
88
|
+
PYTHON: python
|
89
|
+
|
90
|
+
conda:
|
91
|
+
name: conda:${{ matrix.os }}/${{ matrix. ruby }}/${{ matrix.python }}
|
92
|
+
runs-on: ${{ matrix.os }}
|
93
|
+
|
94
|
+
strategy:
|
95
|
+
fail-fast: false
|
96
|
+
matrix:
|
97
|
+
os:
|
98
|
+
- ubuntu-20.04
|
99
|
+
- macos-latest
|
100
|
+
ruby:
|
101
|
+
- "3.0"
|
102
|
+
python:
|
103
|
+
- 3.8
|
104
|
+
|
105
|
+
steps:
|
106
|
+
- uses: actions/checkout@v2
|
107
|
+
with:
|
108
|
+
fetch-depth: 1
|
109
|
+
|
110
|
+
- uses: conda-incubator/setup-miniconda@v2
|
111
|
+
with:
|
112
|
+
activate-environment: test
|
113
|
+
python-version: ${{ matrix.python }}
|
114
|
+
|
115
|
+
- uses: ruby/setup-ruby@v1
|
116
|
+
if: matrix.ruby_version != 'master-nightly'
|
117
|
+
with:
|
118
|
+
ruby-version: ${{ matrix.ruby }}
|
119
|
+
|
120
|
+
- name: Add Ruby path
|
121
|
+
run: |
|
122
|
+
echo >> ~/.profile
|
123
|
+
echo >> ~/.profile
|
124
|
+
IFS=:
|
125
|
+
for p in $PATH; do
|
126
|
+
case $p in
|
127
|
+
*/Ruby/*)
|
128
|
+
echo "export PATH=$p:\$PATH" >> ~/.profile
|
129
|
+
;;
|
130
|
+
esac
|
131
|
+
done
|
132
|
+
|
133
|
+
- run: cat ~/.profile
|
134
|
+
|
135
|
+
- run: bash -xe ~/.profile
|
136
|
+
|
137
|
+
- run: conda install numpy
|
138
|
+
shell: bash -l {0}
|
139
|
+
|
140
|
+
- run: bundle install
|
141
|
+
|
142
|
+
- run: rake compile
|
143
|
+
|
144
|
+
- run: python lib/pycall/python/investigator.py
|
145
|
+
shell: bash -l {0}
|
146
|
+
|
147
|
+
- run: rake
|
148
|
+
env:
|
149
|
+
PYTHON: python
|
150
|
+
shell: bash -l {0}
|
@@ -0,0 +1,127 @@
|
|
1
|
+
name: Windows
|
2
|
+
|
3
|
+
on:
|
4
|
+
push:
|
5
|
+
branches:
|
6
|
+
- master
|
7
|
+
- "check/ci/**"
|
8
|
+
- "check/windows/**"
|
9
|
+
pull_request:
|
10
|
+
types:
|
11
|
+
- opened
|
12
|
+
- synchronize
|
13
|
+
- reopened
|
14
|
+
|
15
|
+
jobs:
|
16
|
+
test:
|
17
|
+
name: ruby-${{ matrix.ruby }}/python-${{ matrix.python }}-${{ matrix.python_architecture }}
|
18
|
+
runs-on: windows-latest
|
19
|
+
|
20
|
+
strategy:
|
21
|
+
fail-fast: false
|
22
|
+
matrix:
|
23
|
+
ruby:
|
24
|
+
- "3.0"
|
25
|
+
- 2.7
|
26
|
+
- 2.6
|
27
|
+
python:
|
28
|
+
- 3.x
|
29
|
+
- 2.x
|
30
|
+
python_architecture:
|
31
|
+
- x64
|
32
|
+
include:
|
33
|
+
- { os: windows-latest , ruby: mingw , python: 3.x , python_architecture: x64 }
|
34
|
+
#- { os: windows-latest , ruby: mswin , python: 3.x , python_architecture: x64 }
|
35
|
+
|
36
|
+
steps:
|
37
|
+
- uses: actions/checkout@v2
|
38
|
+
with:
|
39
|
+
fetch-depth: 1
|
40
|
+
|
41
|
+
- uses: ruby/setup-ruby@v1
|
42
|
+
if: matrix.ruby_version != 'master-nightly'
|
43
|
+
with:
|
44
|
+
ruby-version: ${{ matrix.ruby }}
|
45
|
+
|
46
|
+
- uses: actions/setup-python@v2
|
47
|
+
with:
|
48
|
+
python-version: ${{ matrix.python }}
|
49
|
+
architecture: ${{ matrix.python_architecture }}
|
50
|
+
|
51
|
+
- run: pip install --user numpy
|
52
|
+
|
53
|
+
- run: bundle install
|
54
|
+
|
55
|
+
- run: rake compile
|
56
|
+
|
57
|
+
- run: python lib/pycall/python/investigator.py
|
58
|
+
|
59
|
+
- run: rake
|
60
|
+
env:
|
61
|
+
PYTHON: python
|
62
|
+
|
63
|
+
conda:
|
64
|
+
name: conda:ruby-${{ matrix. ruby }}/python-${{ matrix.python }}
|
65
|
+
runs-on: windows-latest
|
66
|
+
|
67
|
+
strategy:
|
68
|
+
fail-fast: false
|
69
|
+
matrix:
|
70
|
+
ruby:
|
71
|
+
- "3.0"
|
72
|
+
python:
|
73
|
+
- 3.8
|
74
|
+
|
75
|
+
defaults:
|
76
|
+
run:
|
77
|
+
shell: pwsh
|
78
|
+
|
79
|
+
steps:
|
80
|
+
- uses: actions/checkout@v2
|
81
|
+
with:
|
82
|
+
fetch-depth: 1
|
83
|
+
|
84
|
+
- uses: conda-incubator/setup-miniconda@v2
|
85
|
+
with:
|
86
|
+
activate-environment: test
|
87
|
+
python-version: ${{ matrix.python }}
|
88
|
+
|
89
|
+
- run: set
|
90
|
+
shell: cmd
|
91
|
+
|
92
|
+
- name: Add conda's DLL path
|
93
|
+
run: |
|
94
|
+
echo $env:CONDA\Library\bin >> $GITHUB_PATH
|
95
|
+
echo $env:CONDA_PREFIX\Library\bin >> $GITHUB_PATH
|
96
|
+
|
97
|
+
- uses: ruby/setup-ruby@v1
|
98
|
+
if: matrix.ruby_version != 'master-nightly'
|
99
|
+
with:
|
100
|
+
ruby-version: ${{ matrix.ruby }}
|
101
|
+
|
102
|
+
- run: conda install numpy
|
103
|
+
|
104
|
+
- run: python -c 'import numpy; print(numpy)'
|
105
|
+
|
106
|
+
- run: python -c 'import os; print(os.environ)'
|
107
|
+
|
108
|
+
- run: bundle install
|
109
|
+
|
110
|
+
- run: rake compile
|
111
|
+
|
112
|
+
- run: python lib/pycall/python/investigator.py
|
113
|
+
|
114
|
+
- run: |
|
115
|
+
ruby -Ilib -Iext/pycall -rpycall -e "p PyCall.sys.version"
|
116
|
+
ruby -Ilib -Iext/pycall -rpycall -e "PyCall.import_module(:numpy)"
|
117
|
+
env:
|
118
|
+
PYTHON: python
|
119
|
+
continue-on-error: true
|
120
|
+
|
121
|
+
- run: |
|
122
|
+
echo $env:PATH
|
123
|
+
rake
|
124
|
+
env:
|
125
|
+
PYTHON: python
|
126
|
+
CONDA_DLL_SEARCH_MODIFICATION_ENABLE: 1
|
127
|
+
continue-on-error: true
|
data/.gitignore
CHANGED
data/CHANGES.md
CHANGED
@@ -1,5 +1,44 @@
|
|
1
1
|
# The change history of PyCall
|
2
2
|
|
3
|
+
## 1.4.1
|
4
|
+
|
5
|
+
* Fix SEGV occurred on Windows
|
6
|
+
* Add PyCall.iterable
|
7
|
+
|
8
|
+
## 1.4.0
|
9
|
+
|
10
|
+
* Explicitly states that Windows is not supported yet in README
|
11
|
+
* Add PyCall.same?
|
12
|
+
* Improve conda support
|
13
|
+
* Fat gem is no longer supported
|
14
|
+
* Use WeakMap for caching PyPtr instances
|
15
|
+
|
16
|
+
## 1.3.1
|
17
|
+
|
18
|
+
* Stop using `&proc` idiom to prevent warnings
|
19
|
+
|
20
|
+
*Kenta Murata*
|
21
|
+
|
22
|
+
## 1.3.0
|
23
|
+
|
24
|
+
* Add `PyCall.without_gvl` for explicitly releasing the RubyVM GVL
|
25
|
+
|
26
|
+
* Fix for missing if in PyObjectWrapper
|
27
|
+
|
28
|
+
*Kouhei Sutou*
|
29
|
+
|
30
|
+
* Fix for Anaconda environment
|
31
|
+
|
32
|
+
*Ryo MATSUMIYA*
|
33
|
+
|
34
|
+
* Fix against `unknown symbol "PyInt_AsSsize_t"` (Fiddle::DLError)
|
35
|
+
|
36
|
+
*Kouhei Sutou*
|
37
|
+
|
38
|
+
* Fix for `TypeError: Compared with non class/module`
|
39
|
+
|
40
|
+
*Archonic*
|
41
|
+
|
3
42
|
## 1.2.1
|
4
43
|
|
5
44
|
* Prevent circular require in pycall/iruby.rb
|
data/README.md
CHANGED
@@ -5,8 +5,8 @@
|
|
5
5
|
|
6
6
|
# PyCall: Calling Python functions from the Ruby language
|
7
7
|
|
8
|
-
[![Build Status](https://
|
9
|
-
[![Build status](https://ci.appveyor.com/api/projects/status/
|
8
|
+
[![Build Status](https://github.com/mrkn/pycall.rb/workflows/CI/badge.svg)](https://github.com/mrkn/pycall.rb/actions?query=workflow%3ACI)
|
9
|
+
[![Build status](https://ci.appveyor.com/api/projects/status/0fad23u4qj1yr49e/branch/master?svg=true)](https://ci.appveyor.com/project/mrkn/pycall-rb/branch/master)
|
10
10
|
|
11
11
|
This library provides the features to directly call and partially interoperate
|
12
12
|
with Python from the Ruby language. You can import arbitrary Python modules
|
@@ -15,7 +15,7 @@ Ruby to Python.
|
|
15
15
|
|
16
16
|
## Supported Ruby versions
|
17
17
|
|
18
|
-
pycall.rb supports Ruby version 2.
|
18
|
+
pycall.rb supports Ruby version 2.4 or higher.
|
19
19
|
|
20
20
|
## Supported Python versions
|
21
21
|
|
@@ -32,6 +32,12 @@ pyenv does not build the shared library in default, so you need to specify `--en
|
|
32
32
|
$ env PYTHON_CONFIGURE_OPTS='--enable-shared' pyenv install 3.7.2
|
33
33
|
```
|
34
34
|
|
35
|
+
## Note for Windows users
|
36
|
+
|
37
|
+
Currently, pycall.rb does not support Windows. Please try to use pycall.rb on WSL2 environment.
|
38
|
+
|
39
|
+
On Windows, the error "[BUG] object allocation during garbage collection phase" is occurred at unpredictable timings.
|
40
|
+
|
35
41
|
## Installation
|
36
42
|
|
37
43
|
Add this line to your application's Gemfile:
|
@@ -61,6 +67,86 @@ the `Math.sin` in Ruby:
|
|
61
67
|
Type conversions from Ruby to Python are automatically performed for numeric,
|
62
68
|
boolean, string, arrays, and hashes.
|
63
69
|
|
70
|
+
### Calling a constructor
|
71
|
+
|
72
|
+
In Python, we call the constructor of a class by `classname(x, y, z)` syntax. Pycall.rb maps this syntax to `classname.new(x, y, z)`.
|
73
|
+
|
74
|
+
### Calling a callable object
|
75
|
+
|
76
|
+
In Python, we can call the callable object by `obj(x, y, z)` syntax. PyCall.rb maps this syntax to `obj.(x, y, z)`.
|
77
|
+
|
78
|
+
### Passing keyword arguments
|
79
|
+
|
80
|
+
In Python, we can pass keyword arguments by `func(x=1, y=2, z=3)` syntax. In pycallrb, we should rewrite `x=1` to `x: 1`.
|
81
|
+
|
82
|
+
### The callable attribute of an object
|
83
|
+
|
84
|
+
Pycall.rb maps the callable attribute of an object to the instance method of the corresponding wrapper object. So, we can write a Python expression `obj.meth(x, y, z=1)` as `obj.meth(x, y, z: 1)` in Ruby. This mapping allows us to call these attributes naturally as Ruby's manner.
|
85
|
+
|
86
|
+
But, unfortunately, this mapping prohibits us to get the callable attributes. We need to write `PyCall.getattr(obj, :meth)` in Ruby to get `obj.meth` object while we can write `obj.meth` in Python.
|
87
|
+
|
88
|
+
### Specifying the Python version
|
89
|
+
|
90
|
+
If you want to use a specific version of Python instead of the default,
|
91
|
+
you can change the Python version by setting the `PYTHON` environment variable
|
92
|
+
to the path of the `python` executable.
|
93
|
+
|
94
|
+
When `PYTHON` is not specified, pycall.rb tries to use `python3` first,
|
95
|
+
and then tries to use `python`.
|
96
|
+
|
97
|
+
### Releasing the RubyVM GVL during Python function calls
|
98
|
+
|
99
|
+
You may want to release the RubyVM GVL when you call a Python function that takes very long runtime.
|
100
|
+
PyCall provides `PyCall.without_gvl` method for such purpose. When PyCall performs python function call,
|
101
|
+
PyCall checks the current context, and then it releases the RubyVM GVL when the current context is in a `PyCall.without_gvl`'s block.
|
102
|
+
|
103
|
+
```ruby
|
104
|
+
PyCall.without_gvl do
|
105
|
+
# In this block, all Python function calls are performed without
|
106
|
+
# the GVL acquisition.
|
107
|
+
pyobj.long_running_function()
|
108
|
+
end
|
109
|
+
|
110
|
+
# Outside of PyCall.without_gvl block,
|
111
|
+
# all Python function calls are performed with the GVL acquisition.
|
112
|
+
pyobj.long_running_function()
|
113
|
+
```
|
114
|
+
|
115
|
+
### Debugging python finder
|
116
|
+
|
117
|
+
When you encounter `PyCall::PythonNotFound` error, you can investigate PyCall's python finder by setting `PYCALL_DEBUG_FIND_LIBPYTHON` environment variable to `1`. You can see the log like below:
|
118
|
+
|
119
|
+
```
|
120
|
+
$ PYCALL_DEBUG_FIND_LIBPYTHON=1 ruby -rpycall -ePyCall.builtins
|
121
|
+
DEBUG(find_libpython) find_libpython(nil)
|
122
|
+
DEBUG(find_libpython) investigate_python_config("python3")
|
123
|
+
DEBUG(find_libpython) libs: ["Python.framework/Versions/3.7/Python", "Python", "libpython3.7m", "libpython3.7", "libpython"]
|
124
|
+
DEBUG(find_libpython) libpaths: ["/opt/brew/opt/python/Frameworks/Python.framework/Versions/3.7/lib", "/opt/brew/opt/python/lib", "/opt/brew/opt/python/Frameworks", "/opt/brew/Cellar/python/3.7.2_1/Frameworks/Python.framework/Versions/3.7", "/opt/brew/Cellar/python/3.7.2_1/Frameworks/Python.framework/Versions/3.7/lib"]
|
125
|
+
DEBUG(find_libpython) Unable to find /opt/brew/opt/python/Frameworks/Python.framework/Versions/3.7/lib/Python.framework/Versions/3.7/Python
|
126
|
+
DEBUG(find_libpython) Unable to find /opt/brew/opt/python/Frameworks/Python.framework/Versions/3.7/lib/Python.framework/Versions/3.7/Python.dylib
|
127
|
+
DEBUG(find_libpython) Unable to find /opt/brew/opt/python/Frameworks/Python.framework/Versions/3.7/lib/darwin/Python.framework/Versions/3.7/Python
|
128
|
+
DEBUG(find_libpython) Unable to find /opt/brew/opt/python/Frameworks/Python.framework/Versions/3.7/lib/darwin/Python.framework/Versions/3.7/Python.dylib
|
129
|
+
DEBUG(find_libpython) Unable to find /opt/brew/opt/python/lib/Python.framework/Versions/3.7/Python
|
130
|
+
DEBUG(find_libpython) Unable to find /opt/brew/opt/python/lib/Python.framework/Versions/3.7/Python.dylib
|
131
|
+
DEBUG(find_libpython) Unable to find /opt/brew/opt/python/lib/darwin/Python.framework/Versions/3.7/Python
|
132
|
+
DEBUG(find_libpython) Unable to find /opt/brew/opt/python/lib/darwin/Python.framework/Versions/3.7/Python.dylib
|
133
|
+
DEBUG(find_libpython) dlopen("/opt/brew/opt/python/Frameworks/Python.framework/Versions/3.7/Python") = #<Fiddle::Handle:0x00007fc012048650>
|
134
|
+
```
|
135
|
+
|
136
|
+
## Special notes for specific libraries
|
137
|
+
|
138
|
+
### matplotlib
|
139
|
+
|
140
|
+
Use [mrkn/matplotlib.rb](https://github.com/mrkn/matplotlib.rb) instead of just importing it by `PyCall.import_module("matplotlib")`.
|
141
|
+
|
142
|
+
### numpy
|
143
|
+
|
144
|
+
Use [mrkn/numpy.rb](https://github.com/mrkn/numpy.rb) instead of just importing it by `PyCall.import_module("numpy")`.
|
145
|
+
|
146
|
+
### pandas
|
147
|
+
|
148
|
+
Use [mrkn/pandas.rb](https://github.com/mrkn/pandas.rb) instead of just importing it by `PyCall.import_module("pandas")`.
|
149
|
+
|
64
150
|
## PyCall object system
|
65
151
|
|
66
152
|
PyCall wraps pointers of Python objects in `PyCall::PyPtr` objects.
|
@@ -80,11 +166,71 @@ variable `@__pyptr__`. `PyCall::PyObjectWrapper` assumes the existance of
|
|
80
166
|
system and Python object system. For example, `PyCall::PyObjectWrapper`
|
81
167
|
translates Ruby's coerce system into Python's swapped operation protocol.
|
82
168
|
|
83
|
-
|
169
|
+
## Deploying on Heroku
|
84
170
|
|
85
|
-
|
86
|
-
|
87
|
-
|
171
|
+
Heroku's default version of Python is not compiled with the `--enabled-shared`
|
172
|
+
option and can't be accessed by PyCall. Alternative [buildpacks](https://devcenter.heroku.com/articles/buildpacks) are available,
|
173
|
+
including these that have been reported to work with PyCall:
|
174
|
+
|
175
|
+
https://github.com/richgong/heroku-buildpack-python
|
176
|
+
https://github.com/dsounded/heroku-buildpack-python
|
177
|
+
https://github.com/ReforgeHQ/heroku-buildpack-python
|
178
|
+
|
179
|
+
These community-developed buildpacks are not supported by Heroku, so it's
|
180
|
+
worth examining the source to make sure the buildpack you use suits your
|
181
|
+
needs. For instance, 'ReforgeHQ' works well with Python 3.8.1, but has not
|
182
|
+
been configured to work with other versions and may not be as generally
|
183
|
+
useful as the 'dsounded' or 'richgong' buildpacks.
|
184
|
+
|
185
|
+
The buildpack will expect to find both a `runtime.txt` and a `requirements.txt`
|
186
|
+
file in the root of your project. You will need to add these to specify the
|
187
|
+
version of Python and any packages to be installed via `pip`, _e.g_ to use
|
188
|
+
version Python 3.8.1 and version 2.5 of the 'networkx' package:
|
189
|
+
|
190
|
+
$ echo "python-3.8.1" >> runtime.txt
|
191
|
+
$ echo "networkx==2.5" >> requirements.txt
|
192
|
+
|
193
|
+
Commit these two files into project's repository. You'll use these to manage
|
194
|
+
your Python environment in much the same way you use the `Gemfile` to manage
|
195
|
+
Ruby.
|
196
|
+
|
197
|
+
Heroku normally detects which buildpacks to use, but you will want to override
|
198
|
+
this behavior. It's probably best to clear out existing buildpacks and specify
|
199
|
+
exactly which buildpacks from scratch.
|
200
|
+
|
201
|
+
First, take stock of your existing buildpacks:
|
202
|
+
|
203
|
+
$ heroku buildpack [-a YOUR_APP_NAME]
|
204
|
+
|
205
|
+
For a Ruby/Rails application this will typically report the stock `heroku/ruby`
|
206
|
+
buildpack, or possibly both `heroku/ruby` and `heroku/nodejs`.
|
207
|
+
|
208
|
+
Clear the list and progressively add back your buildpacks, starting with the Python
|
209
|
+
community-developed buildpack. For example, if `ruby` and `nodejs` buildpacks were
|
210
|
+
previously installed, and chosing the 'ReforgeHQ' buildback, your setup process will
|
211
|
+
be similar to this:
|
212
|
+
|
213
|
+
$ heroku buildpacks:clear
|
214
|
+
$ heroku buildpacks:add https://github.com/ReforgeHQ/heroku-buildpack-python -i 1
|
215
|
+
$ heroku buildpacks:add heroku/nodejs -i 2
|
216
|
+
# heroku buildpacks:add heroku/ruby -i 3
|
217
|
+
|
218
|
+
If you have multiple applications on Heroku you will need to append each of these
|
219
|
+
with application's identifier (_e.g._ `heroku buildpacks:clear -a YOUR_APP_NAME`).
|
220
|
+
|
221
|
+
With each buildpack we are registering its index (the `-i` switch) in order to
|
222
|
+
specify the order Heroku will load runtimes and execute bootstrapping code. It's
|
223
|
+
important for the Python environment to be engaged first, as PyCall will need to
|
224
|
+
be able to find it when Ruby-based processes start.
|
225
|
+
|
226
|
+
Once you have set up your buildpacks, and have commited both `requirements.txt` and
|
227
|
+
`runtime.txt` files to git, deploy your Heroku application as your normally would.
|
228
|
+
The Python bootstrapping process will appear in the log first, followed by the Ruby
|
229
|
+
and so on. PyCall should now be able to successfully call Python functions from
|
230
|
+
within the Heroku environment.
|
231
|
+
|
232
|
+
NB It is also possible to specify buildpacks within Docker images on Heroku.
|
233
|
+
See Heroku's [documentation on using Docker Images](https://devcenter.heroku.com/articles/build-docker-images-heroku-yml).
|
88
234
|
|
89
235
|
## Development
|
90
236
|
|