Back to module index

Go to module by name

codeop

Utilities to compile possibly incomplete Python source code.

This module provides two interfaces, broadly similar to the builtin
function compile(), which take program text, a filename and a 'mode'
and:

- Return code object if the command is complete and valid
- Return None if the command is incomplete
- Raise SyntaxError, ValueError or OverflowError if the command is a
  syntax error (OverflowError and ValueError can be produced by
  malformed literals).

The two interfaces are:

compile_command(source, filename, symbol):

    Compiles a single command in the manner described above.

CommandCompiler():

    Instances of this class have __call__ methods identical in
    signature to compile_command; the difference is that if the
    instance compiles program text containing a __future__ statement,
    the instance 'remembers' and compiles all subsequent program texts
    with the statement in force.

The module also provides another class:

Compile():

    Instances of this class act like the built-in function compile,
    but with 'memory' in the sense described above.

Classes

CommandCompiler

Instances of this class have __call__ methods identical in
    signature to compile_command; the difference is that if the
    instance compiles program text containing a __future__ statement,
    the instance 'remembers' and compiles all subsequent program texts
    with the statement in force.

Compile

Instances of this class behave much like the built-in compile
    function, but if one is used to compile text containing a future
    statement, it "remembers" and compiles all subsequent program texts
    with the statement in force.

Functions

compile_command

compile_command(source, filename='<input>', symbol='single')

  Compile a command and determine whether it is incomplete.

      Arguments:

      source -- the source string; may contain \n characters
      filename -- optional filename from which source was read; default
                  "<input>"
      symbol -- optional grammar start symbol; "single" (default), "exec"
                or "eval"

      Return value / exceptions raised:

      - Return a code object if the command is complete and valid
      - Return None if the command is incomplete
      - Raise SyntaxError, ValueError or OverflowError if the command is a
        syntax error (OverflowError and ValueError can be produced by
        malformed literals).
    

Other members

PyCF_ALLOW_INCOMPLETE_INPUT = 16384

PyCF_DONT_IMPLY_DEDENT = 512

Modules

warnings