-
Notifications
You must be signed in to change notification settings - Fork 0
/
naming.py
206 lines (165 loc) · 6.81 KB
/
naming.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
import os
import logging
import pathlib
import re
from common import ChangeLog
CAPITALIZED = 'capitalized'
TITLECASE = 'titlecase'
LOWERCASE = 'lowercase'
UPPERCASE = 'uppercase'
ADJACENT_PERIOD_PATTERN = re.compile(r'([^A-Z\d)\]])?\.([^A-Z\d(\[])?',
flags=re.IGNORECASE)
STYLE_NAMES = [
CAPITALIZED,
TITLECASE,
LOWERCASE,
UPPERCASE
]
STRIPPING_CHARS = " _-"
LOG = logging.getLogger('fsclean.naming')
def check_filename(filename: str, style=None, space_char=None):
"""
Parse a given filename for these consistency errors:
- Extraneous spaces
- Uppercase extension names
- Stripping beginning and end of STRIPPING_CHARS
- Anything but alphanumerics before or after "."
- Optionally enforce naming conventions
:param filename: input filename
:param style: enforce a particular naming style
(CAPITALIZED, TITLECASE, LOWERCASE, UPPERCASE)
:param space_char: replace spaces in a file name with this character
:return: a corrected filename
"""
pl_obj = pathlib.Path(filename)
name = pl_obj.stem
ext = pl_obj.suffix
if name != '':
name_stripped = name.strip(STRIPPING_CHARS)
if name_stripped != name:
LOG.debug('"{}": needed stripping'.format(filename))
name_spaces = ' '.join(name_stripped.split())
if name_spaces != name_stripped:
LOG.debug('"{}": had extraneous spaces'.format(filename))
name = name_spaces
if style is not None:
if style == CAPITALIZED:
name_styled = name.capitalize()
elif style == TITLECASE:
name_styled = name.title()
elif style == LOWERCASE:
name_styled = name.lower()
elif style == UPPERCASE:
name_styled = name.upper()
else:
name_styled = name
if name_styled != name:
LOG.debug('"{}": naming style enforced'.format(filename))
name = name_styled
if space_char is not None:
name_replaced = name.replace(' ', space_char)
if name_replaced != name:
LOG.debug('"{}": spaces replaced with "{}"'.format(filename,
space_char))
name = name_replaced
ext_spaces = ext.replace(' ', '')
if ext_spaces != ext:
LOG.debug('"{}": extension spaces removed'.format(filename))
ext_lowering = ext_spaces.lower()
if ext_lowering != ext_spaces:
LOG.debug('"{}": extension converted to lowercase'.format(filename))
first_stage = name + ext_lowering
adjacent_other = ADJACENT_PERIOD_PATTERN.sub('.', first_stage)
if adjacent_other != first_stage:
pattern_text = ADJACENT_PERIOD_PATTERN.pattern
LOG.debug(f'"{filename}": removed chars adjacent to period matching '
f'"{pattern_text}"')
second_stage = adjacent_other
return second_stage
def check_files(files: list, style=None, space_char=None):
"""
Generate a dictionary of files to be renamed and the new name
:param files: a list of file paths to check
:param style: enforce a particular naming style
(CAPITALIZED, TITLECASE, LOWERCASE, UPPERCASE)
:param space_char: replace spaces in a file name with this character
:return: A dictionary in form of {<path>: <new name>}
"""
renamed = {}
for file in files:
new_name = check_filename(file, style=style, space_char=space_char)
if new_name != file:
renamed.update({file: new_name})
LOG.debug('"{}": to be renamed "{}"'.format(file, new_name))
else:
LOG.debug('"{}": no change'.format(file))
return renamed
def rename_files(cl: ChangeLog, directory: str, files: list, dry_run: bool,
style=None, space_char=None):
"""
Check file names for inconsistency and rename
:param cl: ChangeLog instance
:param directory: directory the files are contained in
:param files: a list of file names
:param dry_run: True will not apply changes, only log them
:param style: enforce a particular naming style
(CAPITALIZED, TITLECASE, LOWERCASE, UPPERCASE)
:param space_char: replace spaces in a file name with this character
"""
changes = check_files(files, style=style, space_char=space_char)
# iterate and apply changes
for of, nf in changes.items():
path = os.path.join(directory, of)
dest = os.path.join(directory, nf)
LOG.info('"{}": rename "{}"'.format(path, nf))
if not dry_run:
try:
if not os.path.exists(dest):
os.rename(path, dest)
cl.addChange(__name__, True, src=path, dest=dest)
else:
LOG.warning('"{}": destination already exists'.format(path))
cl.addChange(__name__,
False,
src=path,
dest=dest,
message='destination already exists')
except OSError as e:
LOG.error('failed to rename "{}": {}'.format(path, str(e)))
cl.addChange(__name__,
False,
src=path,
dest=dest,
message=str(e),
errno=e.errno)
else:
cl.addChange(__name__, False, src=path, dest=dest)
def rename_dir(cl: ChangeLog, directory: str, dry_run: bool, recursive: bool,
style=None, space_char=None):
"""
Check files in a directory for naming inconsistency and rename
:param cl: ChangeLog instance
:param directory: directory that the files are contained in
:param dry_run: True will not apply changes, only log them
:param recursive: True to recursively enter sub-directories
:param style: enforce a particular naming style
(CAPITALIZED, TITLECASE, LOWERCASE, UPPERCASE)
:param space_char: replace spaces in a file name with this character
"""
try:
for cd, dirs, files in os.walk(directory, followlinks=False):
LOG.info(f'working in "{cd}" ({len(files)} files, '
f'{len(dirs)} sub directories)')
rename_files(cl,
cd,
files,
dry_run,
style=style,
space_char=space_char)
if recursive:
# check each sub-directory
for sub in dirs:
rename_dir(cl, sub, dry_run, recursive)
except OSError as e:
LOG.error('failed to enumerate "{}": {}'.format(directory,
str(e)))