numpy.numarray.session
index
/usr/lib/python2.6/dist-packages/numpy/numarray/session.py

This module contains a "session saver" which saves the state of a
NumPy session to a file.  At a later time, a different Python
process can be started and the saved session can be restored using
load().
 
The session saver relies on the Python pickle protocol to save and
restore objects.  Objects which are not themselves picklable (e.g.
modules) can sometimes be saved by "proxy",  particularly when they
are global constants of some kind.  If it's not known that proxying
will work,  a warning is issued at save time.  If a proxy fails to
reload properly (e.g. because it's not a global constant),  a warning
is issued at reload time and that name is bound to a _ProxyFailure
instance which tries to identify what should have been restored.
 
First, some unfortunate (probably unnecessary) concessions to doctest
to keep the test run free of warnings.
 
>>> del _PROXY_ALLOWED
>>> del __builtins__
 
By default, save() stores every variable in the caller's namespace:
 
>>> import numpy as na
>>> a = na.arange(10)
>>> save()
 
Alternately,  save() can be passed a comma seperated string of variables:
 
>>> save("a,na")
 
Alternately,  save() can be passed a dictionary, typically one you already
have lying around somewhere rather than created inline as shown here:
 
>>> save(dictionary={"a":a,"na":na})
 
If both variables and a dictionary are specified, the variables to be
saved are taken from the dictionary.
 
>>> save(variables="a,na",dictionary={"a":a,"na":na})
 
Remove names from the session namespace
 
>>> del a, na
 
By default, load() restores every variable/object in the session file
to the caller's namespace.
 
>>> load()
 
load() can be passed a comma seperated string of variables to be
restored from the session file to the caller's namespace:
 
>>> load("a,na")
 
load() can also be passed a dictionary to *restore to*:
 
>>> d = {}
>>> load(dictionary=d)
 
load can be passed both a list variables of variables to restore and a
dictionary to restore to:
 
>>> load(variables="a,na", dictionary=d)
 
>>> na.all(a == na.arange(10))
1
>>> na.__name__
'numpy'
 
NOTE:  session saving is faked for modules using module proxy objects.
Saved modules are re-imported at load time but any "state" in the module
which is not restored by a simple import is lost.

 
Modules
       
pickle
sys

 
Classes
       
object
_ModuleProxy
_ObjectProxy
_SaveSession
RuntimeError(StandardError)
ObjectNotFound
_ProxyingFailure

 
class ObjectNotFound(RuntimeError)
    
Method resolution order:
ObjectNotFound
RuntimeError
StandardError
Exception
BaseException
object

Data descriptors defined here:
__weakref__
list of weak references to the object (if defined)

Methods inherited from RuntimeError:
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Data and other attributes inherited from RuntimeError:
__new__ = <built-in method __new__ of type object at 0x811c40>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)
__str__(...)
x.__str__() <==> str(x)
__unicode__(...)

Data descriptors inherited from BaseException:
__dict__
args
message

 
class _ModuleProxy(object)
    Proxy object which fakes pickling a module
 
  Methods defined here:
__getnewargs__(self)
__getstate__(self)

Static methods defined here:
__new__(_type, name, save=False)

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class _ObjectProxy(object)
    Proxy object which fakes pickling an arbitrary object.  Only global
constants can really be proxied.
 
  Methods defined here:
__getnewargs__(self)
__getstate__(self)

Static methods defined here:
__new__(_type, module, name, _type2, save=False)

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class _ProxyingFailure
    Object which is bound to a variable for a proxy pickle which failed to reload
 
  Methods defined here:
__init__(self, module, name, type=None)
__repr__(self)

 
class _SaveSession(object)
    Tag object which marks the end of a save session and holds the
saved session variable names as a list of strings in the same
order as the session pickles.
 
  Methods defined here:
__getnewargs__(self)
__getstate__(self)

Static methods defined here:
__new__(_type, keys, save=False)

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
Functions
       
_caller()
caller() returns the frame object of the function's caller.
_callers_globals()
callers_globals() returns the global dictionary of the caller.
_callers_modules()
returns a list containing the names of all the modules in the caller's
global namespace.
_errout(*args)
_foo()
_loadmodule(module)
_locate(modules, object)
_unknown(_type)
returns True iff _type isn't known as OK to proxy
_update_proxy_types()
Suppress warnings for known un-picklables with working proxies.
_verbose(*args)
load(variables=None, file='session.dat', dictionary=None, verbose=False)
load a numpy session from a file and store the specified
'variables' into 'dictionary'.
 
'variables'       a string of comma seperated variables: e.g. "a,b,c"
                  Defaults to dictionary.keys().
 
'file'            a filename or file object for the session file.
 
'dictionary'      the dictionary in which to look up the variables.
                  Defaults to the caller's globals()
 
'verbose'         print additional debug output when True.
save(variables=None, file='session.dat', dictionary=None, verbose=False)
saves variables from a numpy session to a file.  Variables
which won't pickle are "proxied" if possible.
 
'variables'       a string of comma seperated variables: e.g. "a,b,c"
                  Defaults to dictionary.keys().
 
'file'            a filename or file object for the session file.
 
'dictionary'      the dictionary in which to look up the variables.
                  Defaults to the caller's globals()
 
'verbose'         print additional debug output when True.
test()

 
Data
        SAVEFILE = 'session.dat'
VERBOSE = False
_PROXY_ALLOWED = (<type 'module'>, <type 'function'>, <type 'NoneType'>)
__all__ = ['load', 'save']
__file__ = '/usr/lib/python2.6/dist-packages/numpy/numarray/session.pyc'
__name__ = 'numpy.numarray.session'
__package__ = 'numpy.numarray'