fixes #697

Author: jph00

fastcore/tools.py

@@ -131,7 +131,7 @@ def strs_replace(
     old_strs:list[str], # List of strings to find and replace
     new_strs:list[str], # List of replacement strings (must match length of old_strs)
 ):
-    "Replace for each str pair in old_strs,new_strs call `str_replace"
+    "Replace for each str pair in old_strs,new_strs"
     res = [str_replace(path, old, new) for (old,new) in zip(old_strs,new_strs)]
     return 'Results for each replacement:\n' + '; '.join(res)
 

fastcore/xml.py

@@ -136,7 +136,9 @@ class Safe(str):
     def __html__(self): return self
 
 # %% ../nbs/09_xml.ipynb
-def _escape(s): return '' if s is None else s.__html__() if hasattr(s, '__html__') else escape(s) if isinstance(s, str) else s
+def _escape(s):
+    return '' if s is None else s.__html__() if hasattr(s, '__html__') \
+        else escape(s, quote=False) if isinstance(s, str) else s
 def _noescape(s): return '' if s is None else s.__html__() if hasattr(s, '__html__') else s
 
 # %% ../nbs/09_xml.ipynb

fastcore/xtras.py

@@ -39,13 +39,15 @@ def walk(
     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
+    ret_folders:bool=False, # return folders, not just files
+    sort:bool=True # sort files by name within each folder
 ):
     "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)
@@ -62,7 +64,8 @@ def globtastic(
     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
-    ret_folders:bool=False  # return folders, not just files
+    ret_folders:bool=False, # return folders, not just files
+    sort:bool=True # sort files by name within each folder
 )->L: # Paths to matched files
     "A more powerful `glob`, including regex matches, symlink handling, and skip parameters"
     from fnmatch import fnmatch
@@ -79,7 +82,7 @@ def _keep_file(root, 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))
+                  func=func, ret_folders=ret_folders, sort=sort))
 
 # %% ../nbs/03_xtras.ipynb
 @contextmanager

nbs/03_xtras.ipynb

@@ -93,13 +93,15 @@
     "    keep_folder:callable=ret_true, # function that returns True for folders to enter\n",
     "    skip_folder:callable=ret_false, # function that returns True for folders to skip\n",
     "    func:callable=os.path.join, # function to apply to each matched file\n",
-    "    ret_folders:bool=False  # return folders, not just files\n",
+    "    ret_folders:bool=False, # return folders, not just files\n",
+    "    sort:bool=True # sort files by name within each folder\n",
     "):\n",
     "    \"Generator version of `os.walk`, using functions to filter files and folders\"\n",
     "    from copy import copy\n",
     "    for root,dirs,files in os.walk(path, followlinks=symlinks):\n",
     "        if keep_folder(root,''):\n",
     "            if ret_folders: yield func(root, '')\n",
+    "            if sort: files = sorted(files)\n",
     "            yield from (func(root, name) for name in files if keep_file(root,name))\n",
     "        for name in copy(dirs):\n",
     "            if skip_folder(root,name): dirs.remove(name)"
@@ -123,7 +125,8 @@
     "    skip_file_re:str=None, # Skip files matching regex\n",
     "    skip_folder_re:str=None, # Skip folders matching regex,\n",
     "    func:callable=os.path.join, # function to apply to each matched file\n",
-    "    ret_folders:bool=False  # return folders, not just files\n",
+    "    ret_folders:bool=False, # return folders, not just files\n",
+    "    sort:bool=True # sort files by name within each folder\n",
     ")->L: # Paths to matched files\n",
     "    \"A more powerful `glob`, including regex matches, symlink handling, and skip parameters\"\n",
     "    from fnmatch import fnmatch\n",
@@ -140,7 +143,7 @@
     "    def _keep_folder(root, name): return not folder_re or folder_re.search(os.path.join(root,name))\n",
     "    def _skip_folder(root, name): return skip_folder_re and skip_folder_re.search(name)\n",
     "    return L(walk(path, symlinks=symlinks, keep_file=_keep_file, keep_folder=_keep_folder, skip_folder=_skip_folder,\n",
-    "                  func=func, ret_folders=ret_folders))"
+    "                  func=func, ret_folders=ret_folders, sort=sort))"
    ]
   },
   {
@@ -163,6 +166,26 @@
     "globtastic('.', skip_folder_re='^[_.]', folder_re='core', file_glob='*.*py*', file_re='c')"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "(#5) ['./fastcore/basics.py','./fastcore/dispatch.py','./fastcore/docments.py','./fastcore/docscrape.py','./fastcore/script.py']"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "globtastic('.', skip_folder_re='^[_.]', folder_re='core', file_glob='*.*py*', file_re='c', sort=True)"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,

nbs/09_xml.ipynb

@@ -364,7 +364,9 @@
    "outputs": [],
    "source": [
     "#| export\n",
-    "def _escape(s): return '' if s is None else s.__html__() if hasattr(s, '__html__') else escape(s) if isinstance(s, str) else s\n",
+    "def _escape(s):\n",
+    "    return '' if s is None else s.__html__() if hasattr(s, '__html__') \\\n",
+    "        else escape(s, quote=False) if isinstance(s, str) else s\n",
     "def _noescape(s): return '' if s is None else s.__html__() if hasattr(s, '__html__') else s"
    ]
   },

nbs/12_tools.ipynb

@@ -622,7 +622,7 @@
     "    old_strs:list[str], # List of strings to find and replace\n",
     "    new_strs:list[str], # List of replacement strings (must match length of old_strs)\n",
     "):\n",
-    "    \"Replace for each str pair in old_strs,new_strs call `str_replace\"\n",
+    "    \"Replace for each str pair in old_strs,new_strs\"\n",
     "    res = [str_replace(path, old, new) for (old,new) in zip(old_strs,new_strs)]\n",
     "    return 'Results for each replacement:\\n' + '; '.join(res)"
    ]