Package Exports
- pickleparser
- pickleparser/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (pickleparser) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Pickle Parser
A pure Javascript implemented parser for Python pickle format
Features
- Pure Typescript implemented.
- Fullly supports Pickle protocol version 4 opcodes.
- Supports Browser.
- Supports Node.js.
- Provides tool to convert pickle file to JSON.
Supported Protocol Version
- Pickle protocol version 0
- Pickle protocol version 1
- Pickle protocol version 2 (Python 2.3)
- Pickle protocol version 3 (Python 3.0)
- Pickle protocol version 4 (Python 3.4)
For more details, See: Supported Opcodes
Installation
$ npm install pickleparserUsage
Node.js
import fs from 'node:fs/promises';
import path from 'node:path';
import { Parser } from '../';
async function unpickle(fname) {
const pkl = await fs.readFile(path.join(fname), 'binary');
const buffer = Buffer.from(pkl, 'binary');
const parser = new Parser(buffer);
const obj = parser.load();
console.log(obj);
// =>
// MyClass {
// data: 'test',
// set: [ false, 1, 2, 3, 'abc', null, 4294967295, 9007199254740991 ],
// fruits: [ 'apple', 'banana', 'cherry', 'orange' ]
// }
}
unpickle('index.pkl');Browser
const fileSelector = document.getElementById('file_selector');
const jsonResultPreviewer = document.getElementById('json_result_previewer');
fileSelector.addEventListener('change', function (e) {
const file = fileSelector.files[0];
const reader = new FileReader();
reader.onload = function (event) {
const buffer = new Uint8Array(event.target.result);
const parser = new pickleparser.Parser(buffer);
const obj = parser.load();
const json = JSON.stringify(obj, null, 4);
jsonResultPreviewer.innerText = json;
}
reader.readAsArrayBuffer(file);
});Terminal
npx pickleparser file.pkl file.json
# or
npm i pickleparser -g
pickletojson file.pkl file.jsonLicense
MIT