python_marshal 0.4.7

A Rust library for reading and writing Python marshal files.
Documentation 
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

use crate::{extract_object, extract_strings_tuple, resolve_object_ref, CodeFlags, Error, Object};

/// Represents a Python code object for Python 3.10.
#[rustfmt::skip]
#[derive(Clone, Debug, PartialEq)]
pub struct Code310 {
    pub argcount:        u32,
    pub posonlyargcount: u32,
    pub kwonlyargcount:  u32,
    pub nlocals:         u32,
    pub stacksize:       u32,
    pub flags:           CodeFlags,
    pub code:            Box<Object>, // Needs to contain Vec<u8> as a value or a reference
    pub consts:          Box<Object>, // Needs to contain Vec<Object> as a value or a reference
    pub names:           Box<Object>, // Needs to contain Vec<PyString> as a value or a reference
    pub varnames:        Box<Object>, // Needs to contain Vec<PyString> as a value or a reference
    pub freevars:        Box<Object>, // Needs to contain Vec<PyString> as a value or a reference
    pub cellvars:        Box<Object>, // Needs to contain Vec<PyString> as a value or a reference
    pub filename:        Box<Object>, // Needs to contain PyString as a value or a reference
    pub name:            Box<Object>, // Needs to contain PyString as a value or a reference
    pub firstlineno:     u32,
    pub linetable:          Box<Object>, // Needs to contain Vec<u8>, as a value or a reference
}

impl Code310 {
    pub fn new(
        argcount: u32,
        posonlyargcount: u32,
        kwonlyargcount: u32,
        nlocals: u32,
        stacksize: u32,
        flags: CodeFlags,
        code: Box<Object>,
        consts: Box<Object>,
        names: Box<Object>,
        varnames: Box<Object>,
        freevars: Box<Object>,
        cellvars: Box<Object>,
        filename: Box<Object>,
        name: Box<Object>,
        firstlineno: u32,
        linetable: Box<Object>,
        references: &[Object],
    ) -> Result<Self, Error> {
        // Ensure all corresponding values are of the correct type
        extract_object!(Some(resolve_object_ref!(Some((*code).clone()), references)?), Object::Bytes(bytes) => bytes, Error::NullInTuple)?;
        extract_object!(Some(resolve_object_ref!(Some((*consts).clone()), references)?), Object::Tuple(objs) => objs, Error::NullInTuple)?;
        extract_strings_tuple!(
            extract_object!(Some(resolve_object_ref!(Some((*names).clone()), references)?), Object::Tuple(objs) => objs, Error::NullInTuple)?,
            references
        )?;
        extract_strings_tuple!(
            extract_object!(Some(resolve_object_ref!(Some((*varnames).clone()), references)?), Object::Tuple(objs) => objs, Error::NullInTuple)?,
            references
        )?;
        extract_strings_tuple!(
            extract_object!(Some(resolve_object_ref!(Some((*freevars).clone()), references)?), Object::Tuple(objs) => objs, Error::NullInTuple)?,
            references
        )?;
        extract_strings_tuple!(
            extract_object!(Some(resolve_object_ref!(Some((*cellvars).clone()), references)?), Object::Tuple(objs) => objs, Error::NullInTuple)?,
            references
        )?;

        extract_object!(Some(resolve_object_ref!(Some((*filename).clone()), references)?), Object::String(string) => string, Error::UnexpectedObject)?;
        extract_object!(Some(resolve_object_ref!(Some((*name).clone()), references)?), Object::String(string) => string, Error::UnexpectedObject)?;
        extract_object!(Some(resolve_object_ref!(Some((*linetable).clone()), references)?), Object::Bytes(bytes) => bytes, Error::NullInTuple)?;

        Ok(Self {
            argcount,
            posonlyargcount,
            kwonlyargcount,
            nlocals,
            stacksize,
            flags,
            code,
            consts,
            names,
            varnames,
            freevars,
            cellvars,
            filename,
            name,
            firstlineno,
            linetable,
        })
    }
}

// Macro to generate Code31x structs for Python 3.11, 3.12, 3.13 (they share the same structure)
macro_rules! define_code31x {
    ($($ver:ident),+) => {
        $(
            #[rustfmt::skip]
            #[derive(Clone, Debug, PartialEq)]
            pub struct $ver {
                pub argcount:        u32,
                pub posonlyargcount: u32,
                pub kwonlyargcount:  u32,
                pub stacksize:       u32,
                pub flags:           CodeFlags,
                pub code:            Box<Object>,
                pub consts:          Box<Object>,
                pub names:           Box<Object>,
                pub localsplusnames: Box<Object>,
                pub localspluskinds: Box<Object>,
                pub filename:        Box<Object>,
                pub name:            Box<Object>,
                pub qualname:        Box<Object>,
                pub firstlineno:     u32,
                pub linetable:       Box<Object>,
                pub exceptiontable:  Box<Object>,
            }

            impl $ver {
                #[allow(clippy::too_many_arguments)]
                pub fn new(
                    argcount: u32,
                    posonlyargcount: u32,
                    kwonlyargcount: u32,
                    stacksize: u32,
                    flags: CodeFlags,
                    code: Box<Object>,
                    consts: Box<Object>,
                    names: Box<Object>,
                    localsplusnames: Box<Object>,
                    localspluskinds: Box<Object>,
                    filename: Box<Object>,
                    name: Box<Object>,
                    qualname: Box<Object>,
                    firstlineno: u32,
                    linetable: Box<Object>,
                    exceptiontable: Box<Object>,
                    references: &[Object],
                ) -> Result<Self, Error> {
                    extract_object!(Some(resolve_object_ref!(Some((*code).clone()), references)?), Object::Bytes(bytes) => bytes, Error::NullInTuple)?;
                    extract_object!(Some(resolve_object_ref!(Some((*consts).clone()), references)?), Object::Tuple(objs) => objs, Error::NullInTuple)?;
                    extract_strings_tuple!(
                        extract_object!(Some(resolve_object_ref!(Some((*names).clone()), references)?), Object::Tuple(objs) => objs, Error::NullInTuple)?,
                        references
                    )?;
                    extract_strings_tuple!(
                        extract_object!(Some(resolve_object_ref!(Some((*localsplusnames).clone()), references)?), Object::Tuple(objs) => objs, Error::NullInTuple)?,
                        references
                    )?;
                    extract_object!(Some(resolve_object_ref!(Some((*localspluskinds).clone()), references)?), Object::Bytes(bytes) => bytes, Error::NullInTuple)?;
                    extract_object!(Some(resolve_object_ref!(Some((*filename).clone()), references)?), Object::String(string) => string, Error::UnexpectedObject)?;
                    extract_object!(Some(resolve_object_ref!(Some((*name).clone()), references)?), Object::String(string) => string, Error::UnexpectedObject)?;
                    extract_object!(Some(resolve_object_ref!(Some((*qualname).clone()), references)?), Object::String(string) => string, Error::UnexpectedObject)?;
                    extract_object!(Some(resolve_object_ref!(Some((*linetable).clone()), references)?), Object::Bytes(bytes) => bytes, Error::NullInTuple)?;
                    extract_object!(Some(resolve_object_ref!(Some((*exceptiontable).clone()), references)?), Object::Bytes(bytes) => bytes, Error::NullInTuple)?;

                    Ok(Self {
                        argcount,
                        posonlyargcount,
                        kwonlyargcount,
                        stacksize,
                        flags,
                        code,
                        consts,
                        names,
                        localsplusnames,
                        localspluskinds,
                        filename,
                        name,
                        qualname,
                        firstlineno,
                        linetable,
                        exceptiontable,
                    })
                }
            }
        )+
    };
}

define_code31x!(Code311, Code312, Code313);