-
Notifications
You must be signed in to change notification settings - Fork 16
/
encode.go
695 lines (575 loc) · 14.7 KB
/
encode.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
package ogórek
import (
"encoding/binary"
"errors"
"fmt"
"io"
"math"
"math/big"
"reflect"
"strings"
)
const highestProtocol = 5 // highest protocol version we support generating
// unicode is string that always encodes as unicode pickle object.
// (regular string encodes to unicode pickle object only for protocol >= 3 by default)
type unicode string
type TypeError struct {
typ string
}
func (te *TypeError) Error() string {
return fmt.Sprintf("no support for type '%s'", te.typ)
}
// An Encoder encodes Go data structures into pickle byte stream
type Encoder struct {
w io.Writer
config *EncoderConfig
}
// EncoderConfig allows to tune [Encoder].
type EncoderConfig struct {
// Protocol specifies which pickle protocol version should be used.
Protocol int
// PersistentRef, if !nil, will be used by encoder to encode objects as persistent references.
//
// Whenever the encoders sees pointer to a Go struct object, it will call
// PersistentRef to find out how to encode that object. If PersistentRef
// returns nil, the object is encoded regularly. If !nil - the object
// will be encoded as an object reference.
//
// See Ref documentation for more details.
PersistentRef func(obj any) *Ref
// StrictUnicode, when true, requests to always encode Go string
// objects as Python unicode independently of used pickle protocol.
// See StrictUnicode mode documentation in top-level package overview
// for details.
StrictUnicode bool
}
// NewEncoder returns a new [Encoder] with the default configuration.
//
// The encoder will emit pickle stream into w.
func NewEncoder(w io.Writer) *Encoder {
return NewEncoderWithConfig(w, &EncoderConfig{
// allow both Python2 and Python3 to decode what ogórek produces by default
Protocol: 2,
})
}
// NewEncoderWithConfig is similar to [NewEncoder], but returns the encoder with the specified configuration.
//
// config must not be nil.
func NewEncoderWithConfig(w io.Writer, config *EncoderConfig) *Encoder {
return &Encoder{w: w, config: config}
}
// Encode writes the pickle encoding of v to w, the encoder's writer
func (e *Encoder) Encode(v any) error {
proto := e.config.Protocol
if !(0 <= proto && proto <= highestProtocol) {
return fmt.Errorf("pickle: encode: invalid protocol %d", proto)
}
// protocol >= 2 -> emit PROTO <protocol>
if proto >= 2 {
err := e.emit(opProto, byte(proto))
if err != nil {
return err
}
}
rv := reflectValueOf(v)
err := e.encode(rv)
if err != nil {
return err
}
return e.emit(opStop)
}
// emit writes byte vector into encoder output.
func (e *Encoder) emitb(b []byte) error {
_, err := e.w.Write(b)
return err
}
// emits writes string into encoder output.
func (e *Encoder) emits(s string) error {
return e.emitb([]byte(s))
}
// emit writes byte arguments into encoder output.
func (e *Encoder) emit(bv ...byte) error {
return e.emitb(bv)
}
// emitf writes formatted string into encoder output.
func (e *Encoder) emitf(format string, argv ...any) error {
_, err := fmt.Fprintf(e.w, format, argv...)
return err
}
func (e *Encoder) encode(rv reflect.Value) error {
switch rk := rv.Kind(); rk {
case reflect.Bool:
return e.encodeBool(rv.Bool())
case reflect.Int, reflect.Int8, reflect.Int64, reflect.Int32, reflect.Int16:
return e.encodeInt(rv.Int())
case reflect.Uint8, reflect.Uint64, reflect.Uint, reflect.Uint32, reflect.Uint16:
return e.encodeUint(rv.Uint())
case reflect.String:
switch rv.Interface().(type) {
case unicode:
return e.encodeUnicode(rv.String())
case Bytes:
return e.encodeBytes(Bytes(rv.String()))
case ByteString:
return e.encodeByteString(rv.String())
default:
return e.encodeString(rv.String())
}
case reflect.Array, reflect.Slice:
if rv.Type().Elem().Kind() == reflect.Uint8 {
return e.encodeByteArray(rv.Bytes())
} else if t, ok := rv.Interface().(Tuple); ok {
return e.encodeTuple(t)
} else {
return e.encodeArray(rv)
}
case reflect.Map:
return e.encodeMap(rv)
case reflect.Struct:
return e.encodeStruct(rv)
case reflect.Float32, reflect.Float64:
return e.encodeFloat(float64(rv.Float()))
case reflect.Interface:
// recurse until we get a concrete type
// could be optimized into a tail call
return e.encode(rv.Elem())
case reflect.Ptr:
if rv.Elem().Kind() == reflect.Struct {
// check if we have to encode this object as persistent reference.
if getref := e.config.PersistentRef; getref != nil {
ref := getref(rv.Interface())
if ref != nil {
return e.encodeRef(ref)
}
}
switch rv.Elem().Interface().(type) {
case None:
return e.encodeStruct(rv.Elem())
}
}
return e.encode(rv.Elem())
case reflect.Invalid:
return e.emit(opNone)
default:
return &TypeError{typ: rk.String()}
}
return nil
}
func (e *Encoder) encodeTuple(t Tuple) error {
l := len(t)
// protocol >= 2: [1-3]() -> TUPLE{1-3}
if e.config.Protocol >= 2 && (1 <= l && l <= 3) {
for i := range t {
err := e.encode(reflectValueOf(t[i]))
if err != nil {
return err
}
}
var op byte
switch l {
case 1:
op = opTuple1
case 2:
op = opTuple2
case 3:
op = opTuple3
}
return e.emit(op)
}
// protocol >= 1: ø tuple -> EMPTY_TUPLE
if e.config.Protocol >= 1 && l == 0 {
return e.emit(opEmptyTuple)
}
// general case: MARK ... TUPLE
// TODO detect cycles and double references to the same object
err := e.emit(opMark)
if err != nil {
return err
}
for i := 0; i < l; i++ {
err = e.encode(reflectValueOf(t[i]))
if err != nil {
return err
}
}
return e.emit(opTuple)
}
func (e *Encoder) encodeArray(arr reflect.Value) error {
l := arr.Len()
// protocol >= 1: ø list -> EMPTY_LIST
if e.config.Protocol >= 1 && l == 0 {
return e.emit(opEmptyList)
}
// MARK + ... + LIST
// TODO detect cycles and double references to the same object
err := e.emit(opMark)
if err != nil {
return err
}
for i := 0; i < l; i++ {
v := arr.Index(i)
err = e.encode(v)
if err != nil {
return err
}
}
return e.emit(opList)
}
func (e *Encoder) encodeBool(b bool) error {
// protocol >= 2 -> NEWTRUE/NEWFALSE
if e.config.Protocol >= 2 {
op := opNewfalse
if b {
op = opNewtrue
}
return e.emit(op)
}
// INT(01 | 00)
var err error
if b {
err = e.emits(opTrue)
} else {
err = e.emits(opFalse)
}
return err
}
func (e *Encoder) encodeBytes(byt Bytes) error {
l := len(byt)
// protocol >= 3 -> BINBYTES*
if e.config.Protocol >= 3 {
if l < 256 {
err := e.emit(opShortBinbytes, byte(l))
if err != nil {
return err
}
} else {
var b = [1+4]byte{opBinbytes}
binary.LittleEndian.PutUint32(b[1:], uint32(l))
err := e.emitb(b[:])
if err != nil {
return err
}
}
return e.emits(string(byt))
}
// protocol 0..2 -> emit as `_codecs.encode(byt.decode('latin1'), 'latin1')`
// (as python3 does)
rlatin1 := make([]rune, len(byt))
for i := 0; i < l; i++ {
rlatin1[i] = rune(byt[i]) // decode as latin1
}
ulatin1 := unicode(rlatin1) // -> UTF8
return e.encodeCall(&Call{
Callable: Class{Module: "_codecs", Name: "encode"},
Args: Tuple{ulatin1, ByteString("latin1")},
})
}
func (e *Encoder) encodeByteArray(bv []byte) error {
// protocol >= 5 -> BYTEARRAY8
if e.config.Protocol >= 5 {
var b = [1+8]byte{opBytearray8}
binary.LittleEndian.PutUint64(b[1:], uint64(len(bv)))
err := e.emitb(b[:])
if err != nil {
return err
}
return e.emitb(bv)
}
// TODO protocol <= 2: pickle can be shorter if we emit -> bytearray(unicode, encoding)
// instead of bytearray(_codecs.encode(unicode, encoding))
return e.encodeCall(&Call{
Callable: pybuiltin(e.config.Protocol, "bytearray"),
Args: Tuple{Bytes(bv)},
})
}
func (e *Encoder) encodeString(s string) error {
// StrictUnicode || protocol >= 3 -> encode string as unicode object as py3 does
if e.config.StrictUnicode || e.config.Protocol >= 3 {
return e.encodeUnicode(s)
// !StrictUnicode && protocol <= 2 -> encode string as bytestr object as py2 does
} else {
return e.encodeByteString(s)
}
}
func (e *Encoder) encodeByteString(s string) error {
l := len(s)
// protocol >= 1 -> BINSTRING*
if e.config.Protocol >= 1 {
if l < 256 {
err := e.emit(opShortBinstring, byte(l))
if err != nil {
return err
}
} else {
var b = [1+4]byte{opBinstring}
binary.LittleEndian.PutUint32(b[1:], uint32(l))
err := e.emitb(b[:])
if err != nil {
return err
}
}
return e.emits(s)
}
// protocol 0: STRING
// XXX Python uses both ' and " for quoting - we quote with " only.
// XXX -> use https://godoc.org/lab.nexedi.com/kirr/go123/xfmt#AppendQuotePy ?
//
// don't use %q - that will use \u and \U in quoting which python won't
// interpret when decoding string literals.
return e.emitf("%c%s\n", opString, pyquote(s))
}
var errP0UnicodeUTF8Only = errors.New(`protocol 0: unicode: raw-unicode-escape cannot represent invalid UTF-8`)
// encodeUnicode emits UTF-8 encoded string s as unicode pickle object.
func (e *Encoder) encodeUnicode(s string) error {
// protocol >= 1 -> BINUNICODE*
if e.config.Protocol >= 1 {
l := len(s)
// protocol >= 4 -> SHORT_BINUNICODE
if l < 256 && e.config.Protocol >= 4 {
err := e.emit(opShortBinUnicode, byte(l))
if err != nil {
return err
}
} else {
var b = [1+4]byte{opBinunicode}
binary.LittleEndian.PutUint32(b[1:], uint32(l))
err := e.emitb(b[:])
if err != nil {
return err
}
}
return e.emits(s)
}
// protocol 0: UNICODE
uesc, err := pyencodeRawUnicodeEscape(s)
if err != nil {
if err != errPyRawUnicodeEscapeInvalidUTF8 {
panic(err) // errPyRawUnicodeEscapeInvalidUTF8 is the only possible error
}
return errP0UnicodeUTF8Only
}
return e.emitf("%c%s\n", opUnicode, uesc)
}
func (e *Encoder) encodeFloat(f float64) error {
// protocol >= 1: BINFLOAT
if e.config.Protocol >= 1 {
u := math.Float64bits(f)
var b = [1+8]byte{opBinfloat}
binary.BigEndian.PutUint64(b[1:], u)
return e.emitb(b[:])
}
// protocol 0: FLOAT
return e.emitf("%c%g\n", opFloat, f)
}
func (e *Encoder) encodeInt(i int64) error {
// protocol >= 1: BININT*
if e.config.Protocol >= 1 {
switch {
case i >= 0 && i <= math.MaxUint8:
return e.emit(opBinint1, byte(i))
case i >= 0 && i <= math.MaxUint16:
return e.emit(opBinint2, byte(i), byte(i >> 8))
case i >= math.MinInt32 && i <= math.MaxInt32:
var b = [1+4]byte{opBinint}
binary.LittleEndian.PutUint32(b[1:], uint32(i))
return e.emitb(b[:])
}
}
// protocol 0: INT
return e.emitf("%c%d\n", opInt, i)
}
func (e *Encoder) encodeUint(u uint64) error {
if u <= math.MaxInt64 {
return e.encodeInt(int64(u))
}
// u > math.MaxInt64 and cannot be represented as int64
// emit it as text INT
return e.emitf("%c%d\n", opInt, u)
}
func (e *Encoder) encodeLong(b *big.Int) error {
// TODO if e.protocol >= 2 use opLong1 & opLong4
return e.emitf("%c%dL\n", opLong, b)
}
func (e *Encoder) encodeMap(m reflect.Value) error {
keys := m.MapKeys()
l := len(keys)
// protocol >= 1: ø dict -> EMPTY_DICT
if e.config.Protocol >= 1 && l == 0 {
return e.emit(opEmptyDict)
}
// MARK + ... + DICT
// TODO detect cycles and double references to the same object
// XXX sort keys, so the output is stable?
err := e.emit(opMark)
if err != nil {
return err
}
for _, k := range keys {
err = e.encode(k)
if err != nil {
return err
}
v := m.MapIndex(k)
err = e.encode(v)
if err != nil {
return err
}
}
return e.emit(opDict)
}
func (e *Encoder) encodeDict(d Dict) error {
l := d.Len()
// protocol >= 1: ø dict -> EMPTY_DICT
if e.config.Protocol >= 1 && l == 0 {
return e.emit(opEmptyDict)
}
// MARK + ... + DICT
// TODO cycles + sort keys (see encodeMap for details)
err := e.emit(opMark)
if err != nil {
return err
}
d.Iter()(func(k, v any) bool {
err = e.encode(reflectValueOf(k))
if err != nil {
return false
}
err = e.encode(reflectValueOf(v))
if err != nil {
return false
}
return true
})
if err != nil {
return err
}
return e.emit(opDict)
}
func (e *Encoder) encodeCall(v *Call) error {
err := e.encodeClass(&v.Callable)
if err != nil {
return err
}
err = e.encodeTuple(v.Args)
if err != nil {
return err
}
return e.emit(opReduce)
}
var errP0123GlobalStringLineOnly = errors.New(`protocol 0-3: global: module & name must be string without \n`)
func (e *Encoder) encodeClass(v *Class) error {
// PEP 3154: Protocol 4 forbids use of the GLOBAL opcode and replaces
// it with STACK_GLOBAL.
if e.config.Protocol >= 4 {
err := e.encodeString(v.Module)
if err != nil {
return err
}
err = e.encodeString(v.Name)
if err != nil {
return err
}
return e.emit(opStackGlobal)
}
// else use GLOBAL opcode from protocol 0
if strings.Contains(v.Module, "\n") || strings.Contains(v.Name, "\n") {
return errP0123GlobalStringLineOnly
}
return e.emitf("%c%s\n%s\n", opGlobal, v.Module, v.Name)
}
var errP0PersIDStringLineOnly = errors.New(`protocol 0: persistent ID must be string without \n`)
func (e *Encoder) encodeRef(v *Ref) error {
// protocol 0: pid must be string without \n
if e.config.Protocol == 0 {
pids, ok := v.Pid.(string)
if !ok || strings.Contains(pids, "\n") {
return errP0PersIDStringLineOnly
}
return e.emitf("%c%s\n", opPersid, pids)
}
// protocol >= 1: we can use opBinpersid which allows arbitrary object as argument
err := e.encode(reflectValueOf(v.Pid))
if err != nil {
return err
}
return e.emit(opBinpersid)
}
func (e *Encoder) encodeStruct(st reflect.Value) error {
typ := st.Type()
// first test if it's one of our internal python structs
switch v := st.Interface().(type) {
case None:
return e.emit(opNone)
case Call:
return e.encodeCall(&v)
case Class:
return e.encodeClass(&v)
case Ref:
return e.encodeRef(&v)
case big.Int:
return e.encodeLong(&v)
case Dict:
return e.encodeDict(v)
}
structTags := getStructTags(st)
err := e.emit(opMark)
if err != nil {
return err
}
if structTags != nil {
for f, i := range structTags {
err := e.encodeString(f)
if err != nil {
return err
}
err = e.encode(st.Field(i))
if err != nil {
return err
}
}
} else {
l := typ.NumField()
for i := 0; i < l; i++ {
fty := typ.Field(i)
if fty.PkgPath != "" {
continue // skip unexported names
}
err := e.encodeString(fty.Name)
if err != nil {
return err
}
err = e.encode(st.Field(i))
if err != nil {
return err
}
}
}
return e.emit(opDict)
}
func reflectValueOf(v any) reflect.Value {
rv, ok := v.(reflect.Value)
if !ok {
rv = reflect.ValueOf(v)
}
return rv
}
func getStructTags(ptr reflect.Value) map[string]int {
if ptr.Kind() != reflect.Struct {
return nil
}
m := make(map[string]int)
t := ptr.Type()
l := t.NumField()
numTags := 0
for i := 0; i < l; i++ {
field := t.Field(i).Tag.Get("pickle")
if field != "" {
m[field] = i
numTags++
}
}
if numTags == 0 {
return nil
}
return m
}