View source for VPython Common Errors and Troubleshooting

(Lucas Christian, page 1 of 2)

This reference lists out some common errors I've seen students encounter while working in VPython.  Programming languages can often generate obscure and confusing error messages, and VPython is no exception.

==System/Environment Errors==

If your system is not set up correctly, or the environment you are running VPython code is incorrect, a number of mysterious errors can result.  

=== VPython does not start or immediately freezes ===

'''Make sure you are running your code in VIDLE (not the identical-looking IDLE).'''

[[File:use_vidle.jpg|300px|thumb|left|Use VIDLE instead of IDLE to avoid errors and crashes.]]

With the most current releases of VPython, code compiles and launches fine in IDLE, but the graphics window comes up grey and hangs.  This is because of a bug in the way regular IDLE executes code, it has difficulty with programs that keep running in a loop, as VPython does so you can drag and zoom the display.

Note that '''if you double-click a .py file in Windows Explorer or Finder, it may open up in the regular IDLE instead of VIDLE'''.  To check if your code is open in VIDLE, click the "Help" menu and look for the "VPython" menu item.  Regular IDLE does not have a "VPython" item in the Help menu.

<div style="clear: both"></div>

=== ImportError: No module named * ===

 Traceback (most recent call last):
   File "/my/documents/folder/vectors.py", line 1
     from future import division
 ImportError: No module named future

Python has only a small number of [https://docs.python.org/2/library/functions.html built-in functions].  The rest are stored in "modules" that you can load when you need them.  The <code>from (blank) import (blank)</code> lines tell Python to import the named functions from a specific module.  When you import a module, Python searches various folders on your computer to find the requested module.  If it cannot find a module with that name, you get an ImportError.

'''Cause #1:''' You made a typo in the module name.

The basic boilerplate for VPython programs written in this class:

 from __future__ import division
 from visual import *

Often missed are the '''two underscores''' (<code> _ _ </code>) not separated by a space before and after <code>future</code>.  Check that this is correct, or copy-and-paste from above.

'''Cause #2:''' VPython is not installed correctly.

It is possible the module actually does not exist on your system.  The VPython installer should install all the needed modules into the module folder for Python 2.7.  If you have a different version of Python installed, it will not be able to find the modules.  Make sure to follow the instructions on the VPython website, and install Python 2.7 from python.org as suggested.

=== NameError: name 'gdisplay' is not defined ===

This is often indicative of a missing import statement.  Make sure your code begins with the boilerplate code above.

If you are using the graph functions, you will also need:

 from visual.graph import *

==="The function ‘CGContextErase’ is obsolete"===

Users on Mac OS X may see this message printed whenever they run a VPython program:

 The function ‘CGContextErase’ is obsolete and will be removed in an upcoming update.
 Unfortunately, this application, or a library it uses, is using this obsolete function, 
 and is thereby contributing to an overall degradation of system performance.

This message can be ignored and will have no impact on the running of your program.

== Syntax Errors ==

A syntax error means Python cannot figure out what your program is asking it to do because you did not follow its grammar. VIDLE will highlight where the error occurred, but sometimes this highlight is misleading.

===Make sure parenthesis match up ===

Consider the following code (asterisks were placed around the part that where IDLE said the syntax error was):

 ## objects
 particle = sphere(pos=vector(1e-10,0,0), radius=2e-11, color=color.red
 
 ## initial values
 ***obslocation*** = vector(3.1e-10, -2.1e-10, 0)  <- Error at word "obslocation"

You can look at that line all you want, but there is no error there.  Instead, look at the end of the <code>particle = sphere(...</code> line.  Notice there is no closing parenthesis.

To fix this error, change the line to:

 particle = sphere(pos=vector(1e-10,0,0), radius=2e-11, color=color.red)    <- closing parenthesis added

== Runtime Errors ==

Even if Python understands the syntax of your program, it can still contain errors that pop up when it tries to run.

=== TypeError: unsupported operand type(s) for * ===

Consider this error and the line of code that produced it:

 Traceback (most recent call last):
   File "/my/documents/folder/lab2.py", line 32
     E = oofpez * (qproton / (r**2)) * rhat
 TypeError: unsupported operand type(s) for ** or pow(): 'vector' and 'int'

The error indicates that <code>pow()</code>, i.e. the exponent function, cannot operate on a <code>vector</code> and an <code>int</code> (an int is short for integer, a.k.a. a number/scalar).

 r = vector(5, 4, 3) - particle.pos
 rmag = sqrt(r.x**2 + r.y**2 + r.z**2)
 rhat = r / rmag
 E = oofpez * (qproton / (r**2)) * rhat  <-- ERROR

Looking at the code, we see that we typed <code>r ** 2</code>, i.e. squaring the vector r, or as we'd write it out on paper:

<math>\vec{r}^2 = \vec{r} * \vec{r} = <5, 4, 3> * <5, 4, 3></math>

If you've taken linear algebra before, you're probably aware that multiplying vectors or matrices is very different from simply multiplying out scalars, and in fact, in this case, is undefined.  The correct code here might have been:

 E = oofpez * (qproton / (rmag**2)) * that

Some other operations to look out for:

* Adding or subtracting a scalar from a vector or vice-versa
* Divining a scalar by a vector
* Multiplying or dividing two vectors

In VPython, there's no syntax to indicate that a variable is a vector. The easiest way to tell is look at where it was defined.  For example, if we created the variable <code>position</code> with any of these lines of code, it would hold a vector:

 position = vector(5, 4, 3)
 position = (5, 4, 3)
 position = arrow.pos     // arrow.pos is a vector property of the arrow object
 position = arrow.pos * 5     // vector multiplied by a scalar is a vector

When tracing these errors, always look and make sure your variables hold the type of data you expect.  When all else fails, you can use <code>print(variable name)</code> to examine the value.

=== ArgumentError: Python argument types in *** did not match C++ signature ===

If you pass the wrong type of data to a function, VPython prints all kinds of nasty jargon out.

 ArgumentError: Python argument types in
     None.None(arrow, int)
 did not match C++ signature:
     None(cvisual::primitive {lvalue}, cvisual::vector)

What the heck is a <code>cvisual::primitive {lvalue}</code>?  Who knows? (it's some internal data type in the C++ code for VPython, and it's an error in VPython that we see this message instead of a nicer, more explanatory one).  Our code that caused this error:

 r = sqrt(5 ** 2 + 4 ** 2 + 3**2)
 ea = arrow(pos=r, axis=E*scale, color=color.orange)

r was likely assumed to be a vector, but it actually appears to hold the magnitude of a vector someone calculated.

Consider another example:

 Traceback (most recent call last):
   File "/my/documents/folder/lab2.py", line 33
     r = vector(x, 5, 2)
 ArgumentError: Python argument types in
     vector.__init__(vector, vector, int, int)
 did not match C++ signature:
     __init__(_object*, cvisual::vector)
     __init__(_object*)
     __init__(_object*, double)
     __init__(_object*, double, double)
     __init__(_object*, double, double, double)

The error points at this line:

 r = vector(x, 5, 2)

Huh.  That looks OK.  Let's see how x is defined:

 x = particle.pos
 print(x)     // prints out <5, 4, 3>

Apparently x is a vector.  So the line that threw the error looks like this to the computer:

 r = vector(vector(5, 4, 3), 5, 2)     // This clearly doesn't make any sense

Hence, when you see these kind of errors, always inspect the arguments you pass to the function, and if any of them are a variable, '''look back at how the variable was defined'''.  If all else fails, try placing each argument into a <code>print()</code> statement separately and make sure what prints out is the type you expect.