#!/usr/bin/env python
#
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#
# 3/2/2009 version 0.4
# mmckerns@caltech.edu
# (C) 2005-2009 All Rights Reserved
#
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#
__license__ = """
This software is part of the open-source DANSE project at the California
Institute of Technology, and is available subject to the conditions and terms
laid out below. By downloading and using this software you are agreeing to the
following conditions.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistribution of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistribution in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentations
and/or other materials provided with the distribution.
* Neither the name of the California Institute of Technology nor the names
of its contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Copyright (c) 2009 California Institute of Technology. All rights reserved.
If you use this software to do productive scientific research that leads to
publication, we ask that you acknowledge use of the software by citing the
following paper in your publication:
"pygrace: python bindings to the Grace plotting package", Michael McKerns,
unpublished; http://www.its.caltech.edu/~mmckerns/software.html
"""
__author__='Mike McKerns'
__doc__ = '''Instructions for pygrace:
Import the grace class >>> from pygrace import grace
Instantiate the grace class >>> pg = grace()
Get help >>> pg.doc()
'''
from numpy import *
try:
from numarray import array as numarr
hasnumarray = True
except ImportError:
hasnumarray = False
try:
from Numeric import array as oldarr
hasnumeric = True
except ImportError:
hasnumeric = False
class grace: #Nathan Gray's gracePlot with interactive prompt added
'''Python-grace bindings
Methods:
prompt() --> start interactive session
eval(command) --> execute a grace command
put(name,val) --> put variable into interactive session
get(name) --> get variable from interactive session
who([name]) --> return the existing grace variables
delete(name) --> destroy selected grace variables
restart() --> restart a grace window
Notes:
grace and numpy must be installed, grace also relies on (open)motif
'''
_privdoc='''Private methods:
_validate(name) --> raise NameError if is invalid python name
_putlocal(name,value) --> add a variable to local store
_getlocal(name) --> return variable value from local store
_poplocal(name) --> delete variable from local store, return value
_wholist() --> get list of strings containing grace variables
_exists(name) --> True if is a variable in grace
'''
def __init__(self):
from gracePlot import gracePlot as grace_plot
self.session = grace_plot()
self.whos = {}
self.reserved = ['and','assert','break','class','continue','def','del',
'elif','else','except','exec','finally','for','from',
'global','if','import','in','is','lambda','not','or',
'pass','print','raise','return','try','while','yield',
'as','None']
return
def __getattr__(self,name):
try:
exec 'attr = self.session.'+name
except:
exec 'attr = self.get("'+name+'")'
return attr
def __setattr__(self,name,value):
if name in ['session','whos','reserved']:
self.__dict__[name] = value
return
self.put(name,value)
return
def __call__(self,*args):
for arg in args:
self.eval(arg)
return
def _validate(self,name):
'''_validate(name) --> raise NameError if is invalid python name'''
#a valid python name begins with a letter or underscore,
#and can include only alphanumeric symbols and the underscore.
#python also does not allow redefinition of reserved words.
if not name: raise NameError, "invalid name"
import re
if re.compile('[_a-zA-Z]').sub('',name[0]):
raise NameError, "invalid first character '%s'" % name[0]
badc = re.compile('[_a-zA-Z0-9]').sub('',name)
if badc: raise NameError, "invalid name '%s'; remove '%s'" % (name,badc)
if name.lower() in self.reserved:
raise NameError, "invalid name '%s'; is a reserved word" % name
return
def _putlocal(self,name,value):
'''_putlocal(name,value) --> add a variable to local store'''
self._validate(name)
self.whos[name] = value
return
def _getlocal(self,name,skip=True):
'''_getlocal(name) --> return variable value from local store'''
if self.whos.has_key(name):
return self.whos[name]
if skip: return #name not found in local store
raise NameError,"'%s' is not defined locally" % str(name)
def _poplocal(self,name):
'''_poplocal(name) --> delete variable from local store, return value'''
return self.whos.pop(name,None)
def _wholist(self):
'''_wholist() --> get list of strings containing grace variables'''
return self.whos.keys()
def _exists(self,name):
'''_exists(name) --> True if is a variable in grace'''
exists = self._wholist().count(name)
if exists: return True
return False
def doc(self):
print self.__doc__
print __license__[-416:] # print copyright and reference
return
def restart(self):
'''restart() --> restart a grace window'''
vars = self.who()
self.exit()
self.session = None
self.__init__()
self.session.whos = vars
return
def put(self,name,val):
'''put(name,val) --> add variable to grace session'''
if name.count('[') or name.count('.') or name.count('('):
varlist = self._wholist()
for var in varlist: #put whos into locals()
exec var+" = self._getlocal('"+var+"')"
if (type(val) is type(array([]))) or \
(hasnumarray and (type(val) is type(numarr([])))) or \
(hasnumeric and (type(val) is type(oldarr([])))):
val = val.tolist()
exec name+' = array('+str(val)+')'
else: exec name+' = '+str(val) #put new var value into locals()
for var in varlist: #use varlist to update state variables
exec 'self._putlocal("'+var+'",locals()["'+var+'"])'
return
return self._putlocal(name,val)
def get(self,name):
'''get(name) --> value; get value from grace session'''
#if name.count('+') or ...
#if name.count('[') or name.count('.') or name.count('('):
varlist = self._wholist()
for var in varlist: #put whos into locals()
exec var+" = self._getlocal('"+var+"')"
exec '___ = '+name #get from locals() as temp variable
return ___
#return self._getlocal(name)
def who(self,name=None):
'''who([name]) --> return the existing grace variables'''
if name: return self._getlocal(name,skip=False)
return self.whos
def delete(self,name):
'''delete(name) --> destroy selected grace variables'''
if not name.count(','):
self._poplocal(name)
return
vars = name.split(',')
for var in vars:
self.delete(var.strip())
return
def eval(self,com):
'''eval(command) --> execute a grace command'''
outlist = []
if self.whos: #add to outlist
for name,val in self.whos.items():
# if numerix:
if (type(val) is type(array([]))) or \
(hasnumarray and (type(val) is type(numarr([])))) or \
(hasnumeric and (type(val) is type(oldarr([])))):
val = val.tolist()
exec name+' = array('+str(val)+')'
else: exec name+' = '+str(val)
exec 'outlist.append("'+name+'")'
if com == 'exit':
return
try: #if intended for python
exec com
if com.startswith('del '):
names = com.split('del ')[1].strip()
self.delete(names)
return
if com.count('='):
name = com.split('=')[0].strip()
if not name.count('['):
outlist.append(name)
except:
try: #if intended for gracePlot
exec 'self.session.'+com
except:
try: #if intended for grace
self.session._send(com)
except: #is unknown command
raise "CommandError", com
for name in outlist: #use outlist to update state variables
if name in locals().keys():
exec 'self._putlocal("'+name+'",locals()["'+name+'"])'
return
def prompt(self):
'''an interactive grace session'''
outlist = []
print "grace interface:"
if self.whos: #print 'put' variables, add to outlist
print "vars="
for name,val in self.whos.items():
# if numerix:
if (type(val) is type(array([]))) or \
(hasnumarray and (type(val) is type(numarr([])))) or \
(hasnumeric and (type(val) is type(oldarr([])))):
val = val.tolist()
exec name+' = array('+str(val)+')'
else: exec name+' = '+str(val)
exec 'print " ","'+name+'"'
exec 'outlist.append("'+name+'")'
while 1:
com = raw_input('grace> ')
## print com
if com == 'exit':
break
elif com == 'exit()':
self.session.exit()
break
else:
try: #if intended for python
exec com
if com.startswith('del '):
names = com.split('del ')[1].strip()
vars = names.split(',')
for var in vars:
self.delete(var.strip())
outlist.remove(var.strip())
if com.count('='):
name = com.split('=')[0].strip()
if not name.count('['):
outlist.append(name)
except:
try: #if intended for gracePlot
exec 'self.session.'+com
except:
try: #if intended for grace
self.session._send(com)
except: #is unknown command
print "CommandError: %s" % com
for name in outlist: #use outlist to update state variables
if name in locals().keys():
exec 'self._putlocal("'+name+'",locals()["'+name+'"])'
return
# elif com.startswith('python('):
# pcom = com[7:-1]
# try:
# exec pcom
# except:
# print "PythonError: %s" % pcom
# elif com.startswith('*'):
# pcom = com[1:]
# try:
# exec 'self.session.'+pcom
# except:
# print "GraceError: %s" % pcom
# else:
# self.session._send(com)
if __name__ == "__main__":
x = range(1,15)
y = []
for i in x:
y.append(i*i)
g = grace()
g.plot(x,y)
g.put('x',x)
g.put('y',y)
g.prompt()
print g.who()
g.exit()