pybind 0.1.0

data/lib/pybind/core_ext/basic.rb

@@ -0,0 +1,66 @@
+class Object
+  def to_python_struct
+    raise TypeError, "can not convert #{inspect} to a PyObjectStruct"
+  end
+  alias_method :to_python, :to_python_struct
+end
+
+class NilClass
+  def to_python
+    PyBind::LibPython.Py_None
+  end
+end
+
+class TrueClass
+  def to_python
+    PyBind::LibPython.Py_True
+  end
+end
+
+class FalseClass
+  def to_python
+    PyBind::LibPython.Py_False
+  end
+end
+
+class Integer
+  def to_python
+    PyBind::LibPython.PyInt_FromSsize_t(self)
+  end
+end
+
+class Float
+  def to_python
+    PyBind::LibPython.PyFloat_FromDouble(self)
+  end
+end
+
+class String
+  def to_python
+    case encoding
+    when Encoding::US_ASCII, Encoding::BINARY
+      PyBind::LibPython.PyString_FromStringAndSize(self, bytesize)
+    else
+      utf8_str = encode(Encoding::UTF_8)
+      PyBind::LibPython.PyUnicode_DecodeUTF8(utf8_str, utf8_str.bytesize, nil)
+    end
+  end
+end
+
+class Symbol
+  def to_python
+    to_s.to_python
+  end
+end
+
+class Hash
+  def to_python
+    PyBind::PyDict.new(self).to_python_struct
+  end
+end
+
+class Array
+  def to_python
+    PyBind::PyList.new(self).to_python_struct
+  end
+end

data/lib/pybind/error.rb

@@ -0,0 +1,38 @@
+module PyBind
+  class PyError < StandardError
+    def self.fetch
+      ptrs = FFI::MemoryPointer.new(:pointer, 3)
+      ptype      = ptrs + 0 * ptrs.type_size
+      pvalue     = ptrs + 1 * ptrs.type_size
+      ptraceback = ptrs + 2 * ptrs.type_size
+      LibPython.PyErr_Fetch(ptype, pvalue, ptraceback)
+      LibPython.PyErr_NormalizeException(ptype, pvalue, ptraceback)
+      type = TypeCast.from_python(PyObjectStruct.new(ptype.read(:pointer)))
+      value = TypeCast.from_python(PyObjectStruct.new(pvalue.read(:pointer)))
+      traceback = TypeCast.from_python(PyObjectStruct.new(ptraceback.read(:pointer)))
+      new(type, value, traceback)
+    end
+
+    def initialize(type, value, traceback)
+      @type = type
+      @value = value
+      @traceback = traceback
+      super("#{type}: #{value}")
+    end
+
+    attr_reader :type, :value, :traceback
+
+    def message
+      baseline = super
+      lines = [baseline] + PyBind.parse_traceback(traceback)
+      lines.join("\n")
+    rescue
+      baseline
+    end
+  end
+
+  def self.parse_traceback(traceback)
+    format_tb_func = PyBind.traceback.get_attribute('format_tb')
+    format_tb_func.call(traceback).to_a
+  end
+end

data/lib/pybind/import.rb

@@ -0,0 +1,51 @@
+module PyBind
+  module Import
+    def pyimport(mod_name, as: mod_name)
+      if as.to_s.include?('.')
+        raise ArgumentError, "#{as.inspect} is not a valid module variable name, use pyimport #{mod_name.inspect}, as: <name>"
+      end
+
+      mod = PyBind.import(mod_name)
+      raise PyError.fetch unless mod
+
+      define_singleton_method(as) { mod }
+    end
+
+    def pyfrom(mod_name, import: nil)
+      raise ArgumentError, "missing identifiers to be imported" unless import
+
+      mod = PyBind.import(mod_name)
+      raise PyError.fetch unless mod
+
+      case import
+      when Hash
+        import.each do |attr, as|
+          val = mod.get_attribute(attr)
+          define_singleton_method(as) { val }
+        end
+      when Array
+        import.each do |attr|
+          val = mod.get_attribute(attr)
+          define_singleton_method(attr) { val }
+        end
+      when Symbol, String
+        val = mod.get_attribute(import)
+        define_singleton_method(import) { val }
+      end
+    end
+  end
+
+  def self.import(name)
+    name = name.to_s if name.is_a? Symbol
+    raise TypeError, 'name must be a String' unless name.is_a? String
+    value = LibPython.PyImport_ImportModule(name)
+    raise PyError.fetch if value.null?
+    value = value.to_ruby
+    return value unless block_given?
+    begin
+      yield value
+    ensure
+      PyBind.decref(value)
+    end
+  end
+end

data/lib/pybind/init.rb

@@ -0,0 +1,23 @@
+module PyBind
+  private_class_method
+
+  class << self
+    attr_reader :builtin
+  end
+
+  def self.__initialize_pybind__
+    initialized = (0 != LibPython.Py_IsInitialized())
+    return if initialized
+
+    LibPython.Py_InitializeEx(0)
+
+    FFI::MemoryPointer.new(:pointer, 1) do |argv|
+      argv.write_pointer(FFI::MemoryPointer.from_string(''))
+      LibPython.PySys_SetArgvEx(0, argv, 0)
+    end
+
+    @builtin = LibPython.PyImport_ImportModule(PYTHON_VERSION < '3.0.0' ? '__builtin__' : 'builtins').to_ruby
+  end
+
+  __initialize_pybind__
+end

data/lib/pybind/libpython.rb

@@ -0,0 +1,371 @@
+require 'ffi'
+
+module PyBind
+  module LibPython
+    extend FFI::Library
+
+    def self.find_libpython(python = nil)
+      python ||= ENV['PYTHON'] || 'python'
+      python_config = investigate_python_config(python)
+
+      version = python_config[:VERSION]
+      libprefix = FFI::Platform::LIBPREFIX
+      libs = []
+      %i(INSTSONAME LDLIBRARY).each do |key|
+        lib = python_config[key]
+        libs << lib << File.basename(lib) if lib
+      end
+      if (lib = python_config[:LIBRARY])
+        libs << File.basename(lib, File.extname(lib))
+      end
+      libs << "#{libprefix}python#{version}" << "#{libprefix}python"
+      libs.uniq!
+
+      executable = python_config[:EXECUTABLE]
+      libpaths = [ python_config[:LIBDIR] ]
+      if FFI::Platform.windows?
+        libpaths << File.dirname(executable)
+      else
+        libpaths << File.expand_path('../../lib', executable)
+      end
+      libpaths << python_config[:PYTHONFRAMEWORKPREFIX] if FFI::Platform.mac?
+      exec_prefix = python_config[:EXECPREFIX]
+      libpaths << exec_prefix << File.join(exec_prefix, 'lib')
+      libpaths.compact!
+
+      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`
+        # and we thus need to set it to both in case they differ.
+        # This is also what the documentation recommends.
+        # However, they are documented to always be the same on Windows,
+        # where it causes problems if we try to include both.
+        if FFI::Platform.windows?
+          ENV['PYTHONHOME'] = exec_prefix
+        else
+          ENV['PYTHONHOME'] = [python_config[:PREFIX], exec_prefix].join(':')
+        end
+
+        # Unfortunately, setting PYTHONHOME screws up Canopy's Python distribution?
+        unless system(python, '-c', 'import site', out: File::NULL, err: File::NULL)
+          ENV['PYTHONHOME'] = nil
+        end
+      end
+
+      # Try LIBPYTHON environment variable first.
+      if ENV['LIBPYTHON']
+        if File.file?(ENV['LIBPYTHON'])
+          begin
+            libs = ffi_lib(ENV['LIBPYTHON'])
+            return libs.first
+          rescue LoadError
+          end
+        end
+        $stderr.puts '[WARN] Ignore the wrong libpython location specified in LIBPYTHON environment variable.'
+      end
+
+      # Find libpython (we hope):
+      libsuffix = FFI::Platform::LIBSUFFIX
+      multiarch = python_config[:MULTIARCH] || python_config[:IMPLEMENTATIONMULTIARCH]
+      dir_sep = File::ALT_SEPARATOR || File::SEPARATOR
+      libs.each do |lib|
+        libpaths.each do |libpath|
+          # NOTE: File.join doesn't use File::ALT_SEPARATOR
+          libpath_libs = [ [libpath, lib].join(dir_sep) ]
+          libpath_libs << [libpath, multiarch, lib].join(dir_sep) if multiarch
+          libpath_libs.each do |libpath_lib|
+            [
+              libpath_lib,
+              "#{libpath_lib}.#{libsuffix}"
+            ].each do |fullname|
+              next unless File.file?(fullname)
+              begin
+                libs = ffi_lib(fullname)
+                return libs.first
+              rescue LoadError
+                # skip load error
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def self.investigate_python_config(python)
+      python_env = { 'PYTHONIOENCODING' => 'UTF-8' }
+      IO.popen(python_env, [python, python_investigator_py], 'r') do |io|
+        {}.tap do |config|
+          io.each_line do |line|
+            key, value = line.chomp.split(': ', 2)
+            config[key.to_sym] = value if value != 'None'
+          end
+        end
+      end
+    end
+
+    def self.python_investigator_py
+      File.expand_path('../python/investigator.py', __FILE__)
+    end
+
+    ffi_lib_flags :lazy, :global
+    libpython = find_libpython ENV['PYTHON']
+
+    # --- global variables ---
+
+    attach_variable :_Py_NoneStruct, PyObjectStruct
+
+    def self.Py_None
+      _Py_NoneStruct
+    end
+
+    attach_variable :PyType_Type, PyObjectStruct
+
+    if libpython.find_variable('PyInt_Type')
+      has_PyInt_Type = true
+      attach_variable :PyInt_Type, PyObjectStruct
+    else
+      has_PyInt_Type = false
+      attach_variable :PyInt_Type, :PyLong_Type, PyObjectStruct
+    end
+
+    attach_variable :PyLong_Type, PyObjectStruct
+    attach_variable :PyBool_Type, PyObjectStruct
+    attach_variable :PyFloat_Type, PyObjectStruct
+    attach_variable :PyComplex_Type, PyObjectStruct
+    attach_variable :PyUnicode_Type, PyObjectStruct
+
+    if libpython.find_symbol('PyString_FromStringAndSize')
+      string_as_bytes = false
+      attach_variable :PyString_Type, PyObjectStruct
+    else
+      string_as_bytes = true
+      attach_variable :PyString_Type, :PyBytes_Type, PyObjectStruct
+    end
+
+    attach_variable :PyTuple_Type, PyObjectStruct
+    attach_variable :PySlice_Type, PyObjectStruct
+    attach_variable :PyList_Type, PyObjectStruct
+    attach_variable :PyDict_Type, PyObjectStruct
+    attach_variable :PySet_Type, PyObjectStruct
+
+    attach_variable :PyFunction_Type, PyObjectStruct
+    attach_variable :PyMethod_Type, PyObjectStruct
+
+    # --- 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
+
+    # Reference count
+
+    attach_function :Py_IncRef, [PyObjectStruct.by_ref], :void
+    attach_function :Py_DecRef, [PyObjectStruct.by_ref], :void
+
+    # Object
+
+    attach_function :PyObject_RichCompare, [PyObjectStruct.by_ref, PyObjectStruct.by_ref, :int], PyObjectStruct.by_ref
+    attach_function :PyObject_RichCompareBool, [PyObjectStruct.by_ref, PyObjectStruct.by_ref, :int], :int
+    attach_function :PyObject_GetAttrString, [PyObjectStruct.by_ref, :string], PyObjectStruct.by_ref
+    attach_function :PyObject_SetAttrString, [PyObjectStruct.by_ref, :string, PyObjectStruct.by_ref], :int
+    attach_function :PyObject_HasAttrString, [PyObjectStruct.by_ref, :string], :int
+    attach_function :PyObject_GetItem, [PyObjectStruct.by_ref, PyObjectStruct.by_ref], PyObjectStruct.by_ref
+    attach_function :PyObject_SetItem, [PyObjectStruct.by_ref, PyObjectStruct.by_ref, PyObjectStruct.by_ref], :int
+    attach_function :PyObject_DelItem, [PyObjectStruct.by_ref, PyObjectStruct.by_ref], :int
+    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_IsSubclass, [PyObjectStruct.by_ref, PyObjectStruct.by_ref], :int
+    attach_function :PyObject_Dir, [PyObjectStruct.by_ref], PyObjectStruct.by_ref
+    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
+    attach_function :PyCallable_Check, [PyObjectStruct.by_ref], :int
+
+    # PyObject_DelAttrString only avaliable in Python 3.x
+    if libpython.find_symbol('PyObject_DelAttrString')
+      attach_function :PyObject_DelAttrString, [PyObjectStruct.by_ref, :string], :int
+    end
+
+    # PyObject_Compare only avaliable in Python 2.x
+    if libpython.find_symbol('PyObject_Compare')
+      attach_function :PyObject_Compare, [PyObjectStruct.by_ref, PyObjectStruct.by_ref], :int
+    end
+
+    # Bool
+
+    attach_function :PyBool_FromLong, [:long], PyObjectStruct.by_ref
+    attach_variable :_Py_TrueStruct, PyObjectStruct
+
+    def self.Py_True
+      _Py_TrueStruct
+    end
+
+    # _Py_ZeroStruct only avaliable in Python 2.x, use _Py_FalseStruct in Python 3.x
+    if libpython.find_symbol('PyObject_Compare')
+      attach_variable :_Py_ZeroStruct, PyObjectStruct
+
+      def self.Py_False
+        _Py_ZeroStruct
+      end
+    else
+      attach_variable :_Py_FalseStruct, PyObjectStruct
+
+      def self.Py_False
+        _Py_FalseStruct
+      end
+    end
+
+    # Integer
+
+    if has_PyInt_Type
+      attach_function :PyInt_AsSsize_t, [PyObjectStruct.by_ref], :ssize_t
+    else
+      attach_function :PyInt_AsSsize_t, :PyLong_AsSsize_t, [PyObjectStruct.by_ref], :ssize_t
+    end
+
+    if has_PyInt_Type
+      attach_function :PyInt_FromSsize_t, [:ssize_t], PyObjectStruct.by_ref
+    else
+      attach_function :PyInt_FromSsize_t, :PyLong_FromSsize_t, [:ssize_t], PyObjectStruct.by_ref
+    end
+
+    # Float
+
+    attach_function :PyFloat_FromDouble, [:double], PyObjectStruct.by_ref
+    attach_function :PyFloat_AsDouble, [PyObjectStruct.by_ref], :double
+
+    # Complex
+
+    attach_function :PyComplex_RealAsDouble, [PyObjectStruct.by_ref], :double
+    attach_function :PyComplex_ImagAsDouble, [PyObjectStruct.by_ref], :double
+
+    # String
+
+    if string_as_bytes
+      attach_function :PyString_FromStringAndSize, :PyBytes_FromStringAndSize, [:string, :ssize_t], PyObjectStruct.by_ref
+    else
+      attach_function :PyString_FromStringAndSize, [:string, :ssize_t], PyObjectStruct.by_ref
+    end
+
+    # PyString_AsStringAndSize :: (PyPtr, char**, int*) -> int
+    if string_as_bytes
+      attach_function :PyString_AsStringAndSize, :PyBytes_AsStringAndSize, [PyObjectStruct.by_ref, :pointer, :pointer], :int
+    else
+      attach_function :PyString_AsStringAndSize, [PyObjectStruct.by_ref, :pointer, :pointer], :int
+    end
+
+    # Unicode
+
+    # PyUnicode_DecodeUTF8
+    case
+    when libpython.find_symbol('PyUnicode_DecodeUTF8')
+      attach_function :PyUnicode_DecodeUTF8, [:string, :ssize_t, :string], PyObjectStruct.by_ref
+    when libpython.find_symbol('PyUnicodeUCS4_DecodeUTF8')
+      attach_function :PyUnicode_DecodeUTF8, :PyUnicodeUCS4_DecodeUTF8, [:string, :ssize_t, :string], PyObjectStruct.by_ref
+    when libpython.find_symbol('PyUnicodeUCS2_DecodeUTF8')
+      attach_function :PyUnicode_DecodeUTF8, :PyUnicodeUCS2_DecodeUTF8, [:string, :ssize_t, :string], PyObjectStruct.by_ref
+    end
+
+    # PyUnicode_AsUTF8String
+    case
+    when libpython.find_symbol('PyUnicode_AsUTF8String')
+      attach_function :PyUnicode_AsUTF8String, [PyObjectStruct.by_ref], PyObjectStruct.by_ref
+    when libpython.find_symbol('PyUnicodeUCS4_AsUTF8String')
+      attach_function :PyUnicode_AsUTF8String, :PyUnicodeUCS4_AsUTF8String, [PyObjectStruct.by_ref], PyObjectStruct.by_ref
+    when libpython.find_symbol('PyUnicodeUCS2_AsUTF8String')
+      attach_function :PyUnicode_AsUTF8String, :PyUnicodeUCS2_AsUTF8String, [PyObjectStruct.by_ref], PyObjectStruct.by_ref
+    end
+
+    # Tuple
+
+    attach_function :PyTuple_New, [:ssize_t], PyObjectStruct.by_ref
+    attach_function :PyTuple_GetItem, [PyObjectStruct.by_ref, :ssize_t], PyObjectStruct.by_ref
+    attach_function :PyTuple_SetItem, [PyObjectStruct.by_ref, :ssize_t, PyObjectStruct.by_ref], :int
+    attach_function :PyTuple_Size, [PyObjectStruct.by_ref], :ssize_t
+
+    # Slice
+
+    attach_function :PySlice_New, [PyObjectStruct.by_ref, PyObjectStruct.by_ref, PyObjectStruct.by_ref], PyObjectStruct.by_ref
+
+    # List
+
+    attach_function :PyList_New, [:ssize_t], PyObjectStruct.by_ref
+    attach_function :PyList_Size, [PyObjectStruct.by_ref], :ssize_t
+    attach_function :PyList_GetItem, [PyObjectStruct.by_ref, :ssize_t], PyObjectStruct.by_ref
+    attach_function :PyList_SetItem, [PyObjectStruct.by_ref, :ssize_t, PyObjectStruct.by_ref], :int
+    attach_function :PyList_Append, [PyObjectStruct.by_ref, PyObjectStruct.by_ref], :int
+
+    # Sequence
+
+    attach_function :PySequence_Size, [PyObjectStruct.by_ref], :ssize_t
+    attach_function :PySequence_GetItem, [PyObjectStruct.by_ref, :ssize_t], PyObjectStruct.by_ref
+    attach_function :PySequence_Contains, [PyObjectStruct.by_ref, PyObjectStruct.by_ref], :int
+
+    # Dict
+
+    attach_function :PyDict_New, [], PyObjectStruct.by_ref
+    attach_function :PyDict_GetItem, [PyObjectStruct.by_ref, PyObjectStruct.by_ref], PyObjectStruct.by_ref
+    attach_function :PyDict_GetItemString, [PyObjectStruct.by_ref, :string], PyObjectStruct.by_ref
+    attach_function :PyDict_SetItem, [PyObjectStruct.by_ref, PyObjectStruct.by_ref, PyObjectStruct.by_ref], :int
+    attach_function :PyDict_SetItemString, [PyObjectStruct.by_ref, :string, PyObjectStruct.by_ref], :int
+    attach_function :PyDict_DelItem, [PyObjectStruct.by_ref, PyObjectStruct.by_ref], :int
+    attach_function :PyDict_DelItem, [PyObjectStruct.by_ref, :string], :int
+    attach_function :PyDict_Size, [PyObjectStruct.by_ref], :ssize_t
+    attach_function :PyDict_Keys, [PyObjectStruct.by_ref], PyObjectStruct.by_ref
+    attach_function :PyDict_Values, [PyObjectStruct.by_ref], PyObjectStruct.by_ref
+    attach_function :PyDict_Items, [PyObjectStruct.by_ref], PyObjectStruct.by_ref
+    attach_function :PyDict_Contains, [PyObjectStruct.by_ref, PyObjectStruct.by_ref], :int
+
+    # Set
+
+    attach_function :PySet_Size, [PyObjectStruct.by_ref], :ssize_t
+    attach_function :PySet_Contains, [PyObjectStruct.by_ref, PyObjectStruct.by_ref], :int
+    attach_function :PySet_Add, [PyObjectStruct.by_ref, PyObjectStruct.by_ref], :int
+    attach_function :PySet_Discard, [PyObjectStruct.by_ref, PyObjectStruct.by_ref], :int
+
+    # Module
+
+    attach_function :PyModule_GetDict, [PyObjectStruct.by_ref], PyObjectStruct.by_ref
+
+    # Import
+
+    attach_function :PyImport_ImportModule, [:string], PyObjectStruct.by_ref
+
+    # Operators
+
+    attach_function :PyNumber_Add, [PyObjectStruct.by_ref, PyObjectStruct.by_ref], PyObjectStruct.by_ref
+    attach_function :PyNumber_Subtract, [PyObjectStruct.by_ref, PyObjectStruct.by_ref], PyObjectStruct.by_ref
+    attach_function :PyNumber_Multiply, [PyObjectStruct.by_ref, PyObjectStruct.by_ref], PyObjectStruct.by_ref
+    attach_function :PyNumber_TrueDivide, [PyObjectStruct.by_ref, PyObjectStruct.by_ref], PyObjectStruct.by_ref
+    attach_function :PyNumber_Remainder, [PyObjectStruct.by_ref, PyObjectStruct.by_ref], PyObjectStruct.by_ref
+    attach_function :PyNumber_Power, [PyObjectStruct.by_ref, PyObjectStruct.by_ref, PyObjectStruct.by_ref], PyObjectStruct.by_ref
+    attach_function :PyNumber_Lshift, [PyObjectStruct.by_ref, PyObjectStruct.by_ref], PyObjectStruct.by_ref
+    attach_function :PyNumber_Rshift, [PyObjectStruct.by_ref, PyObjectStruct.by_ref], PyObjectStruct.by_ref
+    attach_function :PyNumber_And, [PyObjectStruct.by_ref, PyObjectStruct.by_ref], PyObjectStruct.by_ref
+    attach_function :PyNumber_Xor, [PyObjectStruct.by_ref, PyObjectStruct.by_ref], PyObjectStruct.by_ref
+    attach_function :PyNumber_Or, [PyObjectStruct.by_ref, PyObjectStruct.by_ref], PyObjectStruct.by_ref
+    attach_function :PyNumber_Positive, [PyObjectStruct.by_ref], PyObjectStruct.by_ref
+    attach_function :PyNumber_Negative, [PyObjectStruct.by_ref], PyObjectStruct.by_ref
+    attach_function :PyNumber_Invert, [PyObjectStruct.by_ref], PyObjectStruct.by_ref
+    attach_function :PyObject_Not, [PyObjectStruct.by_ref], :int
+
+    # Compiler
+
+    attach_function :Py_CompileString, [:string, :string, :int], PyObjectStruct.by_ref
+    attach_function :PyEval_EvalCode, [PyObjectStruct.by_ref, PyObjectStruct.by_ref, PyObjectStruct.by_ref], PyObjectStruct.by_ref
+
+    # Error
+
+    attach_function :PyErr_Clear, [], :void
+    attach_function :PyErr_Print, [], :void
+    attach_function :PyErr_Occurred, [], PyObjectStruct.by_ref
+    attach_function :PyErr_Fetch, [:pointer, :pointer, :pointer], :void
+    attach_function :PyErr_NormalizeException, [:pointer, :pointer, :pointer], :void
+
+    public_class_method
+  end
+
+  PYTHON_DESCRIPTION = LibPython.Py_GetVersion().freeze
+  PYTHON_VERSION = PYTHON_DESCRIPTION.split(' ', 2)[0].freeze
+end