如何加载文件夹中的所有模块？

Question

有人可以为我提供一种导入整个模块目录的好方法吗？
我有这样的结构：

/Foo
    bar.py
    spam.py
    eggs.py

我尝试通过添加 __init__.py 并执行 from Foo import * 将其转换为包，但它没有按照我的方式工作希望。

Answer 1

当 来自 . import * 还不够好，这是对ted的回答的改进。 具体来说，这种方法不需要使用 __all__。

"""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

请注意，module_name not in globals() 旨在避免重新导入已导入的模块，因为这可能会带来循环导入的风险。

Answer 2

这是迄今为止我发现的最好的方法：

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())

Answer 3

Anurag Uniyal 答案以及建议的改进！

#!/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  

Answer 4

使用 importlib 是唯一的事情你必须添加的是

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

Answer 5

我想添加 Anurag Uniyal 的答案。
您可以使其变得更加简单并摆脱大量导入。
__init__.py 文件的内容：

from os import listdir
from os.path import dirname
__all__ = [i[:-3] for i in listdir(dirname(__file__)) if not i.startswith('__') and i.endswith('.py')]

Answer 6

我为此创建了一个模块，它不依赖于 __init__.py （或任何其他辅助文件），并且使我只需键入以下两行：

import importdir
importdir.do("Foo", globals())

随意重用或贡献: http://gitlab.com/aurelien-lourot/importdir

Answer 7

Anurag 的示例有一些更正：

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")]

Answer 8

查看您的 __init__.py 定义了 __all__。 模块 - 包 文档说

需要 __init__.py 文件才能使 Python 将目录视为包含包； 这样做是为了防止具有通用名称（例如字符串）的目录无意中隐藏稍后出现在模块搜索路径上的有效模块。 在最简单的情况下，__init__.py可以只是一个空文件，但它也可以执行包的初始化代码或设置__all__变量，稍后介绍。

...

唯一的解决方案是包作者提供包的显式索引。 import 语句使用以下约定：如果包的 __init__.py 代码定义了一个名为 __all__ 的列表，则它被视为应导入的模块名称列表遇到 from package import * 。 当包的新版本发布时，包作者有责任保持此列表为最新。 如果包作者没有看到从包中导入 * 的用途，他们也可能决定不支持它。 例如，文件 sounds/effects/__init__.py 可能包含以下代码：

__all__ = ["回声", "环绕", "反向"]

这意味着 from sound.effects import * 将导入声音包的三个命名子模块。

Answer 9

查看标准库中的 pkgutil 模块。 只要目录中有 __init__.py 文件，它就可以让您完全执行您想要的操作。 __init__.py 文件可以为空。

Answer 10

这是一个解决方案，使用它您不必写文件名。 只需将此代码片段添加到您的 __init__.py

from inspect import isclass
from pkgutil import iter_modules
from pathlib import Path
from importlib import import_module

# iterate through the modules in the current package
package_dir = Path(__file__).resolve().parent
for (_, module_name, _) in iter_modules([package_dir]):

    # import the module and iterate through its attributes
    module = import_module(f"{__name__}.{module_name}")
    for attribute_name in dir(module):
        attribute = getattr(module, attribute_name)

        if isclass(attribute):            
            # Add the class to this package's variables
            globals()[attribute_name] = attribute

源

Answer 11

在 Python 3.9.5、Flask 2.2.2 中，没有一个解决方案对我有用，该模块是 cwd 下 2 级的目录。
这是我的解决方案：

import importlib
import pathlib
import re

path = pathlib.Path(__file__).parent.absolute()
names = [x.name[:-3] for x in path.iterdir() if x.is_file() and re.search("^[a-z]*\.py$", x.name)]
for name in names:
    importlib.import_module(f".{name}", __name__)

Answer 12

只需通过 importlib 导入它们并将它们添加到 __all__ （add 操作是可选的）在包的 __init__.py 中递归。

/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

Answer 13

我有一个嵌套的目录结构，即主目录中有多个包含 python 模块的目录。

我将以下脚本添加到我的 __init__.py 文件中以导入所有模块

import glob, re, os 

module_parent_directory = "path/to/the/directory/containing/__init__.py/file"

owd = os.getcwd()
if not owd.endswith(module_parent_directory): os.chdir(module_parent_directory)

module_paths = glob.glob("**/*.py", recursive = True)

for module_path in module_paths:
    if not re.match( ".*__init__.py$", module_path):
        import_path = module_path[:-3]
        import_path = import_path.replace("/", ".")
        exec(f"from .{import_path} import *")

os.chdir(owd)

可能不是实现此目的的最佳方法，但我无法让其他任何东西为我工作。

Answer 14

列出当前文件夹中的所有 python (.py) 文件，并将它们作为 __all__ 变量放入 __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')]

Answer 15

将 __all__ 变量添加到 __init__.py 中，其中包含：

__all__ = ["bar", "spam", "eggs"]

另请参阅 http://docs.python.org/tutorial/modules.html

Answer 16

2017 年更新：您可能想使用 importlib 代替。

通过添加 __init__.py 使 Foo 目录成为一个包。 在 __init__.py 中添加：

import bar
import eggs
import spam

由于您希望它是动态的（这可能是也可能不是一个好主意），请使用 list dir 列出所有 py 文件并使用如下内容导入它们：

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

然后，从您的代码执行此操作：

import Foo

您现在可以使用 etc 访问模块

Foo.bar
Foo.eggs
Foo.spam

。由于多种原因，from Foo import * 不是一个好主意，包括名称冲突以及难以分析代码。

Answer 17

Python，包含一个目录下的所有文件：

对于那些无法让它工作、需要双手握住的新手。

1. 创建一个文件夹 /home/el/foo 并在 /home/el/foo 下创建一个文件 main.py 将以下代码放入其中：

   来自hellokitty导入* 
     spam.spamfunc() 
     ham.hamfunc() 
     

2. 创建一个目录/home/el/foo/hellokitty

3. 创建一个文件 __init__.py< /code> 下 /home/el/foo/hellokitty 并将此代码放在那里：

   __all__ = ["垃圾邮件", "火腿"] 
     

4. 制作两个 python文件：/home/el/foo/hellokitty

   下的 spam.py 和 ham.py

5. 在 spam.py 中定义一个函数：

   def spamfunc(): 
       print("垃圾邮件") 
     

6. 在 ham.py 中定义一个函数：

   def hamfunc(): 
       print("从胡说八道升级") 
     

7. 运行它：

   el@apollo:/home/el/foo$ python main.py  
     垃圾邮件 
     从胡言乱语升级 
     

Answer 18

扩展 Mihail 的答案，我相信非黑客方式（例如，不直接处理文件路径）如下：

1. 在 Foo/__init__.py 文件>
2. 执行

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')

你会得到：

<module 'Foo.bar' from '/home/.../Foo/bar.pyc'>
<module 'Foo.spam' from '/home/.../Foo/spam.pyc'>

Answer 19

我知道我正在更新一篇相当旧的帖子，我尝试使用 automodinit，但发现它的安装过程对于 python3 来说是损坏的。 因此，根据 Luca 的回答，我针对这个问题提出了一个更简单的答案（可能不适用于 .zip），所以我想我应该在这里分享它：

在 __init__.py 模块中yourpackage：

#!/usr/bin/env python
import os, pkgutil
__all__ = list(module for _, module, _ in pkgutil.iter_modules([os.path.dirname(__file__)]))

以及 yourpackage 下面的另一个包中：

from yourpackage import *

然后您将加载该包中放置的所有模块，如果您编写一个新模块，它将也会自动导入。 当然，这种东西要小心使用，能力越大责任越大。

Answer 20

我自己也厌倦了这个问题，所以我编写了一个名为 automodinit 的包来修复它。 您可以从 http://pypi.python.org/pypi/automodinit/ 获取它。

用法如下：

1. 将 automodinit 包包含到 setup.py 依赖项中。
2. 像这样替换所有 __init__.py 文件：

__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.

就是这样！ 从现在开始导入模块会将 __all__ 设置为
模块中的 .py[co] 文件列表，还将导入每个文件
这些文件的数量就像您键入的一样：

for x in __all__: import x

因此“from M import *”的效果与“import M”完全匹配。

automodinit 很乐意从 ZIP 存档内部运行，因此是 ZIP 安全的。

尼尔

Answer 21

import pkgutil
__path__ = pkgutil.extend_path(__path__, __name__)
for imp, module, ispackage in pkgutil.walk_packages(path=__path__, prefix=__name__+'.'):
  __import__(module)

Answer 22

我也遇到了这个问题，这是我的解决方案：

import os

def loadImports(path):
    files = os.listdir(path)
    imps = []

    for i in range(len(files)):
        name = files[i].split('.')
        if len(name) > 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()

该函数创建一个名为 __init__.py 的文件（在提供的文件夹中），其中包含一个 __all__ 变量，该变量保存每个文件夹中的模块。

例如，我有一个名为 Test 的文件夹
其中包含：

Foo.py
Bar.py

因此，在脚本中我希望将模块导入到我将编写的内容中：

loadImports('Test/')
from Test import *

这将从 Test 和 Test 中的 __init__.py 文件导入所有内容 现在将包含：

__all__ = ['Foo','Bar']