从配置中导入参数，但如果配置文件不存在，则先创建它。

Question

我有一些全局常量，它们保存在一个.py文件中，并且在代码库的许多不同地方都需要用到：

from important_parameters import ROOT_DIR, ANOTHER_DIR

这种导入方式在很多文件中都是必需的，我认为这比到处传递这些参数要方便。问题在于，这些参数依赖于用户，即它们是相对目录路径。也就是说，如果另一个用户运行脚本，必须首先创建配置文件。因此，我考虑了如下方案：

if not os.path.exists('important_parameters.py'):
   args = parser.parse_args()
   create_params_file(args)

这里的参数可以在顶部指定，例如：

parser = argparse.ArgumentParser()
parser.add_argument(
    '--root_data_dir', type=str, required=True
)
parser.add_argument(
    '--another_data_dir', type=str, required=True
)

之后，我们可以创建配置文件：

def create_params_file(args):
    with open('important_parameters.py', 'w') as file:
        file.write(f'ROOT_DIR = "{os.path.join(args.root_data_dir)}"
')
        file.write(f'ANOTHER_DIR = "{os.path.join(args.another_data_dir)}"
')

并在主块中使用if条件：

if __name__ == "__main__":
    if not os.path.exists('important_parameters.py'):
        args = parser.parse_args()
        create_params_file(args)

但是，如果文件不存在，这种方法就无法工作，因为我首先会在顶部遇到导入错误。对于我的情况，有没有更优雅的解决方案呢？

Simone Carletti · Answer

我想最好的做法是在主函数中的if语句后直接导入important_parameter。

if __name__ == "__main__":
    if not os.path.exists('important_parameters.py'):
        args = parser.parse_args()
        create_params_file(args)

    from important_parameters import ROOT_DIR, ANOTHER_DIR

Philip Fourie · Answer

当用户在运行时提供导入内容时，这些导入就不能视作真正的全局常量了。

在Python中，当你导入一个模块时，Python会执行该模块的代码并创建其命名空间。因此，如果在尝试首先构建该导入命名空间时，用于定义导入的代码尚未成型（因为依赖于用户的输入），就会导致错误。

针对这一问题，有几种解决方案可供选择，但没有一种是特别推荐的最佳实践：

方案1

声明一个全局变量，从用户输入中分配值，并在不同的文件间共享使用：

# module.py #

ROOT_DIR = None
# arg parser gets user input...
ROOT_DIR = args.root_data_dir


# other_file.py #

import module

global ROOT_DIR

if ROOT_DIR is not None:
    print("Do something")

Option 2

Add the variables to a modules namespace:

# main.py #

import module

user_input = input("Enter a value: ")

# Adding a variable to module's namespace
module.ROOT_DIR = user_input

# Now, you can use the variable in the module
module.foo_or_bar()

# module.py #

def foo_or_bar():
    if ROOT_DIR == "foo":
        print(ROOT_DIR)
    else:
        print("bar")