13

Consider the following code in my WebApp2 application in Google App Engine:

count = 0

class MyHandler(webapp2.RequestHandler):

    def get(self):

        global count
        count = count + 1
        print count

With each refresh of the page, the count increments higher.

I'm coming from the PHP world where every request was a new global environment. What I understand to be happening here is, because I'm using the wsgi configuration for WebApp2, Python does not kick off a new process on each request. If I was using a cgi configuration, on the other hand, the global environment would re-instantiate each time, like PHP...

Assuming the above is correct (If not, please correct me) ...

  1. How could I handle scenarios where I'd want a global variable that persisted only for the lifetime of the request? I could put an instance variable in the RequestHandler class, but what about things like utility modules that I import that use global vars for things like storing a message object?
  2. Is there some sort of technique to reset all variables, or to force a re-instantiation of the environment?
  3. Does the global environment persist indefinitely, or does it reset itself at some point?
  4. Is any of this GAE specific, or does wsgi global persistance work the same in any server scenario?

EDIT:

Here's an attempt using threadlocal:

count = 0

mydata = threading.local()
mydata.count = 0

class MyHandler(webapp2.RequestHandler):

    def get(self):

        global count
        count = count + 1
        print count

        mydata.count = mydata.count + 1
        print mydata.count

These also increment across requests

Yarin
  • 173,523
  • 149
  • 402
  • 512
  • Is there a specific reason you are trying to store global data outside of the datastore? It seems like what you are attempting could be accomplished more easily with a [sharded counter](http://code.google.com/appengine/articles/sharding_counters.html). – Kevin P Nov 17 '11 at 18:26
  • @Kevin- that count variable was just an example- my actual case is something else entirely - I'm just trying to understand the global scope within the application domain. – Yarin Nov 17 '11 at 20:05
  • Related [Why does Pylons use StackedObjectProxies instead of threading.local?](http://stackoverflow.com/q/1686768/95735) – Piotr Dobrogost Nov 06 '15 at 22:44

3 Answers3

17

Your understanding is correct. If you want variables that persist for the duration of the request, you shouldn't make them globals at all - make them instance variables on your RequestHandler class, accessed as self.var. Since a new RequestHandler is instantiated for each request, your variables will stick around exactly as long as you need them to. Global variables are best avoided unless you really do need global (as opposed to request-specific) scope.

Also note that your App Engine app will run on multiple servers; globals are only accessible to requests inside the same server.

Nick Johnson
  • 100,655
  • 16
  • 128
  • 198
5

Your analysis of the situation is correct, a Python web app is a long-running process. It takes a long time to spin up the Python interpreter and is not done every request.

It's entirely possible to create a global variable that is different "per-request". This is done in a lot of frameworks and people seem to like it. The way to do this does depend on the server. Most servers use "one thread per request", and I think GAE does as well. If this is the case you can use a threadlocal variable. If you are worried about this value sticking around between requests on that thread, you will need some management code that can hook to the start/end of a request. WSGI middleware is a good place for this if the WebApp2 framework doesn't provide a nice way to do it.

It's just Python, and a request is served in its own thread. From there you can do what you'd like. There's nothing in Python to just reset all the global variables, and there's generally no guarantee (especially with GAE) that the process serving your request will be the same process everytime, meaning your globals shouldn't be used to persist data between requests unless you really know what you're doing.

There are many frameworks out there that provide good support for doing this already, so if WebApp2 doesn't then I'd suggest looking elsewhere. Python has a lot of options and many of them do run on GAE.

Michael Merickel
  • 23,153
  • 3
  • 54
  • 70
  • thanks. Could you please see my edits- I tried threading.local(), but that count increments just like my global. Am I implementing it right? – Yarin Nov 17 '11 at 17:49
  • Your requests are likely coming in on the same thread. Most WSGI servers are implemented using a thread pool, so it is not necessarily a *new* thread per request. I am not familiar with the inner workings of how GAE servers WSGI apps either, but this is what I'd expect. – Michael Merickel Nov 17 '11 at 20:12
2

In the case of your first question I think you might consider the webapp2.Request.registry feature. It's a dict to store instances that diferent modules can share during the lifetime of the request.

On the other hand it is also useful the webapp2.WSGIApplication.registry. In this case the instances persist between requests and can be shared (and reused) for whatever your app need during the lifetime of your application, avoiding creating instances on the global scope.

jumc
  • 57
  • 3