griefith/test
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Cleanup: update use of typing in for Python scripts

Browse Source
This commit is contained in:
Campbell Barton
2024-10-23 12:48:09 +11:00
parent 39b9863cca
commit a0453ab87a
40 changed files with 287 additions and 367 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
tools/check_docs/check_docs_code_layout.py
View File

@@ -18,12 +18,6 @@ check_docs_code_layout.py --markdown=markdown.txt
import os
import argparse
from typing import (
List,
Optional,
)
# -----------------------------------------------------------------------------
# Constants
@@ -42,7 +36,7 @@ def text_with_title_underline(text: str, underline: str = "=") -> str:
return "\n{:s}\n{:s}\n".format(text, len(text) * underline)
def html_extract_markdown_from_url(url: str) -> Optional[str]:
def html_extract_markdown_from_url(url: str) -> str | None:
"""
Download
"""
@@ -60,7 +54,7 @@ def html_extract_markdown_from_url(url: str) -> Optional[str]:
# -----------------------------------------------------------------------------
# markdown Text Parsing
def markdown_to_paths(markdown: str) -> List[str]:
def markdown_to_paths(markdown: str) -> list[str]:
file_paths = []
markdown = markdown.replace("<p>", "")
markdown = markdown.replace("</p>", "")
@@ -83,14 +77,14 @@ def markdown_to_paths(markdown: str) -> List[str]:
# -----------------------------------------------------------------------------
# Reporting
def report_known_markdown_paths(file_paths: List[str]) -> None:
def report_known_markdown_paths(file_paths: list[str]) -> None:
heading = "Paths Found in markdown Table"
print(text_with_title_underline(heading))
for p in file_paths:
print("-", p)
def report_missing_source(file_paths: List[str]) -> int:
def report_missing_source(file_paths: list[str]) -> int:
heading = "Missing in Source Dir"
test = [p for p in file_paths if not os.path.exists(os.path.join(SOURCE_DIR, p))]
@@ -108,7 +102,7 @@ def report_missing_source(file_paths: List[str]) -> int:
return len(test)
def report_incomplete(file_paths: List[str]) -> int:
def report_incomplete(file_paths: list[str]) -> int:
heading = "Missing Documentation"
test = []
@@ -137,7 +131,7 @@ def report_incomplete(file_paths: List[str]) -> int:
return len(test)
def report_alphabetical_order(file_paths: List[str]) -> int:
def report_alphabetical_order(file_paths: list[str]) -> int:
heading = "Non-Alphabetically Ordered"
test = []