@apify/docusaurus-plugin-typedoc-api 4.2.9 → 4.2.11-0

package/lib/packages/plugin/src/plugin/python/inheritance.js

@@ -0,0 +1,71 @@
+'use strict';
+
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+const utils = require('./utils.js');
+
+/**
+ * Given an ancestor and a descendant objects, injects the children of the ancestor into the descendant.
+ *
+ * Sets the `extendedTypes` / `extendedBy` properties.
+ * @param ancestor
+ * @param descendant
+ */
+function resolveInheritedSymbols(ancestor, descendant) {
+  descendant.children ??= [];
+  descendant.extendedTypes = [...(descendant.extendedTypes ?? []), {
+    name: ancestor.name,
+    target: ancestor.id,
+    type: 'reference'
+  }];
+  ancestor.extendedBy = [...(ancestor.extendedBy ?? []), {
+    name: descendant.name,
+    target: descendant.id,
+    type: 'reference'
+  }];
+  for (const inheritedChild of ancestor.children ?? []) {
+    const ownChild = descendant.children?.find(x => x.name === inheritedChild.name);
+    if (!ownChild) {
+      const childId = utils.getOID();
+      const _utils$getGroupName = utils.getGroupName(inheritedChild),
+        groupName = _utils$getGroupName.groupName;
+      if (!groupName) {
+        throw new Error(`Couldn't resolve the group name for ${inheritedChild.name} (inherited child of ${ancestor.name})`);
+      }
+      const group = descendant.groups?.find(g => g.title === groupName);
+      if (group) {
+        group.children.push(inheritedChild.id);
+      } else {
+        descendant.groups?.push({
+          children: [inheritedChild.id],
+          title: groupName
+        });
+      }
+      descendant.children.push(_objectSpread(_objectSpread({}, inheritedChild), {}, {
+        id: childId,
+        inheritedFrom: {
+          name: `${ancestor.name}.${inheritedChild.name}`,
+          target: inheritedChild.id,
+          type: 'reference'
+        }
+      }));
+    } else if (!ownChild.comment?.summary?.[0]?.text) {
+      ownChild.inheritedFrom = {
+        name: `${ancestor.name}.${inheritedChild.name}`,
+        target: inheritedChild.id,
+        type: 'reference'
+      };
+      for (const key of Object.keys(inheritedChild)) {
+        if (key !== 'id' && key !== 'inheritedFrom') {
+          // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+          ownChild[key] = inheritedChild[key];
+        }
+      }
+    }
+  }
+}
+exports.resolveInheritedSymbols = resolveInheritedSymbols;
+//# sourceMappingURL=inheritance.js.map

package/lib/packages/plugin/src/plugin/python/inheritance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inheritance.js","sources":["../../../../../../src/plugin/python/inheritance.ts"],"sourcesContent":null,"names":["getOID","getGroupName"],"mappings":";;;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAAS,uBAAuB,CAAC,QAAQ,EAAE,UAAU,EAAE;AAC9D,EAAE,UAAU,CAAC,QAAQ,KAAK,EAAE,CAAC;AAC7B,EAAE,UAAU,CAAC,aAAa,GAAG,CAAC,IAAI,UAAU,CAAC,aAAa,IAAI,EAAE,CAAC,EAAE;AACnE,IAAI,IAAI,EAAE,QAAQ,CAAC,IAAI;AACvB,IAAI,MAAM,EAAE,QAAQ,CAAC,EAAE;AACvB,IAAI,IAAI,EAAE,WAAW;AACrB,GAAG,CAAC,CAAC;AACL,EAAE,QAAQ,CAAC,UAAU,GAAG,CAAC,IAAI,QAAQ,CAAC,UAAU,IAAI,EAAE,CAAC,EAAE;AACzD,IAAI,IAAI,EAAE,UAAU,CAAC,IAAI;AACzB,IAAI,MAAM,EAAE,UAAU,CAAC,EAAE;AACzB,IAAI,IAAI,EAAE,WAAW;AACrB,GAAG,CAAC,CAAC;AACL,EAAE,KAAK,MAAM,cAAc,IAAI,QAAQ,CAAC,QAAQ,IAAI,EAAE,EAAE;AACxD,IAAI,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,cAAc,CAAC,IAAI,CAAC,CAAC;AACpF,IAAI,IAAI,CAAC,QAAQ,EAAE;AACnB,MAAM,MAAM,OAAO,GAAGA,YAAM,EAAE,CAAC;AAC/B,MAAM,MAAM;AACZ,QAAQ,SAAS;AACjB,OAAO,GAAGC,kBAAY,CAAC,cAAc,CAAC,CAAC;AACvC,MAAM,IAAI,CAAC,SAAS,EAAE;AACtB,QAAQ,MAAM,IAAI,KAAK,CAAC,CAAC,oCAAoC,EAAE,cAAc,CAAC,IAAI,CAAC,qBAAqB,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AAC5H,OAAO;AACP,MAAM,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC;AACxE,MAAM,IAAI,KAAK,EAAE;AACjB,QAAQ,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;AAC/C,OAAO,MAAM;AACb,QAAQ,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC;AAChC,UAAU,QAAQ,EAAE,CAAC,cAAc,CAAC,EAAE,CAAC;AACvC,UAAU,KAAK,EAAE,SAAS;AAC1B,SAAS,CAAC,CAAC;AACX,OAAO;AACP,MAAM,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC;AAC/B,QAAQ,GAAG,cAAc;AACzB,QAAQ,EAAE,EAAE,OAAO;AACnB,QAAQ,aAAa,EAAE;AACvB,UAAU,IAAI,EAAE,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC;AACzD,UAAU,MAAM,EAAE,cAAc,CAAC,EAAE;AACnC,UAAU,IAAI,EAAE,WAAW;AAC3B,SAAS;AACT,OAAO,CAAC,CAAC;AACT,KAAK,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE;AACtD,MAAM,QAAQ,CAAC,aAAa,GAAG;AAC/B,QAAQ,IAAI,EAAE,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC;AACvD,QAAQ,MAAM,EAAE,cAAc,CAAC,EAAE;AACjC,QAAQ,IAAI,EAAE,WAAW;AACzB,OAAO,CAAC;AACR,MAAM,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE;AACrD,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,eAAe,EAAE;AACrD;AACA,UAAU,QAAQ,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;AAC9C,SAAS;AACT,OAAO;AACP,KAAK;AACL,GAAG;AACH;;;;"}

package/lib/packages/plugin/src/plugin/python/packageVersions.js

@@ -0,0 +1,46 @@
+'use strict';
+
+const childProcess = require('node:child_process');
+const fs = require('node:fs');
+const path = require('node:path');
+const _interopDefault = e => e && e.__esModule ? e : {
+  default: e
+};
+const childProcess__default = /*#__PURE__*/_interopDefault(childProcess);
+const fs__default = /*#__PURE__*/_interopDefault(fs);
+const path__default = /*#__PURE__*/_interopDefault(path);
+
+/**
+ * Looks for the installed versions of the given packages and returns them as a dictionary.
+ */
+function getPackageGitHubTags(packageNames) {
+  // For each package, get the installed version, and set the tag to the corresponding version
+  const packageTags = {};
+  for (const pkg of packageNames) {
+    const spawnResult = childProcess__default.default.spawnSync('python', ['-c', `import ${pkg}; print(${pkg}.__version__)`]);
+    if (spawnResult.status === 0) {
+      packageTags[pkg] = `v${spawnResult.stdout.toString().trim()}`;
+    }
+  }
+  return packageTags;
+}
+function findNearestInParent(currentPath, filename) {
+  let parentPath = currentPath;
+  while (parentPath !== '/') {
+    parentPath = path__default.default.dirname(parentPath);
+    if (fs__default.default.existsSync(path__default.default.join(parentPath, filename))) {
+      return path__default.default.join(parentPath, filename);
+    }
+  }
+  throw new Error(`No ${filename} found in any parent directory`);
+}
+function getCurrentPackageName(pyprojectTomlPath) {
+  const currentPath = path__default.default.dirname(__dirname);
+  pyprojectTomlPath ??= findNearestInParent(currentPath, 'pyproject.toml');
+  const pyprojectToml = fs__default.default.readFileSync(pyprojectTomlPath, 'utf8');
+  return pyprojectToml.match(/^name = "(.+)"$/m)?.[1];
+}
+exports.findNearestInParent = findNearestInParent;
+exports.getCurrentPackageName = getCurrentPackageName;
+exports.getPackageGitHubTags = getPackageGitHubTags;
+//# sourceMappingURL=packageVersions.js.map

package/lib/packages/plugin/src/plugin/python/packageVersions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"packageVersions.js","sources":["../../../../../../src/plugin/python/packageVersions.ts"],"sourcesContent":null,"names":["childProcess","path","fs"],"mappings":";;;;;;;;;;;;AAIA;AACA;AACA;AACO,SAAS,oBAAoB,CAAC,YAAY,EAAE;AACnD;AACA,EAAE,MAAM,WAAW,GAAG,EAAE,CAAC;AACzB,EAAE,KAAK,MAAM,GAAG,IAAI,YAAY,EAAE;AAClC,IAAI,MAAM,WAAW,GAAGA,6BAAY,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;AAC7G,IAAI,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;AAClC,MAAM,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;AACpE,KAAK;AACL,GAAG;AACH,EAAE,OAAO,WAAW,CAAC;AACrB,CAAC;AACM,SAAS,mBAAmB,CAAC,WAAW,EAAE,QAAQ,EAAE;AAC3D,EAAE,IAAI,UAAU,GAAG,WAAW,CAAC;AAC/B,EAAE,OAAO,UAAU,KAAK,GAAG,EAAE;AAC7B,IAAI,UAAU,GAAGC,qBAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;AAC1C,IAAI,IAAIC,mBAAE,CAAC,UAAU,CAACD,qBAAI,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,EAAE;AACxD,MAAM,OAAOA,qBAAI,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;AAC7C,KAAK;AACL,GAAG;AACH,EAAE,MAAM,IAAI,KAAK,CAAC,CAAC,GAAG,EAAE,QAAQ,CAAC,8BAA8B,CAAC,CAAC,CAAC;AAClE,CAAC;AACM,SAAS,qBAAqB,CAAC,iBAAiB,EAAE;AACzD,EAAE,MAAM,WAAW,GAAGA,qBAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;AAC9C,EAAE,iBAAiB,KAAK,mBAAmB,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAC;AAC3E,EAAE,MAAM,aAAa,GAAGC,mBAAE,CAAC,YAAY,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;AACnE,EAAE,OAAO,aAAa,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC;AACtD;;;;;;"}

package/lib/packages/plugin/src/plugin/python/transformation.js

@@ -0,0 +1,359 @@
+'use strict';
+
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+const consts = require('./consts.js');
+const inheritance = require('./inheritance.js');
+const index = require('./type-parsing/index.js');
+const utils = require('./utils.js');
+class DocspecTransformer {
+  pythonTypeResolver;
+  symbolIdMap = {};
+  namesToIds = {};
+  moduleShortcuts;
+
+  /**
+   * Maps the name of the class to the list of Typedoc objects representing the classes that extend it.
+   *
+   * This is used for resolving the references to the base classes - in case the base class is encountered after the class that extends it.
+   */
+  forwardAncestorRefs = new Map();
+
+  /**
+   * Maps the name of the class to the reference to the Typedoc object representing the class.
+   *
+   * This is used to resolve the references to the base classes of a class using the name.
+   */
+  backwardAncestorRefs = new Map();
+
+  /**
+   * Stack of the docstrings of the current context.
+   *
+   * Used to read the class Google-style docstrings from the class' properties and methods.
+   */
+  contextStack = [];
+  settings = {
+    useDocsGroup: false
+  };
+  constructor({
+    moduleShortcuts
+  }) {
+    this.pythonTypeResolver = new index.PythonTypeResolver();
+    this.moduleShortcuts = moduleShortcuts ?? {};
+  }
+  transform(docspecModules) {
+    // Root object of the Typedoc structure, accumulator for the recursive walk
+    const typedocApiReference = {
+      children: [],
+      flags: {},
+      groups: [],
+      id: 0,
+      kind: 1,
+      kindString: 'Project',
+      name: 'apify-client',
+      sources: [{
+        character: 0,
+        fileName: 'src/index.ts',
+        line: 1
+      }],
+      symbolIdMap: this.symbolIdMap
+    };
+    this.settings.useDocsGroup = utils.projectUsesDocsGroupDecorator(docspecModules);
+
+    // Convert all the modules, store them in the root object
+    for (const module of docspecModules) {
+      this.walkAndTransform({
+        currentDocspecNode: module,
+        moduleName: module.name,
+        parentTypeDoc: typedocApiReference
+      });
+    }
+    this.pythonTypeResolver.resolveTypes();
+    this.namesToIds = Object.entries(this.symbolIdMap).reduce((acc, [id, {
+      qualifiedName
+    }]) => {
+      acc[qualifiedName] = Number(id);
+      return acc;
+    }, {});
+    this.fixRefs(typedocApiReference);
+    this.sortChildren(typedocApiReference);
+    return typedocApiReference;
+  }
+  getContext() {
+    return this.contextStack[this.contextStack.length - 1];
+  }
+  popContext() {
+    this.contextStack.pop();
+  }
+  newContext(context) {
+    this.contextStack.push(context);
+  }
+
+  /**
+   * Recursively traverse the Typedoc structure and fix the references to the named entities.
+   *
+   * Searches for the {@link TypeDocType} structure with the `type` property set to `reference`, and replaces the `target` property
+   * with the corresponding ID of the named entity.
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  fixRefs(obj) {
+    for (const key of Object.keys(obj)) {
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+      if (key === 'name' && obj?.type === 'reference' && this.namesToIds[obj?.name]) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+        obj.target = this.namesToIds[obj?.name];
+      }
+      if (typeof obj[key] === 'object' && obj[key] !== null) {
+        this.fixRefs(obj[key]);
+      }
+    }
+  }
+
+  /**
+   * Given a docspec object outputted by `pydoc-markdown`, transforms this object into the Typedoc structure,
+   * and appends it as a child of the `parentTypeDoc` Typedoc object (which serves as an accumulator for the recursion).
+   * @param obj
+   * @param parent
+   * @param module
+   */
+  walkAndTransform({
+    currentDocspecNode,
+    parentTypeDoc,
+    moduleName
+  }) {
+    if (utils.isHidden(currentDocspecNode)) {
+      for (const docspecMember of currentDocspecNode.members ?? []) {
+        this.walkAndTransform({
+          currentDocspecNode: docspecMember,
+          moduleName,
+          // Skips the hidden member, i.e. its children will be appended to the parent of the hidden member
+          parentTypeDoc
+        });
+      }
+      return;
+    }
+    const _this$getTypedocType = this.getTypedocType(currentDocspecNode, parentTypeDoc),
+      typedocType = _this$getTypedocType.typedocType,
+      typedocKind = _this$getTypedocType.typedocKind;
+    const _this$getGitHubUrls = this.getGitHubUrls(currentDocspecNode),
+      filePathInRepo = _this$getGitHubUrls.filePathInRepo;
+    const docstring = this.parseDocstring(currentDocspecNode);
+    const currentId = utils.getOID();
+    this.symbolIdMap[currentId] = {
+      qualifiedName: currentDocspecNode.name,
+      sourceFileName: filePathInRepo
+    };
+
+    // Get the module name of the member, and check if it has a shortcut (reexport from an ancestor module)
+    const fullName = `${moduleName}.${currentDocspecNode.name}`;
+    if (fullName in this.moduleShortcuts) {
+      moduleName = this.moduleShortcuts[fullName].replace(`.${currentDocspecNode.name}`, '');
+    }
+    currentDocspecNode.name = currentDocspecNode.decorations?.find(d => d.name === 'docs_name')?.args.slice(2, -2) ?? currentDocspecNode.name;
+
+    // Create the Typedoc member object
+    const currentTypedocNode = _objectSpread(_objectSpread({}, typedocKind), {}, {
+      children: [],
+      comment: docstring ? {
+        summary: [{
+          kind: 'text',
+          text: docstring.text
+        }]
+      } : undefined,
+      decorations: currentDocspecNode.decorations?.map(({
+        name,
+        args
+      }) => ({
+        args,
+        name
+      })),
+      flags: {},
+      groups: [],
+      id: currentId,
+      module: moduleName,
+      // This is an extension to the original Typedoc structure, to support showing where the member is exported from
+      name: currentDocspecNode.name,
+      sources: [{
+        character: 1,
+        fileName: filePathInRepo,
+        line: currentDocspecNode.location.lineno
+      }],
+      type: typedocType
+    });
+    if (currentTypedocNode.kindString === 'Method') {
+      currentTypedocNode.signatures = [{
+        comment: docstring.text ? {
+          blockTags: docstring?.returns ? [{
+            content: [{
+              kind: 'text',
+              text: docstring.returns
+            }],
+            tag: '@returns'
+          }] : undefined,
+          summary: [{
+            kind: 'text',
+            text: docstring?.text
+          }]
+        } : undefined,
+        flags: {},
+        id: utils.getOID(),
+        kind: 4096,
+        kindString: 'Call signature',
+        modifiers: currentDocspecNode.modifiers ?? [],
+        name: currentDocspecNode.name,
+        parameters: currentDocspecNode.args?.filter(arg => arg.name !== 'self' && arg.name !== 'cls').map(arg => ({
+          comment: docstring.args?.[arg.name] ? {
+            summary: [{
+              kind: 'text',
+              text: docstring.args[arg.name]
+            }]
+          } : undefined,
+          defaultValue: arg.default_value,
+          flags: {
+            isOptional: arg.datatype?.includes('Optional'),
+            'keyword-only': arg.type === 'KEYWORD_ONLY'
+          },
+          id: utils.getOID(),
+          kind: 32_768,
+          kindString: 'Parameter',
+          name: arg.name,
+          type: this.pythonTypeResolver.registerType(arg.datatype)
+        })),
+        type: this.pythonTypeResolver.registerType(currentDocspecNode.return_type)
+      }];
+    }
+    if (currentTypedocNode.kindString === 'Class') {
+      this.newContext(docstring);
+    }
+    for (const docspecMember of currentDocspecNode.members ?? []) {
+      this.walkAndTransform({
+        currentDocspecNode: docspecMember,
+        moduleName,
+        parentTypeDoc: currentTypedocNode
+      });
+    }
+    if (currentTypedocNode.kindString === 'Class') {
+      this.popContext();
+      if (currentDocspecNode.bases && currentDocspecNode.bases.length > 0) {
+        for (const base of currentDocspecNode.bases) {
+          const canonicalAncestorType = this.pythonTypeResolver.getBaseType(base);
+          const baseTypedocMember = this.backwardAncestorRefs.get(canonicalAncestorType);
+          if (baseTypedocMember) {
+            inheritance.resolveInheritedSymbols(baseTypedocMember, currentTypedocNode);
+          } else {
+            this.forwardAncestorRefs.set(canonicalAncestorType, [...(this.forwardAncestorRefs.get(canonicalAncestorType) ?? []), currentTypedocNode]);
+          }
+        }
+      }
+      this.backwardAncestorRefs.set(currentDocspecNode.name, currentTypedocNode);
+    }
+    const _utils$getGroupName = utils.getGroupName(currentTypedocNode),
+      groupName = _utils$getGroupName.groupName,
+      groupSource = _utils$getGroupName.source;
+    if (groupName && (
+    // If the group comes from a decorator, use it always; otherwise check if the symbol isn't top-level
+    !this.settings.useDocsGroup || groupSource === 'decorator' || parentTypeDoc.kindString !== 'Project')) {
+      const group = parentTypeDoc.groups?.find(g => g.title === groupName);
+      if (group) {
+        group.children.push(currentTypedocNode.id);
+      } else {
+        parentTypeDoc.groups?.push({
+          children: [currentTypedocNode.id],
+          title: groupName
+        });
+      }
+    }
+    parentTypeDoc.children?.push(currentTypedocNode);
+    this.sortChildren(currentTypedocNode);
+    if (currentTypedocNode.kindString === 'Class') {
+      for (const descendant of this.forwardAncestorRefs.get(currentTypedocNode.name) ?? []) {
+        inheritance.resolveInheritedSymbols(currentTypedocNode, descendant);
+        this.sortChildren(descendant);
+      }
+    }
+  }
+
+  // Get the URL of the member in GitHub
+  getGitHubUrls(docspecMember) {
+    const filePathInRepo = docspecMember.location.filename.replace(consts.REPO_ROOT_PLACEHOLDER, '');
+    return {
+      filePathInRepo
+    };
+  }
+
+  /**
+   * Sorts the `groups` of `typedocMember` using {@link groupSort} and sorts the children of each group alphabetically.
+   */
+  sortChildren(typedocMember) {
+    if (!typedocMember.groups) return;
+    for (const group of typedocMember.groups) {
+      group.children.sort((a, b) => {
+        const firstName = typedocMember.children?.find(x => x.id === a || x.inheritedFrom?.target === a)?.name ?? 'a';
+        const secondName = typedocMember.children?.find(x => x.id === b || x.inheritedFrom?.target === b)?.name ?? 'b';
+        return firstName.localeCompare(secondName);
+      });
+    }
+    typedocMember.groups?.sort((a, b) => utils.groupSort(a.title, b.title));
+  }
+
+  /**
+   * If possible, parses the `.docstring` property of the passed object. If the docstring is a stringified JSON object,
+   * it extracts the `args` and `returns` sections and adds them to the returned object.
+   *
+   * TODO
+   * This structure is created in the `google` docstring format, which is a JSON object with the following structure:
+   */
+  parseDocstring(docspecMember) {
+    const docstring = {
+      text: docspecMember.docstring?.content ?? ''
+    };
+    try {
+      const parsedDocstring = JSON.parse(docstring.text);
+      docstring.text = parsedDocstring.text;
+      const parsedArguments = parsedDocstring.sections?.find(section => Object.keys(section)[0] === 'Arguments')?.Arguments ?? [];
+      docstring.args = parsedArguments?.reduce((acc, arg) => {
+        acc[arg.param] = arg.desc;
+        return acc;
+      }, {}) ?? {};
+      const returnTypes = docstring.sections?.find(section => Object.keys(section)[0] === 'Returns')?.Returns ?? [];
+      docstring.returns = returnTypes.join('\n');
+    } catch {
+      // Do nothing
+    }
+    if (!docstring.text) {
+      docstring.text = this.getContext()?.args?.[docspecMember.name] ?? '';
+    }
+    return docstring;
+  }
+
+  /**
+   * Given the current Docspec object and the parent Typedoc object, returns the Typedoc type and kind of the current object.
+   */
+  getTypedocType(docspecMember, parentTypeDoc) {
+    let typedocKind = consts.TYPEDOC_KINDS[docspecMember.type];
+    if (docspecMember.bases?.includes('Enum')) {
+      typedocKind = consts.TYPEDOC_KINDS.enum;
+    }
+    let typedocType = this.pythonTypeResolver.registerType(docspecMember.datatype);
+    if (docspecMember.decorations?.some(d => ['property', 'dualproperty'].includes(d.name))) {
+      typedocKind = consts.TYPEDOC_KINDS.data;
+      typedocType = this.pythonTypeResolver.registerType(docspecMember.return_type ?? docspecMember.datatype);
+    }
+    if (parentTypeDoc.kindString === 'Enumeration') {
+      typedocKind = consts.TYPEDOC_KINDS.enumValue;
+      typedocType = {
+        type: 'literal',
+        value: docspecMember.value
+      };
+    }
+    return {
+      typedocKind,
+      typedocType
+    };
+  }
+}
+exports.DocspecTransformer = DocspecTransformer;
+//# sourceMappingURL=transformation.js.map

package/lib/packages/plugin/src/plugin/python/transformation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transformation.js","sources":["../../../../../../src/plugin/python/transformation.ts"],"sourcesContent":null,"names":["PythonTypeResolver","projectUsesDocsGroupDecorator","isHidden","getOID","resolveInheritedSymbols","getGroupName","REPO_ROOT_PLACEHOLDER","groupSort","TYPEDOC_KINDS"],"mappings":";;;;;;;AAIO,MAAM,kBAAkB,CAAC;AAChC,EAAE,kBAAkB,CAAC;AACrB,EAAE,WAAW,GAAG,EAAE,CAAC;AACnB,EAAE,UAAU,GAAG,EAAE,CAAC;AAClB,EAAE,eAAe,CAAC;AAClB;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,mBAAmB,GAAG,IAAI,GAAG,EAAE,CAAC;AAClC;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,oBAAoB,GAAG,IAAI,GAAG,EAAE,CAAC;AACnC;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,YAAY,GAAG,EAAE,CAAC;AACpB,EAAE,QAAQ,GAAG;AACb,IAAI,YAAY,EAAE,KAAK;AACvB,GAAG,CAAC;AACJ,EAAE,WAAW,CAAC;AACd,IAAI,eAAe;AACnB,GAAG,EAAE;AACL,IAAI,IAAI,CAAC,kBAAkB,GAAG,IAAIA,wBAAkB,EAAE,CAAC;AACvD,IAAI,IAAI,CAAC,eAAe,GAAG,eAAe,IAAI,EAAE,CAAC;AACjD,GAAG;AACH,EAAE,SAAS,CAAC,cAAc,EAAE;AAC5B;AACA,IAAI,MAAM,mBAAmB,GAAG;AAChC,MAAM,QAAQ,EAAE,EAAE;AAClB,MAAM,KAAK,EAAE,EAAE;AACf,MAAM,MAAM,EAAE,EAAE;AAChB,MAAM,EAAE,EAAE,CAAC;AACX,MAAM,IAAI,EAAE,CAAC;AACb,MAAM,UAAU,EAAE,SAAS;AAC3B,MAAM,IAAI,EAAE,cAAc;AAC1B,MAAM,OAAO,EAAE,CAAC;AAChB,QAAQ,SAAS,EAAE,CAAC;AACpB,QAAQ,QAAQ,EAAE,cAAc;AAChC,QAAQ,IAAI,EAAE,CAAC;AACf,OAAO,CAAC;AACR,MAAM,WAAW,EAAE,IAAI,CAAC,WAAW;AACnC,KAAK,CAAC;AACN,IAAI,IAAI,CAAC,QAAQ,CAAC,YAAY,GAAGC,mCAA6B,CAAC,cAAc,CAAC,CAAC;AAC/E;AACA;AACA,IAAI,KAAK,MAAM,MAAM,IAAI,cAAc,EAAE;AACzC,MAAM,IAAI,CAAC,gBAAgB,CAAC;AAC5B,QAAQ,kBAAkB,EAAE,MAAM;AAClC,QAAQ,UAAU,EAAE,MAAM,CAAC,IAAI;AAC/B,QAAQ,aAAa,EAAE,mBAAmB;AAC1C,OAAO,CAAC,CAAC;AACT,KAAK;AACL,IAAI,IAAI,CAAC,kBAAkB,CAAC,YAAY,EAAE,CAAC;AAC3C,IAAI,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE;AACzE,MAAM,aAAa;AACnB,KAAK,CAAC,KAAK;AACX,MAAM,GAAG,CAAC,aAAa,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;AACtC,MAAM,OAAO,GAAG,CAAC;AACjB,KAAK,EAAE,EAAE,CAAC,CAAC;AACX,IAAI,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;AACtC,IAAI,IAAI,CAAC,YAAY,CAAC,mBAAmB,CAAC,CAAC;AAC3C,IAAI,OAAO,mBAAmB,CAAC;AAC/B,GAAG;AACH,EAAE,UAAU,GAAG;AACf,IAAI,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AAC3D,GAAG;AACH,EAAE,UAAU,GAAG;AACf,IAAI,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC;AAC5B,GAAG;AACH,EAAE,UAAU,CAAC,OAAO,EAAE;AACtB,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AACpC,GAAG;AACH;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,OAAO,CAAC,GAAG,EAAE;AACf,IAAI,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;AACxC;AACA,MAAM,IAAI,GAAG,KAAK,MAAM,IAAI,GAAG,EAAE,IAAI,KAAK,WAAW,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE;AACrF;AACA,QAAQ,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;AAChD,OAAO;AACP,MAAM,IAAI,OAAO,GAAG,CAAC,GAAG,CAAC,KAAK,QAAQ,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;AAC7D,QAAQ,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;AAC/B,OAAO;AACP,KAAK;AACL,GAAG;AACH;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,gBAAgB,CAAC;AACnB,IAAI,kBAAkB;AACtB,IAAI,aAAa;AACjB,IAAI,UAAU;AACd,GAAG,EAAE;AACL,IAAI,IAAIC,cAAQ,CAAC,kBAAkB,CAAC,EAAE;AACtC,MAAM,KAAK,MAAM,aAAa,IAAI,kBAAkB,CAAC,OAAO,IAAI,EAAE,EAAE;AACpE,QAAQ,IAAI,CAAC,gBAAgB,CAAC;AAC9B,UAAU,kBAAkB,EAAE,aAAa;AAC3C,UAAU,UAAU;AACpB;AACA,UAAU,aAAa;AACvB,SAAS,CAAC,CAAC;AACX,OAAO;AACP,MAAM,OAAO;AACb,KAAK;AACL,IAAI,MAAM;AACV,MAAM,WAAW;AACjB,MAAM,WAAW;AACjB,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,kBAAkB,EAAE,aAAa,CAAC,CAAC;AAC/D,IAAI,MAAM;AACV,MAAM,cAAc;AACpB,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;AAC/C,IAAI,MAAM,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;AAC9D,IAAI,MAAM,SAAS,GAAGC,YAAM,EAAE,CAAC;AAC/B,IAAI,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG;AAClC,MAAM,aAAa,EAAE,kBAAkB,CAAC,IAAI;AAC5C,MAAM,cAAc,EAAE,cAAc;AACpC,KAAK,CAAC;AACN;AACA;AACA,IAAI,MAAM,QAAQ,GAAG,CAAC,EAAE,UAAU,CAAC,CAAC,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;AAChE,IAAI,IAAI,QAAQ,IAAI,IAAI,CAAC,eAAe,EAAE;AAC1C,MAAM,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAC7F,KAAK;AACL,IAAI,kBAAkB,CAAC,IAAI,GAAG,kBAAkB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,WAAW,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,kBAAkB,CAAC,IAAI,CAAC;AAC9I;AACA;AACA,IAAI,MAAM,kBAAkB,GAAG;AAC/B,MAAM,GAAG,WAAW;AACpB,MAAM,QAAQ,EAAE,EAAE;AAClB,MAAM,OAAO,EAAE,SAAS,GAAG;AAC3B,QAAQ,OAAO,EAAE,CAAC;AAClB,UAAU,IAAI,EAAE,MAAM;AACtB,UAAU,IAAI,EAAE,SAAS,CAAC,IAAI;AAC9B,SAAS,CAAC;AACV,OAAO,GAAG,SAAS;AACnB,MAAM,WAAW,EAAE,kBAAkB,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;AACxD,QAAQ,IAAI;AACZ,QAAQ,IAAI;AACZ,OAAO,MAAM;AACb,QAAQ,IAAI;AACZ,QAAQ,IAAI;AACZ,OAAO,CAAC,CAAC;AACT,MAAM,KAAK,EAAE,EAAE;AACf,MAAM,MAAM,EAAE,EAAE;AAChB,MAAM,EAAE,EAAE,SAAS;AACnB,MAAM,MAAM,EAAE,UAAU;AACxB;AACA,MAAM,IAAI,EAAE,kBAAkB,CAAC,IAAI;AACnC,MAAM,OAAO,EAAE,CAAC;AAChB,QAAQ,SAAS,EAAE,CAAC;AACpB,QAAQ,QAAQ,EAAE,cAAc;AAChC,QAAQ,IAAI,EAAE,kBAAkB,CAAC,QAAQ,CAAC,MAAM;AAChD,OAAO,CAAC;AACR,MAAM,IAAI,EAAE,WAAW;AACvB,KAAK,CAAC;AACN,IAAI,IAAI,kBAAkB,CAAC,UAAU,KAAK,QAAQ,EAAE;AACpD,MAAM,kBAAkB,CAAC,UAAU,GAAG,CAAC;AACvC,QAAQ,OAAO,EAAE,SAAS,CAAC,IAAI,GAAG;AAClC,UAAU,SAAS,EAAE,SAAS,EAAE,OAAO,GAAG,CAAC;AAC3C,YAAY,OAAO,EAAE,CAAC;AACtB,cAAc,IAAI,EAAE,MAAM;AAC1B,cAAc,IAAI,EAAE,SAAS,CAAC,OAAO;AACrC,aAAa,CAAC;AACd,YAAY,GAAG,EAAE,UAAU;AAC3B,WAAW,CAAC,GAAG,SAAS;AACxB,UAAU,OAAO,EAAE,CAAC;AACpB,YAAY,IAAI,EAAE,MAAM;AACxB,YAAY,IAAI,EAAE,SAAS,EAAE,IAAI;AACjC,WAAW,CAAC;AACZ,SAAS,GAAG,SAAS;AACrB,QAAQ,KAAK,EAAE,EAAE;AACjB,QAAQ,EAAE,EAAEA,YAAM,EAAE;AACpB,QAAQ,IAAI,EAAE,IAAI;AAClB,QAAQ,UAAU,EAAE,gBAAgB;AACpC,QAAQ,SAAS,EAAE,kBAAkB,CAAC,SAAS,IAAI,EAAE;AACrD,QAAQ,IAAI,EAAE,kBAAkB,CAAC,IAAI;AACrC,QAAQ,UAAU,EAAE,kBAAkB,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,KAAK,MAAM,IAAI,GAAG,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK;AAClH,UAAU,OAAO,EAAE,SAAS,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG;AAChD,YAAY,OAAO,EAAE,CAAC;AACtB,cAAc,IAAI,EAAE,MAAM;AAC1B,cAAc,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;AAC5C,aAAa,CAAC;AACd,WAAW,GAAG,SAAS;AACvB,UAAU,YAAY,EAAE,GAAG,CAAC,aAAa;AACzC,UAAU,KAAK,EAAE;AACjB,YAAY,UAAU,EAAE,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,UAAU,CAAC;AAC1D,YAAY,cAAc,EAAE,GAAG,CAAC,IAAI,KAAK,cAAc;AACvD,WAAW;AACX,UAAU,EAAE,EAAEA,YAAM,EAAE;AACtB,UAAU,IAAI,EAAE,MAAM;AACtB,UAAU,UAAU,EAAE,WAAW;AACjC,UAAU,IAAI,EAAE,GAAG,CAAC,IAAI;AACxB,UAAU,IAAI,EAAE,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC;AAClE,SAAS,CAAC,CAAC;AACX,QAAQ,IAAI,EAAE,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,kBAAkB,CAAC,WAAW,CAAC;AAClF,OAAO,CAAC,CAAC;AACT,KAAK;AACL,IAAI,IAAI,kBAAkB,CAAC,UAAU,KAAK,OAAO,EAAE;AACnD,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;AACjC,KAAK;AACL,IAAI,KAAK,MAAM,aAAa,IAAI,kBAAkB,CAAC,OAAO,IAAI,EAAE,EAAE;AAClE,MAAM,IAAI,CAAC,gBAAgB,CAAC;AAC5B,QAAQ,kBAAkB,EAAE,aAAa;AACzC,QAAQ,UAAU;AAClB,QAAQ,aAAa,EAAE,kBAAkB;AACzC,OAAO,CAAC,CAAC;AACT,KAAK;AACL,IAAI,IAAI,kBAAkB,CAAC,UAAU,KAAK,OAAO,EAAE;AACnD,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;AACxB,MAAM,IAAI,kBAAkB,CAAC,KAAK,IAAI,kBAAkB,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;AAC3E,QAAQ,KAAK,MAAM,IAAI,IAAI,kBAAkB,CAAC,KAAK,EAAE;AACrD,UAAU,MAAM,qBAAqB,GAAG,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;AAClF,UAAU,MAAM,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;AACzF,UAAU,IAAI,iBAAiB,EAAE;AACjC,YAAYC,mCAAuB,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,CAAC;AAC3E,WAAW,MAAM;AACjB,YAAY,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,qBAAqB,EAAE,CAAC,IAAI,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,qBAAqB,CAAC,IAAI,EAAE,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC;AACtJ,WAAW;AACX,SAAS;AACT,OAAO;AACP,MAAM,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,kBAAkB,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;AACjF,KAAK;AACL,IAAI,MAAM;AACV,MAAM,SAAS;AACf,MAAM,MAAM,EAAE,WAAW;AACzB,KAAK,GAAGC,kBAAY,CAAC,kBAAkB,CAAC,CAAC;AACzC,IAAI,IAAI,SAAS;AACjB;AACA,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,IAAI,WAAW,KAAK,WAAW,IAAI,aAAa,CAAC,UAAU,KAAK,SAAS,CAAC,EAAE;AAC3G,MAAM,MAAM,KAAK,GAAG,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC;AAC3E,MAAM,IAAI,KAAK,EAAE;AACjB,QAAQ,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;AACnD,OAAO,MAAM;AACb,QAAQ,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC;AACnC,UAAU,QAAQ,EAAE,CAAC,kBAAkB,CAAC,EAAE,CAAC;AAC3C,UAAU,KAAK,EAAE,SAAS;AAC1B,SAAS,CAAC,CAAC;AACX,OAAO;AACP,KAAK;AACL,IAAI,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;AACrD,IAAI,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;AAC1C,IAAI,IAAI,kBAAkB,CAAC,UAAU,KAAK,OAAO,EAAE;AACnD,MAAM,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE;AAC5F,QAAQD,mCAAuB,CAAC,kBAAkB,EAAE,UAAU,CAAC,CAAC;AAChE,QAAQ,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;AACtC,OAAO;AACP,KAAK;AACL,GAAG;AACH;AACA;AACA,EAAE,aAAa,CAAC,aAAa,EAAE;AAC/B,IAAI,MAAM,cAAc,GAAG,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAACE,4BAAqB,EAAE,EAAE,CAAC,CAAC;AAC9F,IAAI,OAAO;AACX,MAAM,cAAc;AACpB,KAAK,CAAC;AACN,GAAG;AACH;AACA;AACA;AACA;AACA,EAAE,YAAY,CAAC,aAAa,EAAE;AAC9B,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,OAAO;AACtC,IAAI,KAAK,MAAM,KAAK,IAAI,aAAa,CAAC,MAAM,EAAE;AAC9C,MAAM,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK;AACpC,QAAQ,MAAM,SAAS,GAAG,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,MAAM,KAAK,CAAC,CAAC,EAAE,IAAI,IAAI,GAAG,CAAC;AACtH,QAAQ,MAAM,UAAU,GAAG,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,MAAM,KAAK,CAAC,CAAC,EAAE,IAAI,IAAI,GAAG,CAAC;AACvH,QAAQ,OAAO,SAAS,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;AACnD,OAAO,CAAC,CAAC;AACT,KAAK;AACL,IAAI,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAKC,eAAS,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AACtE,GAAG;AACH;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,cAAc,CAAC,aAAa,EAAE;AAChC,IAAI,MAAM,SAAS,GAAG;AACtB,MAAM,IAAI,EAAE,aAAa,CAAC,SAAS,EAAE,OAAO,IAAI,EAAE;AAClD,KAAK,CAAC;AACN,IAAI,IAAI;AACR,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;AACzD,MAAM,SAAS,CAAC,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC;AAC5C,MAAM,MAAM,eAAe,GAAG,eAAe,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,EAAE,SAAS,IAAI,EAAE,CAAC;AAClI,MAAM,SAAS,CAAC,IAAI,GAAG,eAAe,EAAE,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK;AAC7D,QAAQ,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC;AAClC,QAAQ,OAAO,GAAG,CAAC;AACnB,OAAO,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC;AACnB,MAAM,MAAM,WAAW,GAAG,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,EAAE,OAAO,IAAI,EAAE,CAAC;AACpH,MAAM,SAAS,CAAC,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjD,KAAK,CAAC,MAAM;AACZ;AACA,KAAK;AACL,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE;AACzB,MAAM,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;AAC3E,KAAK;AACL,IAAI,OAAO,SAAS,CAAC;AACrB,GAAG;AACH;AACA;AACA;AACA;AACA,EAAE,cAAc,CAAC,aAAa,EAAE,aAAa,EAAE;AAC/C,IAAI,IAAI,WAAW,GAAGC,oBAAa,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;AACxD,IAAI,IAAI,aAAa,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE;AAC/C,MAAM,WAAW,GAAGA,oBAAa,CAAC,IAAI,CAAC;AACvC,KAAK;AACL,IAAI,IAAI,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;AACnF,IAAI,IAAI,aAAa,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE;AAC7F,MAAM,WAAW,GAAGA,oBAAa,CAAC,IAAI,CAAC;AACvC,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,aAAa,CAAC,WAAW,IAAI,aAAa,CAAC,QAAQ,CAAC,CAAC;AAC9G,KAAK;AACL,IAAI,IAAI,aAAa,CAAC,UAAU,KAAK,aAAa,EAAE;AACpD,MAAM,WAAW,GAAGA,oBAAa,CAAC,SAAS,CAAC;AAC5C,MAAM,WAAW,GAAG;AACpB,QAAQ,IAAI,EAAE,SAAS;AACvB,QAAQ,KAAK,EAAE,aAAa,CAAC,KAAK;AAClC,OAAO,CAAC;AACR,KAAK;AACL,IAAI,OAAO;AACX,MAAM,WAAW;AACjB,MAAM,WAAW;AACjB,KAAK,CAAC;AACN,GAAG;AACH;;;;"}

package/lib/packages/plugin/src/plugin/python/type-parsing/index.js

@@ -0,0 +1,79 @@
+'use strict';
+
+const childProcess = require('node:child_process');
+const fs = require('node:fs');
+const path = require('node:path');
+const _interopDefault = e => e && e.__esModule ? e : {
+  default: e
+};
+const childProcess__default = /*#__PURE__*/_interopDefault(childProcess);
+const fs__default = /*#__PURE__*/_interopDefault(fs);
+const path__default = /*#__PURE__*/_interopDefault(path);
+const RAW_TYPES_JSON_FILEPATH = path__default.default.join(__dirname, 'typedoc-types.raw');
+const PARSED_TYPES_JSON_FILEPATH = path__default.default.join(__dirname, 'typedoc-types-parsed.json');
+const PYTHON_SCRIPT_FILEPATH = path__default.default.join(__dirname, 'parse_types.py');
+
+/**
+ * Keeps track of Typedoc type objects. When `resolveTypes` is called, it tries to parse
+ * the Python types using Python's `ast` module.
+ *
+ * The parsed types are then applied to the original registered Typedoc type objects.
+ */
+class PythonTypeResolver {
+  typedocTypes = [];
+
+  /**
+   * Register a new Python type to be resolved.
+   *
+   * Given a string representation of the type, returns a Typedoc type object.
+   */
+  registerType(docspecType) {
+    const newType = {
+      name: docspecType?.replaceAll(/#.*/g, '').replaceAll('\n', '').trim() ?? 'Undefined',
+      type: 'reference'
+    };
+    this.typedocTypes.push(newType);
+    return newType;
+  }
+
+  /**
+   * Parse the registered Python types using Python's ast module.
+   * For the actual Python implementation, see `parse_types.py`.
+   *
+   * Modifies the objects registered with `registerType` in-place.
+   *
+   * @param typedocTypes The "opaque" Python types to parse.
+   * @returns {void} Nothing. The registered types are mutated in-place.
+   */
+  resolveTypes() {
+    fs__default.default.writeFileSync(RAW_TYPES_JSON_FILEPATH, JSON.stringify(this.typedocTypes.map(x => {
+      if (x.type === 'reference') {
+        return x.name;
+      }
+      return null;
+    }).filter(Boolean)));
+    childProcess__default.default.spawnSync('python', [PYTHON_SCRIPT_FILEPATH, RAW_TYPES_JSON_FILEPATH]);
+    const parsedTypes = JSON.parse(fs__default.default.readFileSync(PARSED_TYPES_JSON_FILEPATH, 'utf8'));
+    for (const originalType of this.typedocTypes) {
+      if (originalType.type === 'reference') {
+        const parsedType = parsedTypes[originalType.name];
+        if (parsedType) {
+          for (const key of Object.keys(parsedType)) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            originalType[key] = parsedType[key];
+          }
+        }
+      }
+    }
+  }
+
+  /**
+   * Strips the Optional[] type from the type string,
+   * and replaces generic types with just the main type.
+   */
+  getBaseType(type) {
+    return type?.replace(/Optional\[(.*)]/g, '$1').split('[')[0];
+  }
+}
+exports.PythonTypeResolver = PythonTypeResolver;
+//# sourceMappingURL=index.js.map

package/lib/packages/plugin/src/plugin/python/type-parsing/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../../../../../../src/plugin/python/type-parsing/index.ts"],"sourcesContent":null,"names":["path","fs","childProcess"],"mappings":";;;;;;;;;;;;AAGA,MAAM,uBAAuB,GAAGA,qBAAI,CAAC,IAAI,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;AAC1E,MAAM,0BAA0B,GAAGA,qBAAI,CAAC,IAAI,CAAC,SAAS,EAAE,2BAA2B,CAAC,CAAC;AACrF,MAAM,sBAAsB,GAAGA,qBAAI,CAAC,IAAI,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;AACtE;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAM,kBAAkB,CAAC;AAChC,EAAE,YAAY,GAAG,EAAE,CAAC;AACpB;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,YAAY,CAAC,WAAW,EAAE;AAC5B,IAAI,MAAM,OAAO,GAAG;AACpB,MAAM,IAAI,EAAE,WAAW,EAAE,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,WAAW;AAC1F,MAAM,IAAI,EAAE,WAAW;AACvB,KAAK,CAAC;AACN,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AACpC,IAAI,OAAO,OAAO,CAAC;AACnB,GAAG;AACH;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,YAAY,GAAG;AACjB,IAAIC,mBAAE,CAAC,aAAa,CAAC,uBAAuB,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,IAAI;AACxF,MAAM,IAAI,CAAC,CAAC,IAAI,KAAK,WAAW,EAAE;AAClC,QAAQ,OAAO,CAAC,CAAC,IAAI,CAAC;AACtB,OAAO;AACP,MAAM,OAAO,IAAI,CAAC;AAClB,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AACzB,IAAIC,6BAAY,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,sBAAsB,EAAE,uBAAuB,CAAC,CAAC,CAAC;AACxF,IAAI,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAACD,mBAAE,CAAC,YAAY,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC,CAAC;AACxF,IAAI,KAAK,MAAM,YAAY,IAAI,IAAI,CAAC,YAAY,EAAE;AAClD,MAAM,IAAI,YAAY,CAAC,IAAI,KAAK,WAAW,EAAE;AAC7C,QAAQ,MAAM,UAAU,GAAG,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;AAC1D,QAAQ,IAAI,UAAU,EAAE;AACxB,UAAU,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;AACrD;AACA,YAAY,YAAY,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;AAChD,WAAW;AACX,SAAS;AACT,OAAO;AACP,KAAK;AACL,GAAG;AACH;AACA;AACA;AACA;AACA;AACA,EAAE,WAAW,CAAC,IAAI,EAAE;AACpB,IAAI,OAAO,IAAI,EAAE,OAAO,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AACjE,GAAG;AACH;;;;"}

package/lib/packages/plugin/src/plugin/python/types.js

@@ -0,0 +1,2 @@
+'use strict';
+//# sourceMappingURL=types.js.map

package/lib/packages/plugin/src/plugin/python/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sources":[],"sourcesContent":null,"names":[],"mappings":";;"}