11.1.10.9. Parser_jmgc

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.

SPICE is case insensitive.

class PySpice.Spice.Parser_jmgc.CircuitStatement(title)

Bases: PySpice.Spice.Parser_jmgc.Statement

This class implements a circuit definition.

Spice syntax:

Title ...

append(statement)

Append a statement to the statement’s list.

append_model(statement)

Append a model to the statement’s list.

append_param(statement)

Append a param to the statement’s list.

append_subcircuit(statement)

Append a subcircuit to the statement’s list.

build(ground=0)

property models

Models of the circuit.

property name

Name of the circuit.

property params

Parameters of the circuit.

property subcircuits

Subcircuits of the circuit.

property title

Title of the circuit.

to_python(ground=0)

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

Bases: PySpice.Spice.Parser_jmgc.Statement

class PySpice.Spice.Parser_jmgc.Element(line)

Bases: PySpice.Spice.Parser_jmgc.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_jmgc.Include(line)

Bases: PySpice.Spice.Parser_jmgc.Statement

This class implements a include definition.

to_python(netlist_name)

class PySpice.Spice.Parser_jmgc.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_element(prefix)

Split the line according to the following pattern:

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

Return the list of parameters and the dictionary.

split_keyword(keyword)

Split the line according to the following pattern:

keyword parameter1 parameter2 ( key1=value1 key2=value2 )

Return the list of parameters and the dictionary. The parenthesis can be omitted.

split_words(start_location, until=None)

class PySpice.Spice.Parser_jmgc.Model(line)

Bases: PySpice.Spice.Parser_jmgc.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)

class PySpice.Spice.Parser_jmgc.Parameter(line)

Bases: PySpice.Spice.Parser_jmgc.Statement

This class implements a parameter definition.

Spice syntax:

.param name=expr

build(circuit)

property name

Name of the model

to_python(netlist_name)

exception PySpice.Spice.Parser_jmgc.ParseError

Bases: NameError

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

Bases: object

This class represents a device prefix.

property single

class PySpice.Spice.Parser_jmgc.SpiceParser(path=None, source=None, end_of_line_comment=('$', '//', ';'))

Bases: object

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

Public Attributes:

circuit

models

subcircuits

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).

property circuit

Circuit statements.

is_only_model()

is_only_subcircuit()

property models

Models of the sub-circuit.

static netlist_to_python(netlist_name, statements, ground=0)

property subcircuits

Subcircuits of the sub-circuit.

to_python_code(ground=0)

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

Bases: object

This base 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_jmgc.SubCircuitStatement(line)

Bases: PySpice.Spice.Parser_jmgc.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.

append_model(statement)

Append a model to the statement’s list.

append_param(statement)

Append a param to the statement’s list.

append_subcircuit(statement)

Append a model to the statement’s list.

build(ground=0, parent=None)

property models

Models of the sub-circuit.

property name

Name of the sub-circuit.

property nodes

Nodes of the sub-circuit.

property params

Params of the sub-circuit.

property subcircuits

Subcircuits of the sub-circuit.

to_python(ground=0)

class PySpice.Spice.Parser_jmgc.Title(line)

Bases: PySpice.Spice.Parser_jmgc.Statement

This class implements a title definition.