rubypython 0.3.2 → 0.5.0

data/.autotest

@@ -0,0 +1,3 @@
+require 'rubygems'
+
+# vim: syntax=ruby

data/.gitignore

@@ -0,0 +1,13 @@
+spec/ldap.yml
+.rvmrc
+pkg/
+*.swp
+*.pyc
+html/
+doc/
+publish/
+coverage/
+coverage.info
+.rake_tasks~
+.DS_Store
+website/index.html

data/.hgignore

@@ -0,0 +1,14 @@
+syntax:glob
+*.o
+*.so
+*.bundle
+*.pyc
+*.log
+*~
+doc/*
+ext/*/Makefile
+*.swp
+.yardoc/*
+.DS_Store
+pkg/*
+website/index.html

data/.hgtags

@@ -0,0 +1,7 @@
+910a6e5ac94959fd6d9b04caea995afd354531f6 v0.2.3
+7361975ce7bbbdd284e1d9f84344d4f8df6e9eab v0.2.8
+09e65f05148ae3e1ba5f54156cd7bcf159cfe14f v0.2.9
+7ebd15a009f37aefab52e8e669080eed165320a0 v0.2.10
+fe1fe7136461a92e4012cd7c8f23c8c446d4fbc1 v0.2.11
+746fffb7ee3db61278d592c303939daeb6a17a03 v0.3.1
+e61cfeb18e14c8d0d86e68459bf7957535c4452b v0.3.2

data/.rspec

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

data/Contributors.rdoc

@@ -0,0 +1,9 @@
+== Contributors
+
+RubyPython has a growing list of contributors.
+
+* Zach Raines (raineszm)
+  * The creator of RubyPython.
+* Steeve Morin (steeve)
+* Austin Ziegler (halostatue)
+* Aman Gupta (tmm1)

data/History.rdoc

@@ -0,0 +1,148 @@
+=== 0.5.0 / 2011-03-dd
+* Major Enhancements:
+  * Procs and methods can be passed to Python. [raineszm]
+  * Python to Ruby inheritance: A Ruby class can inherit from a Python class
+    (EXPERIMENTAL). [steeve]
+  * The Python library can now be reloaded (EXPERIMENTAL). There is a good
+    chance of a segfault if this is used with a native extension. [raineszm]
+  * Python functions and methods can be called with a terminal exclamation
+    point to enable keyword argument processing in Python (EXPERIMENTAL). [tmm1]
+* Minor Enhancements:
+  * Improved Python generator support. [steeve]
+  * PythonError now inherits from RuntimeError. [halostatue]
+  * Added a Py_REFCNT macro for debugging reference counting. [tmm1]
+* Changes:
+  * Moved to RSpec2. [halostatue]
+  * Moved Rakefile to hoe; added autotest. [halostatue]
+* Bug Fixes:
+  * Fixed a reference counting bug that could crash the Python VM. [steeve]
+  * Fixed a memory leak/reference counting bug related to method invocation
+    (when turning the argument list into a tuple, PyList_SetItem steals
+    references). Depends on FFI 1.0.7 (or higher) with modifications to
+    aggressively free temporary Python objects created. [tmm1]
+  * Restored Ruby 1.8.7 compatibility where possible. [halostatue]
+  * Fixed FFI loader to be more robust and do more through FFI. [halostatue]
+  * Fixed documentation errors. [halostatue]
+* Project Management:
+  * Rupy has been merged back into RubyPython.
+  * Made the project website on RubyForge generatable from the readme and a
+    template. Adopted the 960 grid system and modern CSS techniques.
+  * Added a contributors document.
+
+=== 0.4.1 / / 2011-01-10
+* Rupy was created as an active fork of Zach Raines's RubyPython and released
+  indepdently.
+* Major Enhancements:
+  * Python/Ruby callbacks [steeve]
+  * Virtualenv support [steeve]
+  * Python-style generators with Ruby (generators only work on Ruby 1.9).
+    [steeve]
+
+=== 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.
+
+=== 0.3.0 / 2010-09-06
+* Major Enhancements
+  * Version 0.3.0 represents an almost complete rewrite of the RubyPython
+    codebase.
+  * A native C extension is no longer required. RubyPython uses the 'ffi' gem.
+  * RubyPython by default now returns proxy instances for all Ruby objects. See
+    the documentation for more information.
+* Compatibility Updates
+  * Version 0.3.0 was created with the goal of being compatible with as many
+    Ruby versions as possible. It should at the very least run on MRI 1.8.6 -
+    1.9.1.
+  * A legacy mode option has been added to provide partial compatibility with
+    version 0.2.x.
+
+=== 0.2.11 / 2010-07-12
+* Bug Fixes
+  * Fixed some issues with building the extension under ruby 1.9. Should now be
+    truly 1.9 compatible.
+
+=== 0.2.10 / 2010-07-08
+* Bug Fixes
+  * Made some changes to how the native extension is configured and build.
+
+=== 0.2.9 / 2009-10-19
+* Minor Enhancements
+  * Updated the C code to make it cleaner, more readable, and more
+    maintainable.
+
+=== 0.2.8 / 2009-10-05
+* Bug Fixes
+  * Some test files were improperly formatted (minor bug fix).
+
+=== 0.2.7 / 2009-3-30
+* Bug Fixes
+  * Fixed some bugs which caused rubypython to be unable to determine python
+    version correctly.
+
+=== 0.2.6 / 2009-3-19
+* Bug Fixes
+  * Further updates to increase compatibility with 1.9.
+
+=== 0.2.5 / 2009-3-18
+* Bug Fixes
+  * Updated to build and run under Ruby 1.9.
+
+=== 0.2.4 / 2008-10-24
+* Major Enhancements
+  * Provided setter methods for object attributes. Python object attributes can
+    now be set from within ruby.
+  * Made wrapper classes a subclass of custom made blank object class to try to
+    avoid name collisions.
+* Bug Fix
+  * Changed part of extconf.rb file that would not work under windows.
+
+=== 0.2.3 / 2008-08-29
+* 2 Major Enhancements
+  * Introduced PyMain object as a singleton wrapper for the Python __main__ and
+    __builtin__ modules.
+  * Introduced block functionality for PyMain object.
+* Compatibility Updates
+  * Changed some declarations in the C code to make RubyPython more compatible
+    with the style conventions of the Ruby C API.
+  * Update how RubyPython locates the Python headers and library.
+* 1 Bug Fix
+  * Fixed an error in ptor.c that might have prevented RubyPython from building
+    correctly on certain systems.
+
+=== 0.2.2 / 2008-08-07
+* Major Enhancements
+  * Wrapped classes and instances should now behave as expected.
+  * Gave RubyPyClasses a "new" method for creating instances.
+  * Callable class can now be called provided that at least one argument is
+    given.
+  * A wrapped object's respond_to? method now has some relation to its actual
+    methods.
+* Bug fixes
+  * Fixed bug with inspect method of RubyPyObject that caused a bus error when
+    inspecting certain objects
+
+=== 0.2.1 / 2008-08-02
+* 1 Bug Fix
+  * Incorrect require fixed
+
+=== 0.2.0 / 2008-08-02
+* 3 major enhancements
+  * RubyPython can now effectively convert or wrap most types from Python.
+  * Errors in the Python interpreter are relayed to Ruby errors.
+  * Less seg faults by mass.
+* Bug Fixes
+  * RubyPython.run did not work correctly. This is fixed now.
+  * Cleanup in RubyPython.stop fixes some issues in RubyPythonBridge.stop
+
+=== 0.1.0 / 2008-08-01
+* A lot of major enhancements
+  * Too many to name. Hey I'm still developing
+
+=== 0.0.1 / 2008-07-30
+* 1 major enhancement:
+  * Initial release

data/{License.txt → License.rdoc}

@@ -1,4 +1,10 @@
-Copyright (c) 2008-2011 Zach Raines
+== License
+
+This software is available under the terms of the MIT license.
+
+* Copyright 2011 Zach Raines, Steeve Morin, Austin Ziegler, and other
+  contributors.
+* Copyright 2008–2010 Zach Raines.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Manifest.txt

@@ -1,34 +1,39 @@
-History.markdown
-License.txt
+.autotest
+.gitignore
+.hgignore
+.hgtags
+.rspec
+Contributors.rdoc
+History.rdoc
+License.rdoc
 Manifest.txt
 PostInstall.txt
-README.markdown
+README.rdoc
 Rakefile
-.rspec
-lib/rubypython
+autotest/discover.rb
 lib/rubypython.rb
 lib/rubypython/blankobject.rb
 lib/rubypython/conversion.rb
-lib/rubypython/core_ext
-lib/rubypython/core_ext/string.rb
 lib/rubypython/legacy.rb
 lib/rubypython/macros.rb
 lib/rubypython/operators.rb
 lib/rubypython/options.rb
+lib/rubypython/pygenerator.rb
 lib/rubypython/pymainclass.rb
 lib/rubypython/pyobject.rb
 lib/rubypython/python.rb
 lib/rubypython/pythonerror.rb
+lib/rubypython/pythonexec.rb
 lib/rubypython/rubypyproxy.rb
-lib/rubypython/version.rb
+lib/rubypython/type.rb
+spec/basic_spec.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/basics.py
 spec/python_helpers/objects.py
-spec/python_helpers/objects.pyc
 spec/pythonerror_spec.rb
 spec/refcnt_spec.rb
 spec/rubypyclass_spec.rb

data/PostInstall.txt

@@ -1,9 +1,16 @@
-A number of things have changed with version 0.3.0. If you are upgrading from a previous version of RubyPython, you should check the docs for instructions on how to get your code working with the new version of RubyPython.
+RubyPython version 0.3 and higher are different than RubyPython through
+version 0.2.x. If you're upgrading from such an earlier version, make sure you
+read the documents for instructions on how your code needs to change to work
+with modern RubyPython.
 
-For more information on RubyPython, see http://raineszm.bitbucket.org/rubypython/index.html
+For more information on RubyPython, see: http://rubypython.rubyforge.org/
 
-If you find a bug, or have any suggestions, email me at: raineszm+rubypython@gmail.com
+If you find a bug, or have any suggestions, please feel free to enter them on
+the tracker:
 
-If you would like to help develop RubyPython, also send me an email.
+  https://bitbucket.org/raineszm/rubypython/issues?status=new&status=open
 
+If you would like to help develop RubyPython, please check out the source on
+Bitbucket:
 
+  https://bitbucket.org/raineszm/rubypython/

data/README.rdoc

@@ -0,0 +1,272 @@
+= rubypython
+
+== Description
+
+RubyPython is a bridge between the Ruby and Python interpreters. It embeds a
+running Python interpreter in the Ruby application's process using FFI and
+provides a means for wrapping, converting, and calling Python objects and
+methods.
+
+RubyPython uses FFI to marshal the data between the Ruby and Python VMs and
+make Python calls. You can:
+
+* Inherit from Python classes.
+* Configure callbacks from Python.
+* Run Python generators (on Ruby 1.9.2 or later).
+
+== Where
+
+* {RubyForge}[http://rubypython.rubyforge.org/]
+* {RubyGems}[http://rubygems.org/gems/rubypython]
+* {Bitbucket}[http://raineszm.bitbucket.org/rubypython/]
+* {GitHub}[https://github.com/halostatue/rubypython]
+
+The RubyPython homepage, project description, and main downloads can be found
+on {RubyForge}[http://rubypython.rubyforge.org/].
+
+Source is kept in sync between
+{Bitbucket}[http://raineszm.bitbucket.org/rubypython/] and
+{GitHub}[https://github.com/halostatue/rubypython], but the Bitbucket
+repository is the canonical repository and where the {issue
+tracker}[https://bitbucket.org/raineszm/rubypython/issues?status=new&status=open]
+resides. We use {Hg-Git}[http://hg-git.github.com/] to keep the two
+repositories in sync.
+
+== Synopsis
+
+RubyPython is fairly easy to start using; there are three phases to its use:
+
+1. Start the Python interpreter (+RubyPython.start+).
+2. Import and use Python code (+RubyPython.import+).
+3. Stop the Python interpreter (+RubyPython.stop+).
+
+There are also two methods, +RubyPython.session+ and +RubyPython.run+ that will
+start before running the code provided in the block and stop it afterwards.
+
+=== Basic Usage
+
+  require "rubypython"
+
+  RubyPython.start # start the Python interpreter
+
+  cPickle = RubyPython.import("cPickle")
+  p cPickle.dumps("Testing RubyPython.").rubify
+
+  RubyPython.stop # stop the Python interpreter
+
+=== Specific Python Version
+
+  require "rubypython"
+
+  RubyPython.start(:python_exe => "python2.7") # Can also be a full path
+
+  cPickle = RubyPython.import("cPickle")
+  p cPickle.dumps("Testing RubyPython.").rubify
+
+  RubyPython.stop # stop the Python interpreter
+
+=== VirtualEnv
+
+  # Easy
+  RubyPython.start_from_virtualenv("/path/to/virtualenv")
+
+  # Or verbose
+  RubyPython.start(:python => "/path/to/virtualenv/bin/python")
+  RubyPython.activate
+
+=== Iterator support
+
+  # Python
+  def readfile():
+    for line in open("/some/file"):
+      yield line
+
+  # Ruby
+  readfile.to_enum.each do |line|
+    puts line
+  end
+
+  # Python
+  def iterate_list():
+    for item in [ 1, 2, 3 ]:
+      yield item
+
+  # Ruby
+  items = []
+  iterate_list.to_enum.each { |item| items << item }
+  puts items == [ 1, 2, 3 ] # => true
+
+=== Python to Ruby callbacks
+
+  # Python
+  def simple_callback(callback, value):
+    return callback(value)
+
+  # Ruby
+  simple_callback(lambda { |v| v * v }, 4) # => 16
+
+  def triple(v)
+    v * 3
+  end
+
+  simple_callback(method(:triple), 4) # => 12
+
+=== Python-style Generators
+
+  # Python
+  def test_generator(callback):
+    for i in callback():
+      print "Got %d" % i
+
+  # Ruby 1.9.2 or later
+  test_generator(RubyPython.generator do
+    (0..10).each { |i| RubyPython.yield i }
+  end)
+
+=== Python named arguments (Experimental)
+
+This format is experimental and may be changed.
+
+  # Python
+  def foo(arg1, arg2):
+    pass
+
+  # Ruby
+  foo!(:arg2 => "bar2", :arg1 => "bar1")
+
+  # with Ruby 1.9
+  foo!(arg2: "bar2", arg1: "bar1")
+
+== Features / Problems
+
+=== Features
+
+* Simple two-way conversion of built-in types between Ruby and Python.
+* Python module import and arbitrary method execution.
+* Python objects can be treated as Ruby objects.
+* Python's standard library available from within Ruby.
+* Pass Ruby methods and procs as callbacks and call them from within Python
+  code.
+* Specify the Python executable to be loaded, including using virtualenv.
+
+==== Experimental Features
+
+* Calling Python methods or functions that expect keyword arguments, or call
+  any Python method or function with named parameters.
+
+    # Python
+    def func(a, b, c):
+      pass
+
+    # Ruby
+    func!(:b => 2, :c => 3, :a => 1) # => [ 1, 2, 3 ]
+
+  While we are committed to keeping this feature in place, we have not yet
+  determined that the form (+method!+) is the best way to achieve this
+  functionality.
+
+  This mechanism is experimental because the use of the bang at the end of the
+  method to indicate the use of keyword arguments may not be the best use of
+  that feature of Ruby naming.
+
+* Changing Python interpreters in a single Ruby program. Under some
+  circumstances, this will partially work. If a native Python extension has
+  been imported (such as +cPickle+), there is a very high likelihood that there
+  will be a segmentation fault because the newly loaded DLL will still refer to
+  the other version's loaded extension. This is not a recommended workflow.
+
+=== Known Problems
+
+* Built-in Python methods requiring a top-level frame object (such as eval(),
+  dir(), and the like) do not work properly at present.
+* There is no support for passing complicated (non-basic) Ruby types to Python.
+
+== What's planned
+There are features that are not currently supported in RubyPython that may be
+considered for future releases, dependent on need, interest, and solutions.
+
+=== Python 3
+We do plan on working this, but as none of the projects any of us are working
+on require Python 3 as of yet, this is not yet started.
+
+=== Simpler Imports
+It might be nice to have some nice import helpers provided by RubyPython to
+make the interface more seamless and provide advanced import features:
+
+==== Import Aliasing
+
+  # Python
+  from mod2.mod1 import sym as mysym
+
+  # Ruby
+  py :from => "mod2.mod1", :import => "sym", :as => "mysym"
+  py :from => "mod2.mod1", :import => :sym, :as => :mysym
+  py :from => [ :mod2, :mod1 ], :import => :sym, :as => :mysym
+
+  # Python
+  import mod1 as mymod
+
+  # Ruby
+  py :import => "mod1", :as => "mymod"
+  py :import => :mod1, :as => :mymod
+
+  # Python
+  from mod2.mod1 import *
+
+  # Ruby
+  py :from => "mod2.mod1", :import => :*
+  pyrequire "mod2/mod1" # ruby style imports
+
+=== Catch Exceptions from Ruby
+
+  # Python
+  class MyFirstException(Exception):
+    pass
+
+  class MySecondException(MyFirstException):
+    pass
+
+  def test():
+    raise MySecondException
+
+  # Ruby
+  begin
+    test
+  rescue MyFirstException => e
+    # We may need to work out name collisions
+    puts e.message
+  end
+
+== Requirements
+
+* Python >= 2.4, < 3.0
+* Ruby >= 1.8.6, or JRuby >= 1.6.0
+* You must either have the ability to build the Ruby
+  {FFI}[https://github.com/ffi/ffi] gem, version 1.0.7 or better in your
+  environment or have a pre-built one that you can install.
+
+=== Python Support
+RubyPython has been tested with the C-based Python interpreter (cpython),
+versions 2.4 through 2.7. Work is planned to enable Python 3 support, but has
+not yet been started. If you're interested in helping us enable Python 3
+support, please let us know.
+
+=== Ruby Support
+* Ruby 1.8.7 and 1.9.2 (MRI)
+* JRuby 1.6.0
+
+It should work with other implementations that support the Ruby FFI gem with no
+modification.
+
+=== OS Support
+RubyPython has been tested on Mac OS 10.5 and 10.6, and Ubuntu 10.10 (64-bit
+Intel). If your platform has a DLL or shared object version of Python and
+supports the FFI gem, it should work. Feedback on other platforms is always
+welcome.
+
+== Install
+  gem install rubypython
+
+:include: Contributors.rdoc
+
+:include: License.rdoc