将 ArgumentParser 与 Swift 并发一起使用

发布于03月30日

我正在使用ArgumentParser包进行命令行解析，并希望将其与Swift并发性的async API一起使用:

struct Foo: ParsableCommand {
    @Argument(
        help: "File to be parsed. If not present, parses stdin.",
        transform: URL.init(fileURLWithPath:)
    )
    var file: URL?

    mutating func run() async throws {
        let handle: FileHandle
        if let file {
            handle = try .init(forReadingFrom: file)
        } else {
            handle = .standardInput
        }

        for try await line in handle.bytes.lines {
            // do something with each line
        }

        try handle.close()
    }
}

但是当我这样做的时候，我总是看到"用法"文本:

USAGE: foo [<file>]

ARGUMENTS:
  <file>                  File to be parsed. If not present, parses stdin.

OPTIONS:
  -h, --help              Show help information.

我没有收到任何编译错误，但无论我是否提供参数，我都会看到"Usage"文本.

推荐答案

问题是ParsableCommand和run() async throws一起使用.

用AsyncParsableCommand代替.正如它的documentation所说的那样:

要在命令的run()方法实现中使用async/await代码，请执行以下步骤:

对于命令行工具中的根命令，无论该命令是否使用异步代码，都应声明符合AsyncParsableCommand.

将@main属性应用于根命令.(注意:如果根命令位于main.Swift文件中，请将该文件重命名为该命令的名称.)

对于需要使用异步代码的任何命令，声明符合AsyncParsableCommand，并将run()方法标记为async.不需要对不使用异步代码的子命令进行更改.

不幸的是，虽然更广泛的documentation偶尔会提到支持async，但您必须深入研究代码样例(具体地说，count-lines)，或者倾注整个类库才能偶然发现AsyncParsableCommand.

因此，使用AsyncParsableCommand,async格式副本为run:

import ArgumentParser

@main
struct Foo: AsyncParsableCommand {
    @Argument(
        help: "File to be parsed. If not present, parses stdin.",
        transform: URL.init(fileURLWithPath:)
    )
    var file: URL?

    mutating func run() async throws {
        let handle: FileHandle
        if let file {
            handle = try .init(forReadingFrom: file)
        } else {
            handle = .standardInput
        }

        for try await line in handle.bytes.lines {
            // do something with each line
        }

        try handle.close()
    }
}

但是，不幸的是，如果您意外地使用了run和ParsableCommand的async格式副本，它编译时不会出错，但在您运行它时只会生成"Usage"文本，而没有关于why它不工作的任何诊断信息.

简而言之，ParsableCommand需要run的非async格式.async的再现需要AsyncParsableCommand个.