webapp2 Web Framework

Common errors

• ImportError: No module named webapp2

  cause The webapp2 library is not installed in your current Python environment or is not found by the Google App Engine development server.
  fix Run `pip install webapp2` in your environment. If using Google App Engine, ensure `libraries:` section in `app.yaml` is correctly configured or that `webapp2` is in your `lib` directory for vendored libraries.

• 500 Internal Server Error (when running a webapp2 application)

  cause This is a generic error indicating an unhandled exception occurred within your webapp2 `RequestHandler` method (e.g., `get`, `post`). The actual traceback is hidden by default in production.
  fix Set `debug=True` in your `webapp2.WSGIApplication` initialization (e.g., `debug=True`) to see the full traceback in development. Log errors extensively and use `try...except` blocks in your handlers to catch and handle specific exceptions.

• TypeError: unsupported operand type(s) for +: 'unicode' and 'str' (or similar Unicode/byte string errors)

  cause In Python 2, mixing `str` (byte strings) and `unicode` objects without explicit encoding/decoding operations can lead to `TypeError` or `UnicodeEncodeError`/`UnicodeDecodeError`.
  fix Ensure consistent handling of string types. For web responses, always encode text to a byte string (e.g., `my_unicode_string.encode('utf-8')`) or ensure all output is unicode. For input, decode byte strings to unicode (e.g., `request.get('param').decode('utf-8')`). Use `u'...'` literals for unicode strings.

Warnings

• breaking webapp2 is exclusively compatible with Python 2. It does not support Python 3, making it unsuitable for modern Python development environments. Attempts to run it on Python 3 will result in syntax errors or compatibility issues.
  Fix: For new projects or migration, consider modern Python 3 frameworks like Flask or Django, which are actively maintained and supported on Google App Engine's flexible or standard environment (Python 3).
• breaking The webapp2 library is no longer actively maintained. This means there will be no new features, bug fixes, or security patches. Using unmaintained software can pose significant security risks and lead to unresolvable issues.
  Fix: It is strongly recommended to use actively maintained web frameworks for any new or critical applications to ensure security, stability, and ongoing support. Migrate existing webapp2 applications to supported frameworks.
• gotcha webapp2 is tightly coupled with the Google App Engine Python 2 Standard Environment. Running it outside this environment, especially without proper WSGI server setup (like `gunicorn` with a custom server wrapper or the GAE dev server), can be complex and is not its primary use case.
  Fix: If running locally for development, use the Google App Engine SDK's development server (`dev_appserver.py`). For deployment, ensure your `app.yaml` correctly points to your `webapp2.WSGIApplication` instance within the GAE Python 2 runtime.

Install

• pip install webapp2 Install via pip

Imports

• RequestHandler

  import webapp2

• WSGIApplication

  import webapp2

Quickstart

This quickstart demonstrates a basic 'Hello, webapp2!' application using a single request handler and a WSGIApplication setup. This code would typically be run within a Google App Engine Python 2 standard environment.

import webapp2

class MainPage(webapp2.RequestHandler):
    def get(self):
        self.response.headers['Content-Type'] = 'text/plain'
        self.response.write('Hello, webapp2!')

app = webapp2.WSGIApplication([
    ('/', MainPage),
], debug=True)

# To run locally with GAE dev server:
# In your app.yaml (or similar) point to this file:
# handlers:
# - url: /.* 
#   script: main.app