0.6.0

.github/workflows/pr_tests.yaml

@@ -31,7 +31,6 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: |
-            3.8
             3.9
             3.10
       - name: Set $PY environment variable
@@ -55,7 +54,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
         pydantic-version: ["pydantic-v1", "pydantic-v2"]
       fail-fast: false
 
@@ -491,7 +490,7 @@ jobs:
           version: "latest"
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.8"
+          python-version: "3.12"
 
       - name: Get coverage files
         uses: actions/download-artifact@v4

docs/create_api_docs.py

@@ -63,7 +63,8 @@ def _get_submodules(package_name: str) -> List[str]:
 
 
 def _import_submodules(
-    module_name: str, include_public_api_only: bool = False
+    module_name: str,
+    include_public_api_only: bool = False,
 ) -> Optional[List[ModuleType]]:
     def _import_module(name: str) -> Optional[ModuleType]:
         try:
@@ -89,7 +90,8 @@ def _import_module(name: str) -> Optional[ModuleType]:
 
 
 def _import_functions_and_classes(
-    m: ModuleType, include_public_api_only: bool = False
+    m: ModuleType,
+    include_public_api_only: bool = False,
 ) -> List[Tuple[str, Union[FunctionType, Type[Any]]]]:
     funcs_and_classes = []
     if not include_public_api_only:
@@ -112,20 +114,23 @@ def _is_private(name: str) -> bool:
 
 
 def _import_all_members(
-    module_name: str, include_public_api_only: bool = False
+    module_name: str,
+    include_public_api_only: bool = False,
 ) -> List[str]:
     submodules = _import_submodules(
-        module_name, include_public_api_only=include_public_api_only
+        module_name,
+        include_public_api_only=include_public_api_only,
     )
     members: List[Tuple[str, Union[FunctionType, Type[Any]]]] = list(
         itertools.chain(
             *[
                 _import_functions_and_classes(
-                    m, include_public_api_only=include_public_api_only
+                    m,
+                    include_public_api_only=include_public_api_only,
                 )
                 for m in submodules
-            ]
-        )
+            ],
+        ),
     )
 
     names = [
@@ -168,9 +173,8 @@ def _get_api_summary_item(x: str) -> str:
     if x.endswith("."):
         indent = " " * (4 * (len(xs) - 1 + 1))
         return f"{indent}- {xs[-2]}"
-    else:
-        indent = " " * (4 * (len(xs) + 1))
-        return f"{indent}- [{xs[-1]}](api/{'/'.join(xs)}.md)"
+    indent = " " * (4 * (len(xs) + 1))
+    return f"{indent}- [{xs[-1]}](api/{'/'.join(xs)}.md)"
 
 
 def _get_api_summary(members: List[str]) -> str:
@@ -236,7 +240,9 @@ def _load_submodules(
 
 
 def _update_single_api_doc(
-    symbol: Union[FunctionType, Type[Any]], docs_path: Path, module_name: str
+    symbol: Union[FunctionType, Type[Any]],
+    docs_path: Path,
+    module_name: str,
 ) -> None:
     en_docs_path = docs_path / "docs" / "en"
 
@@ -263,11 +269,15 @@ def _update_single_api_doc(
 
 
 def _update_api_docs(
-    symbols: List[Union[FunctionType, Type[Any]]], docs_path: Path, module_name: str
+    symbols: List[Union[FunctionType, Type[Any]]],
+    docs_path: Path,
+    module_name: str,
 ) -> None:
     for symbol in symbols:
         _update_single_api_doc(
-            symbol=symbol, docs_path=docs_path, module_name=module_name
+            symbol=symbol,
+            docs_path=docs_path,
+            module_name=module_name,
         )
 
 
@@ -284,8 +294,8 @@ def _generate_api_docs_for_module(root_path: Path, module_name: str) -> Tuple[st
     """
     public_api_summary = _get_api_summary(
         _add_all_submodules(
-            _import_all_members(module_name, include_public_api_only=True)
-        )
+            _import_all_members(module_name, include_public_api_only=True),
+        ),
     )
     # Using public_api/ symlink pointing to api/ because of the issue
     # https://github.com/mkdocs/mkdocs/issues/1974
@@ -308,7 +318,7 @@ def _generate_api_docs_for_module(root_path: Path, module_name: str) -> Tuple[st
 
     _update_api_docs(symbols, root_path, module_name)
 
-    # todo: fix the problem and remove this
+    # TODO: fix the problem and remove this
     src = """                    - [ContactDict](api/faststream/asyncapi/schema/info/ContactDict.md)
 """
     dst = """                    - [ContactDict](api/faststream/asyncapi/schema/info/ContactDict.md)

docs/docs.py

@@ -22,7 +22,7 @@
 CONFIG = BASE_DIR / "mkdocs.yml"
 DOCS_DIR = BASE_DIR / "docs"
 LANGUAGES_DIRS = tuple(
-    filter(lambda f: f.is_dir() and f.name not in IGNORE_DIRS, DOCS_DIR.iterdir())
+    filter(lambda f: f.is_dir() and f.name not in IGNORE_DIRS, DOCS_DIR.iterdir()),
 )
 BUILD_DIR = BASE_DIR / "site"
 
@@ -125,7 +125,7 @@ def add(path=typer.Argument(...)):
             not_exists.append(i)
             file.write_text(
                 f"# {title or get_default_title(file)} \n"
-                "{! " + get_in_progress(i.name) + " !}"
+                "{! " + get_in_progress(i.name) + " !}",
             )
             typer.echo(f"{file} - write `in progress`")
 
@@ -134,7 +134,7 @@ def add(path=typer.Argument(...)):
             file = i / path
             file.write_text(
                 f"# {title or get_default_title(file)} \n"
-                "{! " + get_missing_translation(i.name) + " !}"
+                "{! " + get_missing_translation(i.name) + " !}",
             )
             typer.echo(f"{file} - write `missing translation`")
 
@@ -172,9 +172,8 @@ def mv(path: str = typer.Argument(...), new_path: str = typer.Argument(...)):
 @app.command()
 def update_readme() -> None:
     """Update README.md by expanding embeddings in docs/docs/en/index.md."""
-    # todo: fix this function
+    # TODO: fix this function
     typer.echo("Skipping updating README.md for now")
-    return None
 
     # typer.echo(f"Updating README.md")
     # expand_markdown(input_markdown_path=EN_INDEX_PATH, output_markdown_path=README_PATH)
@@ -208,9 +207,9 @@ def update_contributing():
             (
                 f"> **_NOTE:_**  This is an auto-generated file. Please edit {relative_path} instead.",
                 *content,
-            )
+            ),
         )
-        + "\n"
+        + "\n",
     )