fixes #807

Author: jph00

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 <!-- do not remove -->
 
+## 1.12.41
+
+
+
+
 ## 1.12.40
 
 ### New Features

fastcore/_modidx.py

@@ -868,4 +868,5 @@
                                 'fastcore.xtras.untar_dir': ('xtras.html#untar_dir', 'fastcore/xtras.py'),
                                 'fastcore.xtras.utc2local': ('xtras.html#utc2local', 'fastcore/xtras.py'),
                                 'fastcore.xtras.vars_pub': ('xtras.html#vars_pub', 'fastcore/xtras.py'),
-                                'fastcore.xtras.walk': ('xtras.html#walk', 'fastcore/xtras.py')}}}
+                                'fastcore.xtras.walk': ('xtras.html#walk', 'fastcore/xtras.py'),
+                                'fastcore.xtras.walk_join': ('xtras.html#walk_join', 'fastcore/xtras.py')}}}

fastcore/xtras.py

@@ -3,9 +3,9 @@
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/03_xtras.ipynb.
 
 # %% auto #0
-__all__ = ['spark_chars', 'UNSET', 'walk', 'exttypes', 'globtastic', 'pglob', 'maybe_open', 'mkdir', 'image_size', 'img_bytes',
-           'detect_mime', 'bunzip', 'loads', 'loads_multi', 'dumps', 'untar_dir', 'repo_details', 'shell', 'ssh',
-           'rsync_multi', 'run', 'open_file', 'save_pickle', 'load_pickle', 'parse_env', 'expand_wildcards',
+__all__ = ['spark_chars', 'UNSET', 'walk_join', 'walk', 'exttypes', 'globtastic', 'pglob', 'maybe_open', 'mkdir', 'image_size',
+           'img_bytes', 'detect_mime', 'bunzip', 'loads', 'loads_multi', 'dumps', 'untar_dir', 'repo_details', 'shell',
+           'ssh', 'rsync_multi', 'run', 'open_file', 'save_pickle', 'load_pickle', 'parse_env', 'expand_wildcards',
            'atomic_save', 'dict2obj', 'obj2dict', 'repr_dict', 'is_listy', 'mapped', 'IterLen', 'ReindexCollection',
            'SaveReturn', 'trim_wraps', 'save_iter', 'asave_iter', 'frontmatter', 'clean_cli_output', 'unqid',
            'rtoken_hex', 'friendly_name', 'n_friendly_names', 'exec_eval', 'get_source_link', 'sparkline',
@@ -33,25 +33,36 @@
 from dataclasses import dataclass, field, fields, is_dataclass, MISSING, make_dataclass
 
 # %% ../nbs/03_xtras.ipynb #f64c2b09
+def walk_join(root, name):
+    return (p:=os.path.join(root, name)) + ('/' if os.path.isdir(p) else '')
+
+# %% ../nbs/03_xtras.ipynb #33decc5e
 def walk(
     path:Path|str, # path to start searching
     symlinks:bool=True, # follow symlinks?
     keep_file:callable=ret_true, # function that returns True for wanted files
     keep_folder:callable=ret_true, # function that returns True for folders to enter
     skip_folder:callable=ret_false, # function that returns True for folders to skip
-    func:callable=os.path.join, # function to apply to each matched file
-    ret_folders:bool=False, # return folders, not just files
-    sort:bool=True # sort files by name within each folder
+    func:callable=walk_join, # function applied to each entry; default adds `/` to folders
+    ret_folders:bool=False, # include folder entries inline with files?
+    sort:bool=True, # sort entries alphabetically within each folder?
+    maxdepth:int=None, # max depth to descend (1=just immediate contents; None=unlimited)
 ):
-    "Generator version of `os.walk`, using functions to filter files and folders"
-    from copy import copy
-    for root,dirs,files in os.walk(path, followlinks=symlinks):
-        if keep_folder(root,''):
-            if ret_folders: yield func(root, '')
-            if sort: files = sorted(files)
-            yield from (func(root, name) for name in files if keep_file(root,name))
-        for name in copy(dirs):
-            if skip_folder(root,name): dirs.remove(name)
+    "Generator: yields files and (optionally) folders as unified, inline-sorted entries"
+    path = Path(path)
+    def _walk(root, depth):
+        try: entries = list(os.scandir(root))
+        except OSError: return
+        if sort: entries.sort(key=lambda e: e.name)
+        at_max = maxdepth is not None and depth >= maxdepth-1
+        for e in entries:
+            if e.is_dir(follow_symlinks=symlinks):
+                if skip_folder(root, e.name): continue
+                keep = keep_folder(root, e.name)
+                if ret_folders and keep: yield func(root, e.name)
+                if keep and not at_max: yield from _walk(e.path, depth+1)
+            elif keep_file(root, e.name): yield func(root, e.name)
+    yield from _walk(str(path), 0)
 
 # %% ../nbs/03_xtras.ipynb #12a01ff4
 _exttypes = dict(
@@ -79,14 +90,15 @@ def exttypes(types):
 def globtastic(
     path:Path|str='.', # path to start searching
     recursive:bool=True, # search subfolders
+    maxdepth:int=None, # max depth to descend (1=just immediate contents; None=unlimited)
     symlinks:bool=True, # follow symlinks?
     file_glob:str=None, # Only include files matching glob
     file_re:str=None, # Only include files matching regex
     folder_re:str=None, # Only enter folders matching regex
     skip_file_glob:str=None, # Skip files matching glob
     skip_file_re:str=None, # Skip files matching regex
     skip_folder_re:str=None, # Skip folders matching regex,
-    func:callable=os.path.join, # function to apply to each matched file
+    func:callable=walk_join, # function to apply to each matched file
     ret_folders:bool=False, # return folders, not just files
     sort:bool=True, # sort files by name within each folder
     types:str|list=None,  # list or comma-separated str of ext types from: py, js, java, c, cpp, rb, r, ex, sh, web, doc, cfg
@@ -111,8 +123,8 @@ def _keep_file(root, name):
                 not skip_file_re or not skip_file_re.search(name))
     def _keep_folder(root, name): return not folder_re or folder_re.search(os.path.join(root,name))
     def _skip_folder(root, name): return skip_folder_re and skip_folder_re.search(name)
-    return L(walk(path, symlinks=symlinks, keep_file=_keep_file, keep_folder=_keep_folder, skip_folder=_skip_folder,
-                  func=func, ret_folders=ret_folders, sort=sort))
+    return L(walk(path, symlinks=symlinks, maxdepth=maxdepth, keep_file=_keep_file, keep_folder=_keep_folder,
+                  skip_folder=_skip_folder, func=func, ret_folders=ret_folders, sort=sort))
 
 # %% ../nbs/03_xtras.ipynb #827b4914
 @fdelegates(globtastic)
@@ -447,8 +459,9 @@ def repr_dict(d):
 
 # %% ../nbs/03_xtras.ipynb #20842e1f
 def is_listy(x):
-    "`isinstance(x, (tuple,list,L,slice,Generator))`"
-    return isinstance(x, (tuple,list,L,slice,Generator))
+    "`isinstance(x, (tuple,list,L,slice,Generator,set,frozenset))`"
+    return isinstance(x, (tuple,list,L,slice,Generator,set,frozenset))
+
 
 # %% ../nbs/03_xtras.ipynb #40c2c641
 def mapped(f, it):