How to load all modules in a folder

Question

Could someone provide me with a good way of importing a whole directory of modules  I have a structure like this    Foo     bar py     spam py     eggs py   I tried just converting it to a package by adding   init   py and doing from Foo import   but it didn t work the way I had hoped

User · Answer

Look at the pkgutil module from the standard library  It will let you do exactly what you want as long as you have an   init   py file in the directory  The   init   py file can be empty

User · Answer

I have also encountered this problem and this was my solution   import os  def loadImports path       files   os listdir path      imps           for i in range len files            name   files i  split              if len name   gt  1              if name 1      py  and name 0        init                    name   name 0                 imps append name       file   open path    init   py   w        toWrite      all       str imps       file write toWrite      file close     This function creates a file  in the provided folder  named   init   py  which contains an   all   variable that holds every module in the folder    For example  I have a folder named Test which contains   Foo py Bar py   So in the script I want the modules to be imported into I will write   loadImports  Test    from Test import     This will import everything from Test and the   init   py file in Test will now contain     all       Foo   Bar

User · Answer

When from   import   isn t good enough  this is an improvement over the answer by ted  Specifically  the use of   all   is not necessary with this approach      Import all modules that exist in the current directory       Ref https   stackoverflow com a 60861023  from importlib import import module from pathlib import Path  for f in Path   file    parent glob    py        module name   f stem     if  not module name startswith       and  module name not in globals             import module f   module name      package        del f  module name del import module  Path   Note that module name not in globals   is intended to avoid reimporting the module if it s already imported  as this can risk cyclic imports

User · Answer

I know I m updating a quite old post  and I tried using automodinit  but found out it s setup process is broken for python3  So  based on Luca s answer  I came up with a simpler answer - which might not work with  zip - to this issue  so I figured I should share it here   within the   init   py module from yourpackage      usr bin env python import os  pkgutil   all     list module for    module    in pkgutil iter modules  os path dirname   file         and within another package below yourpackage   from yourpackage import     Then you ll have all the modules that are placed within the package loaded  and if you write a new module  it ll be automagically imported as well  Of course  use that kind of things with care  with great powers comes great responsibilities

User · Answer

Anurag s example with a couple of corrections   import os  glob  modules   glob glob os path join os path dirname   file        py      all      os path basename f   -3  for f in modules if not f endswith    init   py

User · Answer

I got tired of this problem myself  so I wrote a package called automodinit to fix it  You can get it from http   pypi python org pypi automodinit     Usage is like this    Include the automodinit package into your setup py dependencies  Replace all   init   py files like this       all       I will get rewritten     Don t modify the line above  or this line  import automodinit automodinit automodinit   name      file    globals    del automodinit   Anything else you want can go after here  it won t get modified    That s it  From now on importing a module will set   all   to a list of  py co  files in the module and will also import each of those files as though you had typed   for x in   all    import x   Therefore the effect of  from M import    matches exactly  import M    automodinit is happy running from inside ZIP archives and is therefore ZIP safe   Niall

User · Answer

Using importlib the only thing you ve got to add is  from importlib import import module from pathlib import Path    all           import module f   f stem      package        for f in Path   file    parent glob    py       if      not in f stem   del import module  Path

User · Answer

This is the best way i ve found so far   from os path import dirname  join  isdir  abspath  basename from glob import glob pwd   dirname   file    for x in glob join pwd     py         if not x startswith                  import   basename x   -3   globals    locals

User · Answer

Python  include all files under a directory   For newbies who just can t get it to work who need their hands held    Make a folder  home el foo and make a file main py under  home el foo  Put this code in there   from hellokitty import   spam spamfunc   ham hamfunc    Make a directory  home el foo hellokitty Make a file   init   py under  home el foo hellokitty and put this code in there     all       spam    ham    Make two python files  spam py and ham py under  home el foo hellokitty Define a function inside spam py   def spamfunc      print  Spammity spam    Define a function inside ham py   def hamfunc      print  Upgrade from baloney    Run it   el apollo  home el foo  python main py  spammity spam Upgrade from baloney

User · Answer

Anurag Uniyal answer with suggested improvements      usr bin python   - - encoding  utf-8 - -  import os import glob  all list   list   for f in glob glob os path dirname   file        py        if os path isfile f  and not os path basename f  startswith               all list append os path basename f   -3      all     all list

User · Answer

List all python   py  files in the current folder and put them as   all   variable in   init   py  from os path import dirname  basename  isfile  join import glob modules   glob glob join dirname   file        py      all       basename f   -3  for f in modules if isfile f  and not f endswith    init   py

User · Answer

I ve created a module for that  which doesn t rely on   init   py  or any other auxiliary file  and makes me type only the following two lines   import importdir importdir do  Foo   globals      Feel free to re-use or contribute  http   gitlab com aurelien-lourot importdir

User · Answer

Add the   all   Variable to   init   py containing     all       bar    spam    eggs     See also http   docs python org tutorial modules html

User · Answer

Expanding on Mihail s answer  I believe the non-hackish way  as in  not handling the file paths directly  is the following    create an empty   init   py file under Foo  Execute   import pkgutil import sys   def load all modules from dir dirname       for importer  package name    in pkgutil iter modules  dirname            full package name     s  s     dirname  package name          if full package name not in sys modules              module   importer find module package name                           load module full package name              print module   load all modules from dir  Foo     You ll get    lt module  Foo bar  from   home     Foo bar pyc  gt   lt module  Foo spam  from   home     Foo spam pyc  gt

User · Answer

Update in 2017  you probably want to use importlib instead   Make the Foo directory a package by adding an   init   py  In that   init   py add   import bar import eggs import spam   Since you want it dynamic  which may or may not be a good idea   list all py-files with list dir and import them with something like this   import os for module in os listdir os path dirname   file          if module       init   py  or module -3        py           continue       import   module  -3   locals    globals    del module   Then  from your code do this   import Foo   You can now access the modules with  Foo bar Foo eggs Foo spam   etc  from Foo import   is not a good idea for several reasons  including name clashes and making it hard to analyze the code

User · Answer

See that your   init   py defines   all    The modules - packages doc says  The   init   py files are required to make Python treat the directories as containing packages  this is done to prevent directories with a common name  such as string  from unintentionally hiding valid modules that occur later on the module search path  In the simplest case    init   py can just be an empty file  but it can also execute initialization code for the package or set the   all   variable  described later      The only solution is for the package author to provide an explicit index of the package  The import statement uses the following convention  if a package   s   init   py code defines a list named   all    it is taken to be the list of module names that should be imported when from package import   is encountered  It is up to the package author to keep this list up-to-date when a new version of the package is released  Package authors may also decide not to support it  if they don   t see a use for importing   from their package  For example  the file sounds effects   init   py could contain the following code    all       quot echo quot    quot surround quot    quot reverse quot   This would mean that from sound effects import   would import the three named submodules of the sound package

User · Answer

import pkgutil   path     pkgutil extend path   path      name    for imp  module  ispackage in pkgutil walk packages path   path    prefix   name             import   module

User · Answer

Just import them by importlib and add them to   all    add action is optional  in recurse in the   init   py of package    Foo     bar py     spam py     eggs py       init   py      init   py import os import importlib pyfile extes     py       all      importlib import module    s    filename    package    for filename in  os path splitext i  0  for i in os listdir os path dirname   file     if os path splitext i  1  in pyfile extes  if not filename startswith        del os  importlib  pyfile extes

User · Answer

I had a nested directory structure i e  I had multiple directories inside the main directory that contained the python modules  I added the following script to my   init   py file to import all the modules import glob  re  os   module parent directory    quot path to the directory containing   init   py file quot   owd   os getcwd   if not owd endswith module parent directory   os chdir module parent directory   module paths   glob glob  quot      py quot   recursive   True   for module path in module paths      if not re match   quot     init   py  quot   module path           import path   module path  -3          import path   import path replace  quot   quot    quot   quot           exec f quot from   import path  import   quot    os chdir owd   Probably not the best way to achieve this  but I couldn t make anything else work for me

[python] How to load all modules in a folder?

Examples related to python

Examples related to python-import