pycall_thread 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04ac373bef738633cd5d2746983182a216f6a5174a9b927709c5d133234d0a6c
-  data.tar.gz: 11e50545784a6d10755c489e1f95b2b23bcd9965356c3881a2dce7109d3bd6f2
+  metadata.gz: 5f06a9a4d8b09d14190d2001b9463bdd9101df77ced43e4cf898247718d69b1a
+  data.tar.gz: 0e0121315ee956037688ad7016621dc3f667c4ec99e05f7541a3a74b4ea61b2c
 SHA512:
-  metadata.gz: b67602e6888e458a64cd2874a540d9e7bba78cd8ff38e7642c2c1b1ef74da2e854890f6ce0cb139b0ad4b84c0c28d84b6209dcd4ad8a15a8027dbd6d1651084b
-  data.tar.gz: d8d8955f9b99a51cc8f3a80c81c39604945a3beafc4930dfa38f715144d7ca207aab778fc95ffcfa000bf6447224bce143463cbfd033481567cb86e477ad8a4a
+  metadata.gz: 168d6a9aa3c30ece2692ee3bb92502dbabd766097c3e2a90849f3d7d61384806b1e658cb8008c34714a2617c83ca416c395da55c44d2da4d62318d30062385a8
+  data.tar.gz: fc32925321e4ea1812ecde6416ef6d90130bbc6254a72beaeb265710ed18fc6f44fd1ebc0bf9fcdf7b7eb8d01829ab126cb2f0676c72b86039dda5e0c4c39683

data/.rubocop.yml

@@ -10,4 +10,7 @@ Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
 
 Layout/LineLength:
-  Max: 120
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false

data/Gemfile

@@ -9,11 +9,7 @@ gem "rake", "~> 13.0"
 gem "minitest", "~> 5.0"
 gem "rubocop", "~> 1.21"
 
-
-# Include Puma for testing examples:
-gem 'puma', '~> 6.4.1'
-
-# To use the local path, you must also run things with:
+# To use the local pycall, you must also run things with e.g.:
 # bundle exec ruby -I/Users/seth/src/pycall.rb/ext/pycall
 # 
 # gem 'pycall', path: '/Users/seth/src/pycall.rb', require: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pycall_thread (0.1.0)
+    pycall_thread (0.1.2)
       pycall
 
 GEM
@@ -11,13 +11,10 @@ GEM
     json (2.7.2)
     language_server-protocol (3.17.0.3)
     minitest (5.24.1)
-    nio4r (2.7.3)
     parallel (1.26.0)
     parser (3.3.4.2)
       ast (~> 2.4.1)
       racc
-    puma (6.4.2)
-      nio4r (~> 2.0)
     pycall (1.5.2)
     racc (1.8.1)
     rainbow (3.1.1)
@@ -47,7 +44,6 @@ PLATFORMS
 
 DEPENDENCIES
   minitest (~> 5.0)
-  puma (~> 6.4.1)
   pycall_thread!
   rake (~> 13.0)
   rubocop (~> 1.21)

data/examples/puma/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem "puma", "~> 6.4.2"
+gem "pycall_thread", "~> 0.1.2"

data/examples/puma/Gemfile.lock

@@ -0,0 +1,19 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    nio4r (2.7.3)
+    puma (6.4.2)
+      nio4r (~> 2.0)
+    pycall (1.5.2)
+    pycall_thread (0.1.0)
+      pycall
+
+PLATFORMS
+  arm64-darwin-23
+
+DEPENDENCIES
+  puma
+  pycall_thread
+
+BUNDLED WITH
+   2.2.33

data/examples/puma/README.md

@@ -0,0 +1,10 @@
+# PyCallThread Puma Example
+
+```
+bundle install
+bundle exec ./start_puma.sh
+```
+
+Open: [http://localhost:9292](http://localhost:9292)
+
+All the interesting code is in [app.rb](./app.rb)

data/examples/puma/app.rb

@@ -1,25 +1,26 @@
-require_relative '../../lib/pycall_thread/pycall_thread'
+require "pycall_thread"
 
 PyCallThread.init do
   # Setup our local venv (using pdm, in .venv)
-  ENV['PYTHON'] = `pdm run which python`.strip
+  ENV["PYTHON"] = `pdm run which python`.strip
   site_dir = `pdm run python -c 'import site; print(site.getsitepackages()[0])'`.strip
 
-  require 'pycall'
+  require "pycall"
 
   # This is to setup our local venv
-  site = PyCall.import_module('site')
+  site = PyCall.import_module("site")
   site.addsitedir(site_dir)
 end
 
+# Simple Puma App that demonstrates PyCallThread
 class App
-  def call(env)
+  def call(_)
     winequality = PyCallThread.run do
-      pandas = PyCall.import_module('pandas')
-      data = pandas.read_csv('https://archive.ics.uci.edu/ml/machine-learning-databases/wine-quality/winequality-red.csv', sep: ';')
-      data.to_html()
+      pandas = PyCall.import_module("pandas")
+      data = pandas.read_csv("https://archive.ics.uci.edu/ml/machine-learning-databases/wine-quality/winequality-red.csv", sep: ";")
+      data.to_html
     end
 
-    [200, { 'Content-Type' => 'text/html' }, [winequality]]
+    [200, { "Content-Type" => "text/html" }, [winequality]]
   end
-end
+end

data/lib/pycall_thread/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PycallThread
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/pycall_thread.rb

@@ -1,30 +1,40 @@
+# Provides a way to run PyCall code from multiple threads, see
+# PyCallThread.init and PyCallThread.run for more information.
 module PyCallThread
   @queue = Queue.new
 
-  VALID_UNSAFE_RETURN_VALUES = [:allow, :error, :warn]
+  VALID_UNSAFE_RETURN_VALUES = %i[allow error warn].freeze
 
   def self.init(unsafe_return: :error, &require_pycall_block)
-    # Only safe to use PyCallThread if PyCall hasn't already been loaded
-    raise "PyCall::LibPython already exists: PyCall can't have been initialized already" if defined?(PyCall::LibPython)
+    raise ArgumentError, "Invalid value for unsafe_return: #{unsafe_return}. Must be one of: #{VALID_UNSAFE_RETURN_VALUES.join(", ")}" unless VALID_UNSAFE_RETURN_VALUES.include?(unsafe_return)
 
-    @initialized = true
+    @unsafe_return = unsafe_return
 
-    if VALID_UNSAFE_RETURN_VALUES.include?(unsafe_return)
-      @unsafe_return = unsafe_return
-    else
-      raise ArgumentError, "Invalid value for unsafe_return: #{unsafe_return}. Must be one of: #{VALID_UNSAFE_RETURN_VALUES.join(', ')}"
-    end
-    
     # Start the thread we will use to run code invoked with PyCallThread.run
+    @py_thread = Thread.new { pycall_thread_loop }
+
     # If we've been passed a require_pycall_block, use that to require 'pycall'
     # instead of doing it directly.
-    @py_thread = Thread.new { pycall_thread_loop(&require_pycall_block) }
+    require_pycall(&require_pycall_block)
 
-    at_exit do
-      stop_pycall_thread
-    end
+    at_exit { stop_pycall_thread }
 
-    nil
+    @initialized = true
+  end
+
+  def self.require_pycall(&require_pycall_block)
+    # Only safe to use PyCallThread if PyCall hasn't already been loaded
+    raise "PyCall::LibPython already exists: PyCall can't have been initialized already" if defined?(PyCall::LibPython)
+
+    run do
+      # require 'pycall' or run a user-defined block that should do the same
+      if require_pycall_block
+        require_pycall_block.call
+      else
+        require "pycall"
+      end
+      nil
+    end
   end
 
   # Runs &block on the PyCall thread, and returns the result
@@ -32,16 +42,18 @@ module PyCallThread
     init unless @initialized
 
     result_queue = Queue.new
-    @queue << -> do
+    @queue << lambda {
       begin
         result_queue << { retval: block.call }
-      rescue => e
+      rescue StandardError => e
         result_queue << { exception: e }
       end
-    end
+    }
 
-    result = result_queue.pop
+    run_result(result_queue.pop)
+  end
 
+  def self.run_result
     if result[:exception]
       raise result[:exception]
     elsif python_object?(result[:retval])
@@ -62,21 +74,15 @@ module PyCallThread
     @py_thread.join
   end
 
-  def self.pycall_thread_loop(&require_pycall_block)
+  def self.pycall_thread_loop
     Thread.current.name = "pycall"
 
-    # require 'pycall' or run a user-defined block that should do the same
-    if require_pycall_block
-      require_pycall_block.call
-    else
-      require 'pycall'
-    end
-
     loop do
       block = @queue.pop
       break if block == :stop
+
       block.call
-    rescue => e
+    rescue StandardError => e
       puts "pycall_thread_loop(): exception in pycall_thread_loop #{e}"
       puts e.backtrace.join("\n")
     end
@@ -93,7 +99,7 @@ module PyCallThread
       PyCall::PyModuleWrapper,
       PyCall::PyObjectWrapper,
       PyCall::PyTypeObjectWrapper,
-      PyCall::PyPtr,
+      PyCall::PyPtr
     ].any? { |kind| obj.is_a?(kind) }
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pycall_thread
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Seth Nickell
@@ -41,6 +41,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/puma/Gemfile
+- examples/puma/Gemfile.lock
+- examples/puma/README.md
 - examples/puma/app.rb
 - examples/puma/config.ru
 - examples/puma/start_puma.sh