cython API reference

140 public APIs from cython (cython/cython) — 98 classes, 25 functions, 17 methods. Signatures extracted by static analysis of the actual source.

Repository: cython/cython

Kind	Count
Classes	98
Functions	25
Methods	17

API list

classCython.CodeWriter.CodeWriter

A complete Cython code writer.

classCython.CodeWriter.DeclarationWriter

A Cython code writer that is limited to declarations nodes.

classCython.CodeWriter.PxdWriter

A Cython code writer for everything supported in pxd files.

classCython.CodeWriter.StatementWriter

A Cython code writer for most language statement features.

classCython.Compiler.Code.CCodeWriter

Utility class to output C code.

methodCython.Compiler.Code.CCodeWriter.put_acquire_gil(variable=None, unknown_gil_state=True)

Acquire the GIL.

methodCython.Compiler.Code.CCodeWriter.put_ensure_gil(declare_gilstate=True, variable=None)

Acquire the GIL.

methodCython.Compiler.Code.GlobalState.use_utility_code(utility_code, used_by=None)

Adds code to the C file.

classCython.Compiler.Code.NumConst

Global info about a Python number constant held by GlobalState.

classCython.Compiler.Code.PyObjectConst

Global info about a generic constant held by GlobalState.

classCython.Compiler.Code.PyStringConst

Global info about a Python string constant held by GlobalState.

classCython.Compiler.Code.PyxCodeWriter

Can be used for writing out some Cython code.

classCython.Compiler.Code.SharedFunctionDecl

Contains parsed declaration of shared utility function

classCython.Compiler.Code.StringConst

Global info about a C string constant held by GlobalState.

classCython.Compiler.Code.UtilityCode

Stores utility code to add during code generation.

classCython.Compiler.Code.UtilityCodeBase

Support for loading utility code from a file.

classCython.Compiler.FlowControl.ControlBlock

Control flow graph node.

methodCython.Compiler.FlowControl.ControlBlock.detach()

Detach block from parents and children.

classCython.Compiler.FlowControl.ControlFlow

Control-flow graph.

methodCython.Compiler.FlowControl.ControlFlow.newblock(parent=None) -> ControlBlock

Create floating block linked to `parent` if given.

classCython.Compiler.FlowControl.ExceptionDescr

Exception handling helper.

classCython.Compiler.FlowControl.ExitBlock

Non-empty exit point block.

classCython.Compiler.FlowControl.GV

Graphviz DOT renderer.

classCython.Compiler.FlowControl.GVContext

Graphviz subgraph object.

methodCython.Compiler.FlowControl.GVContext.render(fp, name, annotate_defs=False)

Render graphviz dot graph

classCython.Compiler.FlowControl.MessageCollection

Collect error/warnings messages first then sort

classCython.Compiler.FlowControl.StaticAssignment

Initialised at declaration time, e.g.

classCython.Compiler.FlowControl.Uninitialized

Definitely not initialised yet.

classCython.Compiler.FlowControl.Unknown

Coming from outer closure, might be initialised or not.

classCython.Compiler.FusedNode.FusedCFuncDefNode

This node replaces a function with fused arguments.

methodCython.Compiler.FusedNode.FusedCFuncDefNode.analyse_expressions(env)

Analyse the expressions.

classCython.Compiler.Main.CompilationResultSet

Results from compiling multiple Pyrex source files.

classCython.Compiler.MatchCaseNodes.MatchCaseBaseNode

Common base for a MatchCaseNode and a substituted node

classCython.Compiler.Optimize.DropRefcountingTransform

Drop ref-counting in safe places.

classCython.Compiler.ParseTreeTransforms.CnameDirectivesTransform

Only part of the CythonUtilityCode pipeline.

classCython.Compiler.ParseTreeTransforms.DebugTransform

Write debug information for this Cython module.

classCython.Compiler.ParseTreeTransforms.ParallelRangeTransform

Transform cython.parallel stuff.

methodCython.Compiler.ParseTreeTransforms.ParallelRangeTransform.visit(node)

Visit a node that may be None

classCython.Compiler.ParseTreeTransforms.ReplaceFusedTypeChecks

This is not a transform in the pipeline.

funcCython.Compiler.Parsing.p_exception_value_clause(s:PyrexScanner, is_extern:cython.bint) -> tuple

Parse exception value clause.

funcCython.Compiler.Parsing.p_fused_definition(s:PyrexScanner, pos, ctx)

c(type)def fused my_fused_type: ...

funcCython.Compiler.Parsing.p_positional_and_keyword_args(s:PyrexScanner, end_sy_set, templates=None) -> tuple[list, list]

Parses positional and keyword arguments.

classCython.Compiler.PyrexTypes.CIntLike

Mixin for shared behaviour of C integers and enums.

classCython.Compiler.PyrexTypes.CQualifierType

A C qualifier type - currently const, restrict and volatile

classCython.Compiler.PyrexTypes.EnumMixin

Common implementation details for C and C++ enums.

classCython.Compiler.PyrexTypes.FusedType

Represents a Fused Type.

classCython.Compiler.Scanning.FileSourceDescriptor

Represents a code source.

classCython.Compiler.Scanning.SourceDescriptor

A SourceDescriptor should be considered immutable.

classCython.Compiler.StringEncoding.BytesLiteralBuilder

Assemble a byte string or char value.

classCython.Compiler.StringEncoding.UnicodeLiteralBuilder

Assemble a unicode string.

funcCython.Compiler.TreePath.handle_descendants(next, token)

//...

funcCython.Compiler.TreePath.handle_dot(next, token)

/./

funcCython.Compiler.TreePath.handle_func_not(next, token)

not(...)

funcCython.Compiler.TreePath.handle_name(next, token)

/NodeName/ or func(...)

funcCython.Compiler.TreePath.handle_star(next, token)

/*/

classCython.Compiler.TypeInference.PyObjectTypeInferer

If it's not declared, it's a PyObject.

classCython.Compiler.TypeInference.SimpleAssignmentTypeInferer

Very basic type inference.

classCython.Compiler.UtilNodes.TempsBlockNode

Creates a block which allocates temporary variables.

classCython.Compiler.UtilityCode.CythonUtilityCode

Utility code written in the Cython language itself.

classCython.Compiler.Visitor.CythonTransform

Certain common conventions and utilities for Cython transforms.

classCython.Compiler.Visitor.EnvTransform

This transformation keeps a stack of the environments.

classCython.Compiler.Visitor.NodeFinder

Find out if a node appears in a subtree.

classCython.Compiler.Visitor.NodeRefCleanupMixin

Clean up references to nodes that were replaced.

classCython.Compiler.Visitor.PrintTree

Prints a representation of the tree to standard output.

funcCython.Compiler.Visitor.replace_node(ptr, value)

Replaces a node.

classCython.Coverage.CythonModuleTracer

Find the Python/Cython source file for a Cython module.

methodCython.Coverage.CythonModuleTracer.dynamic_source_filename(filename, frame)

Determine source file path.

funcCython.Debugger.Cygdb.main()

Start the Cython debugger.

classCython.Debugger.libcython.ColorizeSourceCode

Tell cygdb whether to colorize source code.

classCython.Debugger.libcython.CyBacktrace

Print the Cython stack

classCython.Debugger.libcython.CyCName

Get the C name of a Cython variable in the current context.

classCython.Debugger.libcython.CyCValue

Get the value of a Cython variable.

classCython.Debugger.libcython.CyCont

Continue a Cython program.

classCython.Debugger.libcython.CyCy

Invoke a Cython command.

classCython.Debugger.libcython.CyDown

Go down a Cython, Python or relevant C frame.

classCython.Debugger.libcython.CyExec

Execute Python code in the nearest Python or Cython frame.

classCython.Debugger.libcython.CyFinish

Execute until the function returns.

classCython.Debugger.libcython.CyGDBError

Base class for Cython-command related errors

classCython.Debugger.libcython.CyGlobals

List the globals from the current Cython module.

classCython.Debugger.libcython.CyLine

Get the current Cython line.

classCython.Debugger.libcython.CyList

List Cython source code.

classCython.Debugger.libcython.CyLocals

List the locals from the current Cython frame.

classCython.Debugger.libcython.CyNext

Step-over Cython, Python or C code.

classCython.Debugger.libcython.CyRun

Run a Cython program.

classCython.Debugger.libcython.CySelect

Select a frame.

classCython.Debugger.libcython.CyStep

Step through Cython, Python or C code.

classCython.Debugger.libcython.CyUp

Go up a Cython, Python or relevant C frame.

classCython.Debugger.libcython.CythonCommand

Base class for Cython commands

classCython.Debugger.libcython.CythonParameter

Base class for cython parameters

classCython.Debugger.libpython.ExecutionControlCommandBase

Superclass for language specific execution control.

methodCython.Debugger.libpython.ExecutionControlCommandBase.finish(*args)

Implements the finish command.

classCython.Debugger.libpython.Frame

Wrapper for gdb.Frame, adding various methods

methodCython.Debugger.libpython.Frame.is_waiting_for_gil()

Is this frame waiting on the GIL?

methodCython.Debugger.libpython.LanguageInfo.exc_info(frame)

See this class' docstring.

classCython.Debugger.libpython.PyBoolObjectPtr

Class wrapping a gdb.Value that's a PyBoolObject* i.e.

classCython.Debugger.libpython.PyBreak

Set a Python breakpoint.

classCython.Debugger.libpython.PyClassObjectPtr

Class wrapping a gdb.Value that's a PyClassObject* i.e.

classCython.Debugger.libpython.PyCodeObjectPtr

Class wrapping a gdb.Value that's a PyCodeObject* i.e.

classCython.Debugger.libpython.PyDictObjectPtr

Class wrapping a gdb.Value that's a PyDictObject* i.e.

classCython.Debugger.libpython.PyFinish

Execute until function returns to a caller.

classCython.Debugger.libpython.PyGlobals

List all the globals in the currently select Python frame

classCython.Debugger.libpython.PyLocals

Look up the given python variable name, and print it

classCython.Debugger.libpython.PyNext

Step-over Python code.

classCython.Debugger.libpython.PyObjectPtrPrinter

Prints a (PyObject*)

classCython.Debugger.libpython.PyPrint

Look up the given python variable name, and print it

classCython.Debugger.libpython.PyRun

Run the program.

classCython.Debugger.libpython.PyStep

Step through Python code.

funcCython.Debugger.libpython.dont_suppress_errors(function)

*sigh*, readline

funcCython.Debugger.libpython.get_selected_inferior()

Return the selected inferior in gdb.

funcCython.Debugger.libpython.is_evalframeex(frame)

Is this a PyEval_EvalFrameEx frame?

funcCython.Debugger.libpython.stackdepth(frame)

Tells the stackdepth of a gdb frame.

methodCython.Distutils.old_build_ext.Optimization.restore_state()

restore the original state

funcCython.LZSS.find_longest_match(pos:cython.Py_ssize_t) -> tuple[cython.Py_ssize_t, cython.Py_ssize_t]

Find longest match in sliding window.

funcCython.LZSS.lzss_compress(data:bytes) -> bytes

LZSS-like compressor.

classCython.Plex.Actions.Call

Internal Plex action which causes a function to be called.

funcCython.Plex.DFA.epsilon_closure(state:Node) -> set

Return the set of states reachable from the given state by epsilon moves.

classCython.Plex.Machines.Machine

A collection of Nodes representing an NFA or DFA.

methodCython.Plex.Machines.Machine.new_state()

Add a new state to the machine and return it.

classCython.Plex.Machines.Node

A state of an NFA or DFA.

classCython.Plex.Regexps.RE

RE is the base class for regular expression constructors.

classCython.Plex.Regexps.Rep1

Rep1(re) is an RE which matches one or more repetitions of |re|.

classCython.Plex.Transitions.TransitionMap

A TransitionMap maps an input event to a set of states.

methodCython.Plex.Transitions.TransitionMap.add(event, new_state)

Add transition to |new_state| on |event|.

methodCython.Plex.Transitions.TransitionMap.check()

Check data structure integrity.

methodCython.Plex.Transitions.TransitionMap.get_special(event) -> set

Get state set for special event, adding a new entry if necessary.

classCython.Shadow.CythonDotParallel

The cython.parallel module.

funcCython.Shadow.index_type(base_type:_T, item:tuple | slice | int) -> _ArrayType[_T]

Support array type creation by slicing, e.g.

classCython.Shadow.pymutex

A low-cost mutex lock type.

classCython.Shadow.pythread_type_lock

A mutex lock type using PyThread_type_lock.

classCython.StringIOTree.StringIOTree

See module docs.

classCython.Tempita._tempita.TemplateError

Exception raised while parsing a template

funcCython.Tempita._tempita.find_position(string:str, index, last_index, last_pos) -> tuple

Given a string and index, return (line, column)

classCython.TestUtils.TransformTest

Utility base class for transform unit tests.

funcCython.load_ipython_extension(ip:Any) -> None

Load the extension in IPython.

classDoc.s5.ep2008.worker.HardWorker

Almost Sisyphus

funcTools.dump_github_issues.dump_issues(repo)

Main entry point.

funcpyximport.pyximport.uninstall(py_importer, pyx_importer)

Uninstall an import hook.

funcruntests.filter_stderr(stderr_bytes)

Filter annoying warnings from output.

funcruntests.get_cc_version(language)

finds gcc version using Popen

funcruntests.get_openmp_compiler_flags(language)

As of gcc 4.2, it supports OpenMP 2.5.

About this data

These signatures were extracted from the public source of cython/cython using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries