patb/tf
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README: document the return value of sed()

Browse Source
This commit is contained in:
Pat Beirne
2021-03-24 08:33:12 -04:00
parent ef4114d1fb
commit ba44d1ec23
1 changed files with 1 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@@ -101,6 +101,7 @@ tf.grep('config.ini', '\[\w*\]', numbers = True)
in: filename the file to edit
pattern a sed pattern, involving one of "aidsxX"
bak_ext the extension to use when creating the file backup (without the dot)
return: tuple(number of lines in the input file, number of lines modified/added/deleted/matched)
```
The *sed* function is an inline file editor, based on `sed` from the Unix world. When invoked, it first renames the source file to have a `.bak` extension. That file is opened and each line of the source file is loaded in, and a regex pattern match is performed. If the line is changed/found/inserted, then the output is streamed to the new (output) file with the same name as the original; it appears to the user that the files is edited-in-place, with a .bak file created.