Pythonic/fullAPI

This is non-authoritative and not autogenerated: its just a reference to help get our heads around the code. Edit as you see fit!

Function

Written in C++

• __py_class_name__ (OBJ)

Return the name of the class of the Python object OBJ.

This is a private internal function not intended for direct use.

• __py_int64_scalar_value__ (X)

Extract a scalar int64 value from the Python integer X.

This is a private internal function not intended for direct use.

• __py_uint64_scalar_value__ (X)

Extract a scalar uint64 value from the Python integer X.

This is a private internal function not intended for direct use.

• __py_is_none__ (X)

Check whether the Python object OBJ is the 'None' object.

This is a private internal function not intended for direct use.

• __py_isinstance__ (X, TYPE)

Check whether X is an instance of a Python type named by the string TYPE (prefix with py).

• __py_objstore_clear__ ()

Clear the contents of the Python object store.

If any existing variables refer to Python values, they will no longer be valid.

This is a private internal function not intended for direct use.

• __py_objstore_drop__ (KEY)

Drop one reference from the Python object stored under KEY. If there are no more references, this will delete the object.

This is a private internal function not intended for direct use.

• __py_objstore_get__ (KEY)

Get the Python object stored under KEY from the object store.

This is a private internal function not intended for direct use.

• __py_objstore_put__ (VALUE)

Convert VALUE to a Python value and store in the object store.

This is a private internal function not intended for direct use.

• __py_objstore_put_none__ ()

Store None in the object store and return its index.

This is a private internal function not intended for direct use.

• __py_objstore_list__ ()

Return all Python objects and their ref counts in the object store.

This is a private internal function not intended for direct use.

• __py_string_value__ (OBJ)

Return the string value or representation of the Python object OBJ.

This is a private internal function not intended for direct use.

• X = pycall (FUNC, ARG1, ARG2, ...)

Call a Python function or callable, passing Octave values as arguments.

• pyeval (EXPR, LOCALNS)

Evaluate a Python expression and return the result.

• pyexec (EXPR, LOCALNS)

Execute a Python expression or block of code.

Written in octave

• __py_objstore_disp__ ()

Print or return all Python objects and their ref counts in the object store.

• pyargs (NAME, VALUE, ...)

Construct a set of Python keyword arguments suitable for passing to a Python function.

• pyversion ()

List information about the Python runtime used by Octave Python functions.

• pythonic ()

Display useful information about the Pythonic package.

Classes

• @py

py.PYNAME Get the value of a Python object or call a Python function.

• @pyobject