Struct CodeObject 

pub struct CodeObject<C = ConstantData>
where
    C: Constant,
{

    pub instructions: CodeUnits,
    pub locations: Box<[(SourceLocation, SourceLocation)]>,
    pub flags: CodeFlags,
    pub posonlyarg_count: u32,
    pub arg_count: u32,
    pub kwonlyarg_count: u32,
    pub source_path: <C as Constant>::Name,
    pub first_line_number: Option<OneIndexed>,
    pub max_stackdepth: u32,
    pub obj_name: <C as Constant>::Name,
    pub qualname: <C as Constant>::Name,
    pub constants: Constants<C>,
    pub names: Box<[<C as Constant>::Name]>,
    pub varnames: Box<[<C as Constant>::Name]>,
    pub cellvars: Box<[<C as Constant>::Name]>,
    pub freevars: Box<[<C as Constant>::Name]>,
    pub localspluskinds: Box<[u8]>,
    pub linetable: Box<[u8]>,
    pub exceptiontable: Box<[u8]>,
}

Primary container of a single code object. Each python function has a code object. Also a module has a code object.

Fields

instructions: CodeUnits

locations: Box<[(SourceLocation, SourceLocation)]>

flags: CodeFlags

posonlyarg_count: u32

Number of positional-only arguments

arg_count: u32

kwonlyarg_count: u32

source_path: <C as Constant>::Name

first_line_number: Option<OneIndexed>

max_stackdepth: u32

obj_name: <C as Constant>::Name

Name of the object that created this code object

qualname: <C as Constant>::Name

Qualified name of the object (like CPython’s co_qualname)

constants: Constants<C>

names: Box<[<C as Constant>::Name]>

varnames: Box<[<C as Constant>::Name]>

cellvars: Box<[<C as Constant>::Name]>

freevars: Box<[<C as Constant>::Name]>

localspluskinds: Box<[u8]>

Per-slot kind flags: CO_FAST_LOCAL, CO_FAST_CELL, CO_FAST_FREE, CO_FAST_HIDDEN. Length = nlocalsplus (nlocals + ncells + nfrees).

linetable: Box<[u8]>

Line number table (CPython 3.11+ format)

exceptiontable: Box<[u8]>

Exception handling table

Implementations

impl<C> CodeObject<C>

where C: Constant,

pub fn arg_names(&self) -> Arguments<'_, <C as Constant>::Name>

Get all arguments of the code object like inspect.getargs

pub fn label_targets(&self) -> BTreeSet<Label>

Return the labels targeted by the instructions of this CodeObject

pub fn display_expand_code_objects(&self) -> impl Display

Recursively display this CodeObject

pub fn map_bag<Bag>( self, bag: Bag, ) -> CodeObject<<Bag as ConstantBag>::Constant>

where Bag: ConstantBag,

Map this CodeObject to one that holds a Bag::Constant

pub fn map_clone_bag<Bag>( &self, bag: &Bag, ) -> CodeObject<<Bag as ConstantBag>::Constant>

where Bag: ConstantBag,

Same as map_bag but clones self

Trait Implementations

impl<C> Clone for CodeObject<C>

where C: Clone + Constant, <C as Constant>::Name: Clone,

fn clone(&self) -> CodeObject<C>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C> Debug for CodeObject<C>

where C: Constant,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<C> Display for CodeObject<C>

where C: Constant,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<C> InstrDisplayContext for CodeObject<C>

where C: Constant,

type Constant = C

fn get_constant(&self, consti: ConstIdx) -> &C

fn get_name(&self, i: usize) -> &str

fn get_varname(&self, var_num: VarNum) -> &str

fn get_localsplus_name(&self, var_num: VarNum) -> &str

Get name for a localsplus index (used by DEREF instructions).

impl ToPyObject for CodeObject

fn to_pyobject(self, vm: &VirtualMachine) -> PyObjectRef

impl ToPyObject for CodeObject<Literal>

fn to_pyobject(self, vm: &VirtualMachine) -> PyObjectRef