pycall 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba0b7938e482d87e6a6eb540b92b2e581974fc6e894e674c7da00b4b68807b15
-  data.tar.gz: ad5ce0352f59744abf9193e69cf33719f9314aad45e9c24fd6584fe73873330e
+  metadata.gz: 79fa29a4fd735c0741f03e74aadce297273cd2d64c0813b9ee2e20ad5fa321b9
+  data.tar.gz: 108942ac4b4d45324644fe90af4e56e239f7ce3b2f27fa0d98d5defa439da8db
 SHA512:
-  metadata.gz: cc2eb8963c91d69086eccab17cb06ebea072908f77f3e4f85a23f328f858f7cda29ebec70c519fa70f3fc88eaf5e37b61b88136515f2326e0c239467a522067b
-  data.tar.gz: cfb14589abee3741fcec45f31d8d94dc076341ae425ee0302e50628e6ffafdfff665a6e90c67a80ce10df6a8866282bc221ecddf198d0049ee85d1055bb50255
+  metadata.gz: eb899c3e9c353622945df3b816df4588cd3b4606f723c53973a2f8d77d8eb9edf94b7dbcf15ff4d33f65430fd6d38a8bc2ccc2fda2a1f8f274dc769b0280e42a
+  data.tar.gz: ff84eb82b4e10d1a2f699abd32cfcdcc6159cba6b83f2258bc4100c7229bb49ca1c7593b5a6629ef2081007728bc3be5e266b65c2967c49c043fb3dfe0bf3835

data/.github/workflows/ci.yml

@@ -1,67 +1,150 @@
 name: CI
 
 on:
-- push
+  push:
+    branches:
+    - master
+    - "check/ci/**"
+    - "check/unix/**"
+  pull_request:
+    types:
+    - opened
+    - synchronize
+    - reopened
 
 jobs:
   test:
-    name: Test
+    name: ${{ matrix.venv }}${{ matrix.os }}/${{ matrix.ruby }}/${{ matrix.python }}-${{ matrix.python_architecture }}
     runs-on: ${{ matrix.os }}
 
     strategy:
       fail-fast: false
       matrix:
         os:
-        - ubuntu-18.04
+        - ubuntu-20.04
         - macos-latest
-        ruby_version:
-        - 2.7.x
-        - 2.6.x
-        - 2.5.x
-        - 2.4.x
-        python_version:
-        - 3.8.x
-        - 3.7.x
-        - 3.6.x
-        - 2.7.x
+        ruby:
+        - "3.0"
+        - 2.7
+        - 2.6
+        python:
+        - 3.x
+        - 2.x
         python_architecture:
         - x64
+        venv:
+        - ""
+        include:
+        - { os: ubuntu-20.04   , ruby: 2.5   , python: 3.x , python_architecture: x64 , venv: "" }
+        - { os: ubuntu-20.04   , ruby: 2.4   , python: 3.x , python_architecture: x64 , venv: "" }
+        - { os: ubuntu-20.04   , ruby: 2.5   , python: 2.x , python_architecture: x64 , venv: "" }
+        - { os: ubuntu-20.04   , ruby: 2.4   , python: 2.x , python_architecture: x64 , venv: "" }
+        - { os: ubuntu-20.04   , ruby: 2.7   , python: 3.8 , python_architecture: x64 , venv: "" }
+        - { os: ubuntu-20.04   , ruby: 2.7   , python: 3.7 , python_architecture: x64 , venv: "" }
+        - { os: ubuntu-20.04   , ruby: 2.7   , python: 3.6 , python_architecture: x64 , venv: "" }
+        - { os: ubuntu-18.04   , ruby: 2.7   , python: 3.8 , python_architecture: x64 , venv: "" }
+        - { os: ubuntu-20.04   , ruby: debug , python: 3.x , python_architecture: x64 , venv: "" }
+        - { os: ubuntu-20.04   , ruby: "3.0" , python: 3.x , python_architecture: x64 , venv: "venv:"  }
+        - { os: ubuntu-18.04   , ruby: "3.0" , python: 3.x , python_architecture: x64 , venv: "venv:"  }
+        - { os: ubuntu-18.04   , ruby: "3.0" , python: 3.8 , python_architecture: x64 , venv: "venv:"  }
+        - { os: macos-latest   , ruby: "3.0" , python: 3.x , python_architecture: x64 , venv: "venv:"  }
+        - { os: macos-latest   , ruby: "3.0" , python: 3.8 , python_architecture: x64 , venv: "venv:"  }
+        #- { os: macos-latest   , ruby: debug , python: 3.x , python_architecture: x64 , venv: "" }
 
     steps:
-      - name: Setup Ruby
-        if: matrix.ruby_version != 'master-nightly'
-        uses: actions/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby_version }}
-
-      - name: Setup Python
-        uses: actions/setup-python@v1
-        with:
-          python-version: ${{ matrix.python_version }}
-          architecture: ${{ matrix.python_architecture }}
-
-      - name: Checkout
-        uses: actions/checkout@v1
-        with:
-          fetch-depth: 1
-
-      - name: Prepare environment
-        run: |
-          gem install bundler
-
-      - name: Install requirements
-        run: |
-          pip install --user numpy
-          bundle install
-
-      - name: Compile pycall.so
-        run: |
-          bundle exec rake compile
-
-      - name: Python investigator
-        run: |
-          python lib/pycall/python/investigator.py
-
-      - name: Test
-        run: |
-          PYTHON=python bundle exec rake
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 1
+
+    - uses: ruby/setup-ruby@v1
+      if: matrix.ruby_version != 'master-nightly'
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python }}
+        architecture: ${{ matrix.python_architecture }}
+
+    - run: pip install --user numpy
+
+    - run: bundle install
+
+    - run: rake compile
+
+    - run: python lib/pycall/python/investigator.py
+
+    - name: venv examination
+      run: |
+        python -m venv ~/test-venv
+        source ~/test-venv/bin/activate
+        ruby -Ilib -Iext/pycall -rpycall -ePyCall.builtins
+      env:
+        PYCALL_DEBUG_FIND_LIBPYTHON: 1
+      if: ${{ matrix.venv != '' }}
+
+    - run: rake
+      env:
+        PYTHON: python
+
+  conda:
+    name: conda:${{ matrix.os }}/${{ matrix. ruby }}/${{ matrix.python }}
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+        - ubuntu-20.04
+        - macos-latest
+        ruby:
+        - "3.0"
+        python:
+        - 3.8
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 1
+
+    - uses: conda-incubator/setup-miniconda@v2
+      with:
+        activate-environment: test
+        python-version: ${{ matrix.python }}
+
+    - uses: ruby/setup-ruby@v1
+      if: matrix.ruby_version != 'master-nightly'
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - name: Add Ruby path
+      run: |
+        echo >> ~/.profile
+        echo >> ~/.profile
+        IFS=:
+        for p in $PATH; do
+          case $p in
+          */Ruby/*)
+            echo "export PATH=$p:\$PATH" >> ~/.profile
+            ;;
+          esac
+        done
+
+    - run: cat ~/.profile
+
+    - run: bash -xe ~/.profile
+
+    - run: conda install numpy
+      shell: bash -l {0}
+
+    - run: bundle install
+
+    - run: rake compile
+
+    - run: python lib/pycall/python/investigator.py
+      shell: bash -l {0}
+
+    - run: rake
+      env:
+        PYTHON: python
+      shell: bash -l {0}

data/.github/workflows/windows.yml

@@ -0,0 +1,127 @@
+name: Windows
+
+on:
+  push:
+    branches:
+    - master
+    - "check/ci/**"
+    - "check/windows/**"
+  pull_request:
+    types:
+    - opened
+    - synchronize
+    - reopened
+
+jobs:
+  test:
+    name: ruby-${{ matrix.ruby }}/python-${{ matrix.python }}-${{ matrix.python_architecture }}
+    runs-on: windows-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+        - "3.0"
+        - 2.7
+        - 2.6
+        python:
+        - 3.x
+        - 2.x
+        python_architecture:
+        - x64
+        include:
+        - { os: windows-latest , ruby: mingw , python: 3.x , python_architecture: x64 }
+        #- { os: windows-latest , ruby: mswin , python: 3.x , python_architecture: x64 }
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 1
+
+    - uses: ruby/setup-ruby@v1
+      if: matrix.ruby_version != 'master-nightly'
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python }}
+        architecture: ${{ matrix.python_architecture }}
+
+    - run: pip install --user numpy
+
+    - run: bundle install
+
+    - run: rake compile
+
+    - run: python lib/pycall/python/investigator.py
+
+    - run: rake
+      env:
+        PYTHON: python
+
+  conda:
+    name: conda:ruby-${{ matrix. ruby }}/python-${{ matrix.python }}
+    runs-on: windows-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+        - "3.0"
+        python:
+        - 3.8
+
+    defaults:
+      run:
+        shell: pwsh
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 1
+
+    - uses: conda-incubator/setup-miniconda@v2
+      with:
+        activate-environment: test
+        python-version: ${{ matrix.python }}
+
+    - run: set
+      shell: cmd
+
+    - name: Add conda's DLL path
+      run: |
+        echo $env:CONDA\Library\bin >> $GITHUB_PATH
+        echo $env:CONDA_PREFIX\Library\bin >> $GITHUB_PATH
+
+    - uses: ruby/setup-ruby@v1
+      if: matrix.ruby_version != 'master-nightly'
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - run: conda install numpy
+
+    - run: python -c 'import numpy; print(numpy)'
+
+    - run: python -c 'import os; print(os.environ)'
+
+    - run: bundle install
+
+    - run: rake compile
+
+    - run: python lib/pycall/python/investigator.py
+
+    - run: |
+        ruby -Ilib -Iext/pycall -rpycall -e "p PyCall.sys.version"
+        ruby -Ilib -Iext/pycall -rpycall -e "PyCall.import_module(:numpy)"
+      env:
+        PYTHON: python
+      continue-on-error: true
+
+    - run: |
+        echo $env:PATH
+        rake
+      env:
+        PYTHON: python
+        CONDA_DLL_SEARCH_MODIFICATION_ENABLE: 1
+      continue-on-error: true

data/.gitignore

@@ -10,6 +10,8 @@
 
 __pycache__/
 .ipynb_checkpoints/
+/ext/**/Makefile
+/ext/**/mkmf.log
 *.bundle
 *.so
 *.o

data/CHANGES.md

@@ -1,5 +1,13 @@
 # The change history of PyCall
 
+## 1.4.0
+
+* Explicitly states that Windows is not supported yet in README
+* Add PyCall.same?
+* Improve conda support
+* Fat gem is no longer supported
+* Use WeakMap for caching PyPtr instances
+
 ## 1.3.1
 
 * Stop using `&proc` idiom to prevent warnings

data/README.md

@@ -6,7 +6,6 @@
 # PyCall: Calling Python functions from the Ruby language
 
 [![Build Status](https://github.com/mrkn/pycall.rb/workflows/CI/badge.svg)](https://github.com/mrkn/pycall.rb/actions?query=workflow%3ACI)
-[![Build Status](https://travis-ci.org/mrkn/pycall.rb.svg?branch=master)](https://travis-ci.org/mrkn/pycall.rb)
 [![Build status](https://ci.appveyor.com/api/projects/status/0fad23u4qj1yr49e/branch/master?svg=true)](https://ci.appveyor.com/project/mrkn/pycall-rb/branch/master)
 
 This library provides the features to directly call and partially interoperate
@@ -16,7 +15,7 @@ Ruby to Python.
 
 ## Supported Ruby versions
 
-pycall.rb supports Ruby version 2.3 or higher.
+pycall.rb supports Ruby version 2.4 or higher.
 
 ## Supported Python versions
 
@@ -33,6 +32,12 @@ pyenv does not build the shared library in default, so you need to specify `--en
 $ env PYTHON_CONFIGURE_OPTS='--enable-shared' pyenv install 3.7.2
 ```
 
+## Note for Windows users
+
+Currently, pycall.rb does not support Windows.  Please try to use pycall.rb on WSL2 environment.
+
+On Windows, the error "[BUG] object allocation during garbage collection phase" is occurred at unpredictable timings.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -62,6 +67,33 @@ the `Math.sin` in Ruby:
 Type conversions from Ruby to Python are automatically performed for numeric,
 boolean, string, arrays, and hashes.
 
+### Calling a constructor
+
+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)`.
+
+### Calling a callable object
+
+In Python, we can call the callable object by `obj(x, y, z)` syntax.  PyCall.rb maps this syntax to `obj.(x, y, z)`.
+
+### Passing keyword arguments
+
+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`.
+
+### The callable attribute of an object
+
+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.
+
+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.
+
+### Specifying the Python version
+
+If you want to use a specific version of Python instead of the default,
+you can change the Python version by setting the `PYTHON` environment variable
+to the path of the `python` executable.
+
+When `PYTHON` is not specified, pycall.rb tries to use `python3` first,
+and then tries to use `python`.
+
 ### Releasing the RubyVM GVL during Python function calls
 
 You may want to release the RubyVM GVL when you call a Python function that takes very long runtime.
@@ -101,6 +133,20 @@ DEBUG(find_libpython) Unable to find /opt/brew/opt/python/lib/darwin/Python.fram
 DEBUG(find_libpython) dlopen("/opt/brew/opt/python/Frameworks/Python.framework/Versions/3.7/Python") = #<Fiddle::Handle:0x00007fc012048650>
 ```
 
+## Special notes for specific libraries
+
+### matplotlib
+
+Use [mrkn/matplotlib.rb](https://github.com/mrkn/matplotlib.rb) instead of just importing it by `PyCall.import_module("matplotlib")`.
+
+### numpy
+
+Use [mrkn/numpy.rb](https://github.com/mrkn/numpy.rb) instead of just importing it by `PyCall.import_module("numpy")`.
+
+### pandas
+
+Use [mrkn/pandas.rb](https://github.com/mrkn/pandas.rb) instead of just importing it by `PyCall.import_module("pandas")`.
+
 ## PyCall object system
 
 PyCall wraps pointers of Python objects in `PyCall::PyPtr` objects.
@@ -120,11 +166,71 @@ variable `@__pyptr__`.  `PyCall::PyObjectWrapper` assumes the existance of
 system and Python object system.  For example, `PyCall::PyObjectWrapper`
 translates Ruby's coerce system into Python's swapped operation protocol.
 
-### Specifying the Python version
+## Deploying on Heroku
 
-If you want to use a specific version of Python instead of the default,
-you can change the Python version by setting the `PYTHON` environment variable
-to the path of the `python` executable.
+Heroku's default version of Python is not compiled with the `--enabled-shared`
+option and can't be accessed by PyCall. Alternative [buildpacks](https://devcenter.heroku.com/articles/buildpacks) are available,
+including these that have been reported to work with PyCall:
+
+https://github.com/richgong/heroku-buildpack-python
+https://github.com/dsounded/heroku-buildpack-python
+https://github.com/ReforgeHQ/heroku-buildpack-python
+
+These community-developed buildpacks are not supported by Heroku, so it's
+worth examining the source to make sure the buildpack you use suits your
+needs. For instance, 'ReforgeHQ' works well with Python 3.8.1, but has not
+been configured to work with other versions and may not be as generally
+useful as the 'dsounded' or 'richgong' buildpacks.
+
+The buildpack will expect to find both a `runtime.txt` and a `requirements.txt` 
+file in the root of your project. You will need to add these to specify the 
+version of Python and any packages to be installed via `pip`, _e.g_ to use 
+version Python 3.8.1 and version 2.5 of the 'networkx' package:
+
+    $ echo "python-3.8.1" >> runtime.txt
+    $ echo "networkx==2.5" >> requirements.txt
+
+Commit these two files into project's repository. You'll use these to manage
+your Python environment in much the same way you use the `Gemfile` to manage
+Ruby.
+
+Heroku normally detects which buildpacks to use, but you will want to override
+this behavior. It's probably best to clear out existing buildpacks and specify
+exactly which buildpacks from scratch.
+
+First, take stock of your existing buildpacks:
+
+    $ heroku buildpack [-a YOUR_APP_NAME]
+
+For a Ruby/Rails application this will typically report the stock `heroku/ruby`
+buildpack, or possibly both `heroku/ruby` and `heroku/nodejs`. 
+
+Clear the list and progressively add back your buildpacks, starting with the Python 
+community-developed buildpack. For example, if `ruby` and `nodejs` buildpacks were 
+previously installed, and chosing the 'ReforgeHQ' buildback, your setup process will 
+be similar to this: 
+
+    $ heroku buildpacks:clear
+    $ heroku buildpacks:add https://github.com/ReforgeHQ/heroku-buildpack-python -i 1
+    $ heroku buildpacks:add heroku/nodejs -i 2
+    # heroku buildpacks:add heroku/ruby -i 3
+
+If you have multiple applications on Heroku you will need to append each of these 
+with application's identifier (_e.g._ `heroku buildpacks:clear -a YOUR_APP_NAME`).
+
+With each buildpack we are registering its index (the `-i` switch) in order to 
+specify the order Heroku will load runtimes and execute bootstrapping code. It's 
+important for the Python environment to be engaged first, as PyCall will need to 
+be able to find it when Ruby-based processes start. 
+
+Once you have set up your buildpacks, and have commited both `requirements.txt` and 
+`runtime.txt` files to git, deploy your Heroku application as your normally would.
+The Python bootstrapping process will appear in the log first, followed by the Ruby
+and so on. PyCall should now be able to successfully call Python functions from 
+within the Heroku environment.
+
+NB It is also possible to specify buildpacks within Docker images on Heroku.
+See Heroku's [documentation on using Docker Images](https://devcenter.heroku.com/articles/build-docker-images-heroku-yml).
 
 ## Development