Skip to content

Commit c8d5344

Browse files
bouttierbouttier
committed
Release as a package, under ALv2
1 parent 2685bef commit c8d5344

File tree

7 files changed

+313
-30
lines changed

7 files changed

+313
-30
lines changed

‎.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
*.swp
2+
*.pyc
3+
__pycache__
4+
build

‎LICENSE

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright 2014 Elie Bouttier
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.rst

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
====
2+
MVim
3+
====
4+
5+
MVim is a small tool to rename or move files by editing their names with vim.

‎bin/mvim

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
#!/usr/bin/env python3
2+
3+
from argparse import ArgumentParser
4+
from mvim import MVim
5+
6+
7+
if __name__ == "__main__":
8+
9+
parser = ArgumentParser(description='Rename files and directories by '
10+
'editing their names with vim.')
11+
parser.add_argument('-a', '--all', dest='all_files', action='store_true',
12+
help='do not ignore entries starting with “.”.')
13+
parser.add_argument('-s', '--follow-symlinks', dest='follow_symlinks',
14+
action='store_true', help='follow symlinks.')
15+
parser.add_argument('-f', '--force', dest='force', action='store_true',
16+
help='bypass “Are you sure?” messages.')
17+
parser.add_argument('-r', '--recursive', dest='recursive',
18+
action='store_true',
19+
help='remove directories and their contents '
20+
'recursively.')
21+
parser.add_argument('files', metavar='FILE', nargs='*', help='file or '
22+
'directory to rename')
23+
24+
args = parser.parse_args()
25+
26+
files = args.files
27+
if not files:
28+
files.append('.')
29+
30+
MVim(args.files,
31+
all_files=args.all_files,
32+
follow_symlinks=args.follow_symlinks,
33+
force=args.force,
34+
recursive=args.recursive)

‎mvim/__init__.py

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
"""
2+
Copyright 2014 Elie Bouttier
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
"""
16+
17+
__version__ = '0.1.0'
18+
19+
from mvim.mvim import MVim
20+
from mvim.mvim import query_yes_no

‎mvim ‎mvim/mvim.py

+34-30
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,18 @@
1-
#!/usr/bin/env python3
1+
"""
2+
Copyright 2014 Elie Bouttier
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
"""
216

317
import os
418
import sys
@@ -7,14 +21,15 @@
721
from argparse import ArgumentParser
822
from shutil import rmtree
923

24+
1025
class MVim:
1126

1227
def __init__(self, files, **kwargs):
1328

14-
self.all_files = False
29+
self.all_files = False # do not ignore entires startinng with .
1530
self.follow_symlinks = False
16-
self.force = False
17-
self.recursive = False
31+
self.force = False # force remove without asking
32+
self.recursive = False # recursively remove directory
1833

1934
for arg in kwargs:
2035
if arg == 'all_files':
@@ -26,7 +41,8 @@ def __init__(self, files, **kwargs):
2641
elif arg == 'recursive':
2742
self.recursive = kwargs[arg]
2843
else:
29-
print("Warning: ignoring invalid option '%s'" %arg, file=sys.stdout)
44+
print("Warning: ignoring invalid option '%s'" %arg,
45+
file=sys.stdout)
3046

3147
self.oldnames = []
3248
self.added_dir = []
@@ -35,7 +51,7 @@ def __init__(self, files, **kwargs):
3551
for file in files:
3652
self.add(file)
3753

38-
self.tmpfile = NamedTemporaryFile(prefix='vimv.')
54+
self.tmpfile = NamedTemporaryFile(prefix='mvim.')
3955
for name in self.oldnames:
4056
self.tmpfile.write(("%s\n" %name).encode('utf8'))
4157
self.tmpfile.file.flush()
@@ -65,7 +81,8 @@ def add(self, file):
6581
if not self.all_files:
6682
listdir = [ x for x in listdir if x[0] != '.' ]
6783
if file != '.':
68-
self.oldnames += list(map(lambda x: os.path.join(file, x), listdir))
84+
self.oldnames += list(map(lambda x:
85+
os.path.join(file, x), listdir))
6986
else:
7087
self.oldnames += listdir
7188
elif os.path.isfile(file):
@@ -82,7 +99,8 @@ def add(self, file):
8299
self.oldnames += [ file ]
83100

84101
else:
85-
print("Warning: ignoring '%s': no such file or directory" %file, file=sys.stderr)
102+
print("Warning: ignoring '%s': no such file or directory" %file,
103+
file=sys.stderr)
86104

87105
def edit(self):
88106
while True:
@@ -111,21 +129,24 @@ def edit(self):
111129

112130
for i in range(0, len(newnames)):
113131
if newnames[i] == "":
114-
if self.force or query_yes_no("Are you sure to delete '%s' ?" %self.oldnames[i], "no"):
115-
if self.recursive and os.path.isdir(self.oldnames[i]) and not os.path.islink(self.oldnames[i]):
132+
if self.force or query_yes_no("Are you sure to delete '%s' ?"
133+
%self.oldnames[i], "no"):
134+
if self.recursive and os.path.isdir(self.oldnames[i]) \
135+
and not os.path.islink(self.oldnames[i]):
116136
rmtree(self.oldnames[i])
117137
else:
118138
try:
119139
os.remove(self.oldnames[i])
120140
except Exception as e:
121-
print("Error: can not delete '%s':" %self.oldnames[i], e.strerror)
141+
print("Error: can not delete '%s':"
142+
%self.oldnames[i], e.strerror)
122143
else:
123144
print("Skipping '%s' ..." %self.oldnames[i])
124145
elif not newnames[i] == self.oldnames[i]:
125-
print("Rename '%s' to '%s' ..." %(self.oldnames[i], newnames[i]))
146+
print("Rename '%s' to '%s' ..."
147+
%(self.oldnames[i], newnames[i]))
126148
os.rename(self.oldnames[i], newnames[i])
127149

128-
129150
def query_yes_no(question, default="yes"):
130151
"""Ask a yes/no question via raw_input() and return their answer.
131152
@@ -157,20 +178,3 @@ def query_yes_no(question, default="yes"):
157178
else:
158179
print("Please respond with 'yes' or 'no' "\
159180
"(or 'y' or 'n').")
160-
161-
if __name__ == "__main__":
162-
163-
parser = ArgumentParser(description='Rename files by editing their names with vim.')
164-
parser.add_argument('-a', '--all', dest='all_files', action='store_true', help='do not ignore entries starting with.')
165-
parser.add_argument('-s', '--follow-symlinks', dest='follow_symlinks', action='store_true', help='follow symlinks.')
166-
parser.add_argument('-f', '--force', dest='force', action='store_true', help='bypass “Are you sure?” messages.')
167-
parser.add_argument('-r', '--recursive', dest='recursive', action='store_true', help='remove directories and their contents recursively.')
168-
parser.add_argument('files', metavar='FILE', nargs='*')
169-
170-
args = parser.parse_args()
171-
172-
files = args.files
173-
if not files:
174-
files.append('.')
175-
176-
MVim(args.files, all_files=args.all_files, follow_symlinks=args.follow_symlinks, force=args.force, recursive=args.recursive)

0 commit comments

Comments
 (0)