python-pickle 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea86f43e4b83bacac94635b88e2c9deeb6eb4aaa553f1770e4943554389422fc
-  data.tar.gz: 973327ecbd8f2c1df7d0ac10f37d76628745e00da9317ab655a9f12644fef441
+  metadata.gz: c18d8d36ae1a85dd7dbdbe13bf136de10bd2d30ddaab523bace2042f1ab3c784
+  data.tar.gz: ad04252dfd4cbcb7e8d80b61e92a1d7439ce256ccfda97b9b3a202e8b3225415
 SHA512:
-  metadata.gz: 8b95a73ff2ebfba7c9ca97648df7c7b3b6be14df61e0e6f4943e3e263a5f300696e79d8cf57aacc7bd9d572bcf3c00a5ec88162e1dd8cc627617afe01414499d
-  data.tar.gz: 73a9a106cfa346d3d74835cf9369732f041fdb2faafdb8a030f1e9ec6b58831e8b7c8aee3a05bec687d11d2d4ea9d48a00d4fcf164f0c686eb84c1248b15f056
+  metadata.gz: 4f64f303012885b2acb6b3ee56527a10a109cac5a9b5f938fea2817552b43bbefad6b5d460f299bb5909388b4eeff722d69b2cba9342e1e8a1c460e3c070a08b
+  data.tar.gz: cc598296cf863810512869805f53b17d2a16bffc9bc09afcb8e35e21fcf1d50b53026151bbd28b687820523618e5dc66a52b42e416281d79ab95a0d6fd636d2a

data/ChangeLog.md

@@ -1,5 +1,10 @@
 ### 0.1.0 / 2023-02-18
 
+* Changed {Python::Pickle.dump} to raise a `NotImplementedError` exception.
+* Fixed a typo in the method signature of {Python::Pickle.dump}.
+
+### 0.1.0 / 2023-02-18
+
 * Initial release:
   * Supports deserializing Python Pickle data into Ruby objects.
   * Supports serializing Ruby objects into Python Pickle data.

data/README.md

@@ -20,7 +20,9 @@ format.
 * Supports Pickle protocol 0, protocol 1, protocol 2, protocol 3, protocol 4,
   and protocol 5.
   * Can parse both Python 2 and Python 3 Pickled data.
-* Supports deserializing Python `tuple` and `bytearray` objects.
+* Supports deserializing Python `None`, `True`, `False`, `int`, `str`, `tuple`,
+  `list`, `bytearray`, and other objects.
+* Supports mapping Python extension codes to Ruby classes.
 * Supports mapping Python functions to Ruby methods.
 * Supports mapping Python classes to Ruby classes.
 

data/lib/python/pickle/version.rb

@@ -1,6 +1,6 @@
 module Python
   module Pickle
     # python-pickle version
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

data/lib/python/pickle.rb

@@ -28,7 +28,7 @@ module Python
     # The default protocol version to use.
     #
     # @api public
-    DEFAULT_PROTCOL = 4
+    DEFAULT_PROTOCOL = 4
 
     # The highest protocol version supported.
     #
@@ -88,12 +88,22 @@ module Python
     #   The explicit protocol version to use. If `nil` the protocol version will
     #   be inferred by inspecting the first two bytes of the stream.
     #
+    # @param [Hash{Symbol => Object}] kwargs
+    #   Additional keyword arguments.
+    #
+    # @option kwargs [Hash{Integer => Object}] :extensions
+    #   A Hash of registered extension IDs and their Objects.
+    #
+    # @option kwargs [Hash{String => Hash{String => Class,Method}}] :constants
+    #   An optional mapping of custom Python constant names to Ruby classes
+    #   or methods.
+    #
     # @api public
     #
-    def self.load(data,**kwargs)
+    def self.load(data, protocol: nil, **kwargs)
       deserializer = Deserializer.new(**kwargs)
 
-      parse(data) do |instruction|
+      parse(data, protocol: protocol) do |instruction|
         status, object = deserializer.execute(instruction)
 
         if status == :halt
@@ -110,11 +120,27 @@ module Python
     # @param [String] path
     #   The path of the file.
     #
+    # @param [Hash{Symbol => Object}] kwargs
+    #   Additional keyword arguments.
+    #
+    # @option kwargs [Hash{Integer => Object}] :extensions
+    #   A Hash of registered extension IDs and their Objects.
+    #
+    # @option kwargs [Hash{String => Hash{String => Class,Method}}] :constants
+    #   An optional mapping of custom Python constant names to Ruby classes
+    #   or methods.
+    #
     # @return [Object]
     #   The deserialized object.
     #
     def self.load_file(path,**kwargs)
-      load(File.open(path,'rb'),**kwargs)
+      result = nil
+
+      File.open(path,'rb') do |file|
+        result = load(file,**kwargs)
+      end
+
+      return result
     end
 
     #
@@ -129,12 +155,12 @@ module Python
     # @param [Integer] protocol
     #   The desired Python Pickle protocol to use.
     #
+    # @note serializing is currently not supported.
+    #
     # @api public
     #
     def self.dump(object,output=nil, protocol: DEFAULT_PROTOCOL)
-      if (protocol < 0) || (protocol > HIGHEST_PROTOCOL)
-        raise(ArgumentError,"protocol must be between 0 or #{HIGHEST_PROTOCOL}, but was #{protocol.inspect}")
-      end
+      raise(NotImplementedError,"pickle serializing is currently not supported")
     end
 
     #

data/spec/deserializer_spec.rb

@@ -2,6 +2,11 @@ require 'spec_helper'
 require 'python/pickle/deserializer'
 
 describe Python::Pickle::Deserializer do
+  module TestDeserializer
+    class MyClass
+    end
+  end
+
   describe "#initialize" do
     it "must initialize #meta_stack to an empty Array" do
       expect(subject.meta_stack).to eq([])
@@ -44,9 +49,55 @@ describe Python::Pickle::Deserializer do
     end
 
     context "when initialized with the `extensions:` keyword argument" do
+      let(:extensions) do
+        {
+          0x41 => Object.new,
+          0x42 => Object.new,
+          0x43 => Object.new
+        }
+      end
+
+      subject { described_class.new(extensions: extensions) }
+
+      it "must add the extensions: values to #extensions" do
+        expect(subject.extensions).to eq(extensions)
+      end
     end
 
     context "when initialized with the `constants:` keyword argument" do
+      let(:constants) do
+        {
+          '__main__' => {
+            'MyClass' => TestDeserializer::MyClass
+          }
+        }
+      end
+
+      subject { described_class.new(constants: constants) }
+
+      it "must merge the constants: keyword argument with the default constants" do
+        expect(subject.constants).to eq(
+          {
+            'copy_reg' => {
+              '_reconstructor' => subject.method(:copyreg_reconstructor)
+            },
+
+            '__builtin__' => {
+              'object'    => described_class::OBJECT_CLASS,
+              'bytearray' => Python::Pickle::ByteArray
+            },
+
+            'builtins' => {
+              'object'    => described_class::OBJECT_CLASS,
+              'bytearray' => Python::Pickle::ByteArray
+            },
+
+            '__main__' => {
+              'MyClass' => TestDeserializer::MyClass
+            }
+          }
+        )
+      end
     end
   end
 

data/spec/pickle_spec.rb

@@ -52,6 +52,33 @@ describe Python::Pickle do
     it "must deserialize the Python Pickle data in the given file" do
       expect(subject.load(data)).to eq({"foo" => "bar"})
     end
+
+    context "when the constants: keyword argument is given" do
+      let(:path) { File.join(fixtures_dir,'object_v4.pkl') }
+
+      module TestLoad
+        class MyClass
+          attr_reader :x, :y
+
+          def __setstate__(attributes)
+            @x = attributes['x']
+            @y = attributes['y']
+          end
+        end
+      end
+
+      let(:constants) do
+        {
+          '__main__' => {
+            'MyClass' => TestLoad::MyClass
+          }
+        }
+      end
+
+      it "must map the Python classes to the Ruby classes" do
+        expect(subject.load(data, constants: constants)).to be_kind_of(TestLoad::MyClass)
+      end
+    end
   end
 
   describe ".load_file" do
@@ -60,9 +87,43 @@ describe Python::Pickle do
     it "must deserialize the Python Pickle data in the given file" do
       expect(subject.load_file(path)).to eq({"foo" => "bar"})
     end
+
+    context "when the constants: keyword argument is given" do
+      let(:path) { File.join(fixtures_dir,'object_v4.pkl') }
+
+      module TestLoad
+        class MyClass
+          attr_reader :x, :y
+
+          def __setstate__(attributes)
+            @x = attributes['x']
+            @y = attributes['y']
+          end
+        end
+      end
+
+      let(:constants) do
+        {
+          '__main__' => {
+            'MyClass' => TestLoad::MyClass
+          }
+        }
+      end
+
+      it "must map the Python classes to the Ruby classes" do
+        expect(subject.load_file(path, constants: constants)).to be_kind_of(TestLoad::MyClass)
+      end
+    end
   end
 
   describe ".dump" do
+    let(:object) { Object.new }
+
+    it do
+      expect {
+        subject.dump(object)
+      }.to raise_error(NotImplementedError,"pickle serializing is currently not supported")
+    end
   end
 
   describe ".infer_protocol_version" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: python-pickle
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Postmodern