Configuration¶
Introduction¶
When you use a Morepath directive, for example to define a view, a path, a setting or a tween, this is called Morepath configuration. Morepath configuration can also be part of third-party code you want to use.
How it works¶
Morepath needs to run the necessary configuration steps before it can
serve WSGI requests. You can do this explicitly by running
morepath.App.commit()
:
if __name__ == '__main__':
App.commit()
application = App()
morepath.run(application)
When you import modules, Morepath registers any directive you used in
modules that you have imported, directly or indirectly, with the
App
subclass you used it on.
Calling commit
on the App class then commits that app class and
any app classes it mounts. After this, the application can be run. The
commit procedure makes sure there are no conflicting pieces of
configuration and resolves any configuration overrides.
You can actually omit App.commit()
if you want to. In this case
the first request served by Morepath also does the commit. This also
means any configuration errors are reported during the first request.
If you prefer seeing configuration errors immediately during startup,
leave the explicit commit
in place.
Scanning a package¶
When you depend on a package that contains Morepath code it is
convenient to be able to recursively import all of it at once. That
way you can’t accidentally forget to import a module and thus have its
directives not be active. You can scan a whole package with
morepath.scan()
:
import my_package
if __name__ == '__main__':
morepath.scan(my_package)
App.commit()
application = App()
morepath.run(application)
All scanning does is recursively import all modules in a package (except for tests directories), nothing more.
Since scanning the current package is common, we have a convenience
shortcut that scan the package the code is in automatically. You use
it by calling morepath.scan()
without arguments:
if __name__ == '__main__':
morepath.scan()
App.commit()
application = App()
morepath.run(application)
You can also use scan()
with packages that contain third-party
Morepath code, but there is an easier way to do that.
Scanning dependencies¶
Morepath is a micro-framework at its core, but you can expand it with other packages that add extra functionality. For instance, you can use more.chameleon for templating or more.transaction for SQLAlchemy integration.
These packages contain their own Morepath configuration, so when we use these packages we need to make sure to scan them too.
Manual scan¶
The most explicit way of scanning your dependencies is a manual scan.
Say you depend on more.jinja2 and you want to extend the the first example.
This is what you do:
import more.jinja2
if __name__ == '__main__':
morepath.scan(more.jinja2) # scan Jinja2 package
morepath.scan() # scan this package
App.commit()
application = App()
morepath.run(application)
As you can see, you need to import your dependency and scan it using
scan()
. If you have more dependencies, just add them in this
fashion.
Automatic scan¶
Manual scanning can get tedious and error-prone as you need to add each and every new dependency that you rely on.
You can use autoscan()
instead, which scans all
packages that have a dependency on Morepath declared. Let’s look at a
modified example that uses autoscan
:
if __name__ == '__main__':
morepath.autoscan()
morepath.scan()
App.commit()
application = App()
morepath.run(application)
As you can see, we also don’t need to import or scan dependencies
anymore. We still need to run scan()
without parameters
however, so our own package or module gets scanned.
If you move your code into a proper Python project that depends on
Morepath you can also get rid of the morepath.scan()
line by
itself. The setup.py
of your project then looks like this:
setup(name='myapp',
packages=find_packages(),
install_requires=[
'more.jinja2',
'morepath'
])
with the code in a Python package called myapp
(a directory
with an __init__.py
file in it).
See Organizing your Project for a lot more information on how to do this, including tips on how to best organize your Python code.
Once you put your code in a Python project with a setup.py
, you can
simplify the setup code to this:
if __name__ == '__main__':
morepath.autoscan()
App.commit()
morepath.run(App())
morepath.autoscan()
makes sure to scan all packages that
depend on Morepath directly or indirectly.
Writing scannable packages¶
A Morepath scannable Python package has to fulfill a few requirements.
The package must be made available using a
setup.py
file.See Organizing your Project and the Setuptool’s documentation for more information.
The package itself or a dependency of the package must include
morepath
in theinstall_requires
list of thesetup.py
file.Morepath only scans package that depend directly or indirectly on Morepath. It filters out packages which in no way depend on Morepath. So if your package has any Morepath configuration, you need to add
morepath
toinstall_requires
:setup(name='myapp' ... install_requires=[ 'morepath' ])
If you set up your dependencies up correctly using
install_requires
this should be there anyway, or be a dependency of another dependency that’s ininstall_requires
. Morepath just uses this information to do its scan.The Python project name in
setup.py
should have the same name as the Python package name, or you use entry points to declare what should be scanned.Scan using naming convention:
The project name defined by
setup.py
can be imported in Python as well: they have the same name. For example: if the project name ismyapp
, the package that contains your code must be namedmyapp
as well. (notmy-app
orMyApp
orElephant
):So if you have a
setup.py
like this:setup( name='myapp', packages=find_packages(), ...
you should have a project directory structure like this:
setup.py myapp __init__.py another_module.py
In other words, the project name
myapp
can be imported:import myapp
If you use a namespace package, you include the full name in the
setup.py
:setup( name='my.app' packages=find_packages() namespace_packages=['my'] ...
This works with a project structure like this:
setup.py my __init__.py app __init__.py another_module.py
We recommend you use this naming convention as your Python projects get a consistent layout. But you don’t have to – you can use entry points too.
Scan entry points:
If for some reason you want a project name that is different from the package name you can still get it scanned automatically by Morepath. In this case you need to explicitly tell Morepath what to scan with an entry point in
setup.py
:setup(name='elephant' ... entry_points={ 'morepath': [ 'scan = my.package' ] }
Note that you still need to have
morepath
in theinstall_requires
list for this to work.