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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
|
# -*- coding: utf-8 -*-
import argparse
import sys
from typing import Callable, Iterable, List, Optional, Pattern, Tuple, Union, cast
import natsort
from natsort.utils import regex_chooser
Num = Union[float, int]
NumIter = Iterable[Num]
NumPair = Tuple[Num, Num]
NumPairIter = Iterable[NumPair]
NumConverter = Callable[[str], Num]
class TypedArgs(argparse.Namespace):
paths: bool
filter: Optional[List[NumPair]]
reverse_filter: Optional[List[NumPair]]
exclude: List[Num]
reverse: bool
number_type: str
nosign: bool
sign: bool
noexp: bool
locale: bool
entries: List[str]
def main(*arguments: str) -> None:
"""
Performs a natural sort on entries given on the command-line.
Arguments are read from sys.argv.
"""
from argparse import ArgumentParser, RawDescriptionHelpFormatter
from textwrap import dedent
parser = ArgumentParser(
description=dedent(cast(str, main.__doc__)),
formatter_class=RawDescriptionHelpFormatter,
)
parser.add_argument(
"--version",
action="version",
version="%(prog)s {}".format(natsort.__version__),
)
parser.add_argument(
"-p",
"--paths",
default=False,
action="store_true",
help="Interpret the input as file paths. This is not "
"strictly necessary to sort all file paths, but in cases "
'where there are OS-generated file paths like "Folder/" '
'and "Folder (1)/", this option is needed to make the '
'paths sorted in the order you expect ("Folder/" before '
'"Folder (1)/").',
)
parser.add_argument(
"-f",
"--filter",
nargs=2,
type=float,
metavar=("LOW", "HIGH"),
action="append",
help="Used for keeping only the entries that have a number "
"falling in the given range.",
)
parser.add_argument(
"-F",
"--reverse-filter",
nargs=2,
type=float,
metavar=("LOW", "HIGH"),
action="append",
dest="reverse_filter",
help="Used for excluding the entries that have a number "
"falling in the given range.",
)
parser.add_argument(
"-e",
"--exclude",
type=float,
action="append",
help="Used to exclude an entry that contains a specific number.",
)
parser.add_argument(
"-r",
"--reverse",
action="store_true",
default=False,
help="Returns in reversed order.",
)
parser.add_argument(
"-t",
"--number-type",
"--number_type",
dest="number_type",
choices=("int", "float", "real", "f", "i", "r"),
default="int",
help='Choose the type of number to search for. "float" will search '
'for floating-point numbers. "int" will only search for '
'integers. "real" is a shortcut for "float" with --sign. '
'"i" is a synonym for "int", "f" is a synonym for '
'"float", and "r" is a synonym for "real".'
"The default is %(default)s.",
)
parser.add_argument(
"--nosign",
default=False,
action="store_false",
dest="signed",
help='Do not consider "+" or "-" as part of a number, i.e. do not '
"take sign into consideration. This is the default.",
)
parser.add_argument(
"-s",
"--sign",
default=False,
action="store_true",
dest="signed",
help='Consider "+" or "-" as part of a number, i.e. '
"take sign into consideration. The default is unsigned.",
)
parser.add_argument(
"--noexp",
default=True,
action="store_false",
dest="exp",
help="Do not consider an exponential as part of a number, i.e. 1e4, "
'would be considered as 1, "e", and 4, not as 10000. This only '
"effects the --number-type=float.",
)
parser.add_argument(
"-l",
"--locale",
action="store_true",
default=False,
help="Causes natsort to use locale-aware sorting. You will get the "
"best results if you install PyICU.",
)
parser.add_argument(
"entries",
nargs="*",
default=sys.stdin,
help="The entries to sort. Taken from stdin if nothing is given on "
"the command line.",
)
args = parser.parse_args(arguments or None, namespace=TypedArgs())
# Make sure the filter range is given properly. Does nothing if no filter
args.filter = check_filters(cast(NumPairIter, args.filter))
args.reverse_filter = check_filters(cast(NumPairIter, args.reverse_filter))
# Remove trailing whitespace from all the entries
entries = [e.strip() for e in args.entries]
# Sort by directory then by file within directory and print.
sort_and_print_entries(entries, args)
def range_check(low: Num, high: Num) -> NumPair:
"""
Verify that that given range has a low lower than the high.
Parameters
----------
low : {float, int}
high : {float, int}
Returns
-------
tuple : low, high
Raises
------
ValueError
Low is greater than or equal to high.
"""
if low >= high:
raise ValueError("low >= high")
else:
return low, high
def check_filters(filters: NumPairIter) -> Optional[List[NumPair]]:
"""
Execute range_check for every element of an iterable.
Parameters
----------
filters : iterable
The collection of filters to check. Each element
must be a two-element tuple of floats or ints.
Returns
-------
The input as-is, or None if it evaluates to False.
Raises
------
ValueError
Low is greater than or equal to high for any element.
"""
if not filters:
return None
try:
return [range_check(f[0], f[1]) for f in filters]
except ValueError as err:
raise ValueError("Error in --filter: " + str(err))
def keep_entry_range(
entry: str,
lows: NumIter,
highs: NumIter,
converter: NumConverter,
regex: Pattern[str],
) -> bool:
"""
Check if an entry falls into a desired range.
Every number in the entry will be extracted using *regex*,
if any are within a given low to high range the entry will
be kept.
Parameters
----------
entry : str
lows : iterable
Collection of low values against which to compare the entry.
highs : iterable
Collection of high values against which to compare the entry.
converter : callable
Function to convert a string to a number.
regex : regex object
Regular expression to locate numbers in a string.
Returns
-------
True if the entry should be kept, False otherwise.
"""
return any(
low <= converter(num) <= high
for num in regex.findall(entry)
for low, high in zip(lows, highs)
)
def keep_entry_value(
entry: str, values: NumIter, converter: NumConverter, regex: Pattern[str]
) -> bool:
"""
Check if an entry does not match a given value.
Every number in the entry will be extracted using *regex*,
if any match a given value the entry will not be kept.
Parameters
----------
entry : str
values : iterable
Collection of values against which to compare the entry.
converter : callable
Function to convert a string to a number.
regex : regex object
Regular expression to locate numbers in a string.
Returns
-------
True if the entry should be kept, False otherwise.
"""
return not any(converter(num) in values for num in regex.findall(entry))
def sort_and_print_entries(entries: List[str], args: TypedArgs) -> None:
"""Sort the entries, applying the filters first if necessary."""
# Extract the proper number type.
is_float = args.number_type in ("float", "real", "f", "r")
signed = args.signed or args.number_type in ("real", "r")
alg: int = (
natsort.ns.FLOAT * is_float
| natsort.ns.SIGNED * signed
| natsort.ns.NOEXP * (not args.exp)
| natsort.ns.PATH * args.paths
| natsort.ns.LOCALE * args.locale
)
# Pre-remove entries that don't pass the filtering criteria
# Make sure we use the same searching algorithm for filtering
# as for sorting.
do_filter = args.filter is not None or args.reverse_filter is not None
if do_filter or args.exclude:
inp_options = (
natsort.ns.FLOAT * is_float
| natsort.ns.SIGNED * signed
| natsort.ns.NOEXP * (not args.exp)
)
regex = regex_chooser(inp_options)
if args.filter is not None:
lows, highs = ([f[0] for f in args.filter], [f[1] for f in args.filter])
entries = [
entry
for entry in entries
if keep_entry_range(entry, lows, highs, float, regex)
]
if args.reverse_filter is not None:
lows, highs = (
[f[0] for f in args.reverse_filter],
[f[1] for f in args.reverse_filter],
)
entries = [
entry
for entry in entries
if not keep_entry_range(entry, lows, highs, float, regex)
]
if args.exclude:
exclude = set(args.exclude)
entries = [
entry
for entry in entries
if keep_entry_value(entry, exclude, float, regex)
]
# Print off the sorted results
for entry in natsort.natsorted(entries, reverse=args.reverse, alg=alg):
print(entry)
if __name__ == "__main__":
try:
main()
except ValueError as a:
sys.exit(str(a))
except KeyboardInterrupt:
sys.exit(1)
|