├── .gitignore
├── LICENSE
├── README.md
├── glob-rename
├── README.md
├── glob-rename.py
├── images
│ ├── img_1.png
│ └── img_2.png
└── testdir
│ ├── file1.txt
│ ├── file2.txt
│ ├── subdir1
│ ├── file1.txt
│ └── file2.txt
│ └── subdir2
│ ├── file1.txt
│ └── file2.txt
└── glob-replace
├── README.md
├── glob-replace.py
├── images
└── img_1.png
└── testdir
├── file1.txt
├── file2.txt
├── subdir1
├── file1.txt
└── file2.txt
└── subdir2
├── file1.txt
└── file2.txt
/.gitignore:
--------------------------------------------------------------------------------
1 | .DS_Store
2 | # Byte-compiled / optimized / DLL files
3 | __pycache__/
4 | *.py[cod]
5 |
6 | # C extensions
7 | *.so
8 |
9 | # Distribution / packaging
10 | .Python
11 | env/
12 | build/
13 | develop-eggs/
14 | dist/
15 | downloads/
16 | eggs/
17 | lib/
18 | lib64/
19 | parts/
20 | sdist/
21 | var/
22 | *.egg-info/
23 | .installed.cfg
24 | *.egg
25 |
26 | # PyInstaller
27 | # Usually these files are written by a python script from a template
28 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
29 | *.manifest
30 | *.spec
31 |
32 | # Installer logs
33 | pip-log.txt
34 | pip-delete-this-directory.txt
35 |
36 | # Unit test / coverage reports
37 | htmlcov/
38 | .tox/
39 | .coverage
40 | .cache
41 | nosetests.xml
42 | coverage.xml
43 |
44 | # Translations
45 | *.mo
46 | *.pot
47 |
48 | # Django stuff:
49 | *.log
50 |
51 | # Sphinx documentation
52 | docs/_build/
53 |
54 | # PyBuilder
55 | target/
56 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 2, June 1991
3 |
4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6 | Everyone is permitted to copy and distribute verbatim copies
7 | of this license document, but changing it is not allowed.
8 |
9 | Preamble
10 |
11 | The licenses for most software are designed to take away your
12 | freedom to share and change it. By contrast, the GNU General Public
13 | License is intended to guarantee your freedom to share and change free
14 | software--to make sure the software is free for all its users. This
15 | General Public License applies to most of the Free Software
16 | Foundation's software and to any other program whose authors commit to
17 | using it. (Some other Free Software Foundation software is covered by
18 | the GNU Lesser General Public License instead.) You can apply it to
19 | your programs, too.
20 |
21 | When we speak of free software, we are referring to freedom, not
22 | price. Our General Public Licenses are designed to make sure that you
23 | have the freedom to distribute copies of free software (and charge for
24 | this service if you wish), that you receive source code or can get it
25 | if you want it, that you can change the software or use pieces of it
26 | in new free programs; and that you know you can do these things.
27 |
28 | To protect your rights, we need to make restrictions that forbid
29 | anyone to deny you these rights or to ask you to surrender the rights.
30 | These restrictions translate to certain responsibilities for you if you
31 | distribute copies of the software, or if you modify it.
32 |
33 | For example, if you distribute copies of such a program, whether
34 | gratis or for a fee, you must give the recipients all the rights that
35 | you have. You must make sure that they, too, receive or can get the
36 | source code. And you must show them these terms so they know their
37 | rights.
38 |
39 | We protect your rights with two steps: (1) copyright the software, and
40 | (2) offer you this license which gives you legal permission to copy,
41 | distribute and/or modify the software.
42 |
43 | Also, for each author's protection and ours, we want to make certain
44 | that everyone understands that there is no warranty for this free
45 | software. If the software is modified by someone else and passed on, we
46 | want its recipients to know that what they have is not the original, so
47 | that any problems introduced by others will not reflect on the original
48 | authors' reputations.
49 |
50 | Finally, any free program is threatened constantly by software
51 | patents. We wish to avoid the danger that redistributors of a free
52 | program will individually obtain patent licenses, in effect making the
53 | program proprietary. To prevent this, we have made it clear that any
54 | patent must be licensed for everyone's free use or not licensed at all.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | GNU GENERAL PUBLIC LICENSE
60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61 |
62 | 0. This License applies to any program or other work which contains
63 | a notice placed by the copyright holder saying it may be distributed
64 | under the terms of this General Public License. The "Program", below,
65 | refers to any such program or work, and a "work based on the Program"
66 | means either the Program or any derivative work under copyright law:
67 | that is to say, a work containing the Program or a portion of it,
68 | either verbatim or with modifications and/or translated into another
69 | language. (Hereinafter, translation is included without limitation in
70 | the term "modification".) Each licensee is addressed as "you".
71 |
72 | Activities other than copying, distribution and modification are not
73 | covered by this License; they are outside its scope. The act of
74 | running the Program is not restricted, and the output from the Program
75 | is covered only if its contents constitute a work based on the
76 | Program (independent of having been made by running the Program).
77 | Whether that is true depends on what the Program does.
78 |
79 | 1. You may copy and distribute verbatim copies of the Program's
80 | source code as you receive it, in any medium, provided that you
81 | conspicuously and appropriately publish on each copy an appropriate
82 | copyright notice and disclaimer of warranty; keep intact all the
83 | notices that refer to this License and to the absence of any warranty;
84 | and give any other recipients of the Program a copy of this License
85 | along with the Program.
86 |
87 | You may charge a fee for the physical act of transferring a copy, and
88 | you may at your option offer warranty protection in exchange for a fee.
89 |
90 | 2. You may modify your copy or copies of the Program or any portion
91 | of it, thus forming a work based on the Program, and copy and
92 | distribute such modifications or work under the terms of Section 1
93 | above, provided that you also meet all of these conditions:
94 |
95 | a) You must cause the modified files to carry prominent notices
96 | stating that you changed the files and the date of any change.
97 |
98 | b) You must cause any work that you distribute or publish, that in
99 | whole or in part contains or is derived from the Program or any
100 | part thereof, to be licensed as a whole at no charge to all third
101 | parties under the terms of this License.
102 |
103 | c) If the modified program normally reads commands interactively
104 | when run, you must cause it, when started running for such
105 | interactive use in the most ordinary way, to print or display an
106 | announcement including an appropriate copyright notice and a
107 | notice that there is no warranty (or else, saying that you provide
108 | a warranty) and that users may redistribute the program under
109 | these conditions, and telling the user how to view a copy of this
110 | License. (Exception: if the Program itself is interactive but
111 | does not normally print such an announcement, your work based on
112 | the Program is not required to print an announcement.)
113 |
114 | These requirements apply to the modified work as a whole. If
115 | identifiable sections of that work are not derived from the Program,
116 | and can be reasonably considered independent and separate works in
117 | themselves, then this License, and its terms, do not apply to those
118 | sections when you distribute them as separate works. But when you
119 | distribute the same sections as part of a whole which is a work based
120 | on the Program, the distribution of the whole must be on the terms of
121 | this License, whose permissions for other licensees extend to the
122 | entire whole, and thus to each and every part regardless of who wrote it.
123 |
124 | Thus, it is not the intent of this section to claim rights or contest
125 | your rights to work written entirely by you; rather, the intent is to
126 | exercise the right to control the distribution of derivative or
127 | collective works based on the Program.
128 |
129 | In addition, mere aggregation of another work not based on the Program
130 | with the Program (or with a work based on the Program) on a volume of
131 | a storage or distribution medium does not bring the other work under
132 | the scope of this License.
133 |
134 | 3. You may copy and distribute the Program (or a work based on it,
135 | under Section 2) in object code or executable form under the terms of
136 | Sections 1 and 2 above provided that you also do one of the following:
137 |
138 | a) Accompany it with the complete corresponding machine-readable
139 | source code, which must be distributed under the terms of Sections
140 | 1 and 2 above on a medium customarily used for software interchange; or,
141 |
142 | b) Accompany it with a written offer, valid for at least three
143 | years, to give any third party, for a charge no more than your
144 | cost of physically performing source distribution, a complete
145 | machine-readable copy of the corresponding source code, to be
146 | distributed under the terms of Sections 1 and 2 above on a medium
147 | customarily used for software interchange; or,
148 |
149 | c) Accompany it with the information you received as to the offer
150 | to distribute corresponding source code. (This alternative is
151 | allowed only for noncommercial distribution and only if you
152 | received the program in object code or executable form with such
153 | an offer, in accord with Subsection b above.)
154 |
155 | The source code for a work means the preferred form of the work for
156 | making modifications to it. For an executable work, complete source
157 | code means all the source code for all modules it contains, plus any
158 | associated interface definition files, plus the scripts used to
159 | control compilation and installation of the executable. However, as a
160 | special exception, the source code distributed need not include
161 | anything that is normally distributed (in either source or binary
162 | form) with the major components (compiler, kernel, and so on) of the
163 | operating system on which the executable runs, unless that component
164 | itself accompanies the executable.
165 |
166 | If distribution of executable or object code is made by offering
167 | access to copy from a designated place, then offering equivalent
168 | access to copy the source code from the same place counts as
169 | distribution of the source code, even though third parties are not
170 | compelled to copy the source along with the object code.
171 |
172 | 4. You may not copy, modify, sublicense, or distribute the Program
173 | except as expressly provided under this License. Any attempt
174 | otherwise to copy, modify, sublicense or distribute the Program is
175 | void, and will automatically terminate your rights under this License.
176 | However, parties who have received copies, or rights, from you under
177 | this License will not have their licenses terminated so long as such
178 | parties remain in full compliance.
179 |
180 | 5. You are not required to accept this License, since you have not
181 | signed it. However, nothing else grants you permission to modify or
182 | distribute the Program or its derivative works. These actions are
183 | prohibited by law if you do not accept this License. Therefore, by
184 | modifying or distributing the Program (or any work based on the
185 | Program), you indicate your acceptance of this License to do so, and
186 | all its terms and conditions for copying, distributing or modifying
187 | the Program or works based on it.
188 |
189 | 6. Each time you redistribute the Program (or any work based on the
190 | Program), the recipient automatically receives a license from the
191 | original licensor to copy, distribute or modify the Program subject to
192 | these terms and conditions. You may not impose any further
193 | restrictions on the recipients' exercise of the rights granted herein.
194 | You are not responsible for enforcing compliance by third parties to
195 | this License.
196 |
197 | 7. If, as a consequence of a court judgment or allegation of patent
198 | infringement or for any other reason (not limited to patent issues),
199 | conditions are imposed on you (whether by court order, agreement or
200 | otherwise) that contradict the conditions of this License, they do not
201 | excuse you from the conditions of this License. If you cannot
202 | distribute so as to satisfy simultaneously your obligations under this
203 | License and any other pertinent obligations, then as a consequence you
204 | may not distribute the Program at all. For example, if a patent
205 | license would not permit royalty-free redistribution of the Program by
206 | all those who receive copies directly or indirectly through you, then
207 | the only way you could satisfy both it and this License would be to
208 | refrain entirely from distribution of the Program.
209 |
210 | If any portion of this section is held invalid or unenforceable under
211 | any particular circumstance, the balance of the section is intended to
212 | apply and the section as a whole is intended to apply in other
213 | circumstances.
214 |
215 | It is not the purpose of this section to induce you to infringe any
216 | patents or other property right claims or to contest validity of any
217 | such claims; this section has the sole purpose of protecting the
218 | integrity of the free software distribution system, which is
219 | implemented by public license practices. Many people have made
220 | generous contributions to the wide range of software distributed
221 | through that system in reliance on consistent application of that
222 | system; it is up to the author/donor to decide if he or she is willing
223 | to distribute software through any other system and a licensee cannot
224 | impose that choice.
225 |
226 | This section is intended to make thoroughly clear what is believed to
227 | be a consequence of the rest of this License.
228 |
229 | 8. If the distribution and/or use of the Program is restricted in
230 | certain countries either by patents or by copyrighted interfaces, the
231 | original copyright holder who places the Program under this License
232 | may add an explicit geographical distribution limitation excluding
233 | those countries, so that distribution is permitted only in or among
234 | countries not thus excluded. In such case, this License incorporates
235 | the limitation as if written in the body of this License.
236 |
237 | 9. The Free Software Foundation may publish revised and/or new versions
238 | of the General Public License from time to time. Such new versions will
239 | be similar in spirit to the present version, but may differ in detail to
240 | address new problems or concerns.
241 |
242 | Each version is given a distinguishing version number. If the Program
243 | specifies a version number of this License which applies to it and "any
244 | later version", you have the option of following the terms and conditions
245 | either of that version or of any later version published by the Free
246 | Software Foundation. If the Program does not specify a version number of
247 | this License, you may choose any version ever published by the Free Software
248 | Foundation.
249 |
250 | 10. If you wish to incorporate parts of the Program into other free
251 | programs whose distribution conditions are different, write to the author
252 | to ask for permission. For software which is copyrighted by the Free
253 | Software Foundation, write to the Free Software Foundation; we sometimes
254 | make exceptions for this. Our decision will be guided by the two goals
255 | of preserving the free status of all derivatives of our free software and
256 | of promoting the sharing and reuse of software generally.
257 |
258 | NO WARRANTY
259 |
260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268 | REPAIR OR CORRECTION.
269 |
270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278 | POSSIBILITY OF SUCH DAMAGES.
279 |
280 | END OF TERMS AND CONDITIONS
281 |
282 | How to Apply These Terms to Your New Programs
283 |
284 | If you develop a new program, and you want it to be of the greatest
285 | possible use to the public, the best way to achieve this is to make it
286 | free software which everyone can redistribute and change under these terms.
287 |
288 | To do so, attach the following notices to the program. It is safest
289 | to attach them to the start of each source file to most effectively
290 | convey the exclusion of warranty; and each file should have at least
291 | the "copyright" line and a pointer to where the full notice is found.
292 |
293 | {description}
294 | Copyright (C) {year} {fullname}
295 |
296 | This program is free software; you can redistribute it and/or modify
297 | it under the terms of the GNU General Public License as published by
298 | the Free Software Foundation; either version 2 of the License, or
299 | (at your option) any later version.
300 |
301 | This program is distributed in the hope that it will be useful,
302 | but WITHOUT ANY WARRANTY; without even the implied warranty of
303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304 | GNU General Public License for more details.
305 |
306 | You should have received a copy of the GNU General Public License along
307 | with this program; if not, write to the Free Software Foundation, Inc.,
308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309 |
310 | Also add information on how to contact you by electronic and paper mail.
311 |
312 | If the program is interactive, make it output a short notice like this
313 | when it starts in an interactive mode:
314 |
315 | Gnomovision version 69, Copyright (C) year name of author
316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317 | This is free software, and you are welcome to redistribute it
318 | under certain conditions; type `show c' for details.
319 |
320 | The hypothetical commands `show w' and `show c' should show the appropriate
321 | parts of the General Public License. Of course, the commands you use may
322 | be called something other than `show w' and `show c'; they could even be
323 | mouse-clicks or menu items--whatever suits your program.
324 |
325 | You should also get your employer (if you work as a programmer) or your
326 | school, if any, to sign a "copyright disclaimer" for the program, if
327 | necessary. Here is a sample; alter the names:
328 |
329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330 | `Gnomovision' (which makes passes at compilers) written by James Hacker.
331 |
332 | {signature of Ty Coon}, 1 April 1989
333 | Ty Coon, President of Vice
334 |
335 | This General Public License does not permit incorporating your program into
336 | proprietary programs. If your program is a subroutine library, you may
337 | consider it more useful to permit linking proprietary applications with the
338 | library. If this is what you want to do, use the GNU Lesser General
339 | Public License instead of this License.
340 |
341 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # py-args
2 |
3 | Python command line tools as productivity supplements for Posix systems
4 |
5 |
6 |
7 |
8 | ### [glob-replace](./glob-replace)
9 |
10 | A Python command line tool for global replacements of strings in text-formatted files in a single directory or directory tree.
11 |
12 |
13 |
14 | ### [glob-rename](./glob-rename)
15 |
16 | A Python command line tool for global renaming of files in a single directory or directory tree.
17 |
--------------------------------------------------------------------------------
/glob-rename/README.md:
--------------------------------------------------------------------------------
1 | # glob-rename
2 |
3 | A Python command line tool for global renaming of files in a single directory or directory tree.
4 |
5 |
6 |
7 |
8 | ## Sections
9 | - [Examples](#examples)
10 | - [Usage](#usage)
11 | - [Changelog](#changelog)
12 |
13 |
14 |
15 |
16 | ## Examples
17 | [[back to top](#sections)]
18 |
19 | An example of replacing all instances of a string 'file' by another string 'item' in all .txt files in a directory tree:
20 |
21 | ./glob-rename.py testdir/ -s item -r file -w
22 | Checked 8 items and renamed 6 files(s) of item
23 |
24 | ### before:
25 | 
26 |
27 | ### after:
28 | 
29 |
30 |
31 |
32 |
33 | Using the `-p` (`--print`) flag, `glob-rename.py` prints out the files that it would rename instead of actually renaming them.
34 |
35 | ./glob-rename.py testdir/ -w -p -s file -r test
36 |
37 | testdir/file1.txt --> testdir/test1.txt
38 | testdir/file2.txt --> testdir/test2.txt
39 | testdir/subdir1/file1.txt --> testdir/subdir1/test1.txt
40 | testdir/subdir1/file2.txt --> testdir/subdir1/test2.txt
41 | testdir/subdir2/file1.txt --> testdir/subdir2/test1.txt
42 | testdir/subdir2/file2.txt --> testdir/subdir2/test2.txt
43 | Checked 8 items and would rename 6 files(s).
44 |
45 |
46 |
47 |
48 | ## Usage
49 | [[back to top](#sections)]
50 |
51 | An overview of all command line arguments.
52 |
53 |
54 | ./glob-rename.py -h
55 | usage: glob-rename.py [-h] [-s SEARCH] [-r REPLACE] [-w] [-e EXTENSIONS] [-p]
56 | [-v]
57 | start_dir
58 |
59 | A command line tool for global renaming of files.
60 |
61 | positional arguments:
62 | start_dir
63 |
64 | optional arguments:
65 | -h, --help show this help message and exit
66 | -s SEARCH, --search SEARCH
67 | String to be replaced.
68 | -r REPLACE, --replace REPLACE
69 | String to replace the search query with.
70 | -w, --walk Applies the global replacement recursively to sub-directorires.
71 | -d, --directories Rename directories as well.
72 |
73 | -e EXTENSIONS, --extensions EXTENSIONS
74 | Only process files with particular extensions. Comma separated, e.g., ".txt,.py"
75 | -p, --print Prints what it would rename.
76 | -v, --version show program's version number and exit
77 |
78 |
79 |
80 |
81 | ## Changelog
82 | [[back to top](#sections)]
83 |
84 | ### v1.1.0
85 | - Adds an option to also rename directories.
86 |
87 | ### v1.0.2
88 | - Skips files where renaming wouldn't result in a file name change for better efficiency.
89 | - Added options `` and ``.
90 |
91 |
92 | ### v1.0.1
93 | - Adding the optional `-p` (`--print`) flag to print out the files that `glob-rename.py` would rename instead of actually renaming them.
94 |
--------------------------------------------------------------------------------
/glob-rename/glob-rename.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 |
3 | # Sebastian Raschka 2014-2018
4 | # A command line tool for global replacements of strings in files.
5 |
6 | import glob
7 | import os
8 | import shutil
9 |
10 | checked_files = 0
11 | renamed_files = 0
12 | checked_dirs = 0
13 | renamed_dirs = 0
14 |
15 |
16 | def check_extension(extensions, filename):
17 | for x in extensions:
18 | if filename.endswith(x):
19 | return True
20 | return False
21 |
22 |
23 | def replace_indir(extensions, search, replace,
24 | cur_dir, print_out):
25 | filenames = glob.glob(os.path.join(cur_dir, '*'))
26 | global checked_files
27 | global renamed_files
28 | for f in filenames:
29 | # for some reason (bug in glob?)
30 | # directories sometimes end up here;
31 | # hence the check on the next line
32 | if not os.path.isfile(f):
33 | continue
34 | else:
35 | if not extensions or check_extension(extensions, f):
36 | if search in f:
37 |
38 | # replace
39 | old_file = os.path.basename(f)
40 |
41 | if replace == '':
42 | new_file = os.path.basename(f).lower()
43 | elif replace == '':
44 | new_file = os.path.basename(f).upper()
45 | else:
46 | new_file = os.path.basename(f).replace(search, replace)
47 |
48 | if old_file != new_file:
49 | new_path = os.path.join(os.path.dirname(f), new_file)
50 | if not print_out:
51 | os.rename(f, new_path)
52 | else:
53 | print('%s --> %s' % (f, new_path))
54 | renamed_files += 1
55 | checked_files += 1
56 |
57 |
58 | def rename_dir(search, replace,
59 | cur_dir, print_out):
60 | global checked_dirs
61 | global renamed_dirs
62 | if not os.path.isdir(cur_dir):
63 | return
64 |
65 | old_dir_base = os.path.basename(cur_dir)
66 |
67 | if replace == '':
68 | new_dir = old_dir_base.lower()
69 | elif replace == '':
70 | new_dir = old_dir_base.upper()
71 | else:
72 | new_dir = old_dir_base.replace(search, replace)
73 |
74 | if old_dir_base != new_dir:
75 | new_path = os.path.join(os.path.dirname(cur_dir), new_dir)
76 | if not print_out:
77 | shutil.move(cur_dir, new_dir)
78 | else:
79 | print('%s --> %s' % (cur_dir, new_path))
80 | renamed_dirs += 1
81 | checked_dirs += 1
82 |
83 |
84 | def run(extensions, search, replace, cur_dir,
85 | recursive, print_out, directories):
86 | if recursive:
87 | tree = os.walk(cur_dir)
88 | for d in tree:
89 | replace_indir(extensions, search, replace,
90 | cur_dir=d[0], print_out=print_out)
91 |
92 | else:
93 | replace_indir(extensions, search, replace,
94 | cur_dir=cur_dir, print_out=print_out)
95 |
96 | if directories:
97 | if recursive:
98 | tree = os.walk(cur_dir)
99 | tree_contents = [d for d in tree]
100 | tree_contents = tree_contents[::-1]
101 | for d in tree_contents:
102 | rename_dir(search, replace,
103 | cur_dir=d[0], print_out=print_out)
104 |
105 | else:
106 | rename_dir(search, replace,
107 | cur_dir=cur_dir, print_out=print_out)
108 |
109 |
110 | if __name__ == '__main__':
111 |
112 | import argparse
113 |
114 | parser = argparse.ArgumentParser(
115 | description='A command line tool for global renaming of files.',
116 | formatter_class=argparse.RawTextHelpFormatter
117 | )
118 |
119 | parser.add_argument('start_dir')
120 |
121 | parser.add_argument('-s', '--search', default='', help=(
122 | 'String to be replaced (default:"").'))
123 | parser.add_argument('-r', '--replace', help=(
124 | 'String to replace the search query with.\nOther '
125 | 'options: "", "" .'))
126 | parser.add_argument('-w', '--walk', action='store_true',
127 | default=False, help=(
128 | 'Applies the global replacement '
129 | 'recursively to sub-directorires.'))
130 | parser.add_argument('-d', '--directories', action='store_true',
131 | default=False, help=('Rename directories as well.'))
132 | parser.add_argument('-e', '--extensions', help=(
133 | 'Only process files with particular extensions. Comma separated,'
134 | ' e.g., ".txt,.py"'))
135 | parser.add_argument('-p', '--print', action='store_true', help=(
136 | 'Prints what it would rename.'))
137 | parser.add_argument('-v', '--version',
138 | action='version', version='v. 1.1')
139 |
140 | args = parser.parse_args()
141 |
142 | extensions = False
143 | if args.extensions:
144 | extensions = args.extensions.split(',')
145 |
146 | run(extensions, args.search, args.replace,
147 | args.start_dir, args.walk, args.print, args.directories)
148 |
149 | would = 'renamed'
150 | if args.print:
151 | would = 'would rename'
152 | print('Checked %s files and %s %s file(s).' % (
153 | checked_files, would, renamed_files))
154 |
155 | if args.directories:
156 | print('Checked %s directories and %s %s dir(s).' % (
157 | checked_dirs, would, renamed_dirs))
158 |
--------------------------------------------------------------------------------
/glob-rename/images/img_1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/rasbt/py-args/34a86bc4c8163ac5fb1886fdbd601ce59d7ded1e/glob-rename/images/img_1.png
--------------------------------------------------------------------------------
/glob-rename/images/img_2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/rasbt/py-args/34a86bc4c8163ac5fb1886fdbd601ce59d7ded1e/glob-rename/images/img_2.png
--------------------------------------------------------------------------------
/glob-rename/testdir/file1.txt:
--------------------------------------------------------------------------------
1 | Hello Earth!
2 | This is a test!
--------------------------------------------------------------------------------
/glob-rename/testdir/file2.txt:
--------------------------------------------------------------------------------
1 | Hello Earth!
2 | This is a test!
--------------------------------------------------------------------------------
/glob-rename/testdir/subdir1/file1.txt:
--------------------------------------------------------------------------------
1 | Hello Earth!
2 | This is a test!
--------------------------------------------------------------------------------
/glob-rename/testdir/subdir1/file2.txt:
--------------------------------------------------------------------------------
1 | Hello Earth!
2 | This is a test!
--------------------------------------------------------------------------------
/glob-rename/testdir/subdir2/file1.txt:
--------------------------------------------------------------------------------
1 | Hello Earth!
2 | This is a test!
--------------------------------------------------------------------------------
/glob-rename/testdir/subdir2/file2.txt:
--------------------------------------------------------------------------------
1 | Hello Earth!
2 | This is a test!
--------------------------------------------------------------------------------
/glob-replace/README.md:
--------------------------------------------------------------------------------
1 | # glob-replace
2 |
3 | A Python command line tool for global replacements of strings in text-formatted files in a single directory or directory tree.
4 |
5 |
6 |
7 |
8 | ## Sections
9 | - [Examples](#examples)
10 | - [Usage](#usage)
11 | - [Changelog](#changelog)
12 |
13 |
14 |
15 |
16 | ## Examples
17 | [[back to top](#sections)]
18 |
19 | The `glob-replace` utility script can come in handy for replacing certain words or phrases in a collection of files. For example, if you are interested in bumping a "Copyright 2013-2022" to "Copyright 2013-2023" on your personal website or code repository.
20 |
21 | I recommend doing this in 3 steps:
22 |
23 | **Step 1: Create a backup**
24 |
25 | Make a copy of the target folder (for the just-in-case scenario).
26 |
27 | ```bash
28 | rsync -avP personal-website ~/Desktop/personal-website-backup
29 | ```
30 |
31 | **Step 2: Dry run**
32 |
33 | Run the replacement command using the `--print` flag, which just prints the files it would change.
34 |
35 | ```bash
36 | python glob-replace.py personal-website --walk --search "2013-2022" --replace "2013-2023" --print
37 | ```
38 |
39 | **Step 3: Apply the changes**
40 |
41 | Run the replacement command without the `--print` flag to make the actual changes.
42 |
43 | ```python
44 | python glob-replace.py personal-website --walk --search "2013-2022" --replace "2013-2023"
45 | ```
46 |
47 |
48 |
49 |
50 |
51 |
52 | ## Usage
53 | [[back to top](#sections)]
54 |
55 | An overview of all command line arguments.
56 |
57 |
58 | ./glob-replace.py -h
59 | usage: glob-replace.py [-h] [-s SEARCH] [-r REPLACE] [-w] [-e EXTENSIONS] [-p]
60 | [-v]
61 | start_dir
62 |
63 | A command line tool for global replacements of strings in files.
64 |
65 | positional arguments:
66 | start_dir
67 |
68 | optional arguments:
69 | -h, --help show this help message and exit
70 | -s SEARCH, --search SEARCH
71 | String to be replaced.
72 | -r REPLACE, --replace REPLACE
73 | String to replace the search query with.
74 | -f REPLACE_FROM_FILE, --replace_from_file REPLACE_FROM_FILE
75 | Link to a text file that contains the text to replace the query with
76 | -w, --walk Applies the global replacement recursively to sub-directorires.
77 | -e EXTENSIONS, --extensions EXTENSIONS
78 | Only process files with particular extensions. Comma separated, e.g., ".txt,.py"
79 | -b, --skip_binary Skips binary files if enabled (may result in false
80 | positives and negatives).
81 | -p, --print Prints what it would rename.
82 | -v, --version show program's version number and exit
83 |
84 |
85 |
86 |
87 |
88 | ## Changelog
89 | [[back to top](#sections)]
90 |
91 | ### v1.3
92 | - Adds an option to read the string that is used for replacement from an external text file.
93 |
94 | ### v1.2
95 | - Adds an optional `-b` (`--skip_binary`) flag to skip binary files.
96 |
97 | ### v1.1
98 | - Adds an optional `-p` (`--print`) flag to print out the number of replacements that `glob-replace.py` would make instead of actually replacing those strings.
--------------------------------------------------------------------------------
/glob-replace/glob-replace.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 |
3 | # Sebastian Raschka 2014-2018
4 | # A command line tool for global replacements of strings in files.
5 |
6 | import glob
7 | import fileinput
8 | import sys
9 | import os
10 |
11 |
12 | searched_files = 0
13 | replaced_instances = 0
14 |
15 | TEXTCHARS = bytearray({7, 8, 9, 10, 12, 13, 27} |
16 | set(range(0x20, 0x100)) - {0x7f})
17 |
18 |
19 | def check_extension(extensions, filename):
20 | for x in extensions:
21 | if filename.endswith(x):
22 | return True
23 | return False
24 |
25 |
26 | def is_binary(filepath):
27 | with open(filepath, 'rb') as f:
28 | content = f.read(1024)
29 | return bool(content.translate(None, TEXTCHARS))
30 |
31 |
32 | def is_invisible(path):
33 | fp = os.path.basename(path)
34 | return fp.startswith((".", "__"))
35 |
36 |
37 | def replace_indir(extensions, search, replace,
38 | cur_dir, print_out, skip_binary):
39 | filenames = glob.glob(os.path.join(cur_dir, '*'))
40 | global searched_files
41 | global replaced_instances
42 | for f in filenames:
43 |
44 | found = 0
45 | if not os.path.isfile(f):
46 | continue
47 |
48 | if skip_binary:
49 | if is_binary(f):
50 | searched_files += 1
51 | continue
52 |
53 | if not extensions or check_extension(extensions, f):
54 | if print_out:
55 | with open(f, 'r', encoding="ISO-8859-1") as in_file:
56 | try:
57 | for line in in_file:
58 | if search in line:
59 | found += 1
60 | except UnicodeDecodeError as e:
61 | print('ERROR: File %s may be binary. You can try to'
62 | ' skip binary by using the --skip_binary flag' %
63 | f)
64 | raise e
65 |
66 | else:
67 | for line in fileinput.input(f, inplace=True, mode='rU'):
68 | if search in line:
69 | found += 1
70 | try:
71 | sys.stdout.write(line.replace(search, replace))
72 | except UnicodeDecodeError as e:
73 | print('ERROR: File %s may be binary. You can try to'
74 | ' skip binary by using the --skip_binary flag' %
75 | f)
76 | raise e
77 |
78 | replaced_instances += found
79 | searched_files += 1
80 | if print_out and found:
81 | print('%d x in %s' % (found, f))
82 |
83 |
84 | def run(extensions, search, replace, cur_dir,
85 | recursive, print_out, skip_binary, skip_invisible):
86 | if recursive:
87 | tree = os.walk(cur_dir)
88 | for d in tree:
89 | if skip_invisible:
90 | if is_invisible(os.path.basename(d[0])):
91 | continue
92 | replace_indir(extensions, search, replace,
93 | cur_dir=d[0], print_out=print_out,
94 | skip_binary=skip_binary)
95 | else:
96 | replace_indir(extensions, search, replace,
97 | cur_dir=cur_dir, print_out=print_out,
98 | skip_binary=skip_binary)
99 |
100 |
101 | if __name__ == '__main__':
102 |
103 | import argparse
104 |
105 | parser = argparse.ArgumentParser(
106 | description=('A command line tool for global '
107 | 'replacements of strings in files.'),
108 | formatter_class=argparse.RawTextHelpFormatter
109 | )
110 |
111 | parser.add_argument('start_dir')
112 |
113 | parser.add_argument('-s', '--search', help='String to be replaced.')
114 | parser.add_argument('-r', '--replace', help='String to replace the search '
115 | 'query with.')
116 | parser.add_argument('-f', '--replace_from_file', help='Link to a text '
117 | 'file that contains the text to replace the'
118 | ' query with')
119 | parser.add_argument('-w', '--walk', action='store_true', default=False,
120 | help='Applies the global replacement recursively to '
121 | 'sub-directorires.')
122 | parser.add_argument('-e', '--extensions', help='Only process files with '
123 | 'particular extensions. '
124 | 'Comma separated, e.g., ".txt,.py"')
125 | parser.add_argument('--skip_invisible', help='Skips files and folders '
126 | 'starting with a leading period or two leading '
127 | 'underscores (e.g., `.git` or `__pycache__`).',
128 | action='store_true', default=False)
129 | parser.add_argument('-p', '--print', action='store_true',
130 | help='Prints what it would rename.')
131 | parser.add_argument('-b', '--skip_binary', action='store_true',
132 | help=('Skips binary files if enabled '
133 | '(may result in false positives'
134 | ' and negatives).'))
135 | parser.add_argument('-v', '--version', action='version', version='v. 1.2')
136 |
137 | args = parser.parse_args()
138 |
139 | if args.replace and args.replace_from_file:
140 | raise AttributeError("Can't have both -r/--replace and "
141 | "--replace_from_file/-f flags at the same time.")
142 |
143 | if args.replace:
144 | replace = args.replace
145 | elif args.replace_from_file:
146 | with open(args.replace_from_file, 'r', encoding="ISO-8859-1") as f:
147 | replace = f.read()
148 | else:
149 | raise AttributeError("Must use either the -r/--replace or "
150 | "--replace_from_file/-f flag.")
151 |
152 | extensions = False
153 | if args.extensions:
154 | extensions = args.extensions.split(',')
155 |
156 | run(extensions, args.search, replace,
157 | args.start_dir, args.walk, args.print, args.skip_binary,
158 | skip_invisible=args.skip_invisible)
159 |
160 | would = 'replaced'
161 | if args.print:
162 | would = 'would replace'
163 |
164 | print('Searched %s file(s) and %s %s instance(s) of %s' % (
165 | searched_files, would, replaced_instances, args.search))
166 |
--------------------------------------------------------------------------------
/glob-replace/images/img_1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/rasbt/py-args/34a86bc4c8163ac5fb1886fdbd601ce59d7ded1e/glob-replace/images/img_1.png
--------------------------------------------------------------------------------
/glob-replace/testdir/file1.txt:
--------------------------------------------------------------------------------
1 | Hello Earth!
2 | This is a test!
--------------------------------------------------------------------------------
/glob-replace/testdir/file2.txt:
--------------------------------------------------------------------------------
1 | Hello Earth!
2 | This is a test!
--------------------------------------------------------------------------------
/glob-replace/testdir/subdir1/file1.txt:
--------------------------------------------------------------------------------
1 | Hello Earth!
2 | This is a test!
--------------------------------------------------------------------------------
/glob-replace/testdir/subdir1/file2.txt:
--------------------------------------------------------------------------------
1 | Hello Earth!
2 | This is a test!
--------------------------------------------------------------------------------
/glob-replace/testdir/subdir2/file1.txt:
--------------------------------------------------------------------------------
1 | Hello Earth!
2 | This is a test!
--------------------------------------------------------------------------------
/glob-replace/testdir/subdir2/file2.txt:
--------------------------------------------------------------------------------
1 | Hello Earth!
2 | This is a test!
--------------------------------------------------------------------------------