setup: doc string describing what the require_auto_deps() function is for

This commit is contained in:
Zooko O'Whielacronx 2008-08-15 10:22:34 -07:00
parent eb695f1c58
commit bb71a8ee3b

View File

@ -20,6 +20,13 @@ if hasattr(sys, 'frozen'):
install_requires=[]
def require_auto_deps():
"""
The purpose of this function is to raise a pkg_resources exception if any of the
requirements can't be imported. This is just to give earlier and more explicit error
messages, as opposed to waiting until the source code tries to import some module from one
of these packages and gets an ImportError. This function gets called from
src/allmydata/__init__.py .
"""
import pkg_resources
for requirement in install_requires:
try: