fix #457: Make --exclude option follow symlinked directories

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+### Bug Fixes
+
+-   Fixes a bug where `--exclude` would not follow symlinks when globbing
+    ([#457](https://github.com/tconbeer/sqlfmt/issues/457) - thank you [@jeancochrane](https://github.com/jeancochrane)!).
+
 ## [0.19.1] - 2023-07-13
 
 ### Bug Fixes

src/sqlfmt/api.py

@@ -100,18 +100,19 @@ def get_matching_paths(paths: Iterable[Path], mode: Mode) -> Set[Path]:
         for s in mode.exclude:
             if PurePath(s).is_absolute():
                 exclude_set.update([Path(g) for g in glob(s, recursive=True)])
-            elif mode.exclude_root is not None:
+            else:
+                exclude_root = mode.exclude_root or Path.cwd()
                 try:
-                    exclude_set.update(mode.exclude_root.glob(s))
+                    # Prefer glob.glob() to Path.glob() here, even though the
+                    # latter would be more concise, since Path.glob() does not
+                    # resolve symlinks properly in Python <3.13
+                    exclude_set.update(
+                        [Path(g) for g in glob(str(exclude_root / s), recursive=True)]
+                    )
                 except IndexError:
                     # for some reason Path.glob(".") raises an index error,
                     # although glob.glob(".") returns ["."]
                     pass
-            else:
-                try:
-                    exclude_set.update(Path.cwd().glob(s))
-                except IndexError:
-                    pass
 
     return include_set - exclude_set
 

tests/data/unit_tests/test_api/test_file_discovery/a_directory/symlink_target_directory

@@ -0,0 +1 @@
+symlink_source_directory

tests/unit_tests/test_api.py

@@ -50,6 +50,8 @@ def all_files(file_discovery_dir: Path) -> Set[Path]:
         p / "a_directory/one_file.sql",
         p / "a_directory/nested_directory/another_file.sql",
         p / "a_directory/nested_directory/j2_extension.sql.jinja",
+        p / "a_directory/symlink_source_directory/symlink_file.sql",
+        p / "a_directory/symlink_target_directory/symlink_file.sql",
     }
     return files
 
@@ -74,7 +76,12 @@ def test_file_discovery(
     [
         ["**/*_file*"],
         ["**/*.sql"],
-        ["**/top*", "**/a_directory/*", "**/a_directory/**/another_file.sql"],
+        [
+            "**/top*",
+            "**/a_directory/*",
+            "**/a_directory/**/another_file.sql",
+            "**/a_directory/**/symlink_file.sql",
+        ],
     ],
 )
 def test_file_discovery_with_excludes(