ci: replace redbaron with griffe in async docstring scripts

Author: vdusek

pyproject.toml

@@ -48,7 +48,7 @@ dev = [
     "black>=24.3.0",
     "datamodel-code-generator[http,ruff]<1.0.0",
     "dycw-pytest-only<3.0.0",
-    "griffe",
+    "griffe<3.0.0",
     "poethepoet<1.0.0",
     "pre-commit<5.0.0",
     "pydoc-markdown<5.0.0",

scripts/_utils.py

@@ -0,0 +1,29 @@
+import pathlib
+import re
+
+PACKAGE_NAME = 'apify_client'
+REPO_ROOT = pathlib.Path(__file__).parent.resolve() / '..'
+PYPROJECT_TOML_FILE_PATH = REPO_ROOT / 'pyproject.toml'
+
+
+SKIPPED_METHODS = {
+    'with_custom_http_client',
+}
+"""Components where the async and sync docstrings are intentionally different."""
+
+
+def sync_to_async_docstring(docstring: str) -> str:
+    """Convert a docstring from a sync component version into a docstring for its async analogue."""
+    substitutions = [
+        (r'Client', r'ClientAsync'),
+        (r'\bsynchronously\b', r'asynchronously'),
+        (r'\bSynchronously\b', r'Asynchronously'),
+        (r'\bsynchronous\b', r'asynchronous'),
+        (r'\bSynchronous\b', r'Asynchronous'),
+        (r'Retry a function', r'Retry an async function'),
+        (r'Function to retry', r'Async function to retry'),
+    ]
+    res = docstring
+    for pattern, replacement in substitutions:
+        res = re.sub(pattern, replacement, res, flags=re.MULTILINE)
+    return res

scripts/check_async_docstrings.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python3
+#!/usr/bin/env python
 
 """Check if async docstrings are the same as sync."""
 
@@ -7,15 +7,10 @@
 from pathlib import Path
 
 from griffe import Module, load
-from utils import sync_to_async_docstring
 
-found_issues = False
+from ._utils import SKIPPED_METHODS, sync_to_async_docstring
 
-# Methods where the async docstring is intentionally different from the sync one
-# (e.g. because they accept different parameter types).
-SKIPPED_METHODS = {
-    'with_custom_http_client',
-}
+found_issues = False
 
 # Load the apify_client package
 src_path = Path(__file__).parent.resolve() / '../src'

scripts/fix_async_docstrings.py

@@ -1,17 +1,12 @@
-#!/usr/bin/env python3
+#!/usr/bin/env python
 
 import ast
 from collections.abc import Generator
 from pathlib import Path
 
 from griffe import Module, load
-from utils import sync_to_async_docstring
 
-# Methods where the async docstring is intentionally different from the sync one
-# (e.g. because they accept different parameter types).
-SKIPPED_METHODS = {
-    'with_custom_http_client',
-}
+from ._utils import SKIPPED_METHODS, sync_to_async_docstring
 
 # Load the apify_client package
 src_path = Path(__file__).parent.resolve() / '../src'