Python导入：使用缩写的导入名称

Question

我正在尝试确定函数导入的一些最佳做法，而PEP 8并未明确提及这一点，实际上PEP 8 imports section相对较小。我想知道使用缩写导入时的最佳做法是什么。

例如：

import pandas as pd
import numpy as np

易于理解，因为它们是使用非常广泛的软件包。就我自己而言，我想导入的模块中可能包含一些晦涩的类或函数，例如：

from my_module import my_fun_function as mff
...
myvar = mff(input1)

与

from my_module import my_fun_function
...
myvar = my_fun_function(input1)

是否有最佳实践参考？

Answer 1

如您所说。如果该模块被广泛使用，则可以使用缩写。如果您有自定义模块，则可以使用缩写作为其名称，只要它有充分的文档证明，清晰的代码并且在代码中得到广泛使用即可。如果只使用了几次，请不要缩写。

但是，我建议不要缩短函数名称，因为这感觉像是代码混淆。我觉得ThisFunctionDoesThatThing（x）比TFDTT（x）更好。

Answer 2

我认为这取决于您的听众。如果您的读者熟悉您所缩写的功能，或者您提供了该功能的文档，那么它肯定会使代码更具可读性。但是，如果您缩写每个导入的晦涩功能（即使仅使用一次），那么它的可读性就会大大降低，并且很难理解。

Answer 3

虽然有一些公认的别名，但没有standards作为别名。

在大多数情况下，使别名保持较短状态看起来不错，但这不是唯一的选择。