The Pyramid Web Application Development Framework Version 1.2.7 Chris McDonough Contents Front Matteri Copyright, Trademarks, and Attributions iii Typographical Conventionsv Author Introduction vii I Narrative Documentation1 1 Pyramid Introduction3 2 Installing Pyramid 21 3 Application Configuration 29 4 Creating Your First Pyramid Application 33 5 Creating a Pyramid Project 39 6 URL Dispatch 61 7 Views 85 8 Renderers 95 9 Templates 109 10 View Configuration 123 11 Static Assets 137 12 Request and Response Objects 147 13 Sessions 157 14 Using Events 165 15 Environment Variables and .ini File Settings 169 16 Logging 181 17 Paste 189 18 Command-Line Pyramid 193 19 Internationalization and Localization 205 20 Virtual Hosting 223 21 Unit, Integration, and Functional Testing 227 22 Resources 235 23 Much Ado About Traversal 247 24 Traversal 255 25 Security 267 26 Combining Traversal and URL Dispatch 279 27 Using Hooks 289 28 Advanced Configuration 311 29 Extending An Existing Pyramid Application 321 30 Startup 327 31 Thread Locals 331 32 Using the Zope Component Architecture in Pyramid 335 II Tutorials 341 33 ZODB + Traversal Wiki Tutorial 343 34 SQLAlchemy + URL Dispatch Wiki Tutorial 389 35 Converting a repoze.bfg Application to Pyramid 439 36 Running Pyramid on Google’s App Engine 443 37 Running a Pyramid Application under mod_wsgi 449 III API Reference 453 38 pyramid.authorization 455 39 pyramid.authentication 457 40 pyramid.chameleon_text 459 41 pyramid.chameleon_zpt 461 42 pyramid.config 463 43 pyramid.events 465 44 pyramid.exceptions 467 45 pyramid.httpexceptions 469 46 pyramid.i18n 471 47 pyramid.interfaces 473 48 pyramid.location 475 49 pyramid.paster 477 50 pyramid.registry 479 51 pyramid.renderers 481 52 pyramid.request 483 53 pyramid.response 485 54 pyramid.scripting 487 55 pyramid.security 489 56 pyramid.settings 491 57 pyramid.testing 493 58 pyramid.threadlocal 495 59 pyramid.traversal 497 60 pyramid.url 499 61 pyramid.view 501 62 pyramid.wsgi 503 IV Glossary and Index 505 Glossary 507 Front Matter Copyright, Trademarks, and Attributions The Pyramid Web Application Development Framework, Version 1.1 by Chris McDonough Copyright © 2008-2011, Agendaless Consulting. ISBN-10: 0615445675 ISBN-13: 978-0615445670 First print publishing: February, 2011 All rights reserved. This material may be copied or distributed only subject to the terms and conditions set forth in the Creative Commons Attribution-Noncommercial-Share Alike 3.0 United States License. You must give the original author credit. You may not use this work for commercial purposes. If you alter, transform, or build upon this work, you may distribute the resulting work only under the same or similar license to this one. While the Pyramid documentation is offered under the Creative Commons Attribution- Nonconmmercial-Share Alike 3.0 United States License, the Pyramid software is offered under a less restrictive (BSD-like) license. All terms mentioned in this book that are known to be trademarks or service marks have been appropri- ately capitalized. However, use of a term in this book should not be regarded as affecting the validity of any trademark or service mark. Every effort has been made to make this book as complete and as accurate as possible, but no warranty or fitness is implied. The information provided is on as “as-is” basis. The author and the publisher shall have neither liability nor responsibility to any person or entity with respect to any loss or damages arising from the information contained in this book. No patent liability is assumed with respect to the use of the information contained herein. iii Attributions Editor: Casey Duncan Contributors: Ben Bangert, Blaise Laflamme, Rob Miller, Mike Orr, Carlos de la Guardia, Paul Everitt, Tres Seaver, John Shipman, Marius Gedminas, Chris Rossi, Joachim Krebs, Xavier Spriet, Reed O’Brien, William Chambers, Charlie Choiniere, Jamaludin Ahmad, Graham Higgins, Patricio Paez, Michael Merickel, Eric Ongerth, Niall O’Higgins, Christoph Zwerschke, John Anderson, Atsushi Odagiri, Kirk Strauser, JD Navarro, Joe Dallago, Savoir-Faire Linux, Łukasz Fidosz, Christopher Lambacher, Claus Conrad, Chris Beelby, Phil Jenvey and a number of people with only psuedonyms on GitHub. Cover Designer: Hugues Laflamme of Kemeneur. Used with permission: The Request and Response Objects chapter is adapted, with permission, from documentation originally written by Ian Bicking. The Much Ado About Traversal chapter is adapted, with permission, from an article written by Rob Miller. The Logging is adapted, with permission, from the Pylons documentation logging chapter, originally written by Phil Jenvey. Print Production The print version of this book was produced using the Sphinx documentation generation system and the LaTeX typesetting system. Contacting The Publisher Please send documentation licensing inquiries, translation inquiries, and other business communications to Agendaless Consulting. Please send software and other technical queries to the Pylons-devel maillist. HTML Version and Source Code An HTML version of this book is freely available via http://docs.pylonsproject.org The source code for the examples used in this book are available within the Pyramid software distribution, always available via https://github.com/Pylons/pyramid iv Typographical Conventions Literals, filenames and function arguments are presented using the following style: argument1 Warnings, which represent limitations and need-to-know information related to a topic or concept are presented in the following style: This is a warning. Notes, which represent additional information related to a topic or concept are presented in the following style: This is a note. We present Python method names using the following style: pyramid.config.Configurator.add_view() We present Python class names, module names, attributes and global variables using the following style: pyramid.config.Configurator.registry References to glossary terms are presented using the following style: Pylons URLs are presented using the following style: Pylons References to sections and chapters are presented using the following style: Traversal Code and configuration file blocks are presented in the following style: v 1 def foo(abc): 2 pass When a command that should be typed on one line is too long to fit on a page, the backslash \ is used to indicate that the following printed line should actually be part of the command: c:\bigfntut\tutorial> ..\Scripts\nosetests --cover-package=tutorial \ --cover-erase --with-coverage A sidebar, which presents a concept tangentially related to content discussed on a page, is rendered like so: This is a sidebar Sidebar information. vi Author Introduction Welcome to “The Pyramid Web Application Framework”. In this introduction, I’ll describe the audience for this book, I’ll describe the book content, I’ll provide some context regarding the genesis of Pyramid, and I’ll thank some important people. I hope you enjoy both this book and the software it documents. I’ve had a blast writing both. Audience This book is aimed primarily at a reader that has the following attributes: • At least a moderate amount of Python experience. • A familiarity with web protocols such as HTTP and CGI. If you fit into both of these categories, you’re in the direct target audience for this book. But don’t worry, even if you have no experience with Python or the web, both are easy to pick up “on the fly”. Python is an excellent language in which to write applications; becoming productive in Python is almost mind-blowingly easy. If you already have experience in another language such as Java, Visual Basic, Perl, Ruby, or even C/C++, learning Python will be a snap; it should take you no longer than a couple of days to become modestly productive. If you don’t have previous programming experience, it will be slightly harder, and it will take a little longer, but you’d be hard-pressed to find a better “first language.” Web technology familiarity is assumed in various places within the book. For example, the book doesn’t try to define common web-related concepts like “URL” or “query string.” Likewise, the book describes various interactions in terms of the HTTP protocol, but it does not describe how the HTTP protocol works in detail. Like any good web framework, though, Pyramid shields you from needing to know most of the gory details of web protocols and low-level data structures. As a result, you can usually avoid becoming “blocked” while you read this book even if you don’t yet deeply understand web technologies. vii Book Content This book is divided into three major parts: Narrative Documentation This is documentation which describes Pyramid concepts in narrative form, written in a largely conversational tone. Each narrative documentation chapter describes an isolated Pyra- mid concept. You should be able to get useful information out of the narrative chapters if you read them out-of-order, or when you need only a reminder about a particular topic while you’re developing an application. Tutorials Each tutorial builds a sample application or implements a set of concepts with a sample; it then describes the application or concepts in terms of the sample. You should read the tutorials if you want a guided tour of Pyramid. API Reference Comprehensive reference material for every public API exposed by Pyramid. The API doc- umentation is organized alphabetically by module name. The Genesis of repoze.bfg Before the end of 2010, Pyramid was known as repoze.bfg. I wrote repoze.bfg after many years of writing applications using Zope. Zope provided me with a lot of mileage: it wasn’t until almost a decade of successfully creating applications using it that I decided to write a different web framework. Although repoze.bfg takes inspiration from a variety of web frameworks, it owes more of its core design to Zope than any other. The Repoze “brand” existed before repoze.bfg was created.