Modifier and Type	Class and Description
pack-priv static interface	PyCode.Layout Interface on a store of information about the variables required by a code object and where they will be stored in the frame it creates.
pack-priv static enum	PyCode.Trait Characteristics of a `PyCode` (as CPython co_flags).
pack-priv static enum	PyCode.VariableTrait Traits characterising local variables of the frame this code object will produce.

Field Summary

Modifier and Type	Field and Description
pack-priv final int	argcount Number of positional parameters (not counting `*args`).
public static final int	CO_ASYNC_GENERATOR The code object is an asynchronous generator function.
public static final int	CO_COROUTINE The code is for a coroutine function (defined with `async def`).
public static final int	CO_GENERATOR The code is for a generator function, i.e. a generator object is returned when the code object is executed..
public static final int	CO_ITERABLE_COROUTINE The flag is used to transform generators into generator-based coroutines.
public static final int	CO_NESTED The code is for a nested function.
public static final int	CO_NEWLOCALS A new `dict` should be created for local variables.
public static final int	CO_OPTIMIZED The code uses fast local local variables, not a map.
public static final int	CO_VARARGS The function has a collector for excess positional arguments
private static final int	CO_VARARGS_SHIFT
public static final int	CO_VARKEYWORDS The function has a collector for excess keyword arguments
private static final int	CO_VARKEYWORDS_SHIFT
pack-priv final Object[]	consts Constant objects needed by the code.
protected static final String[]	EMPTY_STRING_ARRAY Empty (zero-length) array of `String`.
pack-priv final String	filename Source file from which compiled.
pack-priv final int	firstlineno First source line number of this code.
pack-priv final int	flags `int` bitmap of code traits compatible with CPython.
pack-priv final int	kwonlyargcount Number of keyword-only parameters.
pack-priv final String	name Name of function etc.
private static final String	NAME_TUPLES_STRING
pack-priv final String[]	names Names referenced in the code.
pack-priv final int	posonlyargcount Number of positional-only parameters.
pack-priv final String	qualname Fully qualified name of function etc.
pack-priv final EnumSet<PyCode.Trait>	traits Characteristics of this `PyCode` (as CPython co_flags).
public static final PyType	TYPE The Python type `code`.

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	PyCode(String `co_filename` filename, String `co_name` name, String `co_qualname` qualname, int `co_flags` a bitmap of traits flags, int `co_firstlineno` firstlineno, Object[] `co_consts` consts, String[] `co_names` names, int `co_argcount` the number of positional parameters (including positional-only arguments and arguments with default values) argcount, int `co_posonlyargcount` the number of positional-only arguments (including arguments with default values) posonlyargcount, int `co_kwonlyargcount` the number of keyword-only arguments (including arguments with default values) kwonlyargcount) Full constructor.

public

PyCode(String

co_filename

filename, String

co_name

name, String

co_qualname

qualname, int

co_flags a bitmap of traits

flags, int

co_firstlineno

firstlineno, Object[]

co_consts

consts, String[]

co_names

names, int

co_argcount the number of positional parameters (including positional-only arguments and arguments with default values)

argcount, int

co_posonlyargcount the number of positional-only arguments (including arguments with default values)

posonlyargcount, int

co_kwonlyargcount the number of keyword-only arguments (including arguments with default values)

kwonlyargcount)

Full constructor.

Method Summary

Modifier and Type	Method and Description
private Object	__repr__()
private Object	__str__()
protected static PyBytes	Returns: `v` castBytes(Object to check is a Python `bytes` v, String name of argument (for message only) arg)
protected static String	Returns: `v` castString(Object to check and cast/convert v, String the name of the argument (for error production) argName) Cast a Python `str` to a Java String or raise a `TypeError` mentioning an argument name.
protected static PyTuple	Returns: `v` castTuple(Object to check is a Python `tuple` v, String name of argument (for message only) arg)
pack-priv PyTuple	Returns: `co_cellvars` as a `tuple` co_cellvars() Get `co_cellvars` as a `tuple`.
pack-priv PyBytes	co_code()
pack-priv PyTuple	Returns: `consts` as a `tuple` co_consts() Get `consts` as a `tuple`.
pack-priv PyTuple	Returns: `co_freevars` as a `tuple` co_freevars() Get `co_freevars` as a `tuple`.
pack-priv PyBytes	co_lnotab()
pack-priv PyTuple	Returns: `names` as a `tuple` co_names() Get `names` as a `tuple`.
pack-priv int	co_stacksize()
pack-priv PyTuple	Returns: `co_varnames` as a `tuple` co_varnames() Get `co_varnames` as a `tuple`.
pack-priv abstract PyFunction<? extends PyCode>	Returns: the function from this code createFunction(Interpreter providing the module context interpreter, PyDict name space to treat as global variables globals, Object[] default positional argument values or `null` defaults, PyDict default keyword argument values or `null` kwdefaults, Object type annotations (`dict`, `null` or maybe `tuple`) annotations, PyCell[] variables referenced but not defined here, must be size expected by code or `null` if empty. closure) Create a `PyFunction` that will execute this `PyCode`.
pack-priv PyFunction<? extends PyCode>	Returns: the function createFunction(Interpreter providing the module context interpreter, PyDict name space to treat as global variables globals) Create a `PyFunction` that will execute this `PyCode` (adequate for module-level code).
public PyType	getType() Implements org.python.core.CraftedPyObject.getType. The Python `type` of this object.
pack-priv abstract PyCode.Layout	Returns: a `Layout` object describing the variables layout() Describe the layout of the frame local variables (at least the arguments), cell and free variables.
protected static String[]	Returns: the names as `String[]` names(Object of names v, String the name of the argument (for error production) tupleName) Check that all the argument is a tuple and that all objects in it are `str`, and return them as an array of `String`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
pack-priv int	Returns: total space in frame for arguments totalargs() Return the total space in a frame of a code object, that must be reserved for arguments.
pack-priv static int	Returns: total space in frame for arguments totalargs(int argument count excluding collector parameters. argcount, int bit map of code traits flags) From the values of `co_argcount` and `co_flags` (in practice, as they are de-marshalled), compute the total space in a frame of a code object, that must be reserved for arguments.
private static EnumSet<PyCode.Trait>	traitsFrom(int flags) Convert a CPython-style `flags` specifier to `traits`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

argcount	back to summary
pack-priv final int argcount Number of positional parameters (not counting `*args`). Annotations @Member:co_argcount

CO_ASYNC_GENERATOR	back to summary
public static final int CO_ASYNC_GENERATOR The code object is an asynchronous generator function. When the code object is executed it returns an asynchronous generator object. See PEP 525 for more details.

CO_COROUTINE	back to summary
public static final int CO_COROUTINE The code is for a coroutine function (defined with `async def`). When the code object is executed it returns a coroutine object.

CO_GENERATOR	back to summary
public static final int CO_GENERATOR The code is for a generator function, i.e. a generator object is returned when the code object is executed..

CO_ITERABLE_COROUTINE	back to summary
public static final int CO_ITERABLE_COROUTINE The flag is used to transform generators into generator-based coroutines. Generator objects with this flag can be used in `await` expression, and can `yield from` coroutine objects. See PEP 492 for more details.

CO_NESTED	back to summary
public static final int CO_NESTED The code is for a nested function.

CO_NEWLOCALS	back to summary
public static final int CO_NEWLOCALS A new `dict` should be created for local variables.

CO_OPTIMIZED	back to summary
public static final int CO_OPTIMIZED The code uses fast local local variables, not a map.

CO_VARARGS	back to summary
public static final int CO_VARARGS The function has a collector for excess positional arguments

CO_VARARGS_SHIFT	back to summary
private static final int CO_VARARGS_SHIFT

CO_VARKEYWORDS	back to summary
public static final int CO_VARKEYWORDS The function has a collector for excess keyword arguments

CO_VARKEYWORDS_SHIFT	back to summary
private static final int CO_VARKEYWORDS_SHIFT

consts	back to summary
pack-priv final Object[] consts Constant objects needed by the code. Not `null`.

EMPTY_STRING_ARRAY	back to summary
protected static final String[] EMPTY_STRING_ARRAY Empty (zero-length) array of `String`.

filename	back to summary
pack-priv final String filename Source file from which compiled. Annotations @Member:co_filename

firstlineno	back to summary
pack-priv final int firstlineno First source line number of this code.

flags	back to summary
pack-priv final int flags `int` bitmap of code traits compatible with CPython.

kwonlyargcount	back to summary
pack-priv final int kwonlyargcount Number of keyword-only parameters. Annotations @Member:co_kwonlyargcount

name	back to summary
pack-priv final String name Name of function etc. Annotations @Member:co_name

NAME_TUPLES_STRING	back to summary
private static final String NAME_TUPLES_STRING

names	back to summary
pack-priv final String[] names Names referenced in the code. Not `null`.

posonlyargcount	back to summary
pack-priv final int posonlyargcount Number of positional-only parameters. Annotations @Member:co_posonlyargcount

qualname	back to summary
pack-priv final String qualname Fully qualified name of function etc. Annotations @Member:co_qualname

traits	back to summary
pack-priv final EnumSet<PyCode.Trait> traits Characteristics of this `PyCode` (as CPython co_flags).

TYPE	back to summary
public static final PyType TYPE The Python type `code`.

Constructor Detail

PyCode back to summary

PyCode	back to summary
public PyCode(String filename, String name, String qualname, int flags, int firstlineno, Object[] consts, String[] names, int argcount, int posonlyargcount, int kwonlyargcount) Full constructor. The `traits` of the code are supplied here as CPython reports them: as a bit array in an integer, but the constructor makes a conversion, and it is the `traits` which should be used at the Java level. Where the parameters map directly to an attribute of the code object, that is the best way to explain them. Note that this factory method is tuned to the needs of `marshal.read` where the serialised form makes no secret of the version-specific implementation details. Parameters filename:String `co_filename` name:String `co_name` qualname:String `co_qualname` flags:int `co_flags` a bitmap of traits firstlineno:int `co_firstlineno` consts:Object[] `co_consts` names:String[] `co_names` argcount:int `co_argcount` the number of positional parameters (including positional-only arguments and arguments with default values) posonlyargcount:int `co_posonlyargcount` the number of positional-only arguments (including arguments with default values) kwonlyargcount:int `co_kwonlyargcount` the number of keyword-only arguments (including arguments with default values)

public PyCode(String filename, String name, String qualname, int flags, int firstlineno, Object[] consts, String[] names, int argcount, int posonlyargcount, int kwonlyargcount)

Full constructor. The traits of the code are supplied here as CPython reports them: as a bit array in an integer, but the constructor makes a conversion, and it is the traits which should be used at the Java level.

Where the parameters map directly to an attribute of the code object, that is the best way to explain them. Note that this factory method is tuned to the needs of marshal.read where the serialised form makes no secret of the version-specific implementation details.

Parameters

filename:String: co_filename
name:String: co_name
qualname:String: co_qualname
flags:int: co_flags a bitmap of traits
firstlineno:int: co_firstlineno
consts:Object[]: co_consts
names:String[]: co_names
argcount:int: co_argcount the number of positional parameters (including positional-only arguments and arguments with default values)
posonlyargcount:int: co_posonlyargcount the number of positional-only arguments (including arguments with default values)
kwonlyargcount:int: co_kwonlyargcount the number of keyword-only arguments (including arguments with default values)

Method Detail

__repr__	back to summary
private Object __repr__() Annotations @SuppressWarnings:unused

__str__	back to summary
private Object __str__() Annotations @SuppressWarnings:unused

castBytes	back to summary
protected static PyBytes castBytes(Object v, String arg) throws TypeError Parameters v:Object to check is a Python `bytes` arg:String name of argument (for message only) Returns:PyBytes `v` Exceptions TypeError: if `v` cannot be cast to `bytes`

castString back to summary

castString	back to summary
protected static String castString(Object v, String argName) Cast a Python `str` to a Java String or raise a `TypeError` mentioning an argument name. Parameters v:Object to check and cast/convert argName:String the name of the argument (for error production) Returns:String `v`

protected static String castString(Object v, String argName)

Cast a Python str to a Java String or raise a TypeError mentioning an argument name.

Parameters

v:Object: to check and cast/convert
argName:String: the name of the argument (for error production)

Returns:String

v

castTuple	back to summary
protected static PyTuple castTuple(Object v, String arg) Parameters v:Object to check is a Python `tuple` arg:String name of argument (for message only) Returns:PyTuple `v` Exceptions TypeError: if `v` cannot be cast to `tuple`

co_cellvars back to summary

co_cellvars	back to summary
pack-priv PyTuple co_cellvars() Get `co_cellvars` as a `tuple`. Returns:PyTuple `co_cellvars` as a `tuple` Annotations @Getter

pack-priv PyTuple co_cellvars()

Get co_cellvars as a tuple.

Returns:PyTuple

co_cellvars as a tuple

Annotations

@Getter

co_code	back to summary
pack-priv PyBytes co_code() Annotations @SuppressWarnings:static-method @Getter

co_consts back to summary

co_consts	back to summary
pack-priv PyTuple co_consts() Get `consts` as a `tuple`. Returns:PyTuple `consts` as a `tuple` Annotations @Getter

pack-priv PyTuple co_consts()

Get consts as a tuple.

Returns:PyTuple

consts as a tuple

Annotations

@Getter

co_freevars back to summary

co_freevars	back to summary
pack-priv PyTuple co_freevars() Get `co_freevars` as a `tuple`. Returns:PyTuple `co_freevars` as a `tuple` Annotations @Getter

pack-priv PyTuple co_freevars()

Get co_freevars as a tuple.

Returns:PyTuple

co_freevars as a tuple

Annotations

@Getter

co_lnotab	back to summary
pack-priv PyBytes co_lnotab() Annotations @SuppressWarnings:static-method @Getter

co_names back to summary

co_names	back to summary
pack-priv PyTuple co_names() Get `names` as a `tuple`. Returns:PyTuple `names` as a `tuple` Annotations @Getter

pack-priv PyTuple co_names()

Get names as a tuple.

Returns:PyTuple

names as a tuple

Annotations

@Getter

co_stacksize	back to summary
pack-priv int co_stacksize() Annotations @SuppressWarnings:static-method @Getter

co_varnames back to summary

co_varnames	back to summary
pack-priv PyTuple co_varnames() Get `co_varnames` as a `tuple`. Returns:PyTuple `co_varnames` as a `tuple` Annotations @Getter

pack-priv PyTuple co_varnames()

Get co_varnames as a tuple.

Returns:PyTuple

co_varnames as a tuple

Annotations

@Getter

createFunction back to summary

createFunction	back to summary
pack-priv abstract PyFunction<? extends PyCode> createFunction(Interpreter interpreter, PyDict globals, Object[] defaults, PyDict kwdefaults, Object annotations, PyCell[] closure) Create a `PyFunction` that will execute this `PyCode`. The strongly-typed `defaults`, `kwdefaults` , `closure` and `annotations` may be `null` if they would otherwise be empty. `annotations` is always exposed as a `dict`, but may be presented to the constructor as a `dict` or `tuple` of keys and values (or `null`). Parameters interpreter:Interpreter providing the module context globals:PyDict name space to treat as global variables defaults:Object[] default positional argument values or `null` kwdefaults:PyDict default keyword argument values or `null` annotations:Object type annotations (`dict`, `null` or maybe `tuple`) closure:PyCell[] variables referenced but not defined here, must be size expected by code or `null` if empty. Returns:PyFunction<? extends PyCode> the function from this code

pack-priv abstract PyFunction<? extends PyCode> createFunction(Interpreter interpreter, PyDict globals, Object[] defaults, PyDict kwdefaults, Object annotations, PyCell[] closure)

Create a PyFunction that will execute this PyCode. The strongly-typed defaults, kwdefaults , closure and annotations may be null if they would otherwise be empty. annotations is always exposed as a dict, but may be presented to the constructor as a dict or tuple of keys and values (or null).

Parameters

interpreter:Interpreter: providing the module context
globals:PyDict: name space to treat as global variables
defaults:Object[]: default positional argument values or null
kwdefaults:PyDict: default keyword argument values or null
annotations:Object: type annotations (dict, null or maybe tuple)
closure:PyCell[]: variables referenced but not defined here, must be size expected by code or null if empty.

Returns:PyFunction<? extends PyCode>

the function from this code

createFunction back to summary

createFunction	back to summary
pack-priv PyFunction<? extends PyCode> createFunction(Interpreter interpreter, PyDict globals) Create a `PyFunction` that will execute this `PyCode` (adequate for module-level code). Parameters interpreter:Interpreter providing the module context globals:PyDict name space to treat as global variables Returns:PyFunction<? extends PyCode> the function

pack-priv PyFunction<? extends PyCode> createFunction(Interpreter interpreter, PyDict globals)

Create a PyFunction that will execute this PyCode (adequate for module-level code).

Parameters

interpreter:Interpreter: providing the module context
globals:PyDict: name space to treat as global variables

Returns:PyFunction<? extends PyCode>

the function

getType back to summary

getType	back to summary
public PyType getType() Implements org.python.core.CraftedPyObject.getType. Doc from org.python.core.CraftedPyObject.getType. The Python `type` of this object. Returns:PyType `type` of this object Annotations @Override

public PyType getType()

Implements org.python.core.CraftedPyObject.getType.

Doc from org.python.core.CraftedPyObject.getType.

The Python type of this object.

Returns:PyType

type of this object

Annotations

@Override

layout back to summary

layout	back to summary
pack-priv abstract PyCode.Layout layout() Describe the layout of the frame local variables (at least the arguments), cell and free variables. `co_varnames`, `co_cellvars` and `co_freevars` are derived from this, and the signature of the code as a function. Returns:PyCode.Layout a `Layout` object describing the variables

pack-priv abstract PyCode.Layout layout()

Describe the layout of the frame local variables (at least the arguments), cell and free variables. co_varnames, co_cellvars and co_freevars are derived from this, and the signature of the code as a function.

Returns:PyCode.Layout: a Layout object describing the variables

names back to summary

names	back to summary
protected static String[] names(Object v, String tupleName) Check that all the argument is a tuple and that all objects in it are `str`, and return them as an array of `String`. Parameters v:Object of names tupleName:String the name of the argument (for error production) Returns:String[] the names as `String[]`

protected static String[] names(Object v, String tupleName)

Check that all the argument is a tuple and that all objects in it are str, and return them as an array of String.

Parameters

v:Object: of names
tupleName:String: the name of the argument (for error production)

Returns:String[]

the names as String[]

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

totalargs	back to summary
pack-priv int totalargs() Return the total space in a frame of a code object, that must be reserved for arguments. This is also the size of the layout array appearing as an argument to constructors. Returns:int total space in frame for arguments

totalargs

back to summary

pack-priv int totalargs()

Return the total space in a frame of a code object, that must be reserved for arguments. This is also the size of the layout array appearing as an argument to constructors.

Returns:int: total space in frame for arguments

totalargs back to summary

pack-priv static int totalargs(int argcount, int flags)

From the values of co_argcount and co_flags (in practice, as they are de-marshalled), compute the total space in a frame of a code object, that must be reserved for arguments. This is also the size of the layout array appearing as an argument to certain constructors.

Parameters

argcount:int: argument count excluding collector parameters.
flags:int: bit map of code traits

Returns:int

total space in frame for arguments

traitsFrom	back to summary
private static EnumSet<PyCode.Trait> traitsFrom(int flags) Convert a CPython-style `flags` specifier to `traits`.

org.python.core back to summary

pack-priv Interface PyCode.Layout

Known Direct Implementers: org.python.core.CPython311Code.CPythonLayout

Interface on a store of information about the variables required by a code object and where they will be stored in the frame it creates. It is used to initialise

Method Summary

Modifier and Type	Method and Description
public Stream<String>	Returns: names of cell variables (may be parameters). cellvars() Return a stream of the names of variables to include in `co_cellvars`.
public Stream<String>	Returns: names of free variables. freevars() Return a stream of the names of variables to include in `co_freevars`.
public Stream<String>	Returns: names of all local variables. localnames() Return a stream of the names of all the local variables These are the parameters and then the other plain, cell and free variables, but occurring only once each (whereas `co_cellvars` will repeat names from `co_varnames` if they are parameters.
public String	Returns: name of one variable. name(int of variable index) Return name of one local frame variable.
public default int	Returns: the length of `co_cellvars` ncellvars()
public default int	Returns: the length of `co_freevars` nfreevars()
public default int	Returns: the length of `co_varnames` nvarnames()
public default int	Returns: total number of local variables. size()
public EnumSet<PyCode.VariableTrait>	Returns: traits of the local variable traits(int of variable index) Return the `VariableTrait`s of the variable at a given index .
public Stream<String>	Returns: names of non-cell and parameters variables. varnames() Return a stream of the names of variables to include in `co_varnames`.

Method Detail

cellvars back to summary

public Stream<String> cellvars()

Return a stream of the names of variables to include in co_cellvars. These are the variables defined by this code object and stored as cells. Note that some of the parameters may be cell variables.

Returns:Stream<String>: names of cell variables (may be parameters).

freevars back to summary

public Stream<String> freevars()

Return a stream of the names of variables to include in co_freevars. These are the variables stored as cells but defined in another code object.

Returns:Stream<String>: names of free variables.

localnames back to summary

public Stream<String> localnames()

Return a stream of the names of all the local variables These are the parameters and then the other plain, cell and free variables, but occurring only once each (whereas co_cellvars will repeat names from co_varnames if they are parameters.

Returns:Stream<String>: names of all local variables.

name

back to summary

public String name(int index)

Return name of one local frame variable.

Parameters

index:int: of variable

Returns:String

name of one variable.

ncellvars back to summary

public default int ncellvars()

Returns:int: the length of co_cellvars

nfreevars back to summary

public default int nfreevars()

Returns:int: the length of co_freevars

nvarnames back to summary

public default int nvarnames()

Returns:int: the length of co_varnames

size

back to summary

public default int size()

Returns:int: total number of local variables.

traits back to summary

public EnumSet<PyCode.VariableTrait> traits(int index)

Return the VariableTraits of the variable at a given index .

Parameters

index:int: of variable

Returns:EnumSet<PyCode.VariableTrait>

traits of the local variable

varnames back to summary

public Stream<String> varnames()

Return a stream of the names of variables to include in co_varnames. These are the parameters and then the plain (non-cell, non-free) variables. Note that some of the arguments may be cell variables.

Returns:Stream<String>: names of non-cell and parameters variables.

org.python.core back to summary

pack-priv final Enum PyCode.Trait

Class Inheritance

extends Enum<PyCode.Trait>

java.lang.Object
java.lang.Enum
org.python.core.PyCode.Trait

Characteristics of a PyCode (as CPython co_flags). These are not all relevant to all code types.

Field Summary

Modifier and Type	Field and Description
public static final PyCode.Trait	ASYNC_GENERATOR
public static final PyCode.Trait	COROUTINE
public static final PyCode.Trait	GENERATOR
public static final PyCode.Trait	ITERABLE_COROUTINE
public static final PyCode.Trait	NESTED
public static final PyCode.Trait	NEWLOCALS
public static final PyCode.Trait	OPTIMIZED
public static final PyCode.Trait	VARARGS
public static final PyCode.Trait	VARKEYWORDS

Constructor Summary

Access	Constructor and Description
private	Trait()

Method Summary

Modifier and Type	Method and Description
public static PyCode.Trait	valueOf(String name)
public static PyCode.Trait[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ASYNC_GENERATOR	back to summary
public static final PyCode.Trait ASYNC_GENERATOR

COROUTINE	back to summary
public static final PyCode.Trait COROUTINE

GENERATOR	back to summary
public static final PyCode.Trait GENERATOR

ITERABLE_COROUTINE	back to summary
public static final PyCode.Trait ITERABLE_COROUTINE

NESTED	back to summary
public static final PyCode.Trait NESTED

NEWLOCALS	back to summary
public static final PyCode.Trait NEWLOCALS

OPTIMIZED	back to summary
public static final PyCode.Trait OPTIMIZED

VARARGS	back to summary
public static final PyCode.Trait VARARGS

VARKEYWORDS	back to summary
public static final PyCode.Trait VARKEYWORDS

Constructor Detail

Trait	back to summary
private Trait()

Method Detail

valueOf	back to summary
public static PyCode.Trait valueOf(String name)

values	back to summary
public static PyCode.Trait[] values()

org.python.core back to summary

pack-priv final Enum PyCode.VariableTrait

Class Inheritance

extends Enum<PyCode.VariableTrait>

java.lang.Object
java.lang.Enum
org.python.core.PyCode.VariableTrait

Traits characterising local variables of the frame this code object will produce.

Field Summary

Modifier and Type	Field and Description
public static final PyCode.VariableTrait	CELL Belongs in `co_cellvars`.
public static final PyCode.VariableTrait	FREE Belongs in `co_freevars`.
public static final PyCode.VariableTrait	PLAIN Belongs in `co_varnames`.

Constructor Summary

Access	Constructor and Description
private	VariableTrait()

Method Summary

Modifier and Type	Method and Description
public static PyCode.VariableTrait	valueOf(String name)
public static PyCode.VariableTrait[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CELL	back to summary
public static final PyCode.VariableTrait CELL Belongs in `co_cellvars`. This means the non-free cell variables, even if they are also parameters to the function, in which case they have the `PLAIN` trait too.

FREE	back to summary
public static final PyCode.VariableTrait FREE Belongs in `co_freevars`. These are just the free cell variables. (They cannot also be parameters.)

PLAIN	back to summary
public static final PyCode.VariableTrait PLAIN Belongs in `co_varnames`. For legacy reasons this means parameters to the function (even if they are also cell variables), and other local variables that are not cells (or free).

Constructor Detail

VariableTrait	back to summary
private VariableTrait()

Method Detail

valueOf	back to summary
public static PyCode.VariableTrait valueOf(String name)

values	back to summary
public static PyCode.VariableTrait[] values()

public abstract Class PyCode

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Interface PyCode.Layout

Method Summary

Method Detail

pack-priv final Enum PyCode.Trait

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum PyCode.VariableTrait

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail