itk-wasm/src/bindgen/python/function-module-docstring.js

High-performance spatial analysis in a web browser, Node.js, and reproducible execution across programming languages and hardware architectures.

import snakeCase from "../snake-case.js"

import interfaceJsonTypeToPythonType from './interface-json-type-to-python-type.js'
import canonicalType from '../canonical-type.js'

function functionModuleDocstring(interfaceJson) {
  let docstring = `"""${interfaceJson.description}
`
  interfaceJson['inputs'].forEach((value) => {
    const description = value.description.replaceAll('\n', ' ')
    const canonical = canonicalType(value.type)
    const pythonType = interfaceJsonTypeToPythonType.get(canonical)
    docstring += `\n    :param ${snakeCase(value.name)}: ${description}\n`
    docstring += `    :type  ${snakeCase(value.name)}: ${pythonType}\n`
  })
  const outputFiles = interfaceJson.outputs.filter(o => { return o.type.includes('FILE') })
  outputFiles.forEach((output) => {
    const isArray = output.itemsExpectedMax > 1
    const optionName = `${output.name}`
    const description = output.description.replaceAll('\n', ' ')
    docstring += `\n    :param ${snakeCase(optionName)}: ${description}\n`
    if (isArray) {
      docstring += `    :type  ${snakeCase(optionName)}: List[str]\n`
    } else {
      docstring += `    :type  ${snakeCase(optionName)}: str\n`
    }
  })
  interfaceJson['parameters'].forEach((value) => {
    if (value.name === "memory-io" || value.name === "version") {
      return
    }
    const canonical = canonicalType(value.type)
    const pythonType = interfaceJsonTypeToPythonType.get(canonical)
    const description = value.description.replaceAll('\n', ' ')
    docstring += `\n    :param ${snakeCase(value.name)}: ${description}\n`
    docstring += `    :type  ${snakeCase(value.name)}: ${pythonType}\n`
  })
  const jsonOutputs = interfaceJson['outputs']
  jsonOutputs.forEach((value) => {
    if (value.type.includes('FILE')) {
      return
    }
    const description = value.description.replaceAll('\n', ' ')
    const canonical = canonicalType(value.type)
    const pythonType = interfaceJsonTypeToPythonType.get(canonical)
    docstring += `\n    :return: ${description}\n`
    docstring += `    :rtype:  ${pythonType}\n`
  })

  docstring += '    """'

  return docstring
}

export default functionModuleDocstring