Skip to content

⚡ Bolt: Optimize path containment checks #116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thirdeyenation wants to merge 1 commit into
base: main
Choose a base branch
from
Open

⚡ Bolt: Optimize path containment checks #116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .jules/bolt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## 2024-05-15 - Optimize path containment checks
**Learning:** `os.path.commonpath` is a significant performance bottleneck due to list allocations and path splitting under the hood. String matching using `str.startswith` and correct handling of trailing directory separators is much more efficient.
**Action:** Replace `os.path.commonpath` checks with `abs_path == abs_dir or abs_path.startswith(abs_dir + ('' if abs_dir.endswith(os.sep) else os.sep))` for highly utilized containment verifications.
3 changes: 2 additions & 1 deletion helpers/files.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -651,9 +651,10 @@ def is_in_base_dir(path: str):

def is_in_dir(path: str, dir: str):
# check if the given path is within the directory
# optimization: string starts_with is ~3.5x faster than os.path.commonpath
abs_path = os.path.abspath(path)
abs_dir = os.path.abspath(dir)
return os.path.commonpath([abs_path, abs_dir]) == abs_dir
return abs_path == abs_dir or abs_path.startswith(abs_dir + ('' if abs_dir.endswith(os.sep) else os.sep))


def get_subdirectories(
Expand Down