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
|
# -*- coding: utf-8 -*-
"""\
Here are a collection of examples of how this module can be used.
See the README or the natsort homepage for more details.
"""
import os
import pytest
from natsort import natsort_key, natsort_keygen, natsorted, ns
from natsort.compat.locale import get_strxfrm, null_string_locale
@pytest.fixture
def arbitrary_input():
return ["6A-5.034e+1", "/Folder (1)/Foo", 56.7]
@pytest.fixture
def bytes_input():
return b"6A-5.034e+1"
def test_natsort_keygen_demonstration():
original_list = ["a50", "a51.", "a50.31", "a50.4", "a5.034e1", "a50.300"]
copy_of_list = original_list[:]
original_list.sort(key=natsort_keygen(alg=ns.F))
# natsorted uses the output of natsort_keygen under the hood.
assert original_list == natsorted(copy_of_list, alg=ns.F)
def test_natsort_key_public():
assert natsort_key("a-5.034e2") == ("a-", 5, ".", 34, "e", 2)
def test_natsort_keygen_with_invalid_alg_input_raises_value_error():
# Invalid arguments give the correct response
with pytest.raises(ValueError, match="'alg' argument"):
natsort_keygen(None, "1")
@pytest.mark.parametrize(
"alg, expected",
[(ns.DEFAULT, ("a-", 5, ".", 34, "e", 1)), (ns.FLOAT | ns.SIGNED, ("a", -50.34))],
)
def test_natsort_keygen_returns_natsort_key_that_parses_input(alg, expected):
ns_key = natsort_keygen(alg=alg)
assert ns_key("a-5.034e1") == expected
@pytest.mark.parametrize(
"alg, expected",
[
(
ns.DEFAULT,
(("", 6, "A-", 5, ".", 34, "e+", 1), ("/Folder (", 1, ")/Foo"), ("", 56.7)),
),
(
ns.IGNORECASE,
(("", 6, "a-", 5, ".", 34, "e+", 1), ("/folder (", 1, ")/foo"), ("", 56.7)),
),
(ns.REAL, (("", 6.0, "A", -50.34), ("/Folder (", 1.0, ")/Foo"), ("", 56.7))),
(
ns.LOWERCASEFIRST | ns.FLOAT | ns.NOEXP,
(
("", 6.0, "a-", 5.034, "E+", 1.0),
("/fOLDER (", 1.0, ")/fOO"),
("", 56.7),
),
),
(
ns.PATH | ns.GROUPLETTERS,
(
(("", 6, "aA--", 5, "..", 34, "ee++", 1),),
((2 * os.sep,), ("fFoollddeerr ((", 1, "))"), ("fFoooo",)),
(("", 56.7),),
),
),
],
)
def test_natsort_keygen_handles_arbitrary_input(arbitrary_input, alg, expected):
ns_key = natsort_keygen(alg=alg)
assert ns_key(arbitrary_input) == expected
@pytest.mark.parametrize(
"alg, expected",
[
(ns.DEFAULT, (b"6A-5.034e+1",)),
(ns.IGNORECASE, (b"6a-5.034e+1",)),
(ns.REAL, (b"6A-5.034e+1",)),
(ns.LOWERCASEFIRST | ns.FLOAT | ns.NOEXP, (b"6A-5.034e+1",)),
(ns.PATH | ns.GROUPLETTERS, ((b"6A-5.034e+1",),)),
],
)
def test_natsort_keygen_handles_bytes_input(bytes_input, alg, expected):
ns_key = natsort_keygen(alg=alg)
assert ns_key(bytes_input) == expected
@pytest.mark.parametrize(
"alg, expected, is_dumb",
[
(
ns.LOCALE,
(
(null_string_locale, 6, "A-", 5, ".", 34, "e+", 1),
("/Folder (", 1, ")/Foo"),
(null_string_locale, 56.7),
),
False,
),
(
ns.LOCALE,
(
(null_string_locale, 6, "aa--", 5, "..", 34, "eE++", 1),
("//ffoOlLdDeErR ((", 1, "))//ffoOoO"),
(null_string_locale, 56.7),
),
True,
),
(
ns.LOCALE | ns.CAPITALFIRST,
(
(("",), (null_string_locale, 6, "A-", 5, ".", 34, "e+", 1)),
(("/",), ("/Folder (", 1, ")/Foo")),
(("",), (null_string_locale, 56.7)),
),
False,
),
],
)
@pytest.mark.usefixtures("with_locale_en_us")
def test_natsort_keygen_with_locale(mocker, arbitrary_input, alg, expected, is_dumb):
# First, apply the correct strxfrm function to the string values.
strxfrm = get_strxfrm()
expected = [list(sub) for sub in expected]
try:
for i in (2, 4, 6):
expected[0][i] = strxfrm(expected[0][i])
for i in (0, 2):
expected[1][i] = strxfrm(expected[1][i])
expected = tuple(tuple(sub) for sub in expected)
except IndexError: # ns.LOCALE | ns.CAPITALFIRST
expected = [[list(subsub) for subsub in sub] for sub in expected]
for i in (2, 4, 6):
expected[0][1][i] = strxfrm(expected[0][1][i])
for i in (0, 2):
expected[1][1][i] = strxfrm(expected[1][1][i])
expected = tuple(tuple(tuple(subsub) for subsub in sub) for sub in expected)
mocker.patch("natsort.compat.locale.dumb_sort", return_value=is_dumb)
ns_key = natsort_keygen(alg=alg)
assert ns_key(arbitrary_input) == expected
@pytest.mark.parametrize(
"alg, is_dumb",
[(ns.LOCALE, False), (ns.LOCALE, True), (ns.LOCALE | ns.CAPITALFIRST, False)],
)
@pytest.mark.usefixtures("with_locale_en_us")
def test_natsort_keygen_with_locale_bytes(mocker, bytes_input, alg, is_dumb):
expected = (b"6A-5.034e+1",)
mocker.patch("natsort.compat.locale.dumb_sort", return_value=is_dumb)
ns_key = natsort_keygen(alg=alg)
assert ns_key(bytes_input) == expected
|
