pycall 0.1.0.alpha.20170419b → 0.1.0.alpha.20170426

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36ce6abd1f064086a1f22ae9d67294e6b4687387
-  data.tar.gz: 474754869f8f19454eb462523afb95d678f2a8f4
+  metadata.gz: 3bcfecf2fed43a5e8e5c52f5d96cfc899f180a6e
+  data.tar.gz: 66b6648e36b7eef5e8961413144a837e85bb47cf
 SHA512:
-  metadata.gz: ac241e957192e609d29df35bf7655c3430a07b7ae75d4eacec7317157d1435f655c3cdee7c4224cf0de7a55e51b029d5db5e04c099586ecdede39a926e07f189
-  data.tar.gz: a5fcf65ce708790d6f82c6d757c3b8c5313e4e62310064a32917e9c9c80e0761cd11c4188b3618e91d016efdf09e691dd73ba582020951e7952116ffe0edcfca
+  metadata.gz: '0117417889164ebeb9756fd40e7393db68a1c83204f0fdfd57c9be0cabf44cde6d9b474eba22aa08aa69c97a995c78d665a94388f87b32f78761cf4b3ee1e3f1'
+  data.tar.gz: 60d13590b7a44567a8ce47d20e137ac90518a6279777e1398c7ccf4bc6741e63d7f26b3b01672aff82b3eba8299f516017325a55825c0d1672d120b1f1873047

data/.travis.yml

@@ -23,3 +23,7 @@ addons:
 before_install:
   - gem update --system
   - gem update bundler
+
+before_script:
+  - echo === python investigator.py ===
+  - python lib/pycall/python/investigator.py

data/README.md

@@ -1,10 +1,9 @@
-# PyCall
+# PyCall: Calling Python functions from the Ruby language
 
 [![Build Status](https://travis-ci.org/mrkn/pycall.svg?branch=master)](https://travis-ci.org/mrkn/pycall)
+[![Build status](https://ci.appveyor.com/api/projects/status/071is0f4iu0vy8lp/branch/master?svg=true)](https://ci.appveyor.com/project/mrkn/pycall/branch/master)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pycall`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This library provides the features to directly call and partially interoperate with Python from the Ruby language.  You can import arbitrary Python modules into Ruby modules, call Python functions with automatic type conversion from Ruby to Python.
 
 ## Installation
 
@@ -20,11 +19,64 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install pycall
+    $ gem install --pre pycall
 
 ## Usage
 
-TODO: Write usage instructions here
+Here is a simple example to call Python's `math.sin` function and compare it to the `Math.sin` in Ruby:
+
+    require 'pycall/import'
+    include PyCall::Import
+    pyimport :math
+    math.sin.(math.pi / 4) - Math.sin(Math::PI / 4)   # => 0.0
+    #       ^ This period is necessary
+
+Type conversions from Ruby to Python are automatically performed for numeric, boolean, string, arrays, and hashes.
+
+### Python function call
+
+In this version of pycall, the all of functions and methods in Python is wrapped as callable objects in Ruby.  It means we need to put a priod between the name of function and `(` like `math.sin.(...)` in the above example.
+
+This unnatural notation is a temporary specification, so we should be able to write `math.sin(...)` in the future.
+
+## Wrapping Python classes
+
+**NOTE: Currently I'm trying to rewrite class wrapping system, so the content of this section will be changed.**
+
+Using `PyCall::PyObjectWrapper` module, we can create incarnation classes for Python classes in Ruby language.  For example, the following script defines a incarnation class for `numpy.ndarray` class.
+
+```ruby
+require 'pycall'
+
+class Ndarray
+  import PyCall::PyObjectWrapper
+  wrap_class PyCall.import_module('numpy').ndarray
+end
+```
+
+Defineing incarnation classes using `wrap_class` registeres automatic type conversion, so it changes the class of wrapper object.  For example:
+
+    require 'pycall/import'
+    include PyCall::Import
+    pyimport :numpy, as: :np
+    x1 = np.array(PyCall.tuple(10))
+    x1.class   # => PyCall::PyObject
+
+    class Ndarray
+      import PyCall::PyObjectWrapper
+      wrap_class PyCall.import_module('numpy').ndarray
+      # NOTE: From here, numpy.ndarray objects are converted to Ndarray objects
+    end
+
+    x2 = np.array(PyCall.tuple(10))
+    x2.class   # => Ndarray
+
+
+**NOTE: I will write an efficient wrapper for numpy by RubyKaigi 2017.**
+
+### 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.
 
 ## Development
 
@@ -37,6 +89,10 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 Bug reports and pull requests are welcome on GitHub at https://github.com/mrkn/pycall.
 
 
+## Acknowledgement
+
+[PyCall.jl](https://github.com/JuliaPy/PyCall.jl) is referred too many times to implement this library.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/appveyor.yml

@@ -0,0 +1,155 @@
+---
+environment:
+  matrix:
+  # Ruby 2.1 (32bit)
+  - ruby_version: "21"
+    PYTHONDIR: "C:\\Python27"
+    PYTHON: "C:\\Python27\\python.exe"
+
+  - ruby_version: "21"
+    PYTHONDIR: "C:\\Python33"
+    PYTHON: "C:\\Python33\\python.exe"
+
+  - ruby_version: "21"
+    PYTHONDIR: "C:\\Python34"
+    PYTHON: "C:\\Python34\\python.exe"
+
+  - ruby_version: "21"
+    PYTHONDIR: "C:\\Python35"
+    PYTHON: "C:\\Python35\\python.exe"
+
+  - ruby_version: "21"
+    PYTHONDIR: "C:\\Python36"
+    PYTHON: "C:\\Python36\\python.exe"
+
+  # Ruby 2.1 (64bit)
+  - ruby_version: "21-x64"
+    PYTHONDIR: "C:\\Python27-x64"
+    PYTHON: "C:\\Python27-x64\\python.exe"
+
+  - ruby_version: "21-x64"
+    PYTHONDIR: "C:\\Python33-x64"
+    PYTHON: "C:\\Python33-x64\\python.exe"
+
+  - ruby_version: "21-x64"
+    PYTHONDIR: "C:\\Python34-x64"
+    PYTHON: "C:\\Python34-x64\\python.exe"
+
+  - ruby_version: "21-x64"
+    PYTHONDIR: "C:\\Python35-x64"
+    PYTHON: "C:\\Python35-x64\\python.exe"
+
+  - ruby_version: "21-x64"
+    PYTHONDIR: "C:\\Python36-x64"
+    PYTHON: "C:\\Python36-x64\\python.exe"
+
+  # Ruby 2.2 (32bit)
+  - ruby_version: "22"
+    PYTHONDIR: "C:\\Python27"
+    PYTHON: "C:\\Python27\\python.exe"
+
+  - ruby_version: "22"
+    PYTHONDIR: "C:\\Python33"
+    PYTHON: "C:\\Python33\\python.exe"
+
+  - ruby_version: "22"
+    PYTHONDIR: "C:\\Python34"
+    PYTHON: "C:\\Python34\\python.exe"
+
+  - ruby_version: "22"
+    PYTHONDIR: "C:\\Python35"
+    PYTHON: "C:\\Python35\\python.exe"
+
+  - ruby_version: "22"
+    PYTHONDIR: "C:\\Python36"
+    PYTHON: "C:\\Python36\\python.exe"
+
+  # Ruby 2.2 (64bit)
+  - ruby_version: "22-x64"
+    PYTHONDIR: "C:\\Python27-x64"
+    PYTHON: "C:\\Python27-x64\\python.exe"
+
+  - ruby_version: "22-x64"
+    PYTHONDIR: "C:\\Python33-x64"
+    PYTHON: "C:\\Python33-x64\\python.exe"
+
+  - ruby_version: "22-x64"
+    PYTHONDIR: "C:\\Python34-x64"
+    PYTHON: "C:\\Python34-x64\\python.exe"
+
+  - ruby_version: "22-x64"
+    PYTHONDIR: "C:\\Python35-x64"
+    PYTHON: "C:\\Python35-x64\\python.exe"
+
+  - ruby_version: "22-x64"
+    PYTHONDIR: "C:\\Python36-x64"
+    PYTHON: "C:\\Python36-x64\\python.exe"
+
+  # Ruby 2.3 (32bit)
+  - ruby_version: "23"
+    PYTHONDIR: "C:\\Python27"
+    PYTHON: "C:\\Python27\\python.exe"
+
+  - ruby_version: "23"
+    PYTHONDIR: "C:\\Python33"
+    PYTHON: "C:\\Python33\\python.exe"
+
+  - ruby_version: "23"
+    PYTHONDIR: "C:\\Python34"
+    PYTHON: "C:\\Python34\\python.exe"
+
+  - ruby_version: "23"
+    PYTHONDIR: "C:\\Python35"
+    PYTHON: "C:\\Python35\\python.exe"
+
+  - ruby_version: "23"
+    PYTHONDIR: "C:\\Python36"
+    PYTHON: "C:\\Python36\\python.exe"
+
+  # Ruby 2.3 (64bit)
+  - ruby_version: "23-x64"
+    PYTHONDIR: "C:\\Python27-x64"
+    PYTHON: "C:\\Python27-x64\\python.exe"
+
+  - ruby_version: "23-x64"
+    PYTHONDIR: "C:\\Python33-x64"
+    PYTHON: "C:\\Python33-x64\\python.exe"
+
+  - ruby_version: "23-x64"
+    PYTHONDIR: "C:\\Python34-x64"
+    PYTHON: "C:\\Python34-x64\\python.exe"
+
+  - ruby_version: "23-x64"
+    PYTHONDIR: "C:\\Python35-x64"
+    PYTHON: "C:\\Python35-x64\\python.exe"
+
+  - ruby_version: "23-x64"
+    PYTHONDIR: "C:\\Python36-x64"
+    PYTHON: "C:\\Python36-x64\\python.exe"
+
+branches:
+  only:
+    - master
+    - /release-.*/
+
+notifications:
+  - provider: Email
+    on_build_success: false
+    on_build_failure: false
+    on_build_status_changed: false
+
+deploy: off
+build: off
+
+install:
+  - "SET PATH=%PYTHONDIR%;%PYTHONDIR%\\Scripts;%PATH%"
+  - "SET PATH=C:\\Ruby%ruby_version%\\bin;%PATH%"
+  - bundle install
+
+before_test:
+  - ECHO "=== python investigator.py ==="
+  - "python lib\\pycall\\python\\investigator.py"
+
+test_script:
+  - "SET DEBUG_FIND_LIBPYTHON=1"
+  - rake

data/lib/pycall/conversion.rb

@@ -102,13 +102,11 @@ module PyCall
       when Float
         LibPython.PyFloat_FromDouble(obj)
       when String
-        case obj.encoding
-        when Encoding::US_ASCII, Encoding::BINARY
-          LibPython.PyString_FromStringAndSize(obj, obj.bytesize)
-        else
-          obj = obj.encode(Encoding::UTF_8)
-          LibPython.PyUnicode_DecodeUTF8(obj, obj.bytesize, nil)
+        if obj.encoding != Encoding::BINARY && (PyCall.unicode_literals? || !obj.ascii_only?)
+          obj = obj.encode(Encoding::UTF_8) if obj.encoding != Encoding::UTF_8
+          return LibPython.PyUnicode_DecodeUTF8(obj, obj.bytesize, nil)
         end
+        LibPython.PyString_FromStringAndSize(obj, obj.bytesize)
       when Symbol
         from_ruby(obj.to_s)
       when Array

data/lib/pycall/init.rb

@@ -10,7 +10,7 @@ module PyCall
       PyCall::LibPython.PySys_SetArgvEx(0, argv, 0)
     end
 
-    @builtin = LibPython.PyImport_ImportModule(PYTHON_VERSION < '3.0.0' ? '__builtin__' : 'builtins')
+    @builtin = LibPython.PyImport_ImportModule(PYTHON_VERSION < '3.0.0' ? '__builtin__' : 'builtins').to_ruby
   end
 
   class << self

data/lib/pycall/libpython.rb

@@ -26,6 +26,8 @@ module PyCall
     private_class_method
 
     def self.find_libpython(python = nil)
+      debug = (ENV['DEBUG_FIND_LIBPYTHON'] == '1')
+      dir_sep = File::ALT_SEPARATOR || File::SEPARATOR
       python ||= 'python'
       python_config = investigate_python_config(python)
 
@@ -42,6 +44,8 @@ module PyCall
       libs << "#{libprefix}python#{v}" << "#{libprefix}python"
       libs.uniq!
 
+      $stderr.puts "DEBUG(find_libpython) libs: #{libs.inspect}" if debug
+
       executable = python_config[:executable]
       libpaths = [ python_config[:LIBDIR] ]
       if FFI::Platform.windows?
@@ -51,9 +55,11 @@ module PyCall
       end
       libpaths << python_config[:PYTHONFRAMEWORKPREFIX] if FFI::Platform.mac?
       exec_prefix = python_config[:exec_prefix]
-      libpaths << exec_prefix << File.join(exec_prefix, 'lib')
+      libpaths << exec_prefix << [exec_prefix, 'lib'].join(dir_sep)
       libpaths.compact!
 
+      $stderr.puts "DEBUG(find_libpython) libpaths: #{libpaths.inspect}" if debug
+
       unless ENV['PYTHONHOME']
         # PYTHONHOME tells python where to look for both pure python and binary modules.
         # When it is set, it replaces both `prefix` and `exec_prefix`
@@ -88,7 +94,6 @@ module PyCall
       # Find libpython (we hope):
       libsuffix = FFI::Platform::LIBSUFFIX
       multiarch = python_config[:MULTIARCH] || python_config[:multiarch]
-      dir_sep = File::ALT_SEPARATOR || File::SEPARATOR
       libs.each do |lib|
         libpaths.each do |libpath|
           # NOTE: File.join doesn't use File::ALT_SEPARATOR
@@ -99,10 +104,14 @@ module PyCall
               libpath_lib,
               "#{libpath_lib}.#{libsuffix}"
             ].each do |fullname|
-              next unless File.file?(fullname)
+              unless File.file?(fullname)
+                $stderr.puts "DEBUG(find_libpython) Unable to find #{fullname}" if debug
+                next
+              end
               begin
-                libs = ffi_lib(fullname)
-                return libs.first
+                dynlibs = ffi_lib(fullname)
+                $stderr.puts "DEBUG(find_libpython) ffi_lib(#{fullname.inspect}) = #{dynlibs.inspect}" if debug
+                return dynlibs.first
               rescue LoadError
                 # skip load error
               end
@@ -110,6 +119,17 @@ module PyCall
           end
         end
       end
+
+      # Find libpython in the system path
+      libs.each do |lib|
+        begin
+          dynlibs = ffi_lib(lib)
+          $stderr.puts "DEBUG(find_libpython) ffi_lib(#{lib.inspect}) = #{dynlibs.inspect}" if debug
+          return dynlibs.first
+        rescue LoadError
+          # skip load error
+        end
+      end
     end
 
     def self.investigate_python_config(python)
@@ -131,6 +151,18 @@ module PyCall
     ffi_lib_flags :lazy, :global
     libpython = find_libpython ENV['PYTHON']
 
+    attach_function :Py_GetVersion, [], :string
+    PYTHON_DESCRIPTION = LibPython.Py_GetVersion().freeze
+    PYTHON_VERSION = PYTHON_DESCRIPTION.split(' ', 2)[0].freeze
+
+    # --- types ---
+
+    if PYTHON_VERSION < '3.2'
+      typedef :long, :Py_hash_t
+    else
+      typedef :ssize_t, :Py_hash_t
+    end
+
     # --- global variables ---
 
     attach_variable :_Py_NoneStruct, PyObjectStruct
@@ -173,7 +205,6 @@ module PyCall
 
     # --- functions ---
 
-    attach_function :Py_GetVersion, [], :string
     attach_function :Py_InitializeEx, [:int], :void
     attach_function :Py_IsInitialized, [], :int
     attach_function :PySys_SetArgvEx, [:int, :pointer, :int], :void
@@ -194,6 +225,7 @@ module PyCall
     attach_function :PyObject_Call, [PyObjectStruct.by_ref, PyObjectStruct.by_ref, PyObjectStruct.by_ref], PyObjectStruct.by_ref
     attach_function :PyObject_IsInstance, [PyObjectStruct.by_ref, PyObjectStruct.by_ref], :int
     attach_function :PyObject_Dir, [PyObjectStruct.by_ref], PyObjectStruct.by_ref
+    attach_function :PyObject_Hash, [PyObjectStruct.by_ref], :Py_hash_t
     attach_function :PyObject_Repr, [PyObjectStruct.by_ref], PyObjectStruct.by_ref
     attach_function :PyObject_Str, [PyObjectStruct.by_ref], PyObjectStruct.by_ref
     attach_function :PyObject_Type, [PyObjectStruct.by_ref], PyObjectStruct.by_ref
@@ -339,6 +371,10 @@ module PyCall
     public_class_method
   end
 
-  PYTHON_DESCRIPTION = LibPython.Py_GetVersion().freeze
-  PYTHON_VERSION = PYTHON_DESCRIPTION.split(' ', 2)[0].freeze
+  PYTHON_DESCRIPTION = LibPython::PYTHON_DESCRIPTION
+  PYTHON_VERSION = LibPython::PYTHON_VERSION
+
+  def self.unicode_literals?
+    @unicode_literals ||= (PYTHON_VERSION >= '3.0')
+  end
 end

data/lib/pycall/pyobject_wrapper.rb

@@ -56,6 +56,16 @@ module PyCall
 
     attr_reader :__pyobj__
 
+    def eql?(other)
+      rich_compare(other, :==)
+    end
+
+    def hash
+      hash_value = LibPython.PyObject_Hash(__pyobj__)
+      return super if hash_value == -1
+      hash_value
+    end
+
     def type
       LibPython.PyObject_Type(__pyobj__).to_ruby
     end

data/lib/pycall/version.rb

@@ -1,3 +1,3 @@
 module PyCall
-  VERSION = "0.1.0.alpha.20170419b"
+  VERSION = "0.1.0.alpha.20170426"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pycall
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha.20170419b
+  version: 0.1.0.alpha.20170426
 platform: ruby
 authors:
 - Kenta Murata
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-19 00:00:00.000000000 Z
+date: 2017-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -80,6 +80,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- appveyor.yml
 - bin/console
 - bin/guard
 - bin/rspec