在 Jupyter Notebook 中使用 argparse 运行 python 程序来设置输入答案

【问题标题】：running a python program using argparse to setup input In Jupyter Notebook在 Jupyter Notebook 中使用 argparse 运行 python 程序来设置输入
【发布时间】：2021-09-23 18:00:08
【问题描述】：

我有一个遵循正常代码结构的.py 文件

def  main( args ): 
        .......
        .......

   if __name__ == "__main__":
      parser = argparse.ArgumentParser(description = “ forecasting example”)
      parser.add_argument("--train-window", default=2160, type=int)
      parser.add_argument("--test-window", default=336, type=int)
      parser.add_argument("--stride", default=168, type=int)
      parser.add_argument("-n", "--num-steps", default=501, type=int)
      parser.add_argument("-lr", "--learning-rate", default=0.05, type=float)
      parser.add_argument("--dct", action="store_true")
      parser.add_argument("--num-samples", default=100, type=int)
     parser.add_argument("--log-every", default=50, type=int)
     parser.add_argument("--seed", default=1234567890, type=int)
     args = parser.parse_args()
     main(args)

我试图在 Jupyter notebook 中运行这个程序，但它会出现诸如

之类的错误

usage: ipykernel_launcher.py [-h] [--train-window TRAIN_WINDOW]
                             [--test-window TEST_WINDOW] [--stride STRIDE]
                             [-n NUM_STEPS] [-lr LEARNING_RATE] [--dct]
                             [--num-samples NUM_SAMPLES]
                             [--log-every LOG_EVERY] [--seed SEED]
ipykernel_launcher.py: error: unrecognized arguments: -f C:\Users\AppData\Roaming\jupyter\runtime\kernel-4c744f03-3278-4aaf-af5e-50c96e9e41cd.json
An exception has occurred, use %tb to see the full traceback.

SystemExit: 2

我的问题是，如果我想在 Jupyter Notebook 中运行一个使用 argparse 类型机制设置输入参数的 python 程序，我需要做哪些正确的方法或修改？

【问题讨论】：

是什么命令导致你显示的错误？
在笔记本中使用命令行参数充其量是很尴尬的。笔记本看到的sys.argv 来自内核，其中包含有关接口 javascript 文件的信息。启动服务器时提供的参数是针对服务器本身的，而不是针对它可能运行的任何笔记本。
无论如何，代码似乎缩进不正确； if __name__ == "__main__": 应该在 def main(): 之外
-f C:\Users\AppData\Roaming\jupyter\runtime\kernel-4c744f03-3278-4aaf-af5e-50c96e9e41cd.json 来自服务器告诉内核使用哪个json 文件。您的parser 无法使用。

标签： python python-3.x jupyter-notebook argparse

【解决方案1】：

您的代码应该以不同的方式缩进，以便您可以import 将其放入您的笔记本或另一个 Python 脚本中。 if __name__ == "__main__": 块的全部意义在于它在 Python 解析文件时立即执行；仅当您直接运行文件而不是import 它时，该条件才成立。但是该块需要以不同的方式缩进，以便它不在任何def 或类或其他块结构中。

那么，在笔记本中使用它的方法是使用您想要的参数调用main（或您要运行的导入代码中的任何其他函数）。

在这种情况下，main 被设计为期望 Argparse 对象作为其参数，这是非常不幸的。更好的设计会简单地在 main 中进行参数解析，并公开不同的函数或函数集以作为库重用。

假设您的 main 函数的内部结构类似于

def main(args):
    print(
        real_main(args.train_window, args.test_window,
                  stride=args.stride, num_steps=args.num_steps,
                  learning_rate=args.learning_rate,
                  dct=args.dct, num_samples=args.num_samples,
                  log_every=args.log_every, seed=args.seed))

假设你想运行相当于

python thatfile.py -n 23 -lr 0.7--dct --num-samples 2300

笔记本中的等效代码如下所示

from thatfile import real_main as that_main

print(that_main(2160, 336, num_steps=23,
                learning_rate=0.7, dct=True,
                num_samples=2300))

前两个值是简单地从argparse 默认值复制而来的，我显然必须大量推测哪些参数是必需的，哪些是可选的关键字参数，以及它们的名称是否与argparse 相同字段名称。

【讨论】：