fixes #795

Author: jph00

fastcore/docments.py

@@ -439,6 +439,6 @@ def _repr_markdown_(self):
 
     def __repr__(self):
         doc = str(self.dm)
-        if self.docs: doc += f'"""\n{self.docs}\n"""'
+        if self.docs: doc += f'"""{self.docs}"""'
         return doc
     __str__=__repr__

fastcore/imports.py

@@ -44,7 +44,9 @@ def any_is_instance(t, *args): return any(isinstance(a,t) for a in args)
 
 def isinstance_str(x, cls_name):
     "Like `isinstance`, except takes a type name instead of a type"
-    return cls_name in [t.__name__ for t in type(x).__mro__]
+    if isinstance(cls_name, str): cls_name = (cls_name,)
+    names = [t.__name__ for t in type(x).__mro__]
+    return any(c in names for c in cls_name)
 
 def array_equal(a,b):
     if hasattr(a, '__array__'): a = a.__array__()

fastcore/tools.py

@@ -63,12 +63,16 @@ def run_cmd(
     except: return explain_exc(f'running cmd')
     res = outp.stdout
     if res and outp.stderr: res += '\n'
-    return res + outp.stderr
+    res += outp.stderr
+    if not res.strip() and re.search(r'\\[|*?]', argstr):
+        return r'Warning: no output and argstr contains \-escaped chars. Shell escaping is not needed: try without \-escaping.'
+    return res
+
 
 # %% ../nbs/12_tools.ipynb #eb253a39
 @llmtool
 def rg(
-    argstr:str, # All args to the command, will be split with shlex
+    argstr:str, # All args to the command, will be split with shlex. No shell escaping needed for regex chars like `|`
     disallow_re:str=None, # optional regex which, if matched on argstr, will disallow the command
     allow_re:str=None # optional regex which, if not matched on argstr, will disallow the command
 ):
@@ -78,7 +82,7 @@ def rg(
 # %% ../nbs/12_tools.ipynb #09de7b32
 @llmtool
 def sed(
-    argstr:str, # All args to the command, will be split with shlex
+    argstr:str, # All args to the command, will be split with shlex. No shell escaping needed for regex chars like `|`
     disallow_re:str=None, # optional regex which, if matched on argstr, will disallow the command
     allow_re:str=None # optional regex which, if not matched on argstr, will disallow the command
 ):

nbs/04_docments.ipynb

@@ -2494,7 +2494,7 @@
     "\n",
     "    def __repr__(self):\n",
     "        doc = str(self.dm)\n",
-    "        if self.docs: doc += f'\"\"\"\\n{self.docs}\\n\"\"\"'\n",
+    "        if self.docs: doc += f'\"\"\"{self.docs}\"\"\"'\n",
     "        return doc\n",
     "    __str__=__repr__"
    ]
@@ -2525,9 +2525,7 @@
        "    a, b:callable=print, # param b\n",
        "    c:str='foo', # param c\n",
        ")->str: # Result of doing it\n",
-       "\"\"\"\n",
-       "Do a thing\n",
-       "\"\"\""
+       "\"\"\"Do a thing\"\"\""
       ]
      },
      "execution_count": null,
@@ -2560,9 +2558,7 @@
       "    a, b:callable=print, # param b\n",
       "    c:str='foo', # param c\n",
       ")->str: # Result of doing it\n",
-      "\"\"\"\n",
-      "Do a thing\n",
-      "\"\"\"\n"
+      "\"\"\"Do a thing\"\"\"\n"
      ]
     }
    ],
@@ -2613,9 +2609,7 @@
        "    b:int | str, # bb\n",
        "    a:int=0, # aa\n",
        "):\n",
-       "\"\"\"\n",
-       "Call self as a function.\n",
-       "\"\"\""
+       "\"\"\"Call self as a function.\"\"\""
       ]
      },
      "execution_count": null,
@@ -2655,9 +2649,7 @@
        "    b:int, # This is the second of the operands to the *addition* operator.\n",
        "Note that passing a negative value here is the equivalent of the *subtraction* operator.\n",
        ")->int: # The result is calculated using Python's builtin `+` operator.\n",
-       "\"\"\"\n",
-       "Add `a` to `b`\n",
-       "\"\"\""
+       "\"\"\"Add `a` to `b`\"\"\""
       ]
      },
      "execution_count": null,
@@ -2692,12 +2684,10 @@
       ],
       "text/plain": [
        "def next(iterator, default=..., /)\n",
-       "\"\"\"\n",
-       "Return the next item from the iterator.\n",
+       "\"\"\"Return the next item from the iterator.\n",
        "\n",
        "If default is given and the iterator is exhausted,\n",
-       "it is returned instead of raising StopIteration.\n",
-       "\"\"\""
+       "it is returned instead of raising StopIteration.\"\"\""
       ]
      },
      "execution_count": null,
@@ -2804,9 +2794,7 @@
        "def Foo.__call__(\n",
        "    x\n",
        "):\n",
-       "\"\"\"\n",
-       "Call foo\n",
-       "\"\"\""
+       "\"\"\"Call foo\"\"\""
       ]
      },
      "execution_count": null,

nbs/12_tools.ipynb

@@ -84,7 +84,9 @@
       ]
      },
      "execution_count": null,
-     "metadata": {},
+     "metadata": {
+      "__type": "str"
+     },
      "output_type": "execute_result"
     }
    ],
@@ -122,7 +124,9 @@
       ]
      },
      "execution_count": null,
-     "metadata": {},
+     "metadata": {
+      "__type": "str"
+     },
      "output_type": "execute_result"
     }
    ],
@@ -260,7 +264,10 @@
     "    except: return explain_exc(f'running cmd')\n",
     "    res = outp.stdout\n",
     "    if res and outp.stderr: res += '\\n'\n",
-    "    return res + outp.stderr"
+    "    res += outp.stderr\n",
+    "    if not res.strip() and re.search(r'\\\\[|*?]', argstr):\n",
+    "        return r'Warning: no output and argstr contains \\-escaped chars. Shell escaping is not needed: try without \\-escaping.'\n",
+    "    return res\n"
    ]
   },
   {
@@ -283,12 +290,13 @@
      "text": [
       "\u001b[34maai-ws\u001b[m\u001b[m\n",
       "\u001b[34mApplications\u001b[m\u001b[m\n",
-      "autoexec.ipynb\n",
       "\u001b[34mbooks\u001b[m\u001b[m\n",
       "cachy.jsonl\n",
       "\u001b[34mchats\u001b[m\u001b[m\n",
       "CRAFT.ipynb\n",
-      "\u001b[34mDesktop\u001b\n"
+      "CRAFT.py\n",
+      "\u001b[34mCRAFTs\u001b[m\u001b[m\n",
+      "\u001b\n"
      ]
     }
    ],
@@ -341,7 +349,7 @@
     "#| export\n",
     "@llmtool\n",
     "def rg(\n",
-    "    argstr:str, # All args to the command, will be split with shlex\n",
+    "    argstr:str, # All args to the command, will be split with shlex. No shell escaping needed for regex chars like `|`\n",
     "    disallow_re:str=None, # optional regex which, if matched on argstr, will disallow the command\n",
     "    allow_re:str=None # optional regex which, if not matched on argstr, will disallow the command\n",
     "):\n",
@@ -362,7 +370,9 @@
       ]
      },
      "execution_count": null,
-     "metadata": {},
+     "metadata": {
+      "__type": "str"
+     },
      "output_type": "execute_result"
     }
    ],
@@ -498,7 +508,7 @@
     "#| export\n",
     "@llmtool\n",
     "def sed(\n",
-    "    argstr:str, # All args to the command, will be split with shlex\n",
+    "    argstr:str, # All args to the command, will be split with shlex. No shell escaping needed for regex chars like `|`\n",
     "    disallow_re:str=None, # optional regex which, if matched on argstr, will disallow the command\n",
     "    allow_re:str=None # optional regex which, if not matched on argstr, will disallow the command\n",
     "):\n",