-
Notifications
You must be signed in to change notification settings - Fork 13
/
_io.py
311 lines (262 loc) · 10 KB
/
_io.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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
# -*- coding: utf-8 -*-
"""
=============================================
I/O functions (:mod:`sknano.core._io`)
=============================================
.. currentmodule:: sknano.core._io
"""
from __future__ import absolute_import, division, print_function, \
unicode_literals
__docformat__ = 'restructuredtext en'
import json
import os
import re
import sys
try:
import yaml
try:
from yaml import CLoader as Loader, CDumper as Dumper
except ImportError:
from yaml import Loader, Dumper
except ImportError:
yaml = None
__all__ = ['get_fname', 'get_fpath', 'listdir_dirnames', 'listdir_fnames',
'listdir', 'loadobj', 'dumpobj']
def get_fname(fname=None, ext=None, outpath=os.getcwd(), overwrite=False,
add_fnum=True, fnum=None, verbose=False, **kwargs):
"""Generate modified `fname` string based on chosen parameters.
Parameters
----------
fname : str
Name of file, with or without an extension.
ext : str, optional
File extension to append to `fname`. If `ext` is None,
then `fname` is analyzed to see if it likely already has an
extension. An extension is set to the
last element in the list of strings returned by
`fname.split('.')` **if** this list has more than 1 element.
Otherwise, `ext` will be set to an empty string `''`.
If `ext` is not None and is a valid string,
then `fname` is analyzed to see if it already ends with `ext`.
If `fname.endswith(ext)` is `True` from the start, then `ext` will
not be duplicately appended.
outpath : str, optional
Absolute or relative path for generated output file.
Default is the absolute path returned by `os.getcwd()`.
overwrite : bool, optional
If `True`, overwrite an existing file if it has the same generated
file path.
add_fnum : bool, optional
Append integer number to output file name, starting with **1**.
fnum : {None, int}, optional
Starting file number to append if `add_fnum` is `True`.
.. note::
If the generated file path exists and `overwrite` is False,
setting this parameter has no effect.
verbose : bool, optional
Show verbose output.
Returns
-------
fname : str
Updated `fname`.
"""
return get_fpath(fname=fname, ext=ext, outpath=outpath,
overwrite=overwrite, add_fnum=add_fnum, fnum=fnum,
fname_only=True, verbose=verbose)
def get_fpath(fname=None, ext=None, outpath=os.getcwd(), overwrite=False,
add_fnum=True, fnum=None, include_fname=False, fname_only=False,
verbose=False):
"""Generate absolute path to modified `fname`.
Parameters
----------
fname : str
Name of file, with or without an extension.
ext : str, optional
File extension to append to `fname`. If `ext` is None,
then `fname` is analyzed to see if it likely already has an
extension. An extension is set to the
last element in the list of strings returned by
`fname.split('.')` **if** this list has more than 1 element.
Otherwise, `ext` will be set to an empty string `''`.
If `ext` is not None and is a valid string,
then `fname` is analyzed to see if it already ends with `ext`.
If `fname.endswith(ext)` is `True` from the start, then `ext` will
not be duplicately appended.
outpath : str, optional
Absolute or relative path for generated output file.
Default is the absolute path returned by `os.getcwd()`.
overwrite : bool, optional
If `True`, overwrite an existing file if it has the same generated
file path.
add_fnum : bool, optional
Append integer number to output file name, starting with **1**.
fnum : {None, int}, optional
Starting file number to append if `add_fnum` is `True`.
.. note::
If the generated file path exists and `overwrite` is False,
setting this parameter has no effect.
include_fname : bool, optional
If `True`, return `(fpath, fname)` tuple.
fname_only : bool, optional
If `True`, return only `fname`.
verbose : bool, optional
Show verbose output.
Returns
-------
fpath : str
The concatenation of `outpath` followed by the updated `fname`.
(fpath, fname) : tuple (only if `include_fname` is `True`)
2-tuple of strings `(fpath, fname)`.
fname : str (only if `fname_only` is `True`)
Updated `fname`.
"""
f = None
if fname is None or fname == '':
error_msg = '`fname` must be a string at least 1 character long.'
if fname is None:
raise TypeError(error_msg)
else:
raise ValueError(error_msg)
else:
f = fname
fsplit = f.split('.')
if ext is None:
if len(fsplit) > 1:
ext = '.' + fsplit[-1]
else:
ext = ''
else:
# check if extension already starts with a '.'
if not ext.startswith('.'):
ext = '.' + ext
# check if file name already ends with extension.
if f.split('.')[-1] != ext.split('.')[-1]:
f += ext
if add_fnum:
fname = re.split(ext, f)[0]
if fnum is not None:
f = fname + '-{:d}'.format(fnum) + ext
else:
f = fname + '-1' + ext
fpath = None
if outpath is None:
outpath = os.getcwd()
try:
os.makedirs(outpath)
except OSError:
if os.path.isdir(outpath):
pass
else:
outpath = os.curdir
finally:
fname = f
fpath = os.path.join(outpath, fname)
if os.path.isfile(fpath):
if overwrite:
try:
os.remove(fpath)
except OSError as e:
print(e)
sys.exit(1)
else:
if verbose:
print('overwriting existing file: {}'.format(fname))
else:
if add_fnum:
while os.path.isfile(fpath):
fname = \
'-'.join(re.split('-', re.split(ext, f)[0])[:-1])
fnum = re.split('-', re.split(ext, f)[0])[-1]
f = fname + '-' + str(int(fnum) + 1) + ext
fpath = os.path.join(outpath, f)
fname = f
else:
print('file exists: {}\n'.format(fpath))
print('Set `add_fnum=True` to generate unique\n' +
'`fname` or `overwrite=True` to overwrite\n' +
'existing file.')
fpath = None
if verbose:
print('Generated file name: {}'.format(fname))
print('File path: {}'.format(fpath))
if fname_only:
return fname
elif include_fname:
return fpath, fname
else:
return fpath
def listdir_dirnames(path='.', filterfunc=None, include_path=False):
"""Return list of names of directories in the directory given by `path`.
Parameters
----------
path : :class:`~python:str`, optional
filterfunc : `function`, optional
include_path : :class:`~python:bool`, optional
Returns
-------
fnames : :class:`~python:list`
:class:`~python:list` of names of directories in `path`.
"""
return listdir(path, filterfunc=filterfunc,
filter_dirnames=filterfunc is not None,
include_path=include_path)[0]
def listdir_fnames(path='.', filterfunc=None, include_path=False):
"""Return list of names of files in the directory given by `path`.
Parameters
----------
path : :class:`~python:str`, optional
filterfunc : `function`, optional
include_path : :class:`~python:bool`, optional
Returns
-------
fnames : :class:`~python:list`
:class:`~python:list` of names of files in `path`.
"""
return listdir(path, filterfunc=filterfunc,
filter_fnames=filterfunc is not None,
include_path=include_path)[-1]
def listdir(path='.', filterfunc=None, filter_dirnames=False,
filter_fnames=False, include_path=False):
"""Return a tuple of the names of the directories and files in the
directory given by `path`.
Parameters
----------
path : :class:`~python:str`, optional
filterfunc : `function`, optional
filter_dirnames : :class:`~python:bool`, optional
filter_fnames : :class:`~python:bool`, optional
include_path : :class:`~python:bool`, optional
Returns
-------
(dirnames, fnames) : :class:`~python:tuple`
:class:`~python:tuple` of names of directories and files in `path`.
"""
l = os.listdir(path)
dirnames = \
[name for name in l if os.path.isdir(os.path.join(path, name))]
fnames = \
[name for name in l if os.path.isfile(os.path.join(path, name))]
if filter_dirnames and filterfunc is not None:
dirnames = list(filter(filterfunc, dirnames))
if filter_fnames and filterfunc is not None:
fnames = list(filter(filterfunc, fnames))
if include_path:
dirnames = [os.path.join(path, name) for name in dirnames]
fnames = [os.path.join(path, name) for name in fnames]
return dirnames, fnames
def loadobj(fn, *args, **kwargs):
with open(fn) as fp:
if fn.lower().endswith(("yaml", "yml")):
if "Loader" not in kwargs:
kwargs["Loader"] = Loader
return yaml.load(fp, *args, **kwargs)
else:
return json.load(fp, *args, **kwargs)
def dumpobj(obj, fn, *args, **kwargs):
with open(fn, 'wt') as fp:
if fn.lower().endswith(("yaml", "yml")):
if "Dumper" not in kwargs:
kwargs["Dumper"] = Dumper
yaml.dump(obj, fp, *args, **kwargs)
else:
json.dump(obj, fp, *args, **kwargs)