From f3635ae75c80176d7bc207fd783b51f95543b7af Mon Sep 17 00:00:00 2001 From: David Halter Date: Wed, 6 Feb 2013 18:20:57 +0100 Subject: [PATCH] imports docstring --- jedi/imports.py | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/jedi/imports.py b/jedi/imports.py index d53d8328..a7739e27 100644 --- a/jedi/imports.py +++ b/jedi/imports.py @@ -1,3 +1,18 @@ +""" +:mod:`imports` is here to resolve import statements and return the +modules/classes/functions/whatever, which they stand for. However there's not +any actual importing done. This module is about finding modules in the +filesystem. This can be quite tricky sometimes, because Python imports are not +always that simple. + +Currently the import process uses ``imp`` to find modules. In the future, it's +a goal to use ``importlib`` for this purpose. There's a `pull request +`_ for that. + +This module also supports import autocompletion, which means to complete +statements like ``from datetim`` (curser at the end would return ``datetime``). +""" + from __future__ import with_statement import os