-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into struct-op-tools
- Loading branch information
Showing
6 changed files
with
236 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
import os | ||
import re | ||
from pathlib import Path | ||
import black | ||
|
||
DEFAULT_LINE_LENGTH = 70 | ||
BASE_DIR = Path(__file__).resolve().parent | ||
MDX_DIR = BASE_DIR / "../../fern/pages" | ||
FILE_PATTERN = re.compile(r"\.mdx$") | ||
|
||
|
||
def find_files_by_pattern(directory, pattern): | ||
""" | ||
Finds all files in the given directory that match the provided regex pattern. | ||
""" | ||
directory = Path(directory).resolve() | ||
if not directory.is_dir(): | ||
raise ValueError(f"Provided directory {directory} is not valid.") | ||
return [f for f in directory.rglob('*') if f.is_file() and pattern.search(f.name)] | ||
|
||
|
||
def format_python_snippets_in_mdx(file_path, line_length=DEFAULT_LINE_LENGTH): | ||
""" | ||
Formats Python code snippets inside MDX files using Black. | ||
""" | ||
black_mode = black.FileMode(line_length=line_length) | ||
code_block_pattern = re.compile(r"```python\n(.*?)\n```", re.DOTALL) | ||
|
||
with open(file_path, 'r', encoding='utf-8') as file: | ||
original_content = file.read() | ||
|
||
def format_with_black(match): | ||
code = match.group(1) | ||
formatted_code = black.format_str(code, mode=black_mode) | ||
return f"```python\n{formatted_code.strip()}\n```" | ||
|
||
new_content = code_block_pattern.sub(format_with_black, original_content) | ||
|
||
with open(file_path, 'w', encoding='utf-8') as file: | ||
file.write(new_content) | ||
|
||
return original_content, new_content | ||
|
||
|
||
def process_mdx_files(directory, file_pattern, line_length=DEFAULT_LINE_LENGTH, check_changes=False): | ||
""" | ||
Processes all MDX files in the directory, formatting Python code snippets. | ||
Args: | ||
directory (Path or str): Path to the directory containing MDX files. | ||
file_pattern (re.Pattern): Regex pattern to match MDX files. | ||
line_length (int): Line length to use for Black formatting. | ||
check_changes (bool): If True, raises an exception if changes are detected. | ||
""" | ||
matching_files = find_files_by_pattern(directory, file_pattern) | ||
files_changed = [] | ||
|
||
for file_path in matching_files: | ||
original_content, new_content = format_python_snippets_in_mdx(file_path, line_length) | ||
|
||
if original_content != new_content: | ||
files_changed.append(file_path) | ||
|
||
if check_changes and files_changed: | ||
raise RuntimeError( | ||
f"The following files were modified during the run:\n" | ||
+ "\n".join(str(file) for file in files_changed) | ||
) | ||
|
||
|
||
if __name__ == "__main__": | ||
import sys | ||
|
||
path = sys.argv[1] if len(sys.argv) > 1 else MDX_DIR | ||
line_length = int(sys.argv[2]) if len(sys.argv) > 2 else DEFAULT_LINE_LENGTH | ||
check_changes = os.getenv("CI") == "true" # Set to True in CI pipeline | ||
|
||
if Path(path).is_dir(): | ||
process_mdx_files(path, FILE_PATTERN, line_length, check_changes) | ||
elif Path(path).is_file(): | ||
if FILE_PATTERN.search(path): | ||
process_mdx_files(Path(path).parent, FILE_PATTERN, line_length, check_changes) | ||
else: | ||
print("The specified file does not match the MDX pattern.") | ||
else: | ||
print("Provided path is not valid.") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
name: check-python-code-snippets | ||
|
||
on: | ||
pull_request: | ||
branches: | ||
- main | ||
paths: | ||
- 'fern/pages/**/*.mdx' | ||
- 'fern/pages/**/**/*.mdx' | ||
|
||
jobs: | ||
run: | ||
runs-on: ubuntu-latest | ||
permissions: write-all | ||
|
||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v4 | ||
|
||
- name: Set up Python | ||
uses: actions/setup-python@v4 | ||
with: | ||
python-version: '3.11' | ||
|
||
- name: Install Poetry | ||
shell: bash | ||
run: | | ||
pipx install poetry | ||
- name: Install Project Dependencies with Poetry | ||
shell: bash | ||
run: | | ||
poetry install | ||
- name: Run Python MDX Snippet Formatter | ||
shell: bash | ||
env: | ||
CI: true | ||
run: poetry run python .github/scripts/check_python_code_snippets.py fern/pages |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters