Mark Hammond | 7995eb2 | 2002-10-03 23:14:10 +0000 | [diff] [blame] | 1 | # Test the Unicode versions of normal file functions |
| 2 | # open, os.open, os.stat. os.listdir, os.rename, os.remove, os.mkdir, os.chdir, os.rmdir |
Victor Stinner | 1ab6c2d | 2011-11-15 22:27:41 +0100 | [diff] [blame^] | 3 | import os |
| 4 | import sys |
| 5 | import unittest |
| 6 | import warnings |
Florent Xicluna | eb13618 | 2010-03-21 18:49:50 +0000 | [diff] [blame] | 7 | from unicodedata import normalize |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 8 | from test import support |
Mark Hammond | 7995eb2 | 2002-10-03 23:14:10 +0000 | [diff] [blame] | 9 | |
| 10 | filenames = [ |
Victor Stinner | 7362c4f | 2010-10-28 11:20:31 +0000 | [diff] [blame] | 11 | '1_abc', |
| 12 | '2_ascii', |
| 13 | '3_Gr\xfc\xdf-Gott', |
| 14 | '4_\u0393\u03b5\u03b9\u03ac-\u03c3\u03b1\u03c2', |
| 15 | '5_\u0417\u0434\u0440\u0430\u0432\u0441\u0442\u0432\u0443\u0439\u0442\u0435', |
| 16 | '6_\u306b\u307d\u3093', |
| 17 | '7_\u05d4\u05e9\u05e7\u05e6\u05e5\u05e1', |
| 18 | '8_\u66e8\u66e9\u66eb', |
| 19 | '9_\u66e8\u05e9\u3093\u0434\u0393\xdf', |
Florent Xicluna | eb13618 | 2010-03-21 18:49:50 +0000 | [diff] [blame] | 20 | # Specific code points: fn, NFC(fn) and NFKC(fn) all differents |
Victor Stinner | 7362c4f | 2010-10-28 11:20:31 +0000 | [diff] [blame] | 21 | '10_\u1fee\u1ffd', |
Mark Hammond | 7995eb2 | 2002-10-03 23:14:10 +0000 | [diff] [blame] | 22 | ] |
| 23 | |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 24 | # Mac OS X decomposes Unicode names, using Normal Form D. |
| 25 | # http://developer.apple.com/mac/library/qa/qa2001/qa1173.html |
| 26 | # "However, most volume formats do not follow the exact specification for |
| 27 | # these normal forms. For example, HFS Plus uses a variant of Normal Form D |
| 28 | # in which U+2000 through U+2FFF, U+F900 through U+FAFF, and U+2F800 through |
| 29 | # U+2FAFF are not decomposed." |
| 30 | if sys.platform != 'darwin': |
| 31 | filenames.extend([ |
Victor Stinner | fc6f5a4 | 2010-10-28 22:57:03 +0000 | [diff] [blame] | 32 | # Specific code points: NFC(fn), NFD(fn), NFKC(fn) and NFKD(fn) all differents |
| 33 | '11_\u0385\u03d3\u03d4', |
| 34 | '12_\u00a8\u0301\u03d2\u0301\u03d2\u0308', # == NFD('\u0385\u03d3\u03d4') |
| 35 | '13_\u0020\u0308\u0301\u038e\u03ab', # == NFKC('\u0385\u03d3\u03d4') |
| 36 | '14_\u1e9b\u1fc1\u1fcd\u1fce\u1fcf\u1fdd\u1fde\u1fdf\u1fed', |
| 37 | |
Florent Xicluna | fd1b093 | 2010-03-28 00:25:02 +0000 | [diff] [blame] | 38 | # Specific code points: fn, NFC(fn) and NFKC(fn) all differents |
Victor Stinner | 7362c4f | 2010-10-28 11:20:31 +0000 | [diff] [blame] | 39 | '15_\u1fee\u1ffd\ufad1', |
| 40 | '16_\u2000\u2000\u2000A', |
| 41 | '17_\u2001\u2001\u2001A', |
| 42 | '18_\u2003\u2003\u2003A', # == NFC('\u2001\u2001\u2001A') |
| 43 | '19_\u0020\u0020\u0020A', # '\u0020' == ' ' == NFKC('\u2000') == |
Florent Xicluna | 65eb453 | 2011-11-03 23:11:14 +0100 | [diff] [blame] | 44 | # NFKC('\u2001') == NFKC('\u2003') |
| 45 | ]) |
Florent Xicluna | eb13618 | 2010-03-21 18:49:50 +0000 | [diff] [blame] | 46 | |
Florent Xicluna | 87082ee | 2010-08-09 17:18:05 +0000 | [diff] [blame] | 47 | |
| 48 | # Is it Unicode-friendly? |
| 49 | if not os.path.supports_unicode_filenames: |
Victor Stinner | 94908bb | 2010-08-18 21:23:25 +0000 | [diff] [blame] | 50 | fsencoding = sys.getfilesystemencoding() |
Florent Xicluna | 87082ee | 2010-08-09 17:18:05 +0000 | [diff] [blame] | 51 | try: |
| 52 | for name in filenames: |
| 53 | name.encode(fsencoding) |
| 54 | except UnicodeEncodeError: |
| 55 | raise unittest.SkipTest("only NT+ and systems with " |
| 56 | "Unicode-friendly filesystem encoding") |
| 57 | |
| 58 | |
Tim Peters | 1ee401f | 2002-10-05 17:54:56 +0000 | [diff] [blame] | 59 | # Destroy directory dirname and all files under it, to one level. |
| 60 | def deltree(dirname): |
| 61 | # Don't hide legitimate errors: if one of these suckers exists, it's |
| 62 | # an error if we can't remove it. |
| 63 | if os.path.exists(dirname): |
Mark Hammond | 8696ebc | 2002-10-08 02:44:31 +0000 | [diff] [blame] | 64 | # must pass unicode to os.listdir() so we get back unicode results. |
Guido van Rossum | ef87d6e | 2007-05-02 19:09:54 +0000 | [diff] [blame] | 65 | for fname in os.listdir(str(dirname)): |
Tim Peters | 1ee401f | 2002-10-05 17:54:56 +0000 | [diff] [blame] | 66 | os.unlink(os.path.join(dirname, fname)) |
| 67 | os.rmdir(dirname) |
| 68 | |
Florent Xicluna | eb13618 | 2010-03-21 18:49:50 +0000 | [diff] [blame] | 69 | |
Mark Hammond | 7995eb2 | 2002-10-03 23:14:10 +0000 | [diff] [blame] | 70 | class UnicodeFileTests(unittest.TestCase): |
Florent Xicluna | eb13618 | 2010-03-21 18:49:50 +0000 | [diff] [blame] | 71 | files = set(filenames) |
| 72 | normal_form = None |
Tim Peters | 1ee401f | 2002-10-05 17:54:56 +0000 | [diff] [blame] | 73 | |
Mark Hammond | 7995eb2 | 2002-10-03 23:14:10 +0000 | [diff] [blame] | 74 | def setUp(self): |
Mark Hammond | 7995eb2 | 2002-10-03 23:14:10 +0000 | [diff] [blame] | 75 | try: |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 76 | os.mkdir(support.TESTFN) |
Florent Xicluna | 65eb453 | 2011-11-03 23:11:14 +0100 | [diff] [blame] | 77 | except FileExistsError: |
Mark Hammond | 7995eb2 | 2002-10-03 23:14:10 +0000 | [diff] [blame] | 78 | pass |
Florent Xicluna | eb13618 | 2010-03-21 18:49:50 +0000 | [diff] [blame] | 79 | files = set() |
Mark Hammond | 7995eb2 | 2002-10-03 23:14:10 +0000 | [diff] [blame] | 80 | for name in self.files: |
Florent Xicluna | eb13618 | 2010-03-21 18:49:50 +0000 | [diff] [blame] | 81 | name = os.path.join(support.TESTFN, self.norm(name)) |
Florent Xicluna | 87082ee | 2010-08-09 17:18:05 +0000 | [diff] [blame] | 82 | with open(name, 'wb') as f: |
| 83 | f.write((name+'\n').encode("utf-8")) |
Mark Hammond | 7995eb2 | 2002-10-03 23:14:10 +0000 | [diff] [blame] | 84 | os.stat(name) |
Florent Xicluna | eb13618 | 2010-03-21 18:49:50 +0000 | [diff] [blame] | 85 | files.add(name) |
| 86 | self.files = files |
Mark Hammond | 7995eb2 | 2002-10-03 23:14:10 +0000 | [diff] [blame] | 87 | |
| 88 | def tearDown(self): |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 89 | deltree(support.TESTFN) |
Mark Hammond | 7995eb2 | 2002-10-03 23:14:10 +0000 | [diff] [blame] | 90 | |
Florent Xicluna | eb13618 | 2010-03-21 18:49:50 +0000 | [diff] [blame] | 91 | def norm(self, s): |
| 92 | if self.normal_form: |
| 93 | return normalize(self.normal_form, s) |
| 94 | return s |
| 95 | |
Florent Xicluna | 65eb453 | 2011-11-03 23:11:14 +0100 | [diff] [blame] | 96 | def _apply_failure(self, fn, filename, |
| 97 | expected_exception=FileNotFoundError, |
| 98 | check_filename=True): |
Florent Xicluna | eb13618 | 2010-03-21 18:49:50 +0000 | [diff] [blame] | 99 | with self.assertRaises(expected_exception) as c: |
Mark Hammond | 7995eb2 | 2002-10-03 23:14:10 +0000 | [diff] [blame] | 100 | fn(filename) |
Florent Xicluna | eb13618 | 2010-03-21 18:49:50 +0000 | [diff] [blame] | 101 | exc_filename = c.exception.filename |
Florent Xicluna | e0912db | 2011-11-07 21:56:17 +0100 | [diff] [blame] | 102 | # listdir may append a wildcard to the filename |
| 103 | if fn is os.listdir and sys.platform == 'win32': |
| 104 | exc_filename, _, wildcard = exc_filename.rpartition(os.sep) |
Florent Xicluna | be90840 | 2011-11-07 23:24:08 +0100 | [diff] [blame] | 105 | self.assertEqual(wildcard, '*.*') |
Florent Xicluna | 65eb453 | 2011-11-03 23:11:14 +0100 | [diff] [blame] | 106 | if check_filename: |
Victor Stinner | 74ad754 | 2010-10-28 11:09:09 +0000 | [diff] [blame] | 107 | self.assertEqual(exc_filename, filename, "Function '%s(%a) failed " |
Victor Stinner | 7dae81b | 2010-10-28 11:11:24 +0000 | [diff] [blame] | 108 | "with bad filename in the exception: %a" % |
Florent Xicluna | eb13618 | 2010-03-21 18:49:50 +0000 | [diff] [blame] | 109 | (fn.__name__, filename, exc_filename)) |
Mark Hammond | 7995eb2 | 2002-10-03 23:14:10 +0000 | [diff] [blame] | 110 | |
| 111 | def test_failures(self): |
| 112 | # Pass non-existing Unicode filenames all over the place. |
| 113 | for name in self.files: |
| 114 | name = "not_" + name |
Florent Xicluna | 65eb453 | 2011-11-03 23:11:14 +0100 | [diff] [blame] | 115 | self._apply_failure(open, name) |
| 116 | self._apply_failure(os.stat, name) |
| 117 | self._apply_failure(os.chdir, name) |
| 118 | self._apply_failure(os.rmdir, name) |
| 119 | self._apply_failure(os.remove, name) |
Florent Xicluna | e0912db | 2011-11-07 21:56:17 +0100 | [diff] [blame] | 120 | self._apply_failure(os.listdir, name) |
| 121 | |
| 122 | if sys.platform == 'win32': |
Florent Xicluna | be90840 | 2011-11-07 23:24:08 +0100 | [diff] [blame] | 123 | # Windows is lunatic. Issue #13366. |
| 124 | _listdir_failure = NotADirectoryError, FileNotFoundError |
Florent Xicluna | e0912db | 2011-11-07 21:56:17 +0100 | [diff] [blame] | 125 | else: |
| 126 | _listdir_failure = NotADirectoryError |
Mark Hammond | 7995eb2 | 2002-10-03 23:14:10 +0000 | [diff] [blame] | 127 | |
| 128 | def test_open(self): |
| 129 | for name in self.files: |
Guido van Rossum | c12a813 | 2007-10-26 04:29:23 +0000 | [diff] [blame] | 130 | f = open(name, 'wb') |
Mark Hammond | 7995eb2 | 2002-10-03 23:14:10 +0000 | [diff] [blame] | 131 | f.write((name+'\n').encode("utf-8")) |
| 132 | f.close() |
| 133 | os.stat(name) |
Florent Xicluna | e0912db | 2011-11-07 21:56:17 +0100 | [diff] [blame] | 134 | self._apply_failure(os.listdir, name, self._listdir_failure) |
Mark Hammond | 7995eb2 | 2002-10-03 23:14:10 +0000 | [diff] [blame] | 135 | |
Victor Stinner | bfd7b26 | 2010-10-28 23:14:45 +0000 | [diff] [blame] | 136 | # Skip the test on darwin, because darwin does normalize the filename to |
| 137 | # NFD (a variant of Unicode NFD form). Normalize the filename to NFC, NFKC, |
| 138 | # NFKD in Python is useless, because darwin will normalize it later and so |
| 139 | # open(), os.stat(), etc. don't raise any exception. |
Florent Xicluna | 65eb453 | 2011-11-03 23:11:14 +0100 | [diff] [blame] | 140 | @unittest.skipIf(sys.platform == 'darwin', 'irrelevant test on Mac OS X') |
Florent Xicluna | eb13618 | 2010-03-21 18:49:50 +0000 | [diff] [blame] | 141 | def test_normalize(self): |
| 142 | files = set(self.files) |
| 143 | others = set() |
| 144 | for nf in set(['NFC', 'NFD', 'NFKC', 'NFKD']): |
| 145 | others |= set(normalize(nf, file) for file in files) |
| 146 | others -= files |
Florent Xicluna | eb13618 | 2010-03-21 18:49:50 +0000 | [diff] [blame] | 147 | for name in others: |
Florent Xicluna | 65eb453 | 2011-11-03 23:11:14 +0100 | [diff] [blame] | 148 | self._apply_failure(open, name) |
| 149 | self._apply_failure(os.stat, name) |
| 150 | self._apply_failure(os.chdir, name) |
| 151 | self._apply_failure(os.rmdir, name) |
| 152 | self._apply_failure(os.remove, name) |
Florent Xicluna | e0912db | 2011-11-07 21:56:17 +0100 | [diff] [blame] | 153 | self._apply_failure(os.listdir, name) |
Florent Xicluna | eb13618 | 2010-03-21 18:49:50 +0000 | [diff] [blame] | 154 | |
Victor Stinner | bfd7b26 | 2010-10-28 23:14:45 +0000 | [diff] [blame] | 155 | # Skip the test on darwin, because darwin uses a normalization different |
| 156 | # than Python NFD normalization: filenames are different even if we use |
| 157 | # Python NFD normalization. |
Florent Xicluna | 65eb453 | 2011-11-03 23:11:14 +0100 | [diff] [blame] | 158 | @unittest.skipIf(sys.platform == 'darwin', 'irrelevant test on Mac OS X') |
Mark Hammond | 7995eb2 | 2002-10-03 23:14:10 +0000 | [diff] [blame] | 159 | def test_listdir(self): |
Florent Xicluna | eb13618 | 2010-03-21 18:49:50 +0000 | [diff] [blame] | 160 | sf0 = set(self.files) |
Victor Stinner | 1ab6c2d | 2011-11-15 22:27:41 +0100 | [diff] [blame^] | 161 | with warnings.catch_warnings(): |
| 162 | warnings.simplefilter("ignore", DeprecationWarning) |
| 163 | f1 = os.listdir(support.TESTFN.encode(sys.getfilesystemencoding())) |
Florent Xicluna | eb13618 | 2010-03-21 18:49:50 +0000 | [diff] [blame] | 164 | f2 = os.listdir(support.TESTFN) |
Florent Xicluna | eb13618 | 2010-03-21 18:49:50 +0000 | [diff] [blame] | 165 | sf2 = set(os.path.join(support.TESTFN, f) for f in f2) |
Victor Stinner | 2ebe697 | 2010-10-24 21:05:03 +0000 | [diff] [blame] | 166 | self.assertEqual(sf0, sf2, "%a != %a" % (sf0, sf2)) |
Florent Xicluna | eb13618 | 2010-03-21 18:49:50 +0000 | [diff] [blame] | 167 | self.assertEqual(len(f1), len(f2)) |
Mark Hammond | 7995eb2 | 2002-10-03 23:14:10 +0000 | [diff] [blame] | 168 | |
| 169 | def test_rename(self): |
| 170 | for name in self.files: |
Florent Xicluna | eb13618 | 2010-03-21 18:49:50 +0000 | [diff] [blame] | 171 | os.rename(name, "tmp") |
| 172 | os.rename("tmp", name) |
Mark Hammond | 7995eb2 | 2002-10-03 23:14:10 +0000 | [diff] [blame] | 173 | |
| 174 | def test_directory(self): |
Florent Xicluna | eb13618 | 2010-03-21 18:49:50 +0000 | [diff] [blame] | 175 | dirname = os.path.join(support.TESTFN, 'Gr\xfc\xdf-\u66e8\u66e9\u66eb') |
Guido van Rossum | ef87d6e | 2007-05-02 19:09:54 +0000 | [diff] [blame] | 176 | filename = '\xdf-\u66e8\u66e9\u66eb' |
Mark Hammond | 7995eb2 | 2002-10-03 23:14:10 +0000 | [diff] [blame] | 177 | oldwd = os.getcwd() |
| 178 | os.mkdir(dirname) |
| 179 | os.chdir(dirname) |
Florent Xicluna | eb13618 | 2010-03-21 18:49:50 +0000 | [diff] [blame] | 180 | try: |
| 181 | with open(filename, 'wb') as f: |
| 182 | f.write((filename + '\n').encode("utf-8")) |
| 183 | os.access(filename,os.R_OK) |
| 184 | os.remove(filename) |
| 185 | finally: |
| 186 | os.chdir(oldwd) |
| 187 | os.rmdir(dirname) |
| 188 | |
| 189 | |
| 190 | class UnicodeNFCFileTests(UnicodeFileTests): |
| 191 | normal_form = 'NFC' |
| 192 | |
| 193 | |
| 194 | class UnicodeNFDFileTests(UnicodeFileTests): |
| 195 | normal_form = 'NFD' |
| 196 | |
| 197 | |
| 198 | class UnicodeNFKCFileTests(UnicodeFileTests): |
| 199 | normal_form = 'NFKC' |
| 200 | |
| 201 | |
| 202 | class UnicodeNFKDFileTests(UnicodeFileTests): |
| 203 | normal_form = 'NFKD' |
| 204 | |
Mark Hammond | 7995eb2 | 2002-10-03 23:14:10 +0000 | [diff] [blame] | 205 | |
| 206 | def test_main(): |
Tim Peters | 1ee401f | 2002-10-05 17:54:56 +0000 | [diff] [blame] | 207 | try: |
Florent Xicluna | eb13618 | 2010-03-21 18:49:50 +0000 | [diff] [blame] | 208 | support.run_unittest( |
| 209 | UnicodeFileTests, |
| 210 | UnicodeNFCFileTests, |
| 211 | UnicodeNFDFileTests, |
| 212 | UnicodeNFKCFileTests, |
| 213 | UnicodeNFKDFileTests, |
| 214 | ) |
Tim Peters | 1ee401f | 2002-10-05 17:54:56 +0000 | [diff] [blame] | 215 | finally: |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 216 | deltree(support.TESTFN) |
Mark Hammond | 7995eb2 | 2002-10-03 23:14:10 +0000 | [diff] [blame] | 217 | |
Florent Xicluna | eb13618 | 2010-03-21 18:49:50 +0000 | [diff] [blame] | 218 | |
Mark Hammond | 7995eb2 | 2002-10-03 23:14:10 +0000 | [diff] [blame] | 219 | if __name__ == "__main__": |
| 220 | test_main() |