doc db to include types.* (RustPython#6391)

* Add types.* for doc/generate.py

* udpate-doc-db workflow

* Update doc DB for CPython 3.13.9

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: youknowone

.github/workflows/update-doc-db.yml

@@ -1,7 +1,7 @@
 name: Update doc DB
 
 permissions:
-  contents: read
+  contents: write
 
 on:
   workflow_dispatch:
@@ -10,11 +10,14 @@ on:
         description: Target python version to generate doc db for
         type: string
         default: "3.13.9"
+      ref:
+        description: Branch to commit to (leave empty for current branch)
+        type: string
+        default: ""
 
 defaults:
   run:
     shell: bash
-    working-directory: ./crates/rustpython-doc
 
 jobs:
   generate:
@@ -30,19 +33,19 @@ jobs:
         with:
           persist-credentials: false
           sparse-checkout: |
-            crates/rustpython-doc
+            crates/doc
 
       - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0
         with:
           python-version: ${{ inputs.python-version }}
 
       - name: Generate docs
-        run: python ./generate.py
+        run: python crates/doc/generate.py
 
       - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
         with:
           name: doc-db-${{ inputs.python-version }}-${{ matrix.os }}
-          path: "crates/rustpython-doc/generated/*.json"
+          path: "crates/doc/generated/*.json"
           if-no-files-found: error
           retention-days: 7
           overwrite: true
@@ -53,26 +56,25 @@ jobs:
     steps:
       - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
         with:
-          persist-credentials: false
-          sparse-checkout: |
-            crates/rustpython-doc
+          ref: ${{ inputs.ref || github.ref }}
+          token: ${{ secrets.AUTO_COMMIT_PAT }}
 
       - name: Download generated doc DBs
         uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6.0.0
         with:
           pattern: "doc-db-${{ inputs.python-version }}-**"
-          path: crates/rustpython-doc/generated/
+          path: crates/doc/generated/
           merge-multiple: true
 
       - name: Transform JSON
         run: |
           # Merge all artifacts
-          jq -s "add" --sort-keys generated/*.json > generated/merged.json
+          jq -s "add" --sort-keys crates/doc/generated/*.json > crates/doc/generated/merged.json
 
           # Format merged json for the phf macro
-          jq -r 'to_entries[] | "    \(.key | @json) => \(.value | @json),"' generated/merged.json > generated/raw_entries.txt
+          jq -r 'to_entries[] | "    \(.key | @json) => \(.value | @json),"' crates/doc/generated/merged.json > crates/doc/generated/raw_entries.txt
 
-          OUTPUT_FILE='src/data.inc.rs'
+          OUTPUT_FILE='crates/doc/src/data.inc.rs'
 
           echo -n '' > $OUTPUT_FILE
 
@@ -83,13 +85,24 @@ jobs:
           echo '' >> $OUTPUT_FILE
 
           echo "pub static DB: phf::Map<&'static str, &'static str> = phf::phf_map! {" >> $OUTPUT_FILE
-          cat generated/raw_entries.txt >> $OUTPUT_FILE
+          cat crates/doc/generated/raw_entries.txt >> $OUTPUT_FILE
           echo '};' >> $OUTPUT_FILE
 
       - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0
         with:
           name: doc-db-${{ inputs.python-version }}
-          path: "crates/rustpython-doc/src/data.inc.rs"
+          path: "crates/doc/src/data.inc.rs"
           if-no-files-found: error
           retention-days: 7
           overwrite: true
+
+      - name: Commit and push (non-main branches only)
+        if: github.ref != 'refs/heads/main' && inputs.ref != 'main'
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          if [ -n "$(git status --porcelain)" ]; then
+            git add crates/doc/src/data.inc.rs
+            git commit -m "Update doc DB for CPython ${{ inputs.python-version }}"
+            git push
+          fi

crates/doc/generate.py

@@ -194,6 +194,15 @@ def find_doc_entries() -> "Iterable[DocEntry]":
         type(str().__iter__()),
         type(tuple().__iter__()),
     ]
+
+    # Add types from the types module (e.g., ModuleType, FunctionType, etc.)
+    for name in dir(types):
+        if name.startswith("_"):
+            continue
+        obj = getattr(types, name)
+        if isinstance(obj, type):
+            builtin_types.append(obj)
+
     for typ in builtin_types:
         parts = ("builtins", typ.__name__)
         yield DocEntry(parts, pydoc._getowndoc(typ))
@@ -204,7 +213,7 @@ def main():
     docs = {
         entry.key: entry.doc
         for entry in find_doc_entries()
-        if entry.raw_doc is not None
+        if entry.raw_doc is not None and isinstance(entry.raw_doc, str)
     }
     dumped = json.dumps(docs, sort_keys=True, indent=4)
     OUTPUT_FILE.write_text(dumped)