python-pickle 0.1.1 → 0.2.0

data/lib/python/pickle/protocol1.rb

@@ -33,22 +33,96 @@ module Python
     #
     class Protocol1 < Protocol0
 
-      # Opcodes for Pickle protocol version 1.
-      #
-      # @see https://github.com/python/cpython/blob/main/Lib/pickletools.py
-      OPCODES = Protocol0::OPCODES + Set[
-        41,  # EMPTY_TUPLE
-        71,  # BINFLOAT
-        75,  # BININT1
-        84,  # BINSTRING
-        85,  # SHORT_BINSTRING
-        88,  # BINUNICODE
-        93,  # EMPTY_LIST
-        101, # APPENDS
-        113, # BINPUT
-        117, # SETITEMS
-        125  # EMPTY_DICT
-      ]
+      # The `EMPTY_TUPLE` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L140
+      EMPTY_TUPLE = 41
+
+      # The `BINFLOAT` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L142
+      BINFLOAT = 71
+
+      # The `BININT1` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L110
+      BININT1 = 75
+
+      # The `BINSTRING` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L118
+      BINSTRING = 84
+
+      # The `SHORT_BINSTRING` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L119
+      SHORT_BINSTRING = 85
+
+      # The `BINUNICODE` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L121
+      BINUNICODE = 88
+
+      # The `EMPTY_LIST` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L133
+      EMPTY_LIST = 93
+
+      # The `APPENDS` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L127
+      APPENDS = 101
+
+      # The `BINGET` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L138
+      BINGET = 104
+
+      # The `LONG_BINGET` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L140
+      LONG_BINGET = 106
+
+      # The `BINPUT` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L145
+      BINPUT = 113
+
+      # The `SETITEMS` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L141
+      SETITEMS = 117
+
+      # The `EMPTY_DICT` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L126
+      EMPTY_DICT = 125
 
       #
       # Reads an instruction from the pickle stream.
@@ -64,86 +138,47 @@ module Python
         #
         # Protocol 0 instructions
         #
-        when 40 # MARK
-          Instructions::MARK
-        when 46 # STOP
-          Instructions::STOP
-        when 48 # POP
-          Instructions::POP
-        when 49 # POP_MARK
-          Instructions::POP_MARK
-        when 50 # DUP
-          Instructions::DUP
-        when 70 # FLOAT
-          Instructions::Float.new(read_float)
-        when 73 # INT
-          Instructions::Int.new(read_int)
-        when 76 # LONG
-          Instructions::Long.new(read_long)
-        when 78 # NONE
-          Instructions::NONE
-        when 82 # REDUCE
-          Instructions::REDUCE
-        when 83 # STRING
-          Instructions::String.new(read_string)
-        when 86 # UNICODE
-          Instructions::String.new(read_unicode_string)
-        when 97 # APPEND
-          Instructions::APPEND
-        when 98 # BUILD
-          Instructions::BUILD
-        when 99 # GLOBAL
-          Instructions::Global.new(read_nl_string,read_nl_string)
-        when 100 # DICT
-          Instructions::DICT
-        when 103 # GET
-          Instructions::Get.new(read_int)
-        when 108 # LIST
-          Instructions::LIST
-        when 112 # PUT
-          Instructions::Put.new(read_int)
-        when 115 # SETITEM
-          Instructions::SETITEM
-        when 116 # TUPLE
-          Instructions::TUPLE
+        when MARK      then Instructions::MARK
+        when STOP      then Instructions::STOP
+        when POP       then Instructions::POP
+        when POP_MARK  then Instructions::POP_MARK
+        when DUP       then Instructions::DUP
+        when FLOAT     then read_float_instruction
+        when INT       then read_int_instruction
+        when LONG      then read_long_instruction
+        when NONE      then Instructions::NONE
+        when REDUCE    then Instructions::REDUCE
+        when STRING    then read_string_instruction
+        when UNICODE   then read_unicode_instruction
+        when APPEND    then Instructions::APPEND
+        when BUILD     then Instructions::BUILD
+        when GLOBAL    then read_global_instruction
+        when DICT      then Instructions::DICT
+        when GET       then read_get_instruction
+        when LIST      then Instructions::LIST
+        when PUT       then read_put_instruction
+        when SETITEM   then Instructions::SETITEM
+        when TUPLE     then Instructions::TUPLE
+        when INST      then read_inst_instruction
+        when OBJ       then Instructions::OBJ
+        when PERSID    then read_persid_instruction
+        when BINPERSID then Instructions::BINPERSID
         #
         # Protocol 1 instructions
         #
-        when 41  # EMPTY_TUPLE
-          Instructions::EMPTY_TUPLE
-        when 71  # BINFLOAT
-          Instructions::BinFloat.new(read_float64_be)
-        when 75  # BININT1
-          Instructions::BinInt1.new(read_uint8)
-        when 84  # BINSTRING
-          length = read_uint32_le
-          string = @io.read(length)
-
-          Instructions::BinString.new(length,string)
-        when 85  # SHORT_BINSTRING
-          length = read_uint8
-          string = @io.read(length)
-
-          Instructions::ShortBinString.new(length,string)
-        when 88  # BINUNICODE
-          length = read_uint32_le
-          string = @io.read(length).force_encoding(Encoding::UTF_8)
-
-          Instructions::BinUnicode.new(length,string)
-        when 93  # EMPTY_LIST
-          Instructions::EMPTY_LIST
-        when 101 # APPENDS
-          Instructions::APPENDS
-        when 104 # BINGET
-          Instructions::BinGet.new(read_uint8)
-        when 106 # LONG_BINGET
-          Instructions::LongBinGet.new(read_uint32_le)
-        when 113 # BINPUT
-          Instructions::BinPut.new(read_uint8)
-        when 117 # SETITEMS
-          Instructions::SETITEMS
-        when 125 # EMPTY_DICT
-          Instructions::EMPTY_DICT
+        when EMPTY_TUPLE     then Instructions::EMPTY_TUPLE
+        when BINFLOAT        then read_binfloat_instruction
+        when BININT1         then read_binint1_instruction
+        when BINSTRING       then read_binstring_instruction
+        when SHORT_BINSTRING then read_short_binstring_instruction
+        when BINUNICODE      then read_binunicode_instruction
+        when EMPTY_LIST      then Instructions::EMPTY_LIST
+        when APPENDS         then Instructions::APPENDS
+        when BINGET          then read_binget_instruction
+        when LONG_BINGET     then read_long_binget_instruction
+        when BINPUT          then read_binput_instruction
+        when SETITEMS        then Instructions::SETITEMS
+        when EMPTY_DICT      then Instructions::EMPTY_DICT
         else
           raise(InvalidFormat,"invalid opcode (#{opcode.inspect}) for protocol 1")
         end
@@ -178,6 +213,103 @@ module Python
         @io.read(4).unpack1('L<')
       end
 
+      #
+      # Reads a `BINFLOAT` instruction.
+      #
+      # @return [Instructions::BinFloat]
+      #
+      # @since 0.2.0
+      #
+      def read_binfloat_instruction
+        Instructions::BinFloat.new(read_float64_be)
+      end
+
+      #
+      # Reads a `BININT1` instruction.
+      #
+      # @return [Instructions::BinInt1]
+      #
+      # @since 0.2.0
+      #
+      def read_binint1_instruction
+        Instructions::BinInt1.new(read_uint8)
+      end
+
+      #
+      # Reads a `BINSTRING` instruction.
+      #
+      # @return [Instructions::BinString]
+      #
+      # @since 0.2.0
+      #
+      def read_binstring_instruction
+        length = read_uint32_le
+        string = @io.read(length)
+
+        Instructions::BinString.new(length,string)
+      end
+
+      #
+      # Reads a `SHORT_BINSTRING` instruction.
+      #
+      # @return [Instructions::ShortBinString]
+      #
+      # @since 0.2.0
+      #
+      def read_short_binstring_instruction
+        length = read_uint8
+        string = @io.read(length)
+
+        Instructions::ShortBinString.new(length,string)
+      end
+
+      #
+      # Reads a `BINUNICODE` instruction.
+      #
+      # @return [Instructions::BinUnicode]
+      #
+      # @since 0.2.0
+      #
+      def read_binunicode_instruction
+        length = read_uint32_le
+        string = @io.read(length).force_encoding(Encoding::UTF_8)
+
+        Instructions::BinUnicode.new(length,string)
+      end
+
+      #
+      # Reads a `BINGET` instruction.
+      #
+      # @return [Instructions::BinGet]
+      #
+      # @since 0.2.0
+      #
+      def read_binget_instruction
+        Instructions::BinGet.new(read_uint8)
+      end
+
+      #
+      # Reads a `LONG_BINGET` instruction.
+      #
+      # @return [Instructions::LongBinGet]
+      #
+      # @since 0.2.0
+      #
+      def read_long_binget_instruction
+        Instructions::LongBinGet.new(read_uint32_le)
+      end
+
+      #
+      # Reads a `BINPUT` instruction.
+      #
+      # @return [Instructions::BinPut]
+      #
+      # @since 0.2.0
+      #
+      def read_binput_instruction
+        Instructions::BinPut.new(read_uint8)
+      end
+
     end
   end
 end

data/lib/python/pickle/protocol2.rb

@@ -16,23 +16,89 @@ module Python
   module Pickle
     class Protocol2 < Protocol1
 
-      # Opcodes for Pickle protocol version 2.
-      #
-      # @see https://github.com/python/cpython/blob/main/Lib/pickletools.py
-      OPCODES = Protocol1::OPCODES + Set[
-        128, # PROTO
-        129, # NEWOBJ
-        130, # EXT1
-        131, # EXT2
-        132, # EXT4
-        133, # TUPLE1
-        134, # TUPLE2
-        135, # TUPLE3
-        136, # NEWTRUE
-        137, # NEWFALSE
-        138, # LONG1
-        139  # LONG4
-      ]
+      # The `PROTO` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L149
+      PROTO = 128
+
+      # The `NEWOBJ` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L150
+      NEWOBJ = 129
+
+      # The `EXT1` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L151
+      EXT1 = 130
+
+      # The `EXT2` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L152
+      EXT2 = 131
+
+      # The `EXT4` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L153
+      EXT4 = 132
+
+      # The `TUPLE1` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L154
+      TUPLE1 = 133
+
+      # The `TUPLE2` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L155
+      TUPLE2 = 134
+
+      # The `TUPLE3` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L156
+      TUPLE3 = 135
+
+      # The `NEWTRUE` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L157
+      NEWTRUE = 136
+
+      # The `NEWFALSE` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L158
+      NEWFALSE = 137
+
+      # The `LONG1` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L159
+      LONG1 = 138
+
+      # The `LONG4` opcode.
+      #
+      # @since 0.2.0
+      #
+      # @see https://github.com/python/cpython/blob/v2.7/Lib/pickle.py#L160
+      LONG4 = 139
 
       #
       # Reads an instruction from the pickle stream.
@@ -48,119 +114,62 @@ module Python
         #
         # Protocol 0 instructions
         #
-        when 40 # MARK
-          Instructions::MARK
-        when 46 # STOP
-          Instructions::STOP
-        when 48 # POP
-          Instructions::POP
-        when 49 # POP_MARK
-          Instructions::POP_MARK
-        when 50 # DUP
-          Instructions::DUP
-        when 70 # FLOAT
-          Instructions::Float.new(read_float)
-        when 73 # INT
-          Instructions::Int.new(read_int)
-        when 76 # LONG
-          Instructions::Long.new(read_long)
-        when 78 # NONE
-          Instructions::NONE
-        when 82 # REDUCE
-          Instructions::REDUCE
-        when 83 # STRING
-          Instructions::String.new(read_string)
-        when 86 # UNICODE
-          Instructions::String.new(read_unicode_string)
-        when 97 # APPEND
-          Instructions::APPEND
-        when 98 # BUILD
-          Instructions::BUILD
-        when 99 # GLOBAL
-          Instructions::Global.new(read_nl_string,read_nl_string)
-        when 100 # DICT
-          Instructions::DICT
-        when 103 # GET
-          Instructions::Get.new(read_int)
-        when 108 # LIST
-          Instructions::LIST
-        when 112 # PUT
-          Instructions::Put.new(read_int)
-        when 115 # SETITEM
-          Instructions::SETITEM
-        when 116 # TUPLE
-          Instructions::TUPLE
+        when MARK      then Instructions::MARK
+        when STOP      then Instructions::STOP
+        when POP       then Instructions::POP
+        when POP_MARK  then Instructions::POP_MARK
+        when DUP       then Instructions::DUP
+        when FLOAT     then read_float_instruction
+        when INT       then read_int_instruction
+        when LONG      then read_long_instruction
+        when NONE      then Instructions::NONE
+        when REDUCE    then Instructions::REDUCE
+        when STRING    then read_string_instruction
+        when UNICODE   then read_unicode_instruction
+        when APPEND    then Instructions::APPEND
+        when BUILD     then Instructions::BUILD
+        when GLOBAL    then read_global_instruction
+        when DICT      then Instructions::DICT
+        when GET       then read_get_instruction
+        when LIST      then Instructions::LIST
+        when PUT       then read_put_instruction
+        when SETITEM   then Instructions::SETITEM
+        when TUPLE     then Instructions::TUPLE
+        when INST      then read_inst_instruction
+        when OBJ       then Instructions::OBJ
+        when PERSID    then read_persid_instruction
+        when BINPERSID then Instructions::BINPERSID
         #
         # Protocol 1 instructions
         #
-        when 41  # EMPTY_TUPLE
-          Instructions::EMPTY_TUPLE
-        when 71  # BINFLOAT
-          Instructions::BinFloat.new(read_float64_be)
-        when 75  # BININT1
-          Instructions::BinInt1.new(read_uint8)
-        when 84  # BINSTRING
-          length = read_uint32_le
-          string = @io.read(length)
-
-          Instructions::BinString.new(length,string)
-        when 85  # SHORT_BINSTRING
-          length = read_uint8
-          string = @io.read(length)
-
-          Instructions::ShortBinString.new(length,string)
-        when 88  # BINUNICODE
-          length = read_uint32_le
-          string = @io.read(length).force_encoding(Encoding::UTF_8)
-
-          Instructions::BinUnicode.new(length,string)
-        when 93  # EMPTY_LIST
-          Instructions::EMPTY_LIST
-        when 101 # APPENDS
-          Instructions::APPENDS
-        when 104 # BINGET
-          Instructions::BinGet.new(read_uint8)
-        when 106 # LONG_BINGET
-          Instructions::LongBinGet.new(read_uint32_le)
-        when 113 # BINPUT
-          Instructions::BinPut.new(read_uint8)
-        when 117 # SETITEMS
-          Instructions::SETITEMS
-        when 125 # EMPTY_DICT
-          Instructions::EMPTY_DICT
+        when EMPTY_TUPLE     then Instructions::EMPTY_TUPLE
+        when BINFLOAT        then read_binfloat_instruction
+        when BININT1         then read_binint1_instruction
+        when BINSTRING       then read_binstring_instruction
+        when SHORT_BINSTRING then read_short_binstring_instruction
+        when BINUNICODE      then read_binunicode_instruction
+        when EMPTY_LIST      then Instructions::EMPTY_LIST
+        when APPENDS         then Instructions::APPENDS
+        when BINGET          then read_binget_instruction
+        when LONG_BINGET     then read_long_binget_instruction
+        when BINPUT          then read_binput_instruction
+        when SETITEMS        then Instructions::SETITEMS
+        when EMPTY_DICT      then Instructions::EMPTY_DICT
         #
         # Protocol 2 instructions
         #
-        when 128 # PROT
-          Instructions::Proto.new(read_uint8)
-        when 129 # NEWOBJ
-          Instructions::NEWOBJ
-        when 130 # EXT1
-          Instructions::Ext1.new(read_uint8)
-        when 131 # EXT2
-          Instructions::Ext2.new(read_uint16_le)
-        when 132 # EXT4
-          Instructions::Ext4.new(read_uint32_le)
-        when 133 # TUPLE1
-          Instructions::TUPLE1
-        when 134 # TUPLE2
-          Instructions::TUPLE2
-        when 135 # TUPLE3
-          Instructions::TUPLE3
-        when 136 # NEWTRUE
-          Instructions::NEWTRUE
-        when 137 # NEWFALSE
-          Instructions::NEWFALSE
-        when 138 # LONG1
-          length = read_uint8
-          long   = read_int_le(length)
-
-          Instructions::Long1.new(length,long)
-        when 139 # LONG4
-          length = read_uint32_le
-          long   = read_int_le(length)
-
-          Instructions::Long4.new(length,long)
+        when PROTO    then read_proto_instruction
+        when NEWOBJ   then Instructions::NEWOBJ
+        when EXT1     then read_ext1_instruction
+        when EXT2     then read_ext2_instruction
+        when EXT4     then read_ext4_instruction
+        when TUPLE1   then Instructions::TUPLE1
+        when TUPLE2   then Instructions::TUPLE2
+        when TUPLE3   then Instructions::TUPLE3
+        when NEWTRUE  then Instructions::NEWTRUE
+        when NEWFALSE then Instructions::NEWFALSE
+        when LONG1    then read_long1_instruction
+        when LONG4    then read_long4_instruction
         else
           raise(InvalidFormat,"invalid opcode (#{opcode.inspect}) for protocol 2")
         end
@@ -224,6 +233,78 @@ module Python
         return long
       end
 
+      #
+      # Reads a `PROTO` instruction.
+      #
+      # @return [Instructions::Proto]
+      #
+      # @since 0.2.0
+      #
+      def read_proto_instruction
+        Instructions::Proto.new(read_uint8)
+      end
+
+      #
+      # Reads a `EXT1` instruction.
+      #
+      # @return [Instructions::Ext1]
+      #
+      # @since 0.2.0
+      #
+      def read_ext1_instruction
+        Instructions::Ext1.new(read_uint8)
+      end
+
+      #
+      # Reads a `EXT2` instruction.
+      #
+      # @return [Instructions::Ext2]
+      #
+      # @since 0.2.0
+      #
+      def read_ext2_instruction
+        Instructions::Ext2.new(read_uint16_le)
+      end
+
+      #
+      # Reads a `EXT4` instruction.
+      #
+      # @return [Instructions::Ext4]
+      #
+      # @since 0.2.0
+      #
+      def read_ext4_instruction
+        Instructions::Ext4.new(read_uint32_le)
+      end
+
+      #
+      # Reads a `LONG1` instruction.
+      #
+      # @return [Instructions::Long1]
+      #
+      # @since 0.2.0
+      #
+      def read_long1_instruction
+        length = read_uint8
+        long   = read_int_le(length)
+
+        Instructions::Long1.new(length,long)
+      end
+
+      #
+      # Reads a `LONG4` instruction.
+      #
+      # @return [Instructions::Long4]
+      #
+      # @since 0.2.0
+      #
+      def read_long4_instruction
+        length = read_uint32_le
+        long   = read_int_le(length)
+
+        Instructions::Long4.new(length,long)
+      end
+
     end
   end
 end