Differences between revisions 17 and 48 (spanning 31 versions)
Revision 17 as of 2007-01-31 07:09:37
Size: 2634
Editor: BTNL-TN-DSL-dynamic-151
Comment:
Revision 48 as of 2014-04-16 06:53:27
Size: 5090
Comment: update link to python 2 & 3 .How does one edit "Immutable Page"'s
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
#pragma section-numbers off
= CGI Scripts =
= CGI (Common Gateway Interface) Scripts =
Line 4: Line 3:
The [http://www.python.org/doc/current/lib/module-cgi.html cgi module] is at the core of the Python CGI scripts.
Line 6: Line 4:
Basically, you just need to print out an HTTP header ("Content-type: text/html"), a web page, and handle any forms you may have received. The '''cgi module''' is part of the core library of Python.
 * [[https://docs.python.org/2/library/cgi.html|cgi module (Python 2.x)]]
 * [[https://docs.python.org/3/library/cgi.html|cgi module (Python 3.x)]]
Line 8: Line 8:
Getting Apache's permissions just right can be annoying, and is sadly beyond this page's scope.
The simplest CGI script that can be considered interesting involves printing out an HTTP header ("Content-type: text/html") and a Web page. In addition, you might want to handle any incoming inputs from things like HTML forms or request parameters. In the earliest days of CGI, shell scripts were sometimes used to do things like this, so the principles are not particularly advanced.


== Configuration ==
It can be an annoying experience getting the permissions just right on a script so that Web servers like Apache will run it, but the following checklist may be of some use:


 1. Find out which user runs the Web server - it's not often the same one as your own user, and it may be one with very limited permissions.
 1. Check the server configuration to see if it lets you run scripts in a particular directory. Make sure that if you're using a configuration file for a particular directory, the global configuration permits you to define CGI script directories in that directory-local configuration file - some sites stop their users from altering such settings in such a way.
 1. Check the permissions from the top of the filesystem down to the directory where the script resides. The Web server user must be able to read and open/execute all the directories from the top right down to the script.
 1. Make sure your script is readable and executable by the Web server user.
 1. Make sure that the first line of the script refers to an interpreter that the Web server user can run. Things like {{{/usr/bin/env python}}} might not have any meaning to the Web server user because the {{{python}}} program may not be on the user's {{{PATH}}}.


In addition you should make sure your script has the correct **line endings** for your server.
Line 11: Line 27:
The following code attempts to combine simple output of a Web page with the processing of input from users viewing the page. You may wish to choose the actual first line of the script based on one of the first two lines provided below - the first one for Windows and dependent on the Python install path, whereas the second may only work on UNIX-like systems.
Line 12: Line 29:
{{{
#!python

{{{#!python
#!C:\Python27\python.exe -u
Line 39: Line 57:
  <p>form:</p>   <p>form
Line 48: Line 66:
""" % message """ % cgi.escape(message)
Line 50: Line 68:

Line 53: Line 73:
 * [http://www.python.org/doc/current/lib/module-cgi.html cgi module documentation]
 * [http://www.python.org/doc/current/lib/module-Cookie.html Cookie module documentation]
 * [http://webpython.codepoint.net/ Python CGI tutorial] - setup in a shared host, forms, debug, shell commands, cookies, etc
 * [http://www.cs.virginia.edu/~lab2q/lesson_7/ python CGI tutorial] - w/ hints about maintaining sessions either through forms or through cookies
 * [http://gnosis.cx/publish/programming/feature_5min_python.html python CGI tutorial] - w/ hints about printing out tracebacks
 * [http://www.python.org/doc/current/lib/internet.html other internet protocol module documentation]
 * [http://www.devshed.com/index2.php?option=content&task=view&id=198&pop=1&page=0&hide_js=1 Writing CGI Scripts in Python]
 * [http://www.voidspace.org.uk/python/cgi.shtml Voidspace Python CGI collection] - Working Python CGI scripts to use and/or study
 * [[WebProgramming|WebProgramming]] - the natural next step beyond simple CGI scripts.
 * [[http://www.python.org/doc/current/lib/module-cgi.html|cgi module documentation]]
 * [[http://www.python.org/doc/current/lib/module-Cookie.html|Cookie module documentation]]
 * [[http://webpython.codepoint.net/|Python CGI tutorial]] - setup in a shared host, forms, debug, shell commands, cookies, etc
 * [[http://www.cs.virginia.edu/~lab2q/lesson_7/|python CGI tutorial]] - w/ hints about maintaining sessions either through forms or through cookies
 * [[http://gnosis.cx/publish/programming/feature_5min_python.html|python CGI tutorial]] - w/ hints about printing out tracebacks
 * [[http://www.python.org/doc/current/lib/internet.html|other internet protocol module documentation]]
 * [[http://www.devshed.com/index2.php?option=content&task=view&id=198&pop=1&page=0&hide_js=1|Writing CGI Scripts in Python]]
 * [[http://www.voidspace.org.uk/python/cgi.shtml|Voidspace Python CGI collection]] - Working Python CGI scripts to use and/or study
Line 62: Line 83:
= Discussion =
Line 64: Line 84:
  We need a good python CGI framework - Sridhar R
    Nevow and [http://srid.bsdnerds.org/hacking/wallaby/ Wallaby]

    Define "framework," though. Do you mean something like a Django-type deal or something that just makes it easier to write CGI apps?
Line 70: Line 86:
Yes.... == Discussion ==
Line 72: Line 88:
There are many frameworks for Python Web Application
TurboGears danjo Zope ModPython Pso Aquarium Cheetah ++++++...
Line 75: Line 89:
But it would be Nice if python provides native support for
Session Handling,
JSON - like XML-RPC
Standard Environment for RPC + WSGI
and future technologies.... for Easy Web Development
 . We need a good python CGI framework - Sridhar R
  .
  Nevow and [[http://srid.bsdnerds.org/hacking/wallaby/|Wallaby]] Define "framework," though. Do you mean something like a Django-type deal or something that just makes it easier to write CGI apps?




----

Yes....


There are many frameworks for Python Web Application [[TurboGears|TurboGears]] Django Zope [[ModPython|ModPython]] Pso Aquarium Cheetah ++++++...


But it would be Nice if python provides native support for Session Handling, JSON - like XML-RPC Standard Environment for RPC + WSGI and future technologies.... for Easy Web Development
Line 83: Line 109:
CategoryPythonWebsite CategoryLanguage
Many shared hosting servers do not allow persistent processes. They kill a script if it runs for more than 3 minutes. This frameworks do not explain (or make life easier) for someone who as only cgi and ftp. Do you know any way to code easier/faster in this circumstances ? Osvaldo

----
CategoryPythonWebsite

CGI (Common Gateway Interface) Scripts

The cgi module is part of the core library of Python.

The simplest CGI script that can be considered interesting involves printing out an HTTP header ("Content-type: text/html") and a Web page. In addition, you might want to handle any incoming inputs from things like HTML forms or request parameters. In the earliest days of CGI, shell scripts were sometimes used to do things like this, so the principles are not particularly advanced.

Configuration

It can be an annoying experience getting the permissions just right on a script so that Web servers like Apache will run it, but the following checklist may be of some use:

  1. Find out which user runs the Web server - it's not often the same one as your own user, and it may be one with very limited permissions.
  2. Check the server configuration to see if it lets you run scripts in a particular directory. Make sure that if you're using a configuration file for a particular directory, the global configuration permits you to define CGI script directories in that directory-local configuration file - some sites stop their users from altering such settings in such a way.
  3. Check the permissions from the top of the filesystem down to the directory where the script resides. The Web server user must be able to read and open/execute all the directories from the top right down to the script.
  4. Make sure your script is readable and executable by the Web server user.
  5. Make sure that the first line of the script refers to an interpreter that the Web server user can run. Things like /usr/bin/env python might not have any meaning to the Web server user because the python program may not be on the user's PATH.

In addition you should make sure your script has the correct **line endings** for your server.

Sample Code

The following code attempts to combine simple output of a Web page with the processing of input from users viewing the page. You may wish to choose the actual first line of the script based on one of the first two lines provided below - the first one for Windows and dependent on the Python install path, whereas the second may only work on UNIX-like systems.

   1 #!C:\Python27\python.exe -u
   2 #!/usr/bin/env python
   3 
   4 import cgi
   5 import cgitb; cgitb.enable()  # for troubleshooting
   6 
   7 print "Content-type: text/html"
   8 print
   9 
  10 print """
  11 <html>
  12 
  13 <head><title>Sample CGI Script</title></head>
  14 
  15 <body>
  16 
  17   <h3> Sample CGI Script </h3>
  18 """
  19 
  20 form = cgi.FieldStorage()
  21 message = form.getvalue("message", "(no message)")
  22 
  23 print """
  24 
  25   <p>Previous message: %s</p>
  26 
  27   <p>form
  28 
  29   <form method="post" action="index.cgi">
  30     <p>message: <input type="text" name="message"/></p>
  31   </form>
  32 
  33 </body>
  34 
  35 </html>
  36 """ % cgi.escape(message)

See Also


Discussion

  • We need a good python CGI framework - Sridhar R
    • Nevow and Wallaby Define "framework," though. Do you mean something like a Django-type deal or something that just makes it easier to write CGI apps?


Yes....

There are many frameworks for Python Web Application TurboGears Django Zope ModPython Pso Aquarium Cheetah ++++++...

But it would be Nice if python provides native support for Session Handling, JSON - like XML-RPC Standard Environment for RPC + WSGI and future technologies.... for Easy Web Development

-Vinoth vinoth.3v@gmail.com

Many shared hosting servers do not allow persistent processes. They kill a script if it runs for more than 3 minutes. This frameworks do not explain (or make life easier) for someone who as only cgi and ftp. Do you know any way to code easier/faster in this circumstances ? Osvaldo


CategoryPythonWebsite

CgiScripts (last edited 2014-04-16 06:53:27 by DaleAthanasias)

Unable to edit the page? See the FrontPage for instructions.