rubypython 0.3.1 → 0.3.2

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format d

data/History.markdown

@@ -1,3 +1,8 @@
+## 0.3.2 2011-02-02
+* Major Enhancements
+  * Allow procs and methods to be passed to Ruby.
+  * Allow configuration of the loaded Python library.
+
 ## 0.3.1 2011-01-19
 * Compatability Updates
   * Cleanup of code which finds Python library thanks to Austin Ziegler.

data/License.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2008 Zach Raines
+Copyright (c) 2008-2011 Zach Raines
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -4,29 +4,34 @@ Manifest.txt
 PostInstall.txt
 README.markdown
 Rakefile
+.rspec
+lib/rubypython
 lib/rubypython.rb
 lib/rubypython/blankobject.rb
+lib/rubypython/conversion.rb
+lib/rubypython/core_ext
 lib/rubypython/core_ext/string.rb
-lib/rubypython/pythonerror.rb
+lib/rubypython/legacy.rb
 lib/rubypython/macros.rb
-lib/rubypython/conversion.rb
 lib/rubypython/operators.rb
-lib/rubypython/pyobject.rb
+lib/rubypython/options.rb
 lib/rubypython/pymainclass.rb
+lib/rubypython/pyobject.rb
 lib/rubypython/python.rb
+lib/rubypython/pythonerror.rb
 lib/rubypython/rubypyproxy.rb
 lib/rubypython/version.rb
-lib/rubypython/legacy.rb
+spec/callback_spec.rb
+spec/conversion_spec.rb
+spec/legacy_spec.rb
 spec/pymainclass_spec.rb
 spec/pyobject_spec.rb
 spec/python_helpers
 spec/python_helpers/objects.py
+spec/python_helpers/objects.pyc
 spec/pythonerror_spec.rb
+spec/refcnt_spec.rb
 spec/rubypyclass_spec.rb
 spec/rubypyproxy_spec.rb
 spec/rubypython_spec.rb
-spec/refcnt_spec.rb
-spec/conversion_spec.rb
-spec/legacy_spec.rb
-spec/spec.opts
 spec/spec_helper.rb

data/README.markdown

@@ -1,6 +1,6 @@
 # RubyPython
 
-* [RubyPython](http://raineszm.bitbucket.org/rubypython/)
+* [RubyPython](http://bitbucket.org/raineszm/rubypython/)
 
 ## DESCRIPTION:
 
@@ -17,6 +17,8 @@ provides a means for wrapping and converting Python objects.
 * Can execute arbitrary methods on imported modules and return the result
 * Python objects can be treated as Ruby objects!
 * Python's standard library available to you from within Ruby.
+* Pass Ruby methods and procs as callbacks and call them from within Python code.
+* Specify the python executable to be loaded.
 
 ### Known Problems
 
@@ -75,13 +77,13 @@ The documentation should provide a reasonable description of how to use RubyPyth
 Starting with version 0.3.x there are two modes of operation: normal and
 legacy. These are described in the docs.
 
-The most useful to check out [docs](http://raineszm.bitbucket.org/rubypython/) will be those for RubyPython and RubyPython::RubyPyProxy.
+The most useful to check out [docs](http://rubydoc.info/gems/rubypython/) will be those for RubyPython and RubyPython::RubyPyProxy.
 	
 ## LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2008 Zach Raines
+Copyright (c) 2008-2011 Zach Raines
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,14 +1,16 @@
-require 'spec/rake/spectask'
+require 'rspec/core/rake_task'
 require 'yard'
 
 desc "Run all examples"
-Spec::Rake::SpecTask.new('spec') do |t|
-  t.spec_files = FileList['spec/**/*_spec.rb']
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = '-t ~@slow' unless ENV['filter'] == 'none'
 end
 
 desc "Run all examples with RCov"
-Spec::Rake::SpecTask.new('spec:rcov') do |t|
-  t.spec_files = FileList['spec/**/*.rb']
+RSpec::Core::RakeTask.new('spec:rcov') do |t|
+  t.pattern = 'spec/**/*.rb'
+  t.rspec_opts = '--tag ~slow:true' unless ENV['filter'] == 'none'
   t.rcov = true
   t.rcov_opts = ['--exclude', 'spec']
 end

data/lib/rubypython/conversion.rb

@@ -65,12 +65,26 @@ module RubyPython
       Python.PyString_FromString rSymbol.to_s
     end
 
+    def self.rtopProc(rObj)
+      pyMethodDef = Python::PyMethodDef.new
+      callback = Proc.new do |py_self, py_args|
+        ret = rObj.call(*RubyPyProxy.new(py_args).to_a)
+        PyObject.convert(ret)[0].pointer
+      end
+      pyMethodDef[:ml_name] = FFI::MemoryPointer.from_string "Proc::#{rObj.object_id}"
+      pyMethodDef[:ml_meth] = callback
+      pyMethodDef[:ml_flags] = Python::METH_VARARGS
+      pyMethodDef[:ml_doc] = nil
+
+      Python::PyCFunction_New pyMethodDef, nil
+    end
+
     #If possible converts a ruby type to an equivalent
     #python native type.
     #@param rObj a native ruby type
     #@param [Boolean] is_key whether this object will be used as a key in a
     #  python dict.
-    #@return [FFI::Pointer] a to a C PyObject\*
+    #@return [FFI::Pointer] a pointer to a C PyObject\*
     #@raise [UnsupportedConversion]
     def self.rtopObject(rObj, is_key=false)
       case rObj
@@ -101,6 +115,9 @@ module RubyPython
         rtopSymbol rObj
       when nil
         rtopNone
+      when Proc, Method
+        raise UnsupportedConversion.new("Python to Ruby callbacks not suppported in legacy mode") if RubyPython.legacy_mode
+        rtopProc rObj
       else
         raise UnsupportedConversion.new("Unsupported type for RTOP conversion." )
       end

data/lib/rubypython/legacy.rb

@@ -1,5 +1,30 @@
 require 'rubypython'
 
+#A quick way to activate legacy mode for your project. Requiring 
+#'rubypython/legacy' automatically activates legacy_mode as described 
+#in the documentation for {RubyPython}. If you wish to run your 
+#project in legacy mode you can require 'rubypython/legacy' instead of 
+#'rubypython'
+#
+#@example Default Behavior
+#  irb(main):001:0> require 'rubypython'
+#  => true
+#  irb(main):002:0> RubyPython.start
+#  => true
+#  irb(main):003:0> RubyPython::PyMain.float(42).is_a? RubyPython::RubyPyProxy
+#  => true
+#  irb(main):004:0> RubyPython.stop
+#  => true
+# 
+#@example Legacy Mode
+#  irb(main):001:0> require 'rubypython/legacy'
+#  => true
+#  irb(main):002:0> RubyPython.start
+#  => true
+#  irb(main):003:0> RubyPython::PyMain.float(42).is_a? Float
+#  => true
+#  irb(main):004:0> RubyPython.stop
+#  => true
 module RubyPython::LegacyMode
   class << self
     def setup_legacy

data/lib/rubypython/operators.rb

@@ -107,5 +107,12 @@ module RubyPython
       PyMain.cmp(self, other)
     end
 
+    #For internal use only. Called by {RubyPython} when the 
+    #interpreter is started or stopped so that the neccesary 
+    #preperation or cleanup can be done.
+    def self.update(status)
+      @@operator = nil if status.equal? :stop
+    end
+
   end
 end

data/lib/rubypython/options.rb

@@ -0,0 +1,69 @@
+module RubyPython
+  #A hash for storing RubyPython execution options.
+  @options = {}
+
+  #A list of options which require the Python library to be reloaded.
+  NEED_RELOAD = [
+    :python_exe,
+    :python_lib
+  ]
+
+  class << self
+    #Allows one to set options for RubyPython's execution. Parameters 
+    #may be set either by supplying a hash argument or by supplying 
+    #a block and calling setters on the provided OpenStruct.
+    #@param [Hash] opts a hash of options to set
+    #@option opts [String] :python_exe The python executable for 
+    #  the python version you wish to use. Can be anything in your 
+    #  execution path as well as a local or relative path.
+    #@option opts [String] :python_lib The full path to the python 
+    #  library you wish to load.
+    #@return [Hash] a copy of the new options hash
+    #
+    #@example
+    #  irb(main):001:0> RubyPython.run do
+    #  irb(main):002:1*   RubyPython.import('sys').version.rubify.to_f
+    #  irb(main):003:1> end
+    #  => 2.7
+    #  irb(main):004:0> RubyPython.configure :python_exe => 'python2.6'
+    #  => {:python_exe=>"python2.6"}
+    #  irb(main):005:0> RubyPython.run do
+    #  irb(main):006:1*   RubyPython.import('sys').version.rubify.to_f
+    #  irb(main):007:1> end
+    #  => 2.6
+    #  
+    def configure(opts={})
+      old_values = @options.select { |k,v| NEED_RELOAD.include? k }
+
+      if block_given?
+        ostruct = OpenStruct.new @options
+        yield ostruct
+        @options = Hash[*ostruct.instance_eval do 
+          @table.map do |k, v|
+            [k.to_sym, v]
+          end.flatten
+        end]
+      end
+      @options.merge!(opts)
+
+      @reload = true if NEED_RELOAD.any? { |k| @options[k] != old_values[k] } 
+      options
+    end
+
+    #Returns a copy of the hash currently being used to determine run 
+    #options. This allows the user to determine what options have been 
+    #set. Modification of options should be done via the configure 
+    #method.
+    #@return [Hash] a copy of the current options hash
+    def options
+      @options.dup
+    end
+
+    #Reset the options hash.
+    #@return [void]
+    def clear_options
+      @options.clear
+    end
+
+  end
+end

data/lib/rubypython/pymainclass.rb

@@ -17,13 +17,13 @@ module RubyPython
     attr_writer :main, :builtin
     
     #@return [RubyPyModule] a proxy object wrapping the Python \__main\__
-    #namespace.
+    #  namespace.
     def main 
       @main||=RubyPython.import "__main__"
     end
     
     #@return [RubyPyModule] a proxy object wrapping the Python \__builtin\__
-    #namespace.
+    #  namespace.
     def builtin
       @builtin||=RubyPython.import "__builtin__"
     end
@@ -45,6 +45,17 @@ module RubyPython
                end
       block ? block.call(result) : result
     end
+
+    #For internal use only. Called by {RubyPython} when the 
+    #interpreter is started or stopped so that the neccesary 
+    #preperation or cleanup can be done.
+    def update(status)
+      if status.equal? :stop
+        @main = nil
+        @builtin = nil
+      end
+    end
+
   end
 
   PyMain = PyMainClass.instance

data/lib/rubypython/pyobject.rb

@@ -10,8 +10,6 @@ module RubyPython
   #subclasses.
   class PyObject
 
-    #@private
-    #
     #This class wraps C PyObject\*s so that the Python reference count is
     #automatically decreased when the Ruby object referencing them 
     #goes out of scope.
@@ -33,6 +31,14 @@ module RubyPython
             Python.Py_DecRef pointer 
           end
         end
+
+
+        #For internal use only. Called by {RubyPython} when the 
+        #interpreter is started or stopped so that the neccesary 
+        #preperation or cleanup can be done.
+        def update(status)
+          current_pointers.clear if status.equal? :stop
+        end
       end
 
       self.current_pointers = {}
@@ -123,9 +129,15 @@ module RubyPython
     #Tests whether the wrapped object is a function or a method. This is not the
     #same as {#callable?} as many other Python objects are callable.
     def function_or_method?
-      isFunc = (Macros.PyObject_TypeCheck(@pointer, Python.PyFunction_Type.to_ptr) != 0)
-      isMethod = (Macros.PyObject_TypeCheck(@pointer, Python.PyMethod_Type.to_ptr) != 0)
-      isFunc or isMethod
+      [
+        Python.PyFunction_Type,
+        Python.PyMethod_Type,
+        Python.PyCFunction_Type
+      ].each do |type|
+        return true if Macros.PyObject_TypeCheck(@pointer, type.to_ptr) != 0
+      end
+
+      false
     end
 
     #Is the wrapped object callable?