11.1.12.12. Parser

This module implements a partial SPICE netlist parser.

See the cir2py tool for an example of usage of the parser.

It would be difficult to implement a full parser for Ngspice since the syntax is mainly contextual.

class PySpice.Spice.Parser.Comment(line, statement=None)

Bases: PySpice.Spice.Parser.Statement

class PySpice.Spice.Parser.Element(line)

Bases: PySpice.Spice.Parser.Statement

This class implements an element definition.

“{ expression }” are allowed in device line.

build(circuit, ground=0)

property name

Name of the element

to_python(netlist_name, ground=0)

translate_ground_node(ground)

class PySpice.Spice.Parser.Include(line)

Bases: PySpice.Spice.Parser.Statement

This class implements a include definition.

to_python(netlist_name)

class PySpice.Spice.Parser.Lib(line)

Bases: PySpice.Spice.Parser.Statement

This class implements a library definition.

to_python(netlist_name)

class PySpice.Spice.Parser.Line(line, line_range, end_of_line_comment)

Bases: object

This class implements a line in the netlist.

append(line)

property comment

static get_kwarg(text)

property is_comment

lower_case_statement(statement)

Lower case the statement

read_words(start_location, number_of_words)

Read a fixed number of words separated by space.

right_of(text)

split_line(keyword)

Split the line according to the following pattern:

keyword parameter1 parameter2 ... key1=value1 key2=value2 ...

Return the list of parameters and the dictionary.

split_words(start_location, until=None)

class PySpice.Spice.Parser.Model(line)

Bases: PySpice.Spice.Parser.Statement

This class implements a model definition.

Spice syntax:

.model mname type (pname1=pval1 pname2=pval2)

build(circuit)

property name

Name of the model

to_python(netlist_name)

exception PySpice.Spice.Parser.ParseError

Bases: NameError

class PySpice.Spice.Parser.PrefixData(prefix, classes)

Bases: object

This class represents a device prefix.

property single

class PySpice.Spice.Parser.SpiceParser(path=None, source=None, end_of_line_comment=('$', '//', ';'), recurse=False, section=None)

Bases: object

This class parse a Spice netlist file and build a syntax tree.

Public Attributes:

circuit

models

subcircuits

incl_libs

build_circuit(ground=0)

Build a Circuit instance.

Use the ground parameter to specify the node which must be translated to 0 (SPICE ground node).

is_only_model()

is_only_subcircuit()

static netlist_to_python(netlist_name, statements, ground=0)

to_python_code(ground=0)

class PySpice.Spice.Parser.Statement(line, statement=None)

Bases: object

This class implements a statement, in fact a line in a Spice netlist.

join_args(args)

kwargs_to_python(kwargs)

value_to_python(x)

values_to_python(values)

class PySpice.Spice.Parser.SubCircuitStatement(line)

Bases: PySpice.Spice.Parser.Statement

This class implements a sub-circuit definition.

Spice syntax:

.SUBCKT name node1 ... param1=value1 ...

append(statement)

Append a statement to the statement’s list.

build(ground=0)

property name

Name of the sub-circuit.

property nodes

Nodes of the sub-circuit.

to_python(ground=0)

class PySpice.Spice.Parser.Title(line)

Bases: PySpice.Spice.Parser.Statement

This class implements a title definition.