Home       Trees       Indices       Help   
web2py Web Framework
Package web2py :: Package gluon :: Module shell
[hide private]
[frames] | no frames]

Module shell

source code

This file is part of the web2py Web Framework Developed by Massimo Di Pierro <mdipierro@cs.depaul.edu>, limodou <limodou@gmail.com> and srackham <srackham@gmail.com>. License: LGPLv3 (http://www.gnu.org/licenses/lgpl.html)

Functions [hide private]
 
exec_environment(pyfile='', request=1, response=1, session=1)
..		 source code
 
env(a, import_models=True, c=1, f=1, dir='', extra_request={})
Return web2py execution environment for application (a), controller (c), function (f).		 source code
 
exec_pythonrc() source code
 
run(appname, plain=True, import_models=True, startfile=1, bpython=True)
Start interactive shell or run Python script (startfile) in web2py controller environment.		 source code
 
parse_path_info(path_info)
Parse path info formatted like a/c/f where c and f are optional and a leading / accepted.		 source code
 
die(msg) source code
 
test(testpath, import_models=True, verbose=True)
Run doctests in web2py environment.		 source code
 
get_usage() source code
 
execute_from_command_line(argv=1) source code
Variables [hide private]
  logger = logging.getLogger("web2py")
Function Details [hide private]

exec_environment(pyfile='', request=1, response=1, session=1)

source code  

.. function:: gluon.shell.exec_environment([pyfile=''[, request=Request()
    [, response=Response[, session=Session()]]]])

    Environment builder and module loader.


    Builds a web2py environment and optionally executes a Python
    file into the environment.
    A Storage dictionary containing the resulting environment is returned.
    The working directory must be web2py root -- this is the web2py default.

env(a, import_models=True, c=1, f=1, dir='', extra_request={})

source code 

Return web2py execution environment for application (a), controller (c), function (f). If import_models is True the exec all application models into the environment.

extra_request allows you to pass along any extra variables to the request object before your models get executed. This was mainly done to support web2py_utils.test_runner, however you can use it with any wrapper scripts that need access to the web2py environment.

run(appname, plain=True, import_models=True, startfile=1, bpython=True)

source code 

Start interactive shell or run Python script (startfile) in web2py controller environment. appname is formatted like:

a web2py application name a/c exec the controller c into the application environment

parse_path_info(path_info)

source code 
Parse path info formatted like a/c/f where c and f are optional and a leading / accepted. Return tuple (a, c, f). If invalid path_info a is set to None. If c or f are omitted they are set to None.

test(testpath, import_models=True, verbose=True)

source code 

Run doctests in web2py environment. testpath is formatted like:

a tests all controllers in application a a/c tests controller c in application a a/c/f test function f in controller c, application a

Where a, c and f are application, controller and function names respectively. If the testpath is a file name the file is tested. If a controller is specified models are executed by default.

   Home       Trees       Indices       Help   
web2py Web Framework
Generated by Epydoc 3.0beta1 on Thu Aug 4 00:46:59 2011 http://epydoc.sourceforge.net