fastcore 2.1.2__tar.gz → 2.1.3__tar.gz

{fastcore-2.1.2/fastcore.egg-info → fastcore-2.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastcore
-Version: 2.1.2
+Version: 2.1.3
 Summary: Python supercharged for fastai development
 Author-email: Jeremy Howard and Sylvain Gugger <infos@fast.ai>
 License: Apache-2.0

fastcore-2.1.3/fastcore/__init__.py

@@ -0,0 +1 @@
+__version__ = "2.1.3"

{fastcore-2.1.2 → fastcore-2.1.3}/fastcore/_modidx.py

@@ -521,6 +521,7 @@ d = { 'settings': { 'branch': 'main',
                                'fastcore.nbio._join': ('nbio.html#_join', 'fastcore/nbio.py'),
                                'fastcore.nbio._meta_directives': ('nbio.html#_meta_directives', 'fastcore/nbio.py'),
                                'fastcore.nbio._mkout': ('nbio.html#_mkout', 'fastcore/nbio.py'),
+                               'fastcore.nbio._nb_cell': ('nbio.html#_nb_cell', 'fastcore/nbio.py'),
                                'fastcore.nbio._read_json': ('nbio.html#_read_json', 'fastcore/nbio.py'),
                                'fastcore.nbio._rejoin_cell': ('nbio.html#_rejoin_cell', 'fastcore/nbio.py'),
                                'fastcore.nbio._rejoin_mime': ('nbio.html#_rejoin_mime', 'fastcore/nbio.py'),
@@ -529,6 +530,7 @@ d = { 'settings': { 'branch': 'main',
                                'fastcore.nbio._split_mime': ('nbio.html#_split_mime', 'fastcore/nbio.py'),
                                'fastcore.nbio._unparse_dir': ('nbio.html#_unparse_dir', 'fastcore/nbio.py'),
                                'fastcore.nbio.cell2xml': ('nbio.html#cell2xml', 'fastcore/nbio.py'),
+                               'fastcore.nbio.cell_edit': ('nbio.html#cell_edit', 'fastcore/nbio.py'),
                                'fastcore.nbio.cells2xml': ('nbio.html#cells2xml', 'fastcore/nbio.py'),
                                'fastcore.nbio.concat_streams': ('nbio.html#concat_streams', 'fastcore/nbio.py'),
                                'fastcore.nbio.dict2nb': ('nbio.html#dict2nb', 'fastcore/nbio.py'),
@@ -552,6 +554,7 @@ d = { 'settings': { 'branch': 'main',
                                'fastcore.nbio.repair_nb': ('nbio.html#repair_nb', 'fastcore/nbio.py'),
                                'fastcore.nbio.validate_cell': ('nbio.html#validate_cell', 'fastcore/nbio.py'),
                                'fastcore.nbio.validate_nb': ('nbio.html#validate_nb', 'fastcore/nbio.py'),
+                               'fastcore.nbio.view_cell': ('nbio.html#view_cell', 'fastcore/nbio.py'),
                                'fastcore.nbio.write_nb': ('nbio.html#write_nb', 'fastcore/nbio.py')},
             'fastcore.net': { 'fastcore.net.HTTP4xxClientError': ('net.html#http4xxclienterror', 'fastcore/net.py'),
                               'fastcore.net.HTTP5xxServerError': ('net.html#http5xxservererror', 'fastcore/net.py'),
@@ -677,14 +680,17 @@ d = { 'settings': { 'branch': 'main',
                                'fastcore.test.test_warns': ('test.html#test_warns', 'fastcore/test.py')},
             'fastcore.tools': { 'fastcore.tools._norm_lines': ('tools.html#_norm_lines', 'fastcore/tools.py'),
                                 'fastcore.tools.ast_replace': ('tools.html#ast_replace', 'fastcore/tools.py'),
+                                'fastcore.tools.create_file': ('tools.html#create_file', 'fastcore/tools.py'),
                                 'fastcore.tools.del_lines': ('tools.html#del_lines', 'fastcore/tools.py'),
-                                'fastcore.tools.file_create': ('tools.html#file_create', 'fastcore/tools.py'),
                                 'fastcore.tools.file_edit': ('tools.html#file_edit', 'fastcore/tools.py'),
-                                'fastcore.tools.file_view': ('tools.html#file_view', 'fastcore/tools.py'),
                                 'fastcore.tools.insert_line': ('tools.html#insert_line', 'fastcore/tools.py'),
+                                'fastcore.tools.line_hash': ('tools.html#line_hash', 'fastcore/tools.py'),
+                                'fastcore.tools.lnhash': ('tools.html#lnhash', 'fastcore/tools.py'),
+                                'fastcore.tools.lnhash_at': ('tools.html#lnhash_at', 'fastcore/tools.py'),
                                 'fastcore.tools.replace_lines': ('tools.html#replace_lines', 'fastcore/tools.py'),
                                 'fastcore.tools.str_replace': ('tools.html#str_replace', 'fastcore/tools.py'),
-                                'fastcore.tools.strs_replace': ('tools.html#strs_replace', 'fastcore/tools.py')},
+                                'fastcore.tools.strs_replace': ('tools.html#strs_replace', 'fastcore/tools.py'),
+                                'fastcore.tools.view_file': ('tools.html#view_file', 'fastcore/tools.py')},
             'fastcore.transform': {},
             'fastcore.utils': {},
             'fastcore.xdg': { 'fastcore.xdg._path_from_env': ('xdg.html#_path_from_env', 'fastcore/xdg.py'),

{fastcore-2.1.2 → fastcore-2.1.3}/fastcore/nbio.py

@@ -1,21 +1,25 @@
 """Reading and writing Jupyter notebooks
 
+Cell tools apply `fastcore.tools`' string editing primitives to one notebook cell's source, addressed by path and cell id, mirroring that module's file tools: the same operations and parameters, with `path, cell_id` in place of `path`. Each editor returns a diff of the change, and `view_cell` shows a cell's source with optional line numbers or exhash addresses.
+
 Docs: https://fastcore.fast.ai/nbio.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/13_nbio.ipynb.
 
 # %% auto #0
-__all__ = ['langs', 'nb_lang', 'NbCell', 'dict2nb', 'read_nb', 'mk_cell', 'new_nb', 'first_code_ln', 'nb2dict', 'nb2str',
-           'write_nb', 'validate_cell', 'validate_nb', 'repair_cell', 'repair_nb', 'preferred_out', 'mk_stream',
-           'mk_result', 'mk_display', 'mk_error', 'concat_streams', 'preferred_msg_out', 'render_output',
-           'render_outputs', 'render_text', 'cell2xml', 'cells2xml', 'Notebook']
+__all__ = ['langs', 'cell_insert_line', 'cell_str_replace', 'cell_strs_replace', 'cell_replace_lines', 'cell_del_lines',
+           'nb_lang', 'NbCell', 'dict2nb', 'read_nb', 'mk_cell', 'new_nb', 'first_code_ln', 'nb2dict', 'nb2str',
+           'write_nb', 'cell_edit', 'view_cell', 'validate_cell', 'validate_nb', 'repair_cell', 'repair_nb',
+           'preferred_out', 'mk_stream', 'mk_result', 'mk_display', 'mk_error', 'concat_streams', 'preferred_msg_out',
+           'render_output', 'render_outputs', 'render_text', 'cell2xml', 'cells2xml', 'Notebook']
 
 # %% ../nbs/13_nbio.ipynb #954ca1aa
 from .basics import *
-from .xtras import rtoken_hex,clean_cli_output,take_lines
+from .xtras import rtoken_hex,clean_cli_output,take_lines,str_diff
 from .imports import *
 from .ansi import ansi2html
-from .meta import delegates
+from .meta import delegates,splice_sig
+from .tools import insert_line,str_replace,strs_replace,replace_lines,del_lines,lnhash
 
 import ast,functools
 from collections import defaultdict
@@ -151,18 +155,15 @@ def _directive(s, lang='python'):
 
 # %% ../nbs/13_nbio.ipynb #16c08410
 def _meta_directives(cell):
-    "Directives from the `nbdev` dict in cell metadata, as `{name: value}`"
-    def _v(v):
-        if isinstance(v,bool): return '' if v else 'false'
-        if isinstance(v,(list,tuple)): return ' '.join(map(str,v))
-        return '' if v=='true' else str(v)
-    return {k:_v(v) for k,v in cell.get('metadata',{}).get('nbdev',{}).items()}
+    "Directives from the `nbdev` dict in cell metadata, as `{name: value}`; values must be str (`'true'` for a bare directive)"
+    d = cell.get('metadata',{}).get('nbdev',{})
+    if bad := [k for k,v in d.items() if not isinstance(v,str)]:
+        raise TypeError(f"`nbdev` metadata directive values must be str (e.g 'true'/'false'), got non-str for: {bad}")
+    return {k:'' if v=='true' else v for k,v in d.items()}
 
 def _unparse_dir(v):
     "Inverse of `_meta_directives` value parsing: value string back to a metadata value"
-    if v=='': return True
-    if v=='false': return False
-    return v
+    return 'true' if v=='' else v
 
 def _dir_line(k, v, lang='python', quarto=False):
     "A canonical directive comment line; with `quarto`, bare directives render as `: true`"
@@ -255,6 +256,61 @@ def write_nb(nb, path):
     if new!=old:
         with open(path, 'w', encoding='utf-8') as f: f.write(new)
 
+# %% ../nbs/13_nbio.ipynb #3453e541
+_cell_edit_doc = """
+This is a *cell* editing function.
+
+Cell editing standard parameters are `path`: notebook file to modify, and `cell_id`: id of the cell to edit (exact, or unique prefix)
+
+returns: diff of changes, or "none: No changes.", or "error: ..."
+"""
+
+def _nb_cell(nb, cell_id):
+    "Cell in `nb` with id `cell_id` (exact match, or unique prefix)"
+    res = [c for c in nb.cells if c.id==cell_id] or [c for c in nb.cells if c.id.startswith(cell_id)]
+    if len(res)!=1: raise KeyError(f"{'ambiguous' if res else 'no'} cell id: {cell_id!r}")
+    return res[0]
+
+def cell_edit(f, name=None):
+    def wrapper(path:str, cell_id:str, *args, **kw):
+        nb = read_nb(path)
+        cell = _nb_cell(nb, cell_id)
+        text = cell.source
+        try: new_text = f(text, *args, **kw)
+        except ValueError as e: return PrettyString(f'error: {e}')
+        cell.source = new_text
+        write_nb(nb, path)
+        return PrettyString(str_diff(text, new_text) or 'none: No changes.')
+    res = splice_sig(wrapper, f, 'text')
+    if name: res.__name__ = res.__qualname__ = name
+    res.__doc__ = (f.__doc__ or '') + _cell_edit_doc
+    return res
+
+# %% ../nbs/13_nbio.ipynb #bde31026
+cell_insert_line = cell_edit(insert_line, 'cell_insert_line')
+cell_str_replace = cell_edit(str_replace, 'cell_str_replace')
+cell_strs_replace = cell_edit(strs_replace, 'cell_strs_replace')
+cell_replace_lines = cell_edit(replace_lines, 'cell_replace_lines')
+cell_del_lines = cell_edit(del_lines, 'cell_del_lines')
+
+# %% ../nbs/13_nbio.ipynb #421b2b9c
+def view_cell(
+    path:str, # Notebook file to read
+    cell_id:str, # Id of the cell to view (exact, or unique prefix)
+    start_line:int=1, # Starting line to view
+    end_line:int=None, # End line (defaults to last line if None; may be past EOF, which clamps to the last line)
+    nums:bool=True, # Show line numbers?
+    lnhashs:bool=False # Show exhash `lineno|hash|` addresses instead of line numbers?
+):
+    "View a cell's source, optionally limited to 1-based line range"
+    lines = _nb_cell(read_nb(path), cell_id).source.splitlines()
+    if not lines: return ''
+    if end_line is None or end_line > len(lines): end_line = len(lines)
+    if end_line < 0: end_line = len(lines)+end_line+1
+    if not (1 <= start_line <= len(lines)): return f'error: Invalid start_line {start_line}. Valid range: 1-{len(lines)}'
+    fmt = (lambda i,l: lnhash(i,l)+l) if lnhashs else (lambda i,l: f'{i}: {l}') if nums else (lambda i,l: l)
+    return PrettyString('\n'.join(fmt(i,l) for i,l in enumerate(lines[start_line-1:end_line], start_line)))
+
 # %% ../nbs/13_nbio.ipynb #86453c0f
 def validate_cell(cell, idx=None):
     "Raise `ValueError` for structural problems in notebook cell dict `cell`; returns it unchanged if fine"

{fastcore-2.1.2 → fastcore-2.1.3}/fastcore/tools.py

@@ -2,26 +2,29 @@
 
 The editors here are string-level: each takes `text` plus edit parameters and returns the new text, raising `ValueError` when an edit can't apply. The file tools below wrap them with path I/O and diff reporting; message-level wrappers live in llmsurgery. (This module previously held experimental LLM path-editing and command tools, superseded by safecmd, rgapi, and the tools here.)
 
-File tools wrap the primitives with path I/O, returning unified diffs of what changed ("none: No changes." / "error: ..." otherwise). The path is the first argument, e.g:
+`line_hash`, `lnhash`, and `lnhash_at` implement the [exhash](https://answerdotai.github.io/exhash) line-address format in pure Python: `lineno|hash|`, where the hash is 4 hex chars of crc32. They let any tool create lnhash-addressed views of text it holds, without depending on the exhash package.
 
-    file_view('~/a/b.py', 3)
-    file_create('~/a/b/c.py', 'content here')
+File tools wrap the primitives with path I/O, returning unified diffs of what changed ("none: No changes." / "error: ..." otherwise). The path is the first argument (with `view_file`/`create_file` named verb-first, since the file is the verb's object rather than the location of an edit), e.g:
+
+    view_file('~/a/b.py', 3)
+    create_file('~/a/b/c.py', 'content here')
     file_str_replace('myfile.py', 'old_name', 'new_name')
     file_del_lines('myfile.py', 2, 4)
     file_replace_lines('myfile.py', new_content=src)   # no line numbers: replace the entire contents
 
-`file_str_replace`, `file_strs_replace`, and `file_del_lines` support `re_filter` and `invert_filter` for targeting only lines matching (or not matching) a regex, like ex's `g//` and `g!//`, combined with `start_line`/`end_line` to restrict to a region. `ast_replace(text, repls)` and `ast_file(path, repls)` apply ast-grep `(pattern, replacement)` rules with `$VAR` metavariables (requires the optional `remold` package). Where the `exhash` package is available, prefer it for editing: its hash-verified addressing fails loudly on stale context instead of editing nearby text.
+`file_str_replace`, `file_strs_replace`, and `file_del_lines` support `re_filter` and `invert_filter` for targeting only lines matching (or not matching) a regex, like ex's `g//` and `g!//`, combined with `start_line`/`end_line` to restrict to a region. `ast_replace(text, repls)` and `file_ast_replace(path, repls)` apply ast-grep `(pattern, replacement)` rules with `$VAR` metavariables (requires the optional `remold` package). Where the `exhash` package is available, prefer it for editing: its hash-verified addressing fails loudly on stale context instead of editing nearby text.
 
 Docs: https://fastcore.fast.ai/tools.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/12_tools.ipynb.
 
 # %% auto #0
-__all__ = ['file_insert_line', 'file_str_replace', 'file_strs_replace', 'file_replace_lines', 'file_del_lines', 'ast_file',
-           'insert_line', 'str_replace', 'strs_replace', 'replace_lines', 'del_lines', 'file_view', 'file_create',
-           'file_edit', 'ast_replace']
+__all__ = ['file_insert_line', 'file_str_replace', 'file_strs_replace', 'file_replace_lines', 'file_del_lines',
+           'file_ast_replace', 'insert_line', 'str_replace', 'strs_replace', 'replace_lines', 'del_lines', 'line_hash',
+           'lnhash', 'lnhash_at', 'view_file', 'create_file', 'file_edit', 'ast_replace']
 
 # %% ../nbs/12_tools.ipynb #578246d2
+import zlib
 from .imports import *
 from .meta import splice_sig
 from .basics import PrettyString
@@ -138,11 +141,34 @@ def del_lines(
     else: del lines[s-1:e]
     return ''.join(lines)
 
+# %% ../nbs/12_tools.ipynb #6274581f
+def line_hash(
+    line:str # A single line of text, without trailing newline
+)->str:
+    "4-char hex exhash hash of `line`"
+    return f'{zlib.crc32(line.encode()) & 0xffff:04x}'
+
+def lnhash(
+    lineno:int, # 1-based line number
+    line:str # The line's current text
+)->str:
+    "`lineno|hash|` exhash address for `line` at `lineno`"
+    return f'{lineno}|{line_hash(line)}|'
+
+def lnhash_at(
+    s:str|list|tuple, # A document as a str, or its lines
+    line:int # 1-based line number within `s`
+)->str:
+    "`lineno|hash|` exhash address of line `line` of `s`"
+    if isinstance(s,str): s = s.splitlines()
+    return lnhash(line, s[line-1])
+
 # %% ../nbs/12_tools.ipynb #806c957b
-def file_view(
+def view_file(
     path:str, # Path to view (expands `~` if needed)
     start_line:int=1, # Starting line to view
-    end_line:int=None # End line (defaults to last line if None; may be past EOF, which clamps to the last line - handy when the file size is unknown)
+    end_line:int=None, # End line (defaults to last line if None; may be past EOF, which clamps to the last line - handy when the file size is unknown)
+    lnhashs:bool=False # Prefix `lineno|hash|` exhash addresses instead of `lineno: `
 ):
     "Read file contents, optionally limited to 1-based line range"
     path = Path(path).expanduser()
@@ -152,10 +178,10 @@ def file_view(
     if end_line < 0: end_line = len(lines)+end_line+1
     if not (1 <= start_line <= len(lines)): return f'error: Invalid start_line {start_line}. Valid range: 1-{len(lines)}'
     if end_line > len(lines): end_line = len(lines)
-    return PrettyString('\n'.join(f'{i}: {l}' for i,l in enumerate(lines[start_line-1:end_line], start_line)))
+    return PrettyString('\n'.join((lnhash(i,l) if lnhashs else f'{i}: ')+l for i,l in enumerate(lines[start_line-1:end_line], start_line)))
 
 # %% ../nbs/12_tools.ipynb #424d09e1
-def file_create(
+def create_file(
     path:str, # Path to create (expands `~` if needed)
     contents:str, # Contents of file to create
     overwrite:bool=False, # Replace the file if it already exists?
@@ -218,4 +244,4 @@ def ast_replace(
     except ImportError as e: raise ImportError('ast_replace requires the optional `remold` package: `pip install remold`') from e
     return astmap(*repls)(text)
 
-ast_file = file_edit(ast_replace, 'ast_file')
+file_ast_replace = file_edit(ast_replace, 'file_ast_replace')

{fastcore-2.1.2 → fastcore-2.1.3/fastcore.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastcore
-Version: 2.1.2
+Version: 2.1.3
 Summary: Python supercharged for fastai development
 Author-email: Jeremy Howard and Sylvain Gugger <infos@fast.ai>
 License: Apache-2.0

fastcore-2.1.2/fastcore/__init__.py

@@ -1 +0,0 @@
-__version__ = "2.1.2"