Source

rubypython / lib / rubypython / pythonerror.rb

require 'rubypython/python'
require 'rubypython/macros'

# Raised when an error occurs in the \Python interpreter.
class RubyPython::PythonError < RuntimeError
  # The \Python traceback object associated with this error. This will be
  # a RubyPython::RubyPyProxy object.
  attr_reader :traceback

  # Creates the PythonError.
  # [typeName] The class name of the \Python error.
  # [msg] The message attached to the \Python error.
  # [traceback] The traceback, if any, associated with the \Python error.
  def initialize(typeName, msg, traceback = nil)
    @type = typeName
    @traceback = traceback
    super([typeName, msg].join(': '))
  end

  # This method should be called when an error has occurred in the \Python
  # interpreter. This acts as factory function for PythonError objects. The
  # function fetches calls +#fetch+ to get the error information from the
  # \Python interpreter and uses this to build a PythonError object. It then
  # calls +#clear to clear the error flag in the python interpreter. After
  # the error flag has been cleared, the PythonError object is returned.
  def self.handle_error
    rbType, rbValue, rbTraceback = fetch()

    if not rbValue.null?
      msg = rbValue.getAttr("__str__").callObject RubyPython::PyObject.buildArgTuple
      msg = msg.rubify
    else
      msg = nil
    end

    if not rbTraceback.null?
      traceback = RubyPython::RubyPyProxy.new rbTraceback
    else
      traceback = nil
    end

    # Decrease the reference count. This will happen anyway when they go out
    # of scope but might as well.
    rbValue.xDecref
    pyName = rbType.getAttr("__name__")

    rbType.xDecref
    rbName = pyName.rubify
    pyName.xDecref

    RubyPython::PythonError.clear
    RubyPython::PythonError.new(rbName, msg, traceback)
  end

  # A wrapper to the \Python C API +PyErr_Fetch+ function. Returns an array
  # with three PyObject instances, representing the Type, the Value, and the
  # stack trace of the Python error.
  def self.fetch
    typePointer = FFI::MemoryPointer.new :pointer
    valuePointer = FFI::MemoryPointer.new :pointer
    tracebackPointer = FFI::MemoryPointer.new :pointer

    RubyPython::Python.PyErr_Fetch typePointer, valuePointer, tracebackPointer

    rbType = RubyPython::PyObject.new typePointer.read_pointer
    rbValue = RubyPython::PyObject.new valuePointer.read_pointer
    rbTraceback = RubyPython::PyObject.new tracebackPointer.read_pointer
    [rbType, rbValue, rbTraceback]
  end

  # Determines whether an error has occurred in the \Python interpreter.
  def self.error?
    !RubyPython::Python.PyErr_Occurred.null?
  end

  # Resets the \Python interpreter error flag
  def self.clear
    RubyPython::Python.PyErr_Clear
  end
end