Skip to main content
 首页 » 编程设计

python之使用您自己的模块时有关硬编码变量的最佳实践问题

2024年12月31日11dudu

我正在尝试查看在使用硬编码变量和模块时是否有一些推荐的最佳实践。我想,一般来说,硬编码变量应该进入某种包含程序主要执行的主脚本,但是当涉及到您自己创建的附加模块时,比如包含大量函数的东西为简单起见,最好在一个单独的模块中,我想知道是否让模块中的所有内容都更容易从其他脚本“调用”,或者即使主程序应该是包含它们的地方,硬编码的变量是否很好。谢谢!

请您参考如下方法:

你永远不应该对任何东西进行硬编码,永远不要。

主程序也不是包含它们的地方,它只会变得困惑。

Python 有模块。

因此,我自己使用我称之为“Python 配置文件”的东西。

警告:示例不反射(reflect)最佳编程实践。

# config.py 
import os 
 
LIBRARY_VERSION = "1.0.0" 
 
MY_VARIABLE = "This is my variable!" 
if os.name == "nt": 
    DEFAULT_PATH = "C:/" 
elif os.name == "posix": 
    DEFAULT_PATH = "/home/" 
else: 
    raise Exception("This library does not support your operating system.") 

现在您的配置已全部设置好,您可以在具有明确明确含义的变量名的代码中使用它,并且还包含在它们不污染不关心它们的模块的命名空间的地方:

# main.py 
import os 
 
import config 
 
os.chdir(config.DEFAULT_PATH) 
print(f"Cool Library {config.LIBRARY_VERSION} is ready!") 

Python 项目的 Python 是您将使用的最好的配置语言。

如果您有多个模块,您仍然可以通过多个配置或简单地使用 LIBRARY_STUFF_VARIABLE_NAME 来保持合理,例如,openGL API 有这样的:GL_TEXTURE_2D。

所以如果你的库是Cool Library,你可以将它缩短为CL,如果有一个模块叫做Cool Module,你可以缩短它到CM,你得到的是CL_CM_VARIABLE,显然,选择更好的名字,但如果你使用简短和一致的命名,它会很容易使用,而且更多比整个代码中的随机 image.png 和 1 更具可读性。