Add API docstrings to generated Python code

Author: razor-x

codegen/layouts/partials/abstract-route-class.hbs

@@ -1,4 +1,7 @@
 class {{className}}(abc.ABC):
+{{#if docstring}}
+    """{{{docstring}}}"""
+{{/if}}
 {{#if showPass}}
     pass
 {{/if}}
@@ -13,5 +16,6 @@ class {{className}}(abc.ABC):
 
     @abc.abstractmethod
     def {{name}}(self,{{#if hasParams}} *,{{/if}} {{signatureParams}}) -> {{returnType}}:
+        """{{{docstring}}}"""
         raise NotImplementedError()
 {{/each}}

codegen/layouts/partials/resource-dataclass.hbs

@@ -1,5 +1,6 @@
 @dataclass
 class {{className}}:
+    """{{{docstring}}}"""
 {{#each properties}}
     {{safeName}}: {{type}}
 {{/each}}

codegen/layouts/partials/route-method.hbs

@@ -1,4 +1,5 @@
     def {{name}}(self,{{#if hasParams}} *,{{/if}} {{signatureParams}}) -> {{returnType}}:
+        """{{{docstring}}}"""
         json_payload = {}
 
 {{#each params}}

codegen/layouts/route.hbs

@@ -16,6 +16,9 @@ from ..modules.action_attempts import resolve_action_attempt
 
 
 class {{className}}({{abstractClassName}}):
+{{#if docstring}}
+    """{{{docstring}}}"""
+{{/if}}
     def __init__(self, client: SeamHttpClient, defaults: Dict[str, Any]):
         self.client = client
         self.defaults = defaults

codegen/lib/class-model.ts

@@ -4,13 +4,20 @@
 export interface ClassMethodParameter {
   name: string
   type: string
+  description: string
+  isDeprecated: boolean
+  deprecationMessage: string
   position?: number | undefined
   required?: boolean | undefined
 }
 
 export interface ClassMethod {
   methodName: string
   path: string
+  description: string
+  responseDescription: string
+  isDeprecated: boolean
+  deprecationMessage: string
   parameters: ClassMethodParameter[]
   returnPath: string[]
   returnResource: string
@@ -24,6 +31,7 @@ export interface ChildClassIdentifier {
 export interface ClassModel {
   name: string
   namespace: string
+  isDeprecated: boolean
   methods: ClassMethod[]
   childClassIdentifiers: ChildClassIdentifier[]
 }

codegen/lib/layouts/resources.ts

@@ -56,6 +56,7 @@ const toSafeIdentifier = (name: string): string =>
 export interface ResourceLayoutContext {
   className: string
   moduleName: string
+  docstring: string
   properties: Array<{
     name: string
     safeName: string
@@ -64,6 +65,44 @@ export interface ResourceLayoutContext {
   }>
 }
 
+const cleanDoc = (value: string): string =>
+  value.trim().replaceAll('"""', '\\"\\"\\"')
+
+const createResourceDocstring = (
+  description: string,
+  isDeprecated: boolean,
+  deprecationMessage: string,
+  properties: Property[],
+): string => {
+  const lines = [cleanDoc(description)]
+  for (const property of properties) {
+    const deprecated = property.isDeprecated
+      ? `Deprecated${property.deprecationMessage === '' ? '.' : `: ${cleanDoc(property.deprecationMessage)}`}`
+      : ''
+    lines.push(
+      '',
+      `:ivar ${toSafeIdentifier(property.name)}: ${[
+        deprecated,
+        cleanDoc(property.description),
+      ]
+        .filter(Boolean)
+        .join(' ')}`,
+      `:vartype ${toSafeIdentifier(property.name)}: ${mapPropertyToPythonType(property)}`,
+    )
+  }
+  if (isDeprecated) {
+    lines.push(
+      '',
+      '.. deprecated::',
+      `   ${cleanDoc(deprecationMessage) || 'This resource is deprecated.'}`,
+    )
+  }
+  return lines
+    .filter((line, index) => line !== '' || index !== 0)
+    .join('\n')
+    .replaceAll('\n', '\n    ')
+}
+
 export interface ResourcesIndexLayoutContext {
   resources: Array<{ className: string; moduleName: string }>
 }
@@ -84,29 +123,61 @@ const mergeResourceProperties = (resources: Resource[]): Property[] => {
 export const getResourceLayoutContexts = (
   blueprint: Blueprint,
 ): ResourceLayoutContext[] => {
-  const models = new Map<string, Property[]>()
+  const models = new Map<
+    string,
+    {
+      properties: Property[]
+      description: string
+      isDeprecated: boolean
+      deprecationMessage: string
+    }
+  >()
 
   for (const resource of blueprint.resources) {
-    models.set(resource.resourceType, resource.properties)
+    models.set(resource.resourceType, resource)
   }
 
   // The event and action attempt variants merge into a single dataclass with
   // the union of the variant properties, overriding the base resource schema.
-  models.set(
-    'action_attempt',
-    mergeResourceProperties(blueprint.actionAttempts),
-  )
-  models.set('event', mergeResourceProperties(blueprint.events))
+  const actionAttemptModel = models.get('action_attempt')
+  models.set('action_attempt', {
+    properties: mergeResourceProperties(blueprint.actionAttempts),
+    description:
+      actionAttemptModel?.description ??
+      'An attempt to perform an action in the Seam API.',
+    isDeprecated: actionAttemptModel?.isDeprecated ?? false,
+    deprecationMessage: actionAttemptModel?.deprecationMessage ?? '',
+  })
+  const eventModel = models.get('event')
+  models.set('event', {
+    properties: mergeResourceProperties(blueprint.events),
+    description: eventModel?.description ?? 'An event emitted by the Seam API.',
+    isDeprecated: eventModel?.isDeprecated ?? false,
+    deprecationMessage: eventModel?.deprecationMessage ?? '',
+  })
 
   if (blueprint.pagination != null) {
-    models.set('pagination', blueprint.pagination.properties)
+    models.set('pagination', {
+      properties: blueprint.pagination.properties,
+      description: blueprint.pagination.description,
+      isDeprecated: false,
+      deprecationMessage: '',
+    })
   }
 
   return [...models.entries()]
-    .map(([name, properties]) => {
+    .map(([name, model]) => {
+      const { properties, description, isDeprecated, deprecationMessage } =
+        model
       const className = pascalCase(convertCustomResourceName(name))
       return {
         className,
+        docstring: createResourceDocstring(
+          description,
+          isDeprecated,
+          deprecationMessage,
+          properties,
+        ),
         // Derived from the class name rather than the resource type so the
         // module always matches the dataclass it exports (e.g. the "event"
         // resource becomes SeamEvent in seam_event.py).

codegen/lib/layouts/route.ts

@@ -12,6 +12,7 @@ import {
 export interface MethodLayoutContext {
   name: string
   path: string
+  docstring: string
   hasParams: boolean
   signatureParams: string
   params: Array<{ name: string }>
@@ -25,19 +26,22 @@ export interface MethodLayoutContext {
 
 export interface AbstractClassLayoutContext {
   className: string
+  docstring: string
   showPass: boolean
   childProperties: Array<{ namespace: string; abstractClassName: string }>
   methods: Array<{
     name: string
     hasParams: boolean
     signatureParams: string
     returnType: string
+    docstring: string
   }>
 }
 
 export interface RouteLayoutContext {
   className: string
   abstractClassName: string
+  docstring: string
   abstractClass: AbstractClassLayoutContext
   resourceImportList: string
   childClasses: Array<{
@@ -53,6 +57,57 @@ export interface RouteLayoutContext {
 const waitForActionAttemptParameter =
   'wait_for_action_attempt: Optional[Union[bool, Dict[str, float]]] = None'
 
+const cleanDoc = (value: string): string =>
+  value.trim().replaceAll('"""', '\\"\\"\\"')
+
+const indentDoc = (value: string, spaces: number): string =>
+  value.replaceAll('\n', `\n${' '.repeat(spaces)}`)
+
+const methodDocstring = (
+  method: ClassMethod,
+  sortedParameters: ClassMethod['parameters'],
+): string => {
+  const lines = [cleanDoc(method.description)]
+
+  for (const parameter of sortedParameters) {
+    const deprecated = parameter.isDeprecated
+      ? `Deprecated${parameter.deprecationMessage === '' ? '.' : `: ${cleanDoc(parameter.deprecationMessage)}`}`
+      : ''
+    const description = cleanDoc(parameter.description)
+    lines.push(
+      '',
+      `:param ${parameter.name}: ${[deprecated, description].filter(Boolean).join(' ')}`,
+      `:type ${parameter.name}: ${parameter.type}`,
+    )
+  }
+
+  if (method.returnResource === 'ActionAttempt') {
+    lines.push(
+      '',
+      ':param wait_for_action_attempt: Whether, and for how long, to wait for the action attempt to finish.',
+      ':type wait_for_action_attempt: Optional[Union[bool, Dict[str, float]]]',
+    )
+  }
+
+  if (method.returnResource !== 'None') {
+    lines.push(
+      '',
+      `:returns: ${cleanDoc(method.responseDescription)}`,
+      `:rtype: ${method.returnResource}`,
+    )
+  }
+
+  if (method.isDeprecated) {
+    lines.push(
+      '',
+      '.. deprecated::',
+      `   ${cleanDoc(method.deprecationMessage) || 'This method is deprecated.'}`,
+    )
+  }
+
+  return lines.filter((line, index) => line !== '' || index !== 0).join('\n')
+}
+
 export const getMethodLayoutContext = (
   method: ClassMethod,
 ): MethodLayoutContext => {
@@ -83,6 +138,7 @@ export const getMethodLayoutContext = (
   return {
     name: methodName,
     path,
+    docstring: indentDoc(methodDocstring(method, sortedParameters), 8),
     hasParams,
     signatureParams,
     params: sortedParameters.map(({ name }) => ({ name })),
@@ -110,22 +166,27 @@ export const setRouteLayoutContext = (cls: ClassModel): RouteLayoutContext => {
   )
 
   const abstractClassName = `Abstract${cls.name}`
+  const classDocstring = cls.isDeprecated
+    ? indentDoc('.. deprecated::\n   This route is deprecated.', 4)
+    : ''
 
   return {
     className: cls.name,
     abstractClassName,
+    docstring: classDocstring,
     abstractClass: {
       className: abstractClassName,
+      docstring: classDocstring,
       showPass:
         cls.methods.length === 0 && cls.childClassIdentifiers.length === 0,
       childProperties: cls.childClassIdentifiers.map((i) => ({
         namespace: i.namespace,
         abstractClassName: `Abstract${i.className}`,
       })),
       methods: cls.methods.map((method) => {
-        const { name, hasParams, signatureParams, returnType } =
+        const { name, hasParams, signatureParams, returnType, docstring } =
           getMethodLayoutContext(method)
-        return { name, hasParams, signatureParams, returnType }
+        return { name, hasParams, signatureParams, returnType, docstring }
       }),
     },
     resourceImportList: resourceClasses.join(','),

codegen/lib/routes.ts

@@ -42,7 +42,11 @@ export const routes = (
   // Namespaces group routes without endpoints of their own (e.g. /acs) but
   // still produce a route class so their child classes are reachable.
   const classEntries = [...blueprint.namespaces, ...blueprint.routes]
-    .map(({ path, parentPath }) => ({ path, parentPath }))
+    .map(({ path, parentPath, isDeprecated }) => ({
+      path,
+      parentPath,
+      isDeprecated,
+    }))
     .sort((a, b) => (a.path < b.path ? -1 : 1))
 
   const classMap = new Map<string, ClassModel>()
@@ -55,6 +59,7 @@ export const routes = (
     classMap.set(className, {
       name: className,
       namespace,
+      isDeprecated: entry.isDeprecated,
       methods: [],
       childClassIdentifiers: classEntries
         .filter((child) => child.parentPath === entry.path)
@@ -84,9 +89,16 @@ export const routes = (
       cls.methods.push({
         methodName: endpoint.name,
         path: endpoint.path,
+        description: endpoint.description,
+        responseDescription: endpoint.response.description,
+        isDeprecated: endpoint.isDeprecated,
+        deprecationMessage: endpoint.deprecationMessage,
         parameters: endpoint.request.parameters.map((parameter) => ({
           name: parameter.name,
           type: mapParameterToPythonType(parameter),
+          description: parameter.description,
+          isDeprecated: parameter.isDeprecated,
+          deprecationMessage: parameter.deprecationMessage,
           position: parameter.name === idParameterName ? 0 : undefined,
           required: parameter.isRequired,
         })),