如何使用 argsparse 和 Powershell 在 python 代码中将 json 作为字符串参数传递？

Question

我一直在思考这个问题，但找不到解决方案。

我有一个非常简单的代码：

import argparse
import json

def main():
    parser = argparse.ArgumentParser(description="Process a JSON argument.")
    parser.add_argument(
        "--json",
        type=str,
        required=True,
        help="JSON string or path to a JSON file."
    )
    args = parser.parse_args()
    
    # Try to parse the argument as a JSON string or file path
    try:
        # First, attempt to parse it as a JSON string
        data = json.loads(args.json)
        print("Parsed JSON string successfully:", data)
    except json.JSONDecodeError:
        # If that fails, treat it as a file path
        try:
            with open(args.json, 'r') as file:
                data = json.load(file)
                print("Parsed JSON file successfully:", data)
        except FileNotFoundError:
            print("Error: Input is not a valid JSON string or file path.")
            return

    # Use the parsed dictionary (data)
    print("JSON as dictionary:", data)

if __name__ == "__main__":
    main()

另存为 script.py 当我从 Powershell 运行它时

python script.py --json '{"key": "value", "number": 42}'

我收到：

Traceback (most recent call last):
  File "C:\mypath\script.py", line 17, in main
    data = json.loads(args.json)
  File "C:\Users\myuser\miniconda3\envs\ti_nlp\lib\json\__init__.py", line 346, in loads
    return _default_decoder.decode(s)
  File "C:\Users\myuser\miniconda3\envs\ti_nlp\lib\json\decoder.py", line 337, in decode
    obj, end = self.raw_decode(s, idx=_w(s, 0).end())
  File "C:\Users\myuser\miniconda3\envs\ti_nlp\lib\json\decoder.py", line 353, in raw_decode
    obj, end = self.scan_once(s, idx)
json.decoder.JSONDecodeError: Expecting property name enclosed in double quotes: line 1 column 2 (char 1)

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "C:\mypath\script.py", line 33, in <module>
    main()
  File "C:\mypath\script.py", line 22, in main
    with open(args.json, 'r') as file:
OSError: [Errno 22] Invalid argument: '{key: value, number: 42}'

当我用cmd（Anaconda提示符）运行它时：

python script.py --json "{\"key\": \"value\", \"number\": 42}"

效果很好：

Parsed JSON string successfully: {'key': 'value', 'number': 42}
JSON as dictionary: {'key': 'value', 'number': 42}

那么...Powershell 有什么问题以及如何解决这个问题？

Answer 1

Powershell 处理方式与 cmd 不同。

python script.py --json "{""key"": ""value"", ""number"": 42}"

或者像这样使用

python script.py --json @"
{"key": "value", "number": 42}
"@

Answer 2

出现此问题的原因是 PowerShell 处理引号的方式与 CMD 或其他 shell 不同。当您在 PowerShell 中运行脚本时，它会按字面解释 JSON 字符串中的单引号 (')，而不是将它们作为字符串的一部分正确处理。这会导致 JSONDecodeError，因为 JSON 要求将键和字符串值括在双引号 (") 中。

您可以尝试以下方法来解决问题。一：使用转义双引号：

python script.py --json "{\"key\": \"value\", \"number\": 42}"

或者对整个参数使用单引号，如下所示：

python script.py --json '{"key": "value", "number": 42}'