Function pushPyRpcMethodDocstring

scripts/codegen/python.ts:775–806

(
    lines: string[],
    indent: string,
    method: RpcMethod,
    options: {
        paramsName?: string;
        paramsDescription?: string;
        resultDescription?: string;
        deprecated?: boolean;
        experimental?: boolean;
        internal?: boolean;
    } = {}
)

}

function pushPyRpcMethodDocstring(
    lines: string[],
    indent: string,
    method: RpcMethod,
    options: {
        paramsName?: string;
        paramsDescription?: string;
        resultDescription?: string;
        deprecated?: boolean;
        experimental?: boolean;
        internal?: boolean;
    } = {}
): void {
    const sections: string[] = [method.description ?? `Calls ${method.rpcMethod}.`];
    if (options.paramsName && options.paramsDescription) {
        sections.push(`Args:\n    ${options.paramsName}: ${options.paramsDescription}`);
    }
    if (options.resultDescription) {
        sections.push(`Returns:\n    ${options.resultDescription}`);
    }
    if (options.deprecated) {
        sections.push(".. deprecated:: This API is deprecated and will be removed in a future version.");
    }
    if (options.experimental) {
        sections.push(".. warning:: This API is experimental and may change or be removed in future versions.");
    }
    if (options.internal) {
        sections.push(":meta private:\n\nInternal SDK API; not part of the public surface.");
    }

    lines.push(`${indent}${pyDocstringLiteral(sections.join("\n\n"))}`);
}

function modernizePython(code: string): string {
    // Replace Optional[X] with X | None (handles arbitrarily nested brackets)