【问题标题】:Module Importing Good Practice模块导入良好实践
【发布时间】:2021-05-26 05:51:42
【问题描述】:

什么是导入模块的“好习惯”?例如,如果我有一个名为“module”的模块和一个名为“func”的函数,哪个更好?

1:

def do_things():
    from module import func
    func()

2:

from module import func

def do_things():
    func()

3:

import module as mod

def do_things():
    mod.func()

4:

def do_things():
    import module as mod
    mod.func()

我需要确保我的代码为这个项目编写得很好。同样从模块中导入类(例如“from bs4 import BeautifulSoup”)是否可以将它们导入我程序顶部的全局命名空间?如果不是,是否适用与此处相同的规则?

【问题讨论】:

    标签: python class oop import module


    【解决方案1】:

    在寻找最佳实践时,PEP8 通常是第一个寻找的地方。根据 PEP8,它是 #2:https://www.python.org/dev/peps/pep-0008/#imports

    我也喜欢#3,但仅限于某些情况:

    • 如果它是一个广泛使用的包,如果经常缩写(例如import numpy as np)
    • 如果您要导入的包/函数的名称很长(例如import a_ridiculously_long_module_name as short_name 或import module.submodule.subsubmodule as short_name)

    对未知软件包使用别名的危险在于,缩写可能对您有意义,但对其他人没有意义。这可能会妨碍代码的可读性。

    您还可以结合使用别名和绝对导入。所以选项 5 是:

    from module import function as func
    

    【讨论】:

      【解决方案2】:

      从性能的角度来看,import 和 import from are exactly the same。解释器会将整个模块加载到内存中。

      这让您有一个选择:采用哪种方式。我会选择使代码更具可读性和更少歧义的那个:

      • 导入模块(无论是否为别名)使用命名空间方法,这将避免两个模块具有同名函数的情况。
      • 仅导入您需要的功能可能会减轻开发人员的认知负担。

      更新:关于本地导入,请参阅this answer. Python 将使用本地或文件顶部导入。本地导入可以使您免于循环依赖。更好的设计也可以帮助您。

      你必须选择你自己的毒药,这都是关于权衡的。

      【讨论】:

        【解决方案3】:

        这个答案写在我看来:

        对我来说,我更喜欢#3,我的理由是:

        1. 与from module import func 不同,您可以使用该模块中的任何函数而无需显式导入它。
        2. 更少的全局命名空间混乱(而不是from module import func1, func2, fun3,你可以只做import module as mod然后mod.func1()。
        3. 在顶部导入意味着它可以在任何脚本中使用(如果您以后需要在另一个函数中使用它,这样做会更容易)。

        对于导入单个类,如果这是您对该模块唯一要做的事情,我会觉得没问题,但我的第 1 点可以在这里应用,如果该模块也有辅助函数和/或其他类,它可能是最好导入模块然后执行module.Class()。

        【讨论】:

          猜你喜欢
          • 1970-01-01
          • 2018-12-28
          • 1970-01-01
          • 1970-01-01
          • 2023-03-26
          • 2017-12-04
          • 1970-01-01
          • 1970-01-01
          • 2019-01-18
          相关资源
          最近更新 更多