1. Blaise Laflamme
  2. PylonsWikiNG


PylonsWikiNG / basiclayout.rst

Basic Layout

The starter files generated by the bfg_routesalchemy template are basic, but they provide a good orientation for the high-level patterns common to most :term:`url dispatch` -based :mod:`repoze.bfg` projects.

The source code for this tutorial stage can be browsed at docs.repoze.org.


A directory on disk can be turned into a Python :term:`package` by containing an __init__.py file. Even if empty, this marks a directory as a Python package.

Configuration With configure.zcml

:mod:`repoze.bfg` uses a configuration markup language syntactically the same as Zope's implementation of :term:`ZCML`, but using a different default XML namespace. Our sample ZCML file looks like the following:

  1. Line 1. The root <configure> element, using the http://namespaces.repoze.org/bfg namespace.
  2. Line 4. Boilerplate, the comment explains.
  3. Lines 6-11. Register a <route> :term:`route configuration` that will be used when the URL is /. Since this <route> has an empty path attribute, it is the "default" route. The attribute named view with the value .views.my_view is the dotted name to a function we write (generated by the bfg_routesalchemy template) that is given a request object and which returns a response or a dictionary. You will use mostly <route> statements in a :term:`URL dispatch` based application to map URLs to code. This route also names a view_renderer, which is a template which lives in the templates subdirectory of the package. When the .views.my_view view returns a dictionary, a :term:`renderer` will use this template to create a response.
  4. Lines 13-16. Register a <static> directive that will match any URL that starts with /static/. This will serve up static resources for us, in this case, at http://localhost:6543/static/ and below. With this declaration, we're saying that any URL that starts with /static should go to the static view; any remainder of its path (e.g. the /foo in /static/foo) will be used to compose a path to a static file resource, such as a CSS file.

Content Models with models.py

In a SQLAlchemy-based application, a model object is an object composed by querying the SQL database which backs an application. SQLAlchemy is an "object relational mapper" (an ORM). The models.py file is where the bfg_routesalchemy Paster template put the classes that implement our models.

Here is the source for models.py:

  1. Lines 1-16. Imports to support later code.
  2. Line 18. We set up a SQLAlchemy "DBSession" object here. We specify that we'd like to use the "ZopeTransactionExtension". This extension is an extension which allows us to use a transaction manager instead of controlling commits and aborts to database operations by hand.
  3. Line 21. Set up a SQLAlchemy metadata object.
  4. Lines 23-25. A model class named Model. It has an __init__ that takes a single argument (name). It stores a single attribute named name.
  5. Lines 27-32. A SQLAlchemy Table declaration named models_table which we'll use later to map onto our Model class.
  6. Line 34. We map our models_table table to our Models class here. This makes an association between the Model class and the models table in the database, as far as SQLAlchemy is concerned.
  7. Lines 36-41. A function named populate which adds a single model instance into our SQL storage and commits a transaction.
  8. Lines 43-51. A function named initialize_sql which sets up an actual SQL database and binds it to our SQLAlchemy DBSession object. It also calls the populate function, to do initial database population.

App Startup with run.py

When you run the application using the paster command using the tutorial.ini generated config file, the application configuration points at an Setuptools entry point described as egg:tutorial#app. In our application, because the application's setup.py file says so, this entry point happens to be the app function within the file named run.py:

  1. Lines 1-3. Imports to support later code.
  2. Lines 11-14. Get the database configuration string from the tutorial.ini file's [app:sql] section. This will be a URI (something like sqlite://).
  3. Line 15. We initialize our SQL database using SQLAlchemy, passing it the db string.
  4. Line 16. We construct a :term:`Configurator`. settings is passed as a keyword argument with the dictionary values passed by PasteDeploy as the settings argument. This will be a dictionary of settings parsed by PasteDeploy, which contains deployment-related values such as reload_templates, db_string, etc.
  5. Lines 17-20. We then load a ZCML file to do application configuration, and use the :meth:`repoze.bfg.configuration.Configurator.make_wsgi_app` method to return a :term:`WSGI` application.