From: Zooko O'Whielacronx Date: Fri, 15 Aug 2008 17:22:34 +0000 (-0700) Subject: setup: doc string describing what the require_auto_deps() function is for X-Git-Url: https://git.rkrishnan.org/pf/content/en/service/module-simplejson.tests.html?a=commitdiff_plain;h=bb71a8ee3b49aa2ad5aaa85c21ffe3d44e078ad6;p=tahoe-lafs%2Ftahoe-lafs.git setup: doc string describing what the require_auto_deps() function is for --- diff --git a/_auto_deps.py b/_auto_deps.py index ee3a3eb5..0712ec02 100644 --- a/_auto_deps.py +++ b/_auto_deps.py @@ -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: