在Jupyter Notebook中解决argparse报错的方法

认真发呆

发布时间：2026-10-13| 5人浏览过

原创

本文介绍在Jupyter Notebook环境中使用Python的argparse模块时遇到的SystemExit报错问题。通过分析sys.argv默认行为，提出通过手动传入参数列表解决该问题的方法，帮助开发者在交互式环境中顺利运行基于命令行参数的脚本。

Jupyter Notebook中argparse报错问题

IPython Notebook常被用作调试工具。在调试涉及命令行参数解析的代码时，由于Notebook的执行环境与标准命令行不同，直接运行代码会失败。

parse_args()函数解析

查阅parse_args()函数文档可知，其接口为ArgumentParser.parse_args(args=None, namespace=None)。虽然未明确指定args类型，但文档指出默认情况下参数取自sys.argv，并创建空的Namespace对象保存属性。因此，只要传入类似sys.argv结构的列表即可解决问题。

在Notebook环境中，sys.argv可能呈现如下形式：

['/home/user/venv/lib/python2.7/site-packages/ipykernel/__main__.py','-f','/run/user/1000/jupyter/kernel-7b35f85c-27c9-44db-bcf7-e46edb18ee81.json']

这是一个字符串列表，元素源自命令行参数，以空格分隔。只需对代码稍作修改，向parse_args()传入列表即可。例如，若命令行参数为python train.py --gpus 0 --lr 0.1，则传入列表应为['--gpus', '0', '--lr', '0.1']。

补充：Jupyter Notebook使用argparse的问题

补充知识：Jupyter Notebook中使用argparse包存在的问题及解决

argparse模块

argparse是Python用于解析命令行参数和选项的标准模块。

导入argparse包

import argparse

遇到的报错

遇到的问题

parser = argparse.ArgumentParser() parser.parse_args()

usage: __main__.py [-h] __main__.py: error: unrecognized arguments: -f /run/user/1006/jupyter/kernel-ce6cfb61-acb9-40bf-a59b-ff6e1c1eacae.json

An exception has occurred, use %tb to see the full traceback.

SystemExit: 2

问题原因分析

问题分析

在Jupyter Notebook中，args不为空。可查看系统环境变量，大致形式如下：

import sys sys.argv

['/home/liu/anaconda2/lib/python2.7/site-packages/ipykernel/__main__.py', '-f', '/run/user/1006/jupyter/kernel-ce6cfb61-acb9-40bf-a59b-ff6e1c1eacae.json']

错误中的-f /…来源于此。可查看parse_args()函数源码：

以及其调用的parse_known_args()源码。

尽管args默认参数为None，但实质执行的是args = _sys.argv[1:]。

因此，在Jupyter中，查看所需系统环境变量后，以列表形式传参给args即可解决。

parser.parse_args?? parser.parse_known_args??


Signature: parser.parse_args(args=None, namespace=None)
Source: 
 def parse_args(self, args=None, namespace=None):
 args, argv = self.parse_known_args(args, namespace)
 if argv:
  msg = _('unrecognized arguments: %s')
  self.error(msg % ' '.join(argv))
 return args
File: /home/liu/anaconda2/lib/python2.7/argparse.py
Type: instancemethod

Signature: parser.parse_known_args(args=None, namespace=None)
Source: 
 def parse_known_args(self, args=None, namespace=None):
 if args is None:
  # args default to the system args
  args = _sys.argv[1:]
 else:
  # make sure that args are mutable
  args = list(args)

 # default Namespace built from parser defaults
 if namespace is None:
  namespace = Namespace()

 # add any action defaults that aren't present
 for action in self._actions:
  if action.dest is not SUPPRESS:
  if not hasattr(namespace, action.dest):
   if action.default is not SUPPRESS:
   setattr(namespace, action.dest, action.default)

 # add any parser defaults that aren't present
 for dest in self._defaults:
  if not hasattr(namespace, dest):
  setattr(namespace, dest, self._defaults[dest])

 # parse the arguments and exit if there are any errors
 try:
  namespace, args = self._parse_known_args(args, namespace)
  if hasattr(namespace, _UNRECOGNIZED_ARGS_ATTR):
  args.extend(getattr(namespace, _UNRECOGNIZED_ARGS_ATTR))
  delattr(namespace, _UNRECOGNIZED_ARGS_ATTR)
  return namespace, args
 except ArgumentError:
  err = _sys.exc_info()[1]
  self.error(str(err))
File: /home/liu/anaconda2/lib/python2.7/argparse.py
Type: instancemethod

解决方案

问题解决


parser = argparse.ArgumentParser()
parser.add_argument("--verbosity", help="increase output verbosity")
args = parser.parse_args(args=[])
print(args)