FooFinder 3.0.60

A package designed to help you find foo.

A package designed to help you find foo. FooFinder makes relative imports easy with this one simple trick!

---

Installation:

pip install FooFinder

Usage:

ParentFolder/
    MySuperAwesomeModule.py                 <- and you want to import this awesome module
    SubFolder1/
        SubFolder2/
            CurrentModule.py           <- you are here

from FooFinder import MySuperAwesomeModule

---

FooFinder will walk up to each parent directory, and down to each child directory, from the location of your current module. FooFinder will import and return the first module or package that it finds with the name you give it.

---

Other ways to use FooFinder:

Using a namespace:

from FooFinder import CoolStuff as SuperCoolStuff

Finding a downstream module:

ParentFolder/
    CurrentModule.py                   <- you are here
    SubFolder1/
        SubFolder2/
            DownstreamModule.py             <- and you want to import this downstream module

from FooFinder import DownstreamModule

Importing a package:

ParentPackage/
    __init__.py                                <- and you want to import this parent package
    SubFolder1/
	NeighboringPackage/	               <- and this neighboring package
	    __init__.py
        SubFolder2/
	    SubFolder3/
		DownstreamPackage/	       <- and this downstream package
		    __init__.py
            CurrentModule.py           <- you are here

from FooFinder import ParentPackage

from FooFinder import NeighboringPackage

from FooFinder import DownstreamPackage

---

FooFinder can find the package you're currently in, a package from a parent directory, or a package from a child directory. Modules within packages will be found as if they were folders.

---

Using a parent package as a reference point:

ParentFolder/
    __init__.py
    SubFolder1/
        TargetModule.py                     <- and you want to import this module
    SubFolder2/
        SubSubFolder/
            CurrentModule.py           <- you are here

from FooFinder.ParentFolder import TargetModule

Using a neighboring package as a reference point:

ParentFolder/
    SubFolder1/
        __init__.py
        SubSubFolder/
            TargetModule.py                 <- and you want to import that
    SubFolder2/
        SubSubFolder/
            CurrentNotebook.ipynb      <- you are here

from FooFinder.SubFolder1 import TargetModule

from FooFinder.SubFolder1 import SomePackageAttribute

Using a root module as a reference point:

ParentFolder/
    RootModule.py
    SubFolder1/
        SubSubFolder/
            TargetPackage/                  <- and you want to import this package
                __init__.py
    SubFolder2/
        SubSubFolder/
            CurrentModule.py           <- you are here

from FooFinder.RootModule import TargetPackage

Importing Modules and Packages from a zip file:

ParentFolder/
    ZippedFile.zip/
        ZippedPackage/                      <- and you want to import this zipped package
            __init__.py
        ZippedModule.py                     <- or this zipped module
    SubFolder1/
        SubFolder2/
            CurrentModule.py         <- you are here

from FooFinder.ZippedFile import ZippedPackage
from FooFinder.ZippedFile import ZippedModule

---

Limitations:

FooFinder will not search directories that start with a "." such as .git or .hg, it will also skip any egg-info or __pycache__ folders. FooFinder will try each possible parent path to your module with os.path.exists instead of retrieving a directory listing. It will not recurse the parent folders. If none of the parent paths exist it will then recursively try each path downwards from your current module. If you're using a reference point, it will first find the reference point, and then search only downwards from the reference point.

Zip importing uses zipimport.zipimporter.load_module so it's limited to just what zipimporter can see, and can't recursively search the contents of the zip file.

If a user has modules or packages installed at the root of their system that have the same name you're trying to import, there could be a conflict. However this would be a very strange system configuration to have, so the risk of this should be quite minimal.

---

See the test module for example usage and complete test coverage.