The py4cl2 Reference Manual

Table of Contents

The py4cl2 Reference Manual

This is the py4cl2 Reference Manual, version 2.7.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 17:29:36 2021 GMT+0.

1 Introduction

This is a fork of bendudson/py4cl.

Github Pages

Detailed documentation is available on github-pages (could be a bit outdated).

Releases

Check the Releases section.

Quick Demonstration

(ql:quickload :py4cl2 :silent t)

(py4cl2:defpymodule "numpy" nil :lisp-package "NP")
(py4cl2:defpymodule "scipy.integrate" nil :lisp-package "INTEGRATE")

;; Integrate some ODEs
(defparameter *data*
  (integrate:odeint 
   :func (lambda (y time) 
           (list (aref y 1)       ; dy[0]/dt = y[1]
                 (- (aref y 0)))) ; dy[1]/dt = -y[0]
   :y-0 #(1.0 0.0)   ; Initial state
   :t (np:linspace :start 0.0 :stop (* 2 pi) :num 20)))
                                        ; Vector of times

; (array-dimensions *data*) => (20 2)

;; Make a plot, save and show it in a window
(py4cl2:defpymodule "matplotlib.pyplot" nil :lisp-package "PLT")

(plt:plot *data*)
(plt:xlabel :xlabel "Time")
(plt:savefig "result.pdf")
(plt:show)

Great thanks to Ben Dudson for starting this project, and documenting it enough to make it more-buildable!

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 py4cl2

License

MIT

Description

Some improvements over py4cl. py4cl is a library for interfacing with python libraries from common lisp, using streams to communicate with the python process. Report the issues at https://github.com/digikar99/py4cl2/issues
(More) Documentation is available at https://digikar99.github.io/py4cl2/

Version

2.7.0

Dependencies

• alexandria
• bordeaux-threads
• cl-json
• trivial-garbage
• iterate
• numpy-file-format
• parse-number
• uiop

Source

py4cl2.asd (file)

Components

• python-code (file)
• package.lisp (file)
• config.lisp (file)
• features.lisp (file)
• reader.lisp (file)
• writer.lisp (file)
• python-process.lisp (file)
• lisp-classes.lisp (file)
• callpython.lisp (file)
• arg-list.lisp (file)
• import-export.lisp (file)
• do-after-load.lisp (file)
• .config (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 py4cl2.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/py4cl2-v2.7.0/py4cl2.asd

Systems

py4cl2 (system)

3.1.2 py4cl2/package.lisp

Dependency

python-code (file)

Parent

py4cl2 (system)

Location

package.lisp

Packages

py4cl2

3.1.3 py4cl2/config.lisp

Dependency

package.lisp (file)

Parent

py4cl2 (system)

Location

config.lisp

Exported Definitions

• *array-type* (special variable)
• *arrayfiers* (special variable)
• *config* (special variable)
• config-var (function)
• (setf config-var) (function)
• initialize (function)
• load-config (function)
• py-cd (function)
• save-config (function)

Internal Definitions

• +py4cl2-config-path+ (constant)
• take-input (function)

3.1.4 py4cl2/features.lisp

Dependencies

• package.lisp (file)
• config.lisp (file)

Parent

py4cl2 (system)

Location

features.lisp

Exported Definitions

• *internal-features* (special variable)
• *warn-on-unavailable-feature-usage* (special variable)

Internal Definitions

• *feature-exclusion-alist* (special variable)
• numpy-installed-p (function)

3.1.5 py4cl2/reader.lisp

Dependencies

• package.lisp (file)
• features.lisp (file)

Parent

py4cl2 (system)

Location

reader.lisp

Internal Definitions

• *freed-python-objects* (special variable)
• copy-python-object (function)
• delete-freed-python-objects (function)
• delete-numpy-pickle-arrays (function)
• free-python-object (function)
• make-python-object (function)
• make-python-object-finalize (function)
• python-object (structure)
• python-object-handle (function)
• (setf python-object-handle) (function)
• python-object-p (function)
• python-object-type (function)
• (setf python-object-type) (function)
• stream-read-string (function)
• stream-read-value (function)

3.1.6 py4cl2/writer.lisp

Dependencies

• package.lisp (file)
• features.lisp (file)
• reader.lisp (file)

Parent

py4cl2 (system)

Location

writer.lisp

Exported Definitions

• pythonize (generic function)
• pythonize (method)
• pythonize (method)
• pythonize (method)
• pythonize (method)
• pythonize (method)
• pythonize (method)
• pythonize (method)
• pythonize (method)
• pythonize (method)
• pythonize (method)
• pythonize (method)

Internal Definitions

• *handle-counter* (special variable)
• *lisp-objects* (special variable)
• *lisp-to-python-alist* (special variable)
• *numpy-pickle-index* (special variable)
• clear-lisp-objects (function)
• free-handle (function)
• lisp-object (function)
• object-handle (function)
• stream-write-string (function)
• stream-write-value (function)

3.1.7 py4cl2/python-process.lisp

Dependencies

• package.lisp (file)
• features.lisp (file)
• writer.lisp (file)

Parent

py4cl2 (system)

Location

python-process.lisp

Exported Definitions

• pyinterrupt (function)
• pystart (function)
• pystop (function)
• python-alive-p (function)
• python-process-startup-error (condition)
• python-start-if-not-alive (function)
• with-python-output (macro)

Internal Definitions

• *current-python-process-id* (special variable)
• *in-with-python-output* (special variable)
• *py4cl-tests* (special variable)
• *python* (special variable)
• *python-code* (special variable)
• *python-output-semaphore* (special variable)
• *python-output-thread* (special variable)
• *python-process-busy-p* (special variable)
• *python-startup-error* (special variable)
• command (method)

3.1.8 py4cl2/lisp-classes.lisp

Dependencies

• package.lisp (file)
• python-process.lisp (file)

Parent

py4cl2 (system)

Location

lisp-classes.lisp

Exported Definitions

• python-getattr (generic function)
• python-setattr (generic function)

3.1.9 py4cl2/callpython.lisp

Dependencies

• reader.lisp (file)
• writer.lisp (file)
• python-process.lisp (file)
• lisp-classes.lisp (file)

Parent

py4cl2 (system)

Location

callpython.lisp

Exported Definitions

• chain (macro)
• chain* (function)
• (setf chain*) (function)
• pycall (function)
• pyerror (condition)
• pyeval (function)
• (setf pyeval) (function)
• pyexec (function)
• pygenerator (function)
• pyhelp (function)
• pymethod (function)
• pyslot-value (function)
• (setf pyslot-value) (function)
• python-eof-and-dead (condition)
• python-eof-but-alive (condition)
• pyversion-info (function)
• raw-pyeval (function)
• (setf raw-pyeval) (function)
• raw-pyexec (function)
• with-remote-objects (macro)
• with-remote-objects* (macro)

Internal Definitions

• %chain* (function)
• %pycall-args (function)
• dispatch-messages (function)
• dispatch-reply (function)
• python-process (method)
• python-process (method)
• raw-py (function)
• text (method)

3.1.10 py4cl2/arg-list.lisp

Dependencies

• package.lisp (file)
• callpython.lisp (file)

Parent

py4cl2 (system)

Location

arg-list.lisp

Internal Definitions

• %get-arg-list (method)
• %get-arg-list (method)
• %get-arg-list (method)
• %get-arg-list (method)
• both-positional-and-keyword-rest (condition)
• break-into-words (function)
• collect-first-word (function)
• default-arg-list-necessary (condition)
• default-is-python-object (condition)
• get-arg-list (function)
• get-unique-symbol (function)
• lispify-name (function)
• numeric-char-p (function)
• pythonize-kwargs (function)
• split-point-p (function)

3.1.11 py4cl2/import-export.lisp

Dependencies

• callpython.lisp (file)
• arg-list.lisp (file)

Parent

py4cl2 (system)

Location

import-export.lisp

Exported Definitions

• *defpymodule-silent-p* (special variable)
• defpyfun (macro)
• defpyfuns (macro)
• defpymodule (macro)
• export-function (function)
• pymethod-list (function)
• pyslot-list (function)

Internal Definitions

• *called-from-defpymodule* (special variable)
• *function-reload-string* (special variable)
• *is-submodule* (special variable)
• *lisp-package-supplied-p* (special variable)
• builtin-p (function)
• defpysubmodules (function)
• defvar-doc (macro)
• fun-symbol (function)
• function-reload-string (function)
• pymodule-import-string (function)

3.1.12 py4cl2/do-after-load.lisp

Dependency

import-export.lisp (file)

Parent

py4cl2 (system)

Location

do-after-load.lisp

3.2 Static

3.2.1 py4cl2/python-code

Parent

py4cl2 (system)

Location

/home/quickref/quicklisp/dists/quicklisp/software/py4cl2-v2.7.0/py4cl.py

3.2.2 py4cl2/.config

Dependency

do-after-load.lisp (file)

Parent

py4cl2 (system)

Location

/home/quickref/quicklisp/dists/quicklisp/software/py4cl2-v2.7.0/.config

4 Packages

Packages are listed by definition order.

4.1 py4cl2

Source

package.lisp (file)

Use List

• alexandria
• iterate
• common-lisp

Exported Definitions

• *array-type* (special variable)
• *arrayfiers* (special variable)
• *config* (special variable)
• *defpymodule-silent-p* (special variable)
• *internal-features* (special variable)
• *warn-on-unavailable-feature-usage* (special variable)
• chain (macro)
• chain* (function)
• (setf chain*) (function)
• config-var (function)
• (setf config-var) (function)
• defpyfun (macro)
• defpyfuns (macro)
• defpymodule (macro)
• export-function (function)
• initialize (function)
• load-config (function)
• py-cd (function)
• pycall (function)
• pyerror (condition)
• pyeval (function)
• (setf pyeval) (function)
• pyexec (function)
• pygenerator (function)
• pyhelp (function)
• pyinterrupt (function)
• pymethod (function)
• pymethod-list (function)
• pyslot-list (function)
• pyslot-value (function)
• (setf pyslot-value) (function)
• pystart (function)
• pystop (function)
• python-alive-p (function)
• python-eof-and-dead (condition)
• python-eof-but-alive (condition)
• python-getattr (generic function)
• python-process-startup-error (condition)
• python-setattr (generic function)
• python-start-if-not-alive (function)
• pythonize (generic function)
• pythonize (method)
• pythonize (method)
• pythonize (method)
• pythonize (method)
• pythonize (method)
• pythonize (method)
• pythonize (method)
• pythonize (method)
• pythonize (method)
• pythonize (method)
• pythonize (method)
• pyversion-info (function)
• raw-pyeval (function)
• (setf raw-pyeval) (function)
• raw-pyexec (function)
• save-config (function)
• with-python-output (macro)
• with-remote-objects (macro)
• with-remote-objects* (macro)

Internal Definitions

• %chain* (function)
• %get-arg-list (generic function)
• %get-arg-list (method)
• %get-arg-list (method)
• %get-arg-list (method)
• %get-arg-list (method)
• %pycall-args (function)
• *called-from-defpymodule* (special variable)
• *current-python-process-id* (special variable)
• *feature-exclusion-alist* (special variable)
• *freed-python-objects* (special variable)
• *function-reload-string* (special variable)
• *handle-counter* (special variable)
• *in-with-python-output* (special variable)
• *is-submodule* (special variable)
• *lisp-objects* (special variable)
• *lisp-package-supplied-p* (special variable)
• *lisp-to-python-alist* (special variable)
• *numpy-pickle-index* (special variable)
• *py4cl-tests* (special variable)
• *python* (special variable)
• *python-code* (special variable)
• *python-output-semaphore* (special variable)
• *python-output-thread* (special variable)
• *python-process-busy-p* (special variable)
• *python-startup-error* (special variable)
• +py4cl2-config-path+ (constant)
• both-positional-and-keyword-rest (condition)
• break-into-words (function)
• builtin-p (function)
• clear-lisp-objects (function)
• collect-first-word (function)
• command (generic function)
• command (method)
• copy-python-object (function)
• default-arg-list-necessary (condition)
• default-is-python-object (condition)
• defpysubmodules (function)
• defvar-doc (macro)
• delete-freed-python-objects (function)
• delete-numpy-pickle-arrays (function)
• dispatch-messages (function)
• dispatch-reply (function)
• free-handle (function)
• free-python-object (function)
• fun-symbol (function)
• function-reload-string (function)
• get-arg-list (function)
• get-unique-symbol (function)
• lisp-object (function)
• lispify-name (function)
• make-python-object (function)
• make-python-object-finalize (function)
• numeric-char-p (function)
• numpy-installed-p (function)
• object-handle (function)
• pymodule-import-string (function)
• python-object (structure)
• python-object-handle (function)
• (setf python-object-handle) (function)
• python-object-p (function)
• python-object-type (function)
• (setf python-object-type) (function)
• python-process (generic function)
• python-process (method)
• python-process (method)
• pythonize-kwargs (function)
• raw-py (function)
• split-point-p (function)
• stream-read-string (function)
• stream-read-value (function)
• stream-write-string (function)
• stream-write-value (function)
• take-input (function)
• text (generic function)
• text (method)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *array-type*

(GETF *ARRAYFIERS* *ARRAY-TYPE*) should return a single argument function that converts the ARRAY into the required type.

Package

py4cl2

Source

config.lisp (file)

Special Variable: *arrayfiers*

(GETF *ARRAYFIERS* *ARRAY-TYPE*) should return a single argument function that converts the ARRAY into the required type.

Package

py4cl2

Source

config.lisp (file)

Special Variable: *config*

Configuration variable used to store configuration values for PY4CL2. This variable should be manipulated using CONFIG-VAR and (SETF CONFIG-VAR).

Package

py4cl2

Source

config.lisp (file)

Special Variable: *defpymodule-silent-p*

DEFPYMODULE avoids printing progress if this is T.

Package

py4cl2

Source

import-export.lisp (file)

Special Variable: *internal-features*

A list of PY4CL2 features available on the system. (Support for :ARRAYS requires numpy and is only determinable after python process has started.)

Package

py4cl2

Source

features.lisp (file)

Special Variable: *warn-on-unavailable-feature-usage*

If non-NIL, then issues a WARNING on use of a feature unavailable on the platform. See PY4CL2:*INTERNAL-FEATURES* for the list of available features.

Package

py4cl2

Source

features.lisp (file)

5.1.2 Macros

Macro: chain &rest CHAIN

Package

py4cl2

Source

callpython.lisp (file)

Macro: defpyfun FUN-NAME &optional PYMODULE-NAME &key AS LISP-FUN-NAME LISP-PACKAGE SAFETY

Defines a function which calls python
Example
(py4cl:pyexec "import math")
(py4cl:defpyfun "math.sqrt")
(math.sqrt 42) -> 6.4807405

Arguments:
FUN-NAME: name of the function in python, before import
PYMODULE-NAME: name of the module containing FUN-NAME
AS: name of the function in python, after import
LISP-FUN-NAME: name of the lisp symbol to which the function is bound* LISP-PACKAGE: package (not its name) in which LISP-FUN-NAME will be interned SAFETY: if T, adds an additional line in the function asking to import the package or function, so that the function works even after PYSTOP is called. However, this increases the overhead of stream communication, and therefore, can reduce speed.

Package

py4cl2

Source

import-export.lisp (file)

Macro: defpyfuns &rest ARGS

Each ARG is supposed to be a 2-3 element list of
(pyfun-name pymodule-name) or (pyfun-name pymodule-name lisp-fun-name). In addition, when ARG is a 2-element list, then, the first element can be a list of python function names.

Package

py4cl2

Source

import-export.lisp (file)

Macro: defpymodule PYMODULE-NAME &optional IMPORT-SUBMODULES &key LISP-PACKAGE RELOAD SAFETY CONTINUE-IGNORING-ERRORS SILENT

Import a python module (and its submodules) lisp-package Lisp package(s). Example:
(py4cl:defpymodule "math" :lisp-package "M")
(m:sqrt 4) ; => 2.0
"Package already exists." is returned if the package exists and :RELOAD is NIL.
Arguments:
PYMODULE-NAME: name of the module in python, before importing IMPORT-SUBMODULES: leave nil for purposes of speed, if you won’t use the submodules
LISP-PACKAGE: lisp package, in which to intern (and export) the callables RELOAD: whether to redefine and reimport
SAFETY: value of safety to pass to defpyfun; see defpyfun
SILENT: prints "status" lines when NIL

Package

py4cl2

Source

import-export.lisp (file)

Macro: with-python-output &body FORMS-DECL

Gets the output of the python program executed in FORMS-DECL in the form a string.

Package

py4cl2

Source

python-process.lisp (file)

Macro: with-remote-objects &body BODY

Ensures that all values returned by python functions
and methods are kept in python, and only handles returned to lisp. This is useful if performing operations on large datasets.

Package

py4cl2

Source

callpython.lisp (file)

Macro: with-remote-objects* &body BODY

Ensures that all values returned by python functions
and methods are kept in python, and only handles returned to lisp.
This is useful if performing operations on large datasets. Unlike with-remote-objects, evaluates the last result and returns not just a handle.

Package

py4cl2

Source

callpython.lisp (file)

5.1.3 Functions

Function: chain* &rest CHAIN

Function: (setf chain*) VALUE &rest ARGS

Package

py4cl2

Source

callpython.lisp (file)

Function: config-var VAR

Returns the value associated with VAR in *CONFIG*.
Configuration variables include (all in PY4CL2 package):

- PYCMD: Path to the python binary to be used
- NUMPY-PICKLE-LOCATION: PY4CL2 uses pickled files to transfer large arrays between lisp
and python efficiently. These can have sizes exceeding 100MB. It is recommended that this
be set to path on a ram-disk. See [this](https://unix.stackexchange.com/questions/66329/creating-a-ram-disk-on-linux) for
instructions on creating a ram-disk on linux-based systems.
- NUMPY-PICKLE-LOWER-BOUND: The minimum size of the array for which PY4CL2 should use pickled files.
- USE-NUMCL-ARRAYS: NUMCL uses displaced arrays. If this variable is T and the system PY4CL2+NUMCL is loaded, arrays returned by python process are passed through NUMCL:ASARRAY before returning them to the user.

Package

py4cl2

Source

config.lisp (file)

Writer

(setf config-var) (function)

Function: (setf config-var) NEW-VALUE VAR

Sets the value of VAR to NEW-VALUE in *CONFIG*. For all but PYCMD, the values are saved to a configuration-file for persistence whenever they are changed. To persist PYCMD, call SAVE-CONFIG.

Package

py4cl2

Source

config.lisp (file)

Reader

config-var (function)

Function: export-function FUNCTION PYTHON-NAME

Makes a lisp FUNCTION available in python process as PYTHON-NAME

Package

py4cl2

Source

import-export.lisp (file)

Function: initialize ()

Intended to be called first upon installation. Sets up default python command, and numpy pickle file and lower bounds.

Package

py4cl2

Source

config.lisp (file)

Function: load-config ()

Load to *CONFIG* from /home/quickref/quicklisp/dists/quicklisp/software/py4cl2-v2.7.0/src/../.config

Package

py4cl2

Source

config.lisp (file)

Function: py-cd PATH

Package

py4cl2

Source

config.lisp (file)

Function: pycall FUN-NAME &rest ARGS

Calls FUN-NAME with ARGS as arguments. Arguments can be keyword based, or otherwise.

Package

py4cl2

Source

callpython.lisp (file)

Function: pyeval &rest ARGS

Calls python eval on args; PYTHONIZEs arg if it satisfies PYTHONIZEP. Eg.
> (let ((a 5)) (pyeval a "*" a))
25

Package

py4cl2

Source

callpython.lisp (file)

Writer

(setf pyeval) (function)

Function: (setf pyeval) VALUE &rest ARGS

Set an expression to a value. Just adds "=" and the value to the end of the expression. Note that the result is evaluated with exec rather than eval.
Example:
(setf (pyeval "a") 2) ; python "a=2"
Can be useful for modifying a value directly in python.

Package

py4cl2

Source

callpython.lisp (file)

Reader

pyeval (function)

Function: pyexec &rest ARGS

Calls python exec on args; PYTHONIZEs arg if it satisfies PYTHONIZEP.

Package

py4cl2

Source

callpython.lisp (file)

Function: pygenerator FUNCTION STOP-VALUE

Package

py4cl2

Source

callpython.lisp (file)

Function: pyhelp OBJECT

Package

py4cl2

Source

callpython.lisp (file)

Function: pyinterrupt &optional PROCESS-INFO

Issues a SIGINT command to the python process

Package

py4cl2

Source

python-process.lisp (file)

Function: pymethod OBJECT METHOD &rest ARGS

PYCALLs METHOD of OBJECT with ARGS
Examples:
> (pymethod "’hello {0}’" ’format "world") "hello world"
> (pymethod ’(1 2 3) ’–len–)
3
Note: FUN-NAME is NOT PYTHONIZEd if it is a string.

Package

py4cl2

Source

callpython.lisp (file)

Function: pymethod-list PYTHON-OBJECT &key AS-VECTOR

Package

py4cl2

Source

import-export.lisp (file)

Function: pyslot-list PYTHON-OBJECT &key AS-VECTOR

Package

py4cl2

Source

import-export.lisp (file)

Function: pyslot-value OBJECT SLOT-NAME

Function: (setf pyslot-value) NEW-VALUE OBJECT SLOT-NAME

Package

py4cl2

Source

callpython.lisp (file)

Function: pystart &optional COMMAND

Start a new python subprocess
This sets the global variable *python* to the process handle,
in addition to returning it.
COMMAND is a string with the python executable to launch e.g. "python" By default this is is set to *PYTHON-COMMAND*

Package

py4cl2

Source

python-process.lisp (file)

Function: pystop &optional PROCESS-INFO

Stop (Quit) the python process PROCESS

Package

py4cl2

Source

python-process.lisp (file)

Function: python-alive-p &optional PROCESS-INFO

Returns non-NIL if the python process is alive
(e.g. SBCL -> T, CCL -> RUNNING).
Optionally pass the process object returned by PYTHON-START

Package

py4cl2

Source

python-process.lisp (file)

Function: python-start-if-not-alive ()

If no python process is running, tries to start it. If still not alive, raises a condition.

Package

py4cl2

Source

python-process.lisp (file)

Function: pyversion-info ()

Return a list, using the result of python’s sys.version_info.

Package

py4cl2

Source

callpython.lisp (file)

Function: raw-pyeval &rest STRINGS

Calls python eval on the concatenation of strings, as they are, without any pythonization or modification.

Package

py4cl2

Source

callpython.lisp (file)

Writer

(setf raw-pyeval) (function)

Function: (setf raw-pyeval) VALUE &rest ARGS

Package

py4cl2

Source

callpython.lisp (file)

Reader

raw-pyeval (function)

Function: raw-pyexec &rest STRINGS

Calls python exec on the concatenation of strings, as they are, without any pythonization or modification.
NOTE: Like usual, there are peculiarities to exec commands.
For instance,
import sys
def foo:
sys.stdout.write(’hello’)
foo()
will result in ’sys’ name not defined PYERROR.

Package

py4cl2

Source

callpython.lisp (file)

Function: save-config ()

Save to /home/quickref/quicklisp/dists/quicklisp/software/py4cl2-v2.7.0/src/../.config from *CONFIG*

Package

py4cl2

Source

config.lisp (file)

5.1.4 Generic functions

Generic Function: python-getattr OBJECT SLOT-NAME

Called when python accesses an object’s slot (__getattr__)

Package

py4cl2

Source

lisp-classes.lisp (file)

Generic Function: python-setattr OBJECT SLOT-NAME VALUE

Called when python sets an object’s slot (__setattr__)

Package

py4cl2

Source

lisp-classes.lisp (file)

Generic Function: pythonize OBJ

Convert an object into a string which can be written to stream. Default implementation creates a handle to an unknown Lisp object.

Package

py4cl2

Source

writer.lisp (file)

Methods

Method: pythonize (OBJ ratio)

Handle ratios, using Python’s Fraction if available

Method: pythonize (OBJ python-object)

A handle for a python object, stored in a dict in Python

Method: pythonize (OBJ function)

Handle a function by converting to a callback object
The lisp function is stored in the same object store as other objects.

Method: pythonize (OBJ hash-table)

Convert hash-table to python map. Produces a string {key1:value1, key2:value2,}

Method: pythonize (OBJ symbol)

One-to-one mapping between python name and lisp symbol names: symbol : symbol-name : python-name
’foo-bar : "FOO-BAR" : foo_bar
’|Foo-Bar| : "Foo-Bar" : Foo_Bar
’*foo-bar* : "*FOO-BAR*" : FOO_BAR
t : "T" : True
nil : "NIL" : False

Method: pythonize (OBJ string)

Method: pythonize (OBJ cons)

Convert a list. This leaves a trailing comma so that python evals a list with a single element as a tuple

Method: pythonize (OBJ array)

Method: pythonize (OBJ complex)

Create string of the form "(1+2j".
If imaginary part is negative the output is of form "(1+-2j" which is interpreted correctly by python (3.7.2).

Method: pythonize (OBJ real)

Write a real number.
Note that python doesn’t handle ’d’,’f’, ’s’ or ’L’ exponent markers

Method: pythonize OBJ

5.1.5 Conditions

Condition: pyerror ()

Package

py4cl2

Source

callpython.lisp (file)

Direct superclasses

error (condition)

Direct methods

text (method)

Direct slots

Slot: text

Initargs

:text

Readers

text (generic function)

Condition: python-eof-and-dead ()

Package

py4cl2

Source

callpython.lisp (file)

Direct superclasses

end-of-file (condition)

Direct methods

python-process (method)

Direct slots

Slot: python-process

Initargs

:python-process

Readers

python-process (generic function)

Condition: python-eof-but-alive ()

Package

py4cl2

Source

callpython.lisp (file)

Direct superclasses

end-of-file (condition)

Direct methods

python-process (method)

Direct slots

Slot: python-process

Initargs

:python-process

Readers

python-process (generic function)

Condition: python-process-startup-error ()

Package

py4cl2

Source

python-process.lisp (file)

Direct superclasses

error (condition)

Direct methods

command (method)

Direct slots

Slot: command

Initargs

:command

Readers

command (generic function)

5.2 Internal definitions

5.2.1 Constants

Constant: +py4cl2-config-path+

Package

py4cl2

Source

config.lisp (file)

5.2.2 Special variables

Special Variable: *called-from-defpymodule*

Internal variable used for coordinating between DEFPYMODULE and DEFPYFUN.

Package

py4cl2

Source

import-export.lisp (file)

Special Variable: *current-python-process-id*

A number which changes when python is started. This
is used to prevent garbage collection from deleting objects in the wrong python session

Package

py4cl2

Source

python-process.lisp (file)

Special Variable: *feature-exclusion-alist*

Package

py4cl2

Source

features.lisp (file)

Special Variable: *freed-python-objects*

A list of handles to be freed. This is used because garbage collection may occur in parallel with the main thread.

Package

py4cl2

Source

reader.lisp (file)

Special Variable: *function-reload-string*

String pyexec-ed at the start of a DEFPYFUN when SAFETY is T.

Package

py4cl2

Source

import-export.lisp (file)

Special Variable: *handle-counter*

Package

py4cl2

Source

writer.lisp (file)

Special Variable: *in-with-python-output*

Package

py4cl2

Source

python-process.lisp (file)

Special Variable: *is-submodule*

Used for coordinating import statements from defpymodule while calling recursively

Package

py4cl2

Source

import-export.lisp (file)

Special Variable: *lisp-objects*

Package

py4cl2

Source

writer.lisp (file)

Special Variable: *lisp-package-supplied-p*

Internal variable used by PYMODULE-IMPORT-STRING to determine the import string.

Package

py4cl2

Source

import-export.lisp (file)

Special Variable: *lisp-to-python-alist*

Package

py4cl2

Source

writer.lisp (file)

Special Variable: *numpy-pickle-index*

Used for transferring multiple numpy-pickled arrays in one pyeval/exec/etc

Package

py4cl2

Source

writer.lisp (file)

Special Variable: *py4cl-tests*

Package

py4cl2

Source

python-process.lisp (file)

Special Variable: *python*

Most recently started python subprocess

Package

py4cl2

Source

python-process.lisp (file)

Special Variable: *python-code*

Package

py4cl2

Source

python-process.lisp (file)

Special Variable: *python-output-semaphore*

Package

py4cl2

Source

python-process.lisp (file)

Special Variable: *python-output-thread*

Package

py4cl2

Source

python-process.lisp (file)

Special Variable: *python-process-busy-p*

Used by pyinterrupt to determine if python process is waiting for input, or
is busy processing.

A possible workaround is to use strace.
See https://askubuntu.com/questions/1118109/how-do-i-tell-if-a-command-is-running-or-waiting-for-user-input

Package

py4cl2

Source

python-process.lisp (file)

Special Variable: *python-startup-error*

Package

py4cl2

Source

python-process.lisp (file)

5.2.3 Macros

Macro: defvar-doc NAME DOC

Package

py4cl2

Source

import-export.lisp (file)

5.2.4 Functions

Function: %chain* &rest CHAIN

Package

py4cl2

Source

callpython.lisp (file)

Function: %pycall-args &rest ARGS

Package

py4cl2

Source

callpython.lisp (file)

Function: break-into-words CHAR-LIST

Returns ((h e l l o) (W o r l d)), given (h e l l o W o r l d).

Package

py4cl2

Source

arg-list.lisp (file)

Function: builtin-p PYMODULE-NAME

Some builtin functions like ’sum’ do not take keyword args.

Package

py4cl2

Source

import-export.lisp (file)

Function: clear-lisp-objects ()

Clear the *lisp-objects* object store, allowing them to be GC’d

Package

py4cl2

Source

writer.lisp (file)

Function: collect-first-word CHAR-LIST

Returns ((h e l l o) W o r l d), given (h e l l o W o r l d).

Package

py4cl2

Source

arg-list.lisp (file)

Function: copy-python-object INSTANCE

Package

py4cl2

Source

reader.lisp (file)

Function: defpysubmodules PYMODULE-NAME LISP-PACKAGE CONTINUE-IGNORING-ERRORS

Package

py4cl2

Source

import-export.lisp (file)

Function: delete-freed-python-objects ()

Package

py4cl2

Source

reader.lisp (file)

Function: delete-numpy-pickle-arrays ()

Delete pickled arrays, to free space.

Package

py4cl2

Source

reader.lisp (file)

Function: dispatch-messages PROCESS

Read response from python, loop to handle any callbacks

Package

py4cl2

Source

callpython.lisp (file)

Function: dispatch-reply STREAM VALUE

Package

py4cl2

Source

callpython.lisp (file)

Function: free-handle HANDLE

Remove an object with HANDLE from the hash table

Package

py4cl2

Source

writer.lisp (file)

Function: free-python-object PYTHON-ID HANDLE

Package

py4cl2

Source

reader.lisp (file)

Function: fun-symbol PYFUN-NAME PYFULLNAME LISP-PACKAGE &optional ENSURE-UNIQUE

Package

py4cl2

Source

import-export.lisp (file)

Function: function-reload-string &key PYMODULE-NAME LISP-PACKAGE FUN-NAME AS

Package

py4cl2

Source

import-export.lisp (file)

Function: get-arg-list FULLNAME LISP-PACKAGE

Returns a list of two lists: PARAMETER-LIST and PASS_LIST

Package

py4cl2

Source

arg-list.lisp (file)

Function: get-unique-symbol SYMBOL-NAME PACKAGE-NAME

Package

py4cl2

Source

arg-list.lisp (file)

Function: lisp-object HANDLE

Get the lisp object corresponding to HANDLE

Package

py4cl2

Source

writer.lisp (file)

Function: lispify-name NAME

Converts NAME to a lisp-like name. Specifically: 1. Replaces underscores with hyphens.
2. CamelCase is converted to CAMEL-CASE

Package

py4cl2

Source

arg-list.lisp (file)

Function: make-python-object &key (TYPE TYPE) (HANDLE HANDLE)

Package

py4cl2

Source

reader.lisp (file)

Function: make-python-object-finalize &key TYPE HANDLE

Make a PYTHON-OBJECT struct with a finalizer.
This deletes the object from the dict store in python.

Uses trivial-garbage (public domain)

Package

py4cl2

Source

reader.lisp (file)

Function: numeric-char-p CH

Package

py4cl2

Source

arg-list.lisp (file)

Function: numpy-installed-p ()

Package

py4cl2

Source

features.lisp (file)

Function: object-handle OBJECT

Store OBJECT and return a handle

Package

py4cl2

Source

writer.lisp (file)

Function: pymodule-import-string PYMODULE-NAME LISP-PACKAGE

Package

py4cl2

Source

import-export.lisp (file)

Function: python-object-handle INSTANCE

Function: (setf python-object-handle) VALUE INSTANCE

Package

py4cl2

Source

reader.lisp (file)

Function: python-object-p OBJECT

Package

py4cl2

Source

reader.lisp (file)

Function: python-object-type INSTANCE

Function: (setf python-object-type) VALUE INSTANCE

Package

py4cl2

Source

reader.lisp (file)

Function: pythonize-kwargs ARG-PLIST

Package

py4cl2

Source

arg-list.lisp (file)

Function: raw-py CMD-CHAR &rest STRINGS

Intended as an abstraction to RAW-PYEVAL and RAW_PYEXEC. Passes strings as they are, without any ’pythonize’ation.

Package

py4cl2

Source

callpython.lisp (file)

Function: split-point-p PCH CH

Package

py4cl2

Source

arg-list.lisp (file)

Function: stream-read-string STREAM

Reads a string from a stream
Expects a line containing the number of chars following e.g. ’5~%hello’
Returns the string or nil on error

Package

py4cl2

Source

reader.lisp (file)

Function: stream-read-value STREAM

Get a value from a stream
Currently works by reading a string then using read-from-string

Package

py4cl2

Source

reader.lisp (file)

Function: stream-write-string STR STREAM

Write a string to a stream, putting the length first

Package

py4cl2

Source

writer.lisp (file)

Function: stream-write-value VALUE STREAM

Write a value to a stream, in a format which can be read by the python subprocess as the corresponding python type

Package

py4cl2

Source

writer.lisp (file)

Function: take-input PROMPT DEFAULT

Package

py4cl2

Source

config.lisp (file)

5.2.5 Generic functions

Generic Function: %get-arg-list PACKAGE FULLNAME LISP-PACKAGE

Package

py4cl2

Methods

Method: %get-arg-list PACKAGE FULLNAME LISP-PACKAGE

Source

arg-list.lisp (file)

Method: %get-arg-list (PACKAGE (eql type)) FULLNAME LISP-PACKAGE

Source

arg-list.lisp (file)

Method: %get-arg-list (PACKAGE (eql builtin_function_or_method)) FULLNAME LISP-PACKAGE

Source

arg-list.lisp (file)

Method: %get-arg-list (PACKAGE (eql numpy.ufunc)) FULLNAME LISP-PACKAGE

Source

arg-list.lisp (file)

Generic Function: command CONDITION

Package

py4cl2

Methods

Method: command (CONDITION python-process-startup-error)

Source

python-process.lisp (file)

Generic Function: python-process CONDITION

Package

py4cl2

Methods

Method: python-process (CONDITION python-eof-and-dead)

Source

callpython.lisp (file)

Method: python-process (CONDITION python-eof-but-alive)

Source

callpython.lisp (file)

Generic Function: text CONDITION

Package

py4cl2

Methods

Method: text (CONDITION pyerror)

Source

callpython.lisp (file)

5.2.6 Conditions

Condition: both-positional-and-keyword-rest ()

Package

py4cl2

Source

arg-list.lisp (file)

Direct superclasses

default-arg-list-necessary (condition)

Condition: default-arg-list-necessary ()

Package

py4cl2

Source

arg-list.lisp (file)

Direct superclasses

condition (condition)

Direct subclasses

• default-is-python-object (condition)
• both-positional-and-keyword-rest (condition)

Condition: default-is-python-object ()

Package

py4cl2

Source

arg-list.lisp (file)

Direct superclasses

default-arg-list-necessary (condition)

5.2.7 Structures

Structure: python-object ()

A handle for a python object
which couldn’t be translated into a Lisp value.
TYPE slot is the python type string
HANDLE slot is a unique key used to refer to a value in python.

Package

py4cl2

Source

reader.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

pythonize (method)

Direct slots

Slot: type

Type

string

Initform

""

Readers

python-object-type (function)

Writers

(setf python-object-type) (function)

Slot: handle

Readers

python-object-handle (function)

Writers

(setf python-object-handle) (function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables