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 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017
|
# -*- coding: utf-8 -*-
#
# Copyright (C) 2019 Radim Rehurek <me@radimrehurek.com>
#
# This code is distributed under the terms and conditions
# from the MIT License (MIT).
#
import bz2
import csv
import contextlib
import functools
import io
import gzip
import hashlib
import logging
import os
from smart_open.compression import INFER_FROM_EXTENSION, NO_COMPRESSION
import tempfile
import unittest
from unittest import mock
import warnings
import boto3
import pytest
import responses
# See https://github.com/piskvorky/smart_open/issues/800
# This supports moto 4 & 5 until v4 is no longer used by distros.
try:
from moto import mock_s3
except ImportError:
from moto import mock_aws as mock_s3
import smart_open
from smart_open import smart_open_lib
from smart_open import webhdfs
from smart_open.smart_open_lib import patch_pathlib, _patch_pathlib
from .test_s3 import patch_invalid_range_response
logger = logging.getLogger(__name__)
CURR_DIR = os.path.abspath(os.path.dirname(__file__))
SAMPLE_TEXT = 'Hello, world!'
SAMPLE_BYTES = SAMPLE_TEXT.encode('utf-8')
_resource = functools.partial(boto3.resource, region_name='us-east-1')
#
# For Windows platforms, under which tempfile.NamedTemporaryFile has some
# unwanted quirks.
#
# https://docs.python.org/3.14/library/tempfile.html#tempfile.NamedTemporaryFile
# https://stackoverflow.com/a/58955530
#
@contextlib.contextmanager
def named_temporary_file(mode='w+b', prefix=None, suffix=None, delete=True):
filename = io.StringIO()
if prefix:
filename.write(prefix)
filename.write(os.urandom(8).hex())
if suffix:
filename.write(suffix)
pathname = os.path.join(tempfile.gettempdir(), filename.getvalue())
with open(pathname, mode) as f:
yield f
if delete:
try:
os.unlink(pathname)
except PermissionError as e:
#
# This can happen on Windows for unknown reasons.
#
logger.error(e)
def test_compression_extensions():
for extension in smart_open.compression.get_supported_extensions():
with named_temporary_file(suffix=extension) as tmp:
with smart_open.open(tmp.name, "wt") as fout:
print("hello world", file=fout)
print("this is a test", file=fout)
with smart_open.open(tmp.name, "rt") as fin:
got = list(fin)
assert got == ["hello world\n", "this is a test\n"], f"Error for {extension=}, mode='wt'"
with named_temporary_file(suffix=extension) as tmp:
with smart_open.open(tmp.name, "w") as fout:
fout.write("hello world\n")
fout.write("this is a test\n")
with smart_open.open(tmp.name, "r") as fin:
got = list(fin)
assert got == ["hello world\n", "this is a test\n"], f"Error for {extension=}, mode='w'"
with named_temporary_file(suffix=extension) as tmp:
with smart_open.open(tmp.name, "wb") as fout:
fout.write(b"hello world\n")
fout.write(b"this is a test\n")
with smart_open.open(tmp.name, "rb") as fin:
got = list(fin)
assert got == [b"hello world\n", b"this is a test\n"], f"Error for {extension=}, mode='wb'"
class ParseUriTest(unittest.TestCase):
"""
Test ParseUri class.
"""
def test_scheme(self):
"""Do URIs schemes parse correctly?"""
# supported schemes
for scheme in ("s3", "s3a", "s3n", "hdfs", "file", "http", "https", "gs", "azure"):
parsed_uri = smart_open_lib._parse_uri(scheme + "://mybucket/mykey")
self.assertEqual(parsed_uri.scheme, scheme)
# unsupported scheme => NotImplementedError
self.assertRaises(NotImplementedError, smart_open_lib._parse_uri, "foobar://mybucket/mykey")
# unknown scheme => default_scheme
parsed_uri = smart_open_lib._parse_uri("blah blah")
self.assertEqual(parsed_uri.scheme, "file")
def test_s3_uri(self):
"""Do S3 URIs parse correctly?"""
# correct uri without credentials
parsed_uri = smart_open_lib._parse_uri("s3://mybucket/mykey")
self.assertEqual(parsed_uri.scheme, "s3")
self.assertEqual(parsed_uri.bucket_id, "mybucket")
self.assertEqual(parsed_uri.key_id, "mykey")
self.assertEqual(parsed_uri.access_id, None)
self.assertEqual(parsed_uri.access_secret, None)
def test_s3_uri_contains_slash(self):
parsed_uri = smart_open_lib._parse_uri("s3://mybucket/mydir/mykey")
self.assertEqual(parsed_uri.scheme, "s3")
self.assertEqual(parsed_uri.bucket_id, "mybucket")
self.assertEqual(parsed_uri.key_id, "mydir/mykey")
self.assertEqual(parsed_uri.access_id, None)
self.assertEqual(parsed_uri.access_secret, None)
def test_s3_uri_with_credentials(self):
parsed_uri = smart_open_lib._parse_uri("s3://ACCESSID456:acces/sse_cr-et@mybucket/mykey")
self.assertEqual(parsed_uri.scheme, "s3")
self.assertEqual(parsed_uri.bucket_id, "mybucket")
self.assertEqual(parsed_uri.key_id, "mykey")
self.assertEqual(parsed_uri.access_id, "ACCESSID456")
self.assertEqual(parsed_uri.access_secret, "acces/sse_cr-et")
def test_s3_uri_with_credentials2(self):
parsed_uri = smart_open_lib._parse_uri("s3://accessid:access/secret@mybucket/mykey")
self.assertEqual(parsed_uri.scheme, "s3")
self.assertEqual(parsed_uri.bucket_id, "mybucket")
self.assertEqual(parsed_uri.key_id, "mykey")
self.assertEqual(parsed_uri.access_id, "accessid")
self.assertEqual(parsed_uri.access_secret, "access/secret")
def test_s3_uri_has_atmark_in_key_name(self):
parsed_uri = smart_open_lib._parse_uri("s3://accessid:access/secret@mybucket/my@ke@y")
self.assertEqual(parsed_uri.scheme, "s3")
self.assertEqual(parsed_uri.bucket_id, "mybucket")
self.assertEqual(parsed_uri.key_id, "my@ke@y")
self.assertEqual(parsed_uri.access_id, "accessid")
self.assertEqual(parsed_uri.access_secret, "access/secret")
#
# Nb. should never happen in theory, but if it does, we should avoid crashing
#
def test_s3_uri_has_colon_in_secret(self):
parsed_uri = smart_open_lib._parse_uri("s3://accessid:access/secret:totally@mybucket/my@ke@y")
self.assertEqual(parsed_uri.scheme, "s3")
self.assertEqual(parsed_uri.bucket_id, "mybucket")
self.assertEqual(parsed_uri.key_id, "my@ke@y")
self.assertEqual(parsed_uri.access_id, "accessid")
self.assertEqual(parsed_uri.access_secret, "access/secret:totally")
def test_s3_uri_has_atmark_in_key_name2(self):
parsed_uri = smart_open_lib._parse_uri(
"s3://accessid:access/secret@hostname:1234@mybucket/dir/my@ke@y"
)
self.assertEqual(parsed_uri.scheme, "s3")
self.assertEqual(parsed_uri.bucket_id, "mybucket")
self.assertEqual(parsed_uri.key_id, "dir/my@ke@y")
self.assertEqual(parsed_uri.access_id, "accessid")
self.assertEqual(parsed_uri.access_secret, "access/secret")
self.assertEqual(parsed_uri.host, "hostname")
self.assertEqual(parsed_uri.port, 1234)
def test_s3_uri_has_atmark_in_key_name3(self):
parsed_uri = smart_open_lib._parse_uri("s3://accessid:access/secret@hostname@mybucket/dir/my@ke@y")
self.assertEqual(parsed_uri.scheme, "s3")
self.assertEqual(parsed_uri.bucket_id, "mybucket")
self.assertEqual(parsed_uri.key_id, "dir/my@ke@y")
self.assertEqual(parsed_uri.access_id, "accessid")
self.assertEqual(parsed_uri.access_secret, "access/secret")
self.assertEqual(parsed_uri.host, "hostname")
self.assertEqual(parsed_uri.port, 443)
def test_s3_handles_fragments(self):
uri_str = 's3://bucket-name/folder/picture #1.jpg'
parsed_uri = smart_open_lib._parse_uri(uri_str)
self.assertEqual(parsed_uri.key_id, "folder/picture #1.jpg")
def test_s3_handles_querystring(self):
uri_str = 's3://bucket-name/folder/picture1.jpg?bar'
parsed_uri = smart_open_lib._parse_uri(uri_str)
self.assertEqual(parsed_uri.key_id, "folder/picture1.jpg?bar")
def test_s3_invalid_url_atmark_in_bucket_name(self):
self.assertRaises(
ValueError, smart_open_lib._parse_uri,
"s3://access_id:access_secret@my@bucket@port/mykey",
)
def test_s3_invalid_uri_missing_colon(self):
self.assertRaises(
ValueError, smart_open_lib._parse_uri,
"s3://access_id@access_secret@mybucket@port/mykey",
)
def test_webhdfs_uri_to_http(self):
parsed_uri = smart_open_lib._parse_uri("webhdfs://host:14000/path/file")
actual = webhdfs.convert_to_http_uri(parsed_uri)
expected = "http://host:14000/webhdfs/v1/path/file"
self.assertEqual(actual, expected)
def test_webhdfs_uri_to_http_with_query(self):
parsed_uri = smart_open_lib._parse_uri("webhdfs://host:14000/path/file?a=1")
actual = webhdfs.convert_to_http_uri(parsed_uri)
expected = "http://host:14000/webhdfs/v1/path/file?a=1"
self.assertEqual(actual, expected)
def test_webhdfs_uri_to_http_with_user(self):
parsed_uri = smart_open_lib._parse_uri("webhdfs://user@host:14000/path")
actual = webhdfs.convert_to_http_uri(parsed_uri)
expected = "http://host:14000/webhdfs/v1/path?user.name=user"
self.assertEqual(actual, expected)
def test_webhdfs_uri_to_http_with_user_and_query(self):
parsed_uri = smart_open_lib._parse_uri("webhdfs://user@host:14000/path?a=1")
actual = webhdfs.convert_to_http_uri(parsed_uri)
expected = "http://host:14000/webhdfs/v1/path?a=1&user.name=user"
self.assertEqual(actual, expected)
def test_uri_from_issue_223_works(self):
uri = "s3://:@omax-mis/twilio-messages-media/final/MEcd7c36e75f87dc6dd9e33702cdcd8fb6"
parsed_uri = smart_open_lib._parse_uri(uri)
self.assertEqual(parsed_uri.scheme, "s3")
self.assertEqual(parsed_uri.bucket_id, "omax-mis")
self.assertEqual(parsed_uri.key_id, "twilio-messages-media/final/MEcd7c36e75f87dc6dd9e33702cdcd8fb6")
self.assertEqual(parsed_uri.access_id, "")
self.assertEqual(parsed_uri.access_secret, "")
def test_s3_uri_with_colon_in_key_name(self):
""" Correctly parse the s3 url if there is a colon in the key or dir """
parsed_uri = smart_open_lib._parse_uri("s3://mybucket/mydir/my:key")
self.assertEqual(parsed_uri.scheme, "s3")
self.assertEqual(parsed_uri.bucket_id, "mybucket")
self.assertEqual(parsed_uri.key_id, "mydir/my:key")
self.assertEqual(parsed_uri.access_id, None)
self.assertEqual(parsed_uri.access_secret, None)
def test_s3_uri_with_at_symbol_in_key_name0(self):
""" Correctly parse the s3 url if there is an @ symbol (and colon) in the key or dir """
parsed_uri = smart_open_lib._parse_uri("s3://mybucket/mydir:my@key")
self.assertEqual(parsed_uri.scheme, "s3")
self.assertEqual(parsed_uri.bucket_id, "mybucket")
self.assertEqual(parsed_uri.key_id, "mydir:my@key")
self.assertEqual(parsed_uri.access_id, None)
self.assertEqual(parsed_uri.access_secret, None)
def test_s3_uri_with_at_symbol_in_key_name1(self):
""" Correctly parse the s3 url if there is an @ symbol (and colon) in the key or dir """
parsed_uri = smart_open_lib._parse_uri("s3://mybucket/my:dir@my/key")
self.assertEqual(parsed_uri.scheme, "s3")
self.assertEqual(parsed_uri.bucket_id, "mybucket")
self.assertEqual(parsed_uri.key_id, "my:dir@my/key")
self.assertEqual(parsed_uri.access_id, None)
self.assertEqual(parsed_uri.access_secret, None)
def test_s3_uri_contains_question_mark(self):
parsed_uri = smart_open_lib._parse_uri("s3://mybucket/mydir/mykey?param")
self.assertEqual(parsed_uri.scheme, "s3")
self.assertEqual(parsed_uri.bucket_id, "mybucket")
self.assertEqual(parsed_uri.key_id, "mydir/mykey?param")
def test_host_and_port(self):
as_string = 's3u://user:secret@host:1234@mybucket/mykey.txt'
uri = smart_open_lib._parse_uri(as_string)
self.assertEqual(uri.scheme, "s3u")
self.assertEqual(uri.bucket_id, "mybucket")
self.assertEqual(uri.key_id, "mykey.txt")
self.assertEqual(uri.access_id, "user")
self.assertEqual(uri.access_secret, "secret")
self.assertEqual(uri.host, "host")
self.assertEqual(uri.port, 1234)
def test_invalid_port(self):
as_string = 's3u://user:secret@host:port@mybucket/mykey.txt'
self.assertRaises(ValueError, smart_open_lib._parse_uri, as_string)
def test_invalid_port2(self):
as_string = 's3u://user:secret@host:port:foo@mybucket/mykey.txt'
self.assertRaises(ValueError, smart_open_lib._parse_uri, as_string)
def test_leading_slash_local_file(self):
path = "/home/misha/hello.txt"
uri = smart_open_lib._parse_uri(path)
self.assertEqual(uri.scheme, "file")
self.assertEqual(uri.uri_path, path)
uri = smart_open_lib._parse_uri('//' + path)
self.assertEqual(uri.scheme, "file")
self.assertEqual(uri.uri_path, '//' + path)
def test_ssh(self):
as_string = 'ssh://user@host:1234/path/to/file'
uri = smart_open_lib._parse_uri(as_string)
self.assertEqual(uri.scheme, 'ssh')
self.assertEqual(uri.uri_path, '/path/to/file')
self.assertEqual(uri.user, 'user')
self.assertEqual(uri.host, 'host')
self.assertEqual(uri.port, 1234)
self.assertEqual(uri.password, None)
def test_ssh_with_pass(self):
as_string = 'ssh://user:pass@host:1234/path/to/file'
uri = smart_open_lib._parse_uri(as_string)
self.assertEqual(uri.scheme, 'ssh')
self.assertEqual(uri.uri_path, '/path/to/file')
self.assertEqual(uri.user, 'user')
self.assertEqual(uri.host, 'host')
self.assertEqual(uri.port, 1234)
self.assertEqual(uri.password, 'pass')
def test_scp(self):
as_string = 'scp://user@host:/path/to/file'
uri = smart_open_lib._parse_uri(as_string)
self.assertEqual(uri.scheme, 'scp')
self.assertEqual(uri.uri_path, '/path/to/file')
self.assertEqual(uri.user, 'user')
self.assertEqual(uri.host, 'host')
self.assertEqual(uri.port, None)
self.assertEqual(uri.password, None)
def test_scp_with_pass(self):
as_string = 'scp://user:pass@host:/path/to/file'
uri = smart_open_lib._parse_uri(as_string)
self.assertEqual(uri.scheme, 'scp')
self.assertEqual(uri.uri_path, '/path/to/file')
self.assertEqual(uri.user, 'user')
self.assertEqual(uri.host, 'host')
self.assertEqual(uri.port, None)
self.assertEqual(uri.password, 'pass')
def test_sftp(self):
as_string = 'sftp://host/path/to/file'
uri = smart_open_lib._parse_uri(as_string)
self.assertEqual(uri.scheme, 'sftp')
self.assertEqual(uri.uri_path, '/path/to/file')
self.assertEqual(uri.user, None)
self.assertEqual(uri.host, 'host')
self.assertEqual(uri.port, None)
self.assertEqual(uri.password, None)
def test_sftp_with_user_and_pass(self):
as_string = 'sftp://user:pass@host:2222/path/to/file'
uri = smart_open_lib._parse_uri(as_string)
self.assertEqual(uri.scheme, 'sftp')
self.assertEqual(uri.uri_path, '/path/to/file')
self.assertEqual(uri.user, 'user')
self.assertEqual(uri.host, 'host')
self.assertEqual(uri.port, 2222)
self.assertEqual(uri.password, 'pass')
def test_ssh_complex_password_with_colon(self):
as_string = 'sftp://user:some:complex@password$$@host:2222/path/to/file'
uri = smart_open_lib._parse_uri(as_string)
self.assertEqual(uri.password, 'some:complex@password$$')
def test_gs_uri(self):
"""Do GCS URIs parse correctly?"""
# correct uri without credentials
parsed_uri = smart_open_lib._parse_uri("gs://mybucket/myblob")
self.assertEqual(parsed_uri.scheme, "gs")
self.assertEqual(parsed_uri.bucket_id, "mybucket")
self.assertEqual(parsed_uri.blob_id, "myblob")
def test_gs_uri_contains_slash(self):
parsed_uri = smart_open_lib._parse_uri("gs://mybucket/mydir/myblob")
self.assertEqual(parsed_uri.scheme, "gs")
self.assertEqual(parsed_uri.bucket_id, "mybucket")
self.assertEqual(parsed_uri.blob_id, "mydir/myblob")
def test_gs_uri_contains_question_mark(self):
parsed_uri = smart_open_lib._parse_uri("gs://mybucket/mydir/myblob?param")
self.assertEqual(parsed_uri.scheme, "gs")
self.assertEqual(parsed_uri.bucket_id, "mybucket")
self.assertEqual(parsed_uri.blob_id, "mydir/myblob?param")
def test_azure_blob_uri(self):
"""Do Azure Blob URIs parse correctly?"""
# correct uri without credentials
parsed_uri = smart_open_lib._parse_uri("azure://mycontainer/myblob")
self.assertEqual(parsed_uri.scheme, "azure")
self.assertEqual(parsed_uri.container_id, "mycontainer")
self.assertEqual(parsed_uri.blob_id, "myblob")
def test_azure_blob_uri_root_container(self):
parsed_uri = smart_open_lib._parse_uri("azure://myblob")
self.assertEqual(parsed_uri.scheme, "azure")
self.assertEqual(parsed_uri.container_id, "$root")
self.assertEqual(parsed_uri.blob_id, "myblob")
def test_azure_blob_uri_contains_slash(self):
parsed_uri = smart_open_lib._parse_uri("azure://mycontainer/mydir/myblob")
self.assertEqual(parsed_uri.scheme, "azure")
self.assertEqual(parsed_uri.container_id, "mycontainer")
self.assertEqual(parsed_uri.blob_id, "mydir/myblob")
def test_pathlib_monkeypatch(self):
from smart_open.smart_open_lib import pathlib
assert pathlib.Path.open != smart_open.open
with patch_pathlib():
assert pathlib.Path.open == smart_open.open
assert pathlib.Path.open != smart_open.open
obj = patch_pathlib()
assert pathlib.Path.open == smart_open.open
_patch_pathlib(obj.old_impl)
assert pathlib.Path.open != smart_open.open
def test_pathlib_monkeypatch_read_gz(self):
from smart_open.smart_open_lib import pathlib
path = pathlib.Path(CURR_DIR) / 'test_data' / 'crime-and-punishment.txt.gz'
# Check that standard implementation can't work with gzip
with path.open("r") as infile:
with self.assertRaises(Exception):
lines = infile.readlines()
# Check that our implementation works with gzip
obj = patch_pathlib()
try:
with path.open("r", encoding='utf-8') as infile:
lines = infile.readlines()
self.assertEqual(len(lines), 3)
finally:
_patch_pathlib(obj.old_impl)
class SmartOpenHttpTest(unittest.TestCase):
"""
Test reading from HTTP connections in various ways.
"""
@mock.patch('smart_open.ssh.open', return_value=open(__file__))
def test_read_ssh(self, mock_open):
"""Is SSH line iterator called correctly?"""
obj = smart_open.open(
"ssh://ubuntu:pass@ip_address:1022/some/path/lines.txt",
mode='rb',
transport_params=dict(hello='world'),
)
obj.__iter__()
mock_open.assert_called_with(
'/some/path/lines.txt',
'rb',
host='ip_address',
user='ubuntu',
password='pass',
port=1022,
)
@responses.activate
def test_http_read(self):
"""Does http read method work correctly"""
responses.add(responses.GET, "http://127.0.0.1/index.html",
body='line1\nline2')
smart_open_object = smart_open.open("http://127.0.0.1/index.html", 'rb')
self.assertEqual(smart_open_object.read().decode("utf-8"), "line1\nline2")
@responses.activate
def test_https_readline(self):
"""Does https readline method work correctly"""
responses.add(responses.GET, "https://127.0.0.1/index.html",
body=u'line1\u2028still line1\nline2')
smart_open_object = smart_open.open("https://127.0.0.1/index.html", 'rb')
self.assertEqual(smart_open_object.readline().decode("utf-8"), u"line1\u2028still line1\n")
smart_open_object = smart_open.open("https://127.0.0.1/index.html", 'r', encoding='utf-8')
self.assertEqual(smart_open_object.readline(), u"line1\u2028still line1\n")
@responses.activate
def test_http_pass(self):
"""Does http authentication work correctly"""
responses.add(responses.GET, "http://127.0.0.1/index.html",
body='line1\nline2')
tp = dict(user='me', password='pass')
smart_open.open("http://127.0.0.1/index.html", transport_params=tp)
self.assertEqual(len(responses.calls), 1)
actual_request = responses.calls[0].request
self.assertTrue('Authorization' in actual_request.headers)
self.assertTrue(actual_request.headers['Authorization'].startswith('Basic '))
@responses.activate
def test_http_cert(self):
"""Does cert parameter get passed to requests"""
responses.add(responses.GET, "http://127.0.0.1/index.html",
body='line1\nline2')
cert_path = '/path/to/my/cert.pem'
tp = dict(cert=cert_path)
smart_open.open("http://127.0.0.1/index.html", transport_params=tp)
self.assertEqual(len(responses.calls), 1)
actual_request = responses.calls[0].request
self.assertEqual(cert_path, actual_request.req_kwargs['cert'])
@responses.activate
def _test_compressed_http(self, suffix, query):
"""Can open <suffix> via http?"""
assert suffix in ('.gz', '.bz2')
raw_data = b'Hello World Compressed.' * 10000
compressed_data = gzip_compress(raw_data) if suffix == '.gz' else bz2.compress(raw_data)
responses.add(responses.GET, 'http://127.0.0.1/data' + suffix, body=compressed_data)
url = 'http://127.0.0.1/data%s%s' % (suffix, '?some_param=some_val' if query else '')
smart_open_object = smart_open.open(url, 'rb')
assert smart_open_object.read() == raw_data
def test_http_gz(self):
"""Can open gzip via http?"""
self._test_compressed_http(".gz", False)
def test_http_bz2(self):
"""Can open bzip2 via http?"""
self._test_compressed_http(".bz2", False)
def test_http_gz_query(self):
"""Can open gzip via http with a query appended to URI?"""
self._test_compressed_http(".gz", True)
def test_http_bz2_query(self):
"""Can open bzip2 via http with a query appended to URI?"""
self._test_compressed_http(".bz2", True)
class RealFileSystemTests(unittest.TestCase):
"""Tests that touch the file system via temporary files."""
def setUp(self):
with named_temporary_file(prefix='test', delete=False) as fout:
fout.write(SAMPLE_BYTES)
self.temp_file = fout.name
def tearDown(self):
os.unlink(self.temp_file)
def test_rt(self):
with smart_open.open(self.temp_file, 'rt') as fin:
data = fin.read()
self.assertEqual(data, SAMPLE_TEXT)
def test_wt(self):
#
# The file already contains SAMPLE_TEXT, so write something different.
#
text = 'nippon budokan'
with smart_open.open(self.temp_file, 'wt') as fout:
fout.write(text)
with smart_open.open(self.temp_file, 'rt') as fin:
data = fin.read()
self.assertEqual(data, text)
def test_ab(self):
with smart_open.open(self.temp_file, 'ab') as fout:
fout.write(SAMPLE_BYTES)
with smart_open.open(self.temp_file, 'rb') as fin:
data = fin.read()
self.assertEqual(data, SAMPLE_BYTES * 2)
def test_aplus(self):
with smart_open.open(self.temp_file, 'a+') as fout:
fout.write(SAMPLE_TEXT)
with smart_open.open(self.temp_file, 'rt') as fin:
text = fin.read()
self.assertEqual(text, SAMPLE_TEXT * 2)
def test_at(self):
with smart_open.open(self.temp_file, 'at') as fout:
fout.write(SAMPLE_TEXT)
with smart_open.open(self.temp_file, 'rt') as fin:
text = fin.read()
self.assertEqual(text, SAMPLE_TEXT * 2)
def test_atplus(self):
with smart_open.open(self.temp_file, 'at+') as fout:
fout.write(SAMPLE_TEXT)
with smart_open.open(self.temp_file, 'rt') as fin:
text = fin.read()
self.assertEqual(text, SAMPLE_TEXT * 2)
class CompressionRealFileSystemTests(RealFileSystemTests):
"""Same as RealFileSystemTests but with a compressed file."""
def setUp(self):
with named_temporary_file(prefix='test', suffix='.zst', delete=False) as fout:
self.temp_file = fout.name
with smart_open.open(self.temp_file, 'wb') as fout:
fout.write(SAMPLE_BYTES)
def test_aplus(self):
pass # transparent (de)compression unsupported for mode 'ab+'
def test_atplus(self):
pass # transparent (de)compression unsupported for mode 'ab+'
#
# What exactly to patch here differs on _how_ we're opening the file.
# See the _shortcut_open function for details.
#
_IO_OPEN = 'io.open'
_BUILTIN_OPEN = 'smart_open.smart_open_lib._builtin_open'
class SmartOpenReadTest(unittest.TestCase):
"""
Test reading from files under various schemes.
"""
def test_shortcut(self):
fpath = os.path.join(CURR_DIR, 'test_data/crime-and-punishment.txt')
with mock.patch('smart_open.smart_open_lib._builtin_open') as mock_open:
smart_open.open(fpath, 'r').read()
mock_open.assert_called_with(fpath, 'r', buffering=-1)
def test_open_binary(self):
fpath = os.path.join(CURR_DIR, 'test_data/cp852.tsv.txt')
with open(fpath, 'rb') as fin:
expected = fin.read()
with smart_open.open(fpath, 'rb') as fin:
actual = fin.read()
self.assertEqual(expected, actual)
def test_open_with_keywords(self):
"""This test captures Issue #142."""
fpath = os.path.join(CURR_DIR, 'test_data/cp852.tsv.txt')
with open(fpath, 'r', encoding='cp852') as fin:
expected = fin.read()
with smart_open.open(fpath, encoding='cp852') as fin:
actual = fin.read()
self.assertEqual(expected, actual)
def test_open_with_keywords_explicit_r(self):
fpath = os.path.join(CURR_DIR, 'test_data/cp852.tsv.txt')
with open(fpath, 'r', encoding='cp852') as fin:
expected = fin.read()
with smart_open.open(fpath, mode='r', encoding='cp852') as fin:
actual = fin.read()
self.assertEqual(expected, actual)
def test_open_and_read_pathlib_path(self):
"""If ``pathlib.Path`` is available we should be able to open and read."""
from smart_open.smart_open_lib import pathlib
fpath = os.path.join(CURR_DIR, 'test_data/cp852.tsv.txt')
with open(fpath, 'rb') as fin:
expected = fin.read().decode('cp852')
with smart_open.open(pathlib.Path(fpath), mode='r', encoding='cp852', newline='') as fin:
actual = fin.read()
self.assertEqual(expected, actual)
@mock_s3
def test_read_never_returns_none(self):
"""read should never return None."""
s3 = _resource('s3')
s3.create_bucket(Bucket='mybucket')
test_string = u"ветер по морю гуляет..."
with smart_open.open("s3://mybucket/mykey", "wb") as fout:
fout.write(test_string.encode('utf8'))
r = smart_open.open("s3://mybucket/mykey", "rb")
self.assertEqual(r.read(), test_string.encode("utf-8"))
self.assertEqual(r.read(), b"")
self.assertEqual(r.read(), b"")
@mock_s3
def test_read_newline_none(self):
"""Does newline open() parameter for reading work according to
https://docs.python.org/3/library/functions.html#open-newline-parameter
"""
_resource('s3').create_bucket(Bucket='mybucket')
# Unicode line separator and various others must never split lines
test_file = u"line\u2028 LF\nline\x1c CR\rline\x85 CRLF\r\nlast line"
with smart_open.open("s3://mybucket/mykey", "wb") as fout:
fout.write(test_file.encode("utf-8"))
# No newline parameter means newline=None i.e. universal newline mode with all
# line endings translated to '\n'
with smart_open.open("s3://mybucket/mykey", "r", encoding='utf-8') as fin:
self.assertEqual(list(fin), [
u"line\u2028 LF\n",
u"line\x1c CR\n",
u"line\x85 CRLF\n",
u"last line"
])
@mock_s3
def test_read_newline_empty(self):
_resource('s3').create_bucket(Bucket='mybucket')
test_file = u"line\u2028 LF\nline\x1c CR\rline\x85 CRLF\r\nlast line"
with smart_open.open("s3://mybucket/mykey", "wb") as fout:
fout.write(test_file.encode("utf-8"))
# If newline='' universal newline mode is enabled but line separators are not replaced
with smart_open.open("s3://mybucket/mykey", "r", encoding='utf-8', newline='') as fin:
self.assertEqual(list(fin), [
u"line\u2028 LF\n",
u"line\x1c CR\r",
u"line\x85 CRLF\r\n",
u"last line"
])
@mock_s3
def test_read_newline_cr(self):
_resource('s3').create_bucket(Bucket='mybucket')
test_file = u"line\u2028 LF\nline\x1c CR\rline\x85 CRLF\r\nlast line"
with smart_open.open("s3://mybucket/mykey", "wb") as fout:
fout.write(test_file.encode("utf-8"))
# If newline='\r' only CR splits lines
with smart_open.open("s3://mybucket/mykey", "r", encoding='utf-8', newline='\r') as fin:
self.assertEqual(list(fin), [
u"line\u2028 LF\nline\x1c CR\r",
u"line\x85 CRLF\r",
u"\nlast line"
])
@mock_s3
def test_read_newline_lf(self):
_resource('s3').create_bucket(Bucket='mybucket')
test_file = u"line\u2028 LF\nline\x1c CR\rline\x85 CRLF\r\nlast line"
with smart_open.open("s3://mybucket/mykey", "wb") as fout:
fout.write(test_file.encode("utf-8"))
# If newline='\n' only LF splits lines
with smart_open.open("s3://mybucket/mykey", "r", encoding='utf-8', newline='\n') as fin:
self.assertEqual(list(fin), [
u"line\u2028 LF\n",
u"line\x1c CR\rline\x85 CRLF\r\n",
u"last line"
])
@mock_s3
def test_read_newline_crlf(self):
_resource('s3').create_bucket(Bucket='mybucket')
test_file = u"line\u2028 LF\nline\x1c CR\rline\x85 CRLF\r\nlast line"
with smart_open.open("s3://mybucket/mykey", "wb") as fout:
fout.write(test_file.encode("utf-8"))
# If newline='\r\n' only CRLF splits lines
with smart_open.open("s3://mybucket/mykey", "r", encoding='utf-8', newline='\r\n') as fin:
self.assertEqual(list(fin), [
u"line\u2028 LF\nline\x1c CR\rline\x85 CRLF\r\n",
u"last line"
])
@mock_s3
def test_read_newline_slurp(self):
_resource('s3').create_bucket(Bucket='mybucket')
test_file = u"line\u2028 LF\nline\x1c CR\rline\x85 CRLF\r\nlast line"
with smart_open.open("s3://mybucket/mykey", "wb") as fout:
fout.write(test_file.encode("utf-8"))
# Even reading the whole file with read() must replace newlines
with smart_open.open("s3://mybucket/mykey", "r", encoding='utf-8', newline=None) as fin:
self.assertEqual(
fin.read(),
u"line\u2028 LF\nline\x1c CR\nline\x85 CRLF\nlast line"
)
@mock_s3
def test_read_newline_binary(self):
_resource('s3').create_bucket(Bucket='mybucket')
test_file = u"line\u2028 LF\nline\x1c CR\rline\x85 CRLF\r\nlast line"
with smart_open.open("s3://mybucket/mykey", "wb") as fout:
fout.write(test_file.encode("utf-8"))
# If the file is opened in binary mode only LF splits lines
with smart_open.open("s3://mybucket/mykey", "rb") as fin:
self.assertEqual(list(fin), [
u"line\u2028 LF\n".encode('utf-8'),
u"line\x1c CR\rline\x85 CRLF\r\n".encode('utf-8'),
u"last line".encode('utf-8')
])
@mock_s3
def test_write_newline_none(self):
"""Does newline open() parameter for writing work according to
https://docs.python.org/3/library/functions.html#open-newline-parameter
"""
_resource('s3').create_bucket(Bucket='mybucket')
# Unicode line separator and various others must never split lines
test_file = u"line\u2028 LF\nline\x1c CR\rline\x85 CRLF\r\nlast line"
# No newline parameter means newline=None, all LF are translatest to os.linesep
with smart_open.open("s3://mybucket/mykey", "w", encoding='utf-8') as fout:
fout.write(test_file)
with smart_open.open("s3://mybucket/mykey", "rb") as fin:
self.assertEqual(
fin.read().decode('utf-8'),
u"line\u2028 LF" + os.linesep
+ u"line\x1c CR\rline\x85 CRLF\r" + os.linesep
+ u"last line"
)
@mock_s3
def test_write_newline_empty(self):
_resource('s3').create_bucket(Bucket='mybucket')
test_file = u"line\u2028 LF\nline\x1c CR\rline\x85 CRLF\r\nlast line"
# If newline='' nothing is changed
with smart_open.open("s3://mybucket/mykey", "w", encoding='utf-8', newline='') as fout:
fout.write(test_file)
with smart_open.open("s3://mybucket/mykey", "rb") as fin:
self.assertEqual(
fin.read().decode('utf-8'),
u"line\u2028 LF\nline\x1c CR\rline\x85 CRLF\r\nlast line"
)
@mock_s3
def test_write_newline_lf(self):
_resource('s3').create_bucket(Bucket='mybucket')
test_file = u"line\u2028 LF\nline\x1c CR\rline\x85 CRLF\r\nlast line"
# If newline='\n' nothing is changed
with smart_open.open("s3://mybucket/mykey", "w", encoding='utf-8', newline='\n') as fout:
fout.write(test_file)
with smart_open.open("s3://mybucket/mykey", "rb") as fin:
self.assertEqual(
fin.read().decode('utf-8'),
u"line\u2028 LF\nline\x1c CR\rline\x85 CRLF\r\nlast line"
)
@mock_s3
def test_write_newline_cr(self):
_resource('s3').create_bucket(Bucket='mybucket')
test_file = u"line\u2028 LF\nline\x1c CR\rline\x85 CRLF\r\nlast line"
# If newline='\r' all LF are replaced by CR
with smart_open.open("s3://mybucket/mykey", "w", encoding='utf-8', newline='\r') as fout:
fout.write(test_file)
with smart_open.open("s3://mybucket/mykey", "rb") as fin:
self.assertEqual(
fin.read().decode('utf-8'),
u"line\u2028 LF\rline\x1c CR\rline\x85 CRLF\r\rlast line"
)
@mock_s3
def test_write_newline_crlf(self):
_resource('s3').create_bucket(Bucket='mybucket')
test_file = u"line\u2028 LF\nline\x1c CR\rline\x85 CRLF\r\nlast line"
# If newline='\r\n' all LF are replaced by CRLF
with smart_open.open("s3://mybucket/mykey", "w", encoding='utf-8', newline='\r\n') as fout:
fout.write(test_file)
with smart_open.open("s3://mybucket/mykey", "rb") as fin:
self.assertEqual(
fin.read().decode('utf-8'),
u"line\u2028 LF\r\nline\x1c CR\rline\x85 CRLF\r\r\nlast line"
)
@mock_s3
def test_readline(self):
"""Does readline() return the correct file content?"""
s3 = _resource('s3')
s3.create_bucket(Bucket='mybucket')
test_string = u"hello žluťoučký\u2028world!\nhow are you?".encode('utf8')
with smart_open.open("s3://mybucket/mykey", "wb") as fout:
fout.write(test_string)
reader = smart_open.open("s3://mybucket/mykey", "rb")
self.assertEqual(reader.readline(), u"hello žluťoučký\u2028world!\n".encode("utf-8"))
@mock_s3
def test_readline_iter(self):
"""Does __iter__ return the correct file content?"""
s3 = _resource('s3')
s3.create_bucket(Bucket='mybucket')
lines = [u"всем\u2028привет!\n", u"что нового?"]
with smart_open.open("s3://mybucket/mykey", "wb") as fout:
fout.write("".join(lines).encode("utf-8"))
reader = smart_open.open("s3://mybucket/mykey", "rb")
actual_lines = [line.decode("utf-8") for line in reader]
self.assertEqual(2, len(actual_lines))
self.assertEqual(lines[0], actual_lines[0])
self.assertEqual(lines[1], actual_lines[1])
@mock_s3
def test_readline_eof(self):
"""Does readline() return empty string on EOF?"""
s3 = _resource('s3')
s3.create_bucket(Bucket='mybucket')
with smart_open.open("s3://mybucket/mykey", "wb"):
pass
with patch_invalid_range_response('0'):
reader = smart_open.open("s3://mybucket/mykey", "rb")
self.assertEqual(reader.readline(), b"")
self.assertEqual(reader.readline(), b"")
self.assertEqual(reader.readline(), b"")
@mock_s3
def test_s3_iter_lines(self):
"""Does s3_iter_lines give correct content?"""
# create fake bucket and fake key
s3 = _resource('s3')
s3.create_bucket(Bucket='mybucket')
test_string = u"hello žluťoučký\u2028world!\nhow are you?".encode('utf8')
with smart_open.open("s3://mybucket/mykey", "wb") as fin:
fin.write(test_string)
# call s3_iter_lines and check output
reader = smart_open.open("s3://mybucket/mykey", "rb")
output = list(reader)
self.assertEqual(len(output), 2)
self.assertEqual(b''.join(output), test_string)
# TODO: add more complex test for file://
@mock.patch('smart_open.smart_open_lib._builtin_open')
def test_file(self, mock_smart_open):
"""Is file:// line iterator called correctly?"""
prefix = "file://"
full_path = '/tmp/test.txt'
read_mode = "rb"
smart_open_object = smart_open.open(prefix+full_path, read_mode)
smart_open_object.__iter__()
# called with the correct path?
mock_smart_open.assert_called_with(full_path, read_mode, buffering=-1)
full_path = '/tmp/test#hash##more.txt'
read_mode = "rb"
smart_open_object = smart_open.open(prefix+full_path, read_mode)
smart_open_object.__iter__()
# called with the correct path?
mock_smart_open.assert_called_with(full_path, read_mode, buffering=-1)
full_path = 'aa#aa'
read_mode = "rb"
smart_open_object = smart_open.open(full_path, read_mode)
smart_open_object.__iter__()
# called with the correct path?
mock_smart_open.assert_called_with(full_path, read_mode, buffering=-1)
short_path = "~/tmp/test.txt"
full_path = os.path.expanduser(short_path)
@mock.patch(_BUILTIN_OPEN)
def test_file_errors(self, mock_smart_open):
prefix = "file://"
full_path = '/tmp/test.txt'
read_mode = "r"
short_path = "~/tmp/test.txt"
full_path = os.path.expanduser(short_path)
smart_open_object = smart_open.open(prefix+short_path, read_mode, errors='strict')
smart_open_object.__iter__()
# called with the correct expanded path?
mock_smart_open.assert_called_with(full_path, read_mode, buffering=-1, errors='strict')
@mock.patch(_BUILTIN_OPEN)
def test_file_buffering(self, mock_smart_open):
smart_open_object = smart_open.open('/tmp/somefile', 'rb', buffering=0)
smart_open_object.__iter__()
# called with the correct expanded path?
mock_smart_open.assert_called_with('/tmp/somefile', 'rb', buffering=0)
@mock.patch(_BUILTIN_OPEN)
def test_file_buffering2(self, mock_smart_open):
smart_open_object = smart_open.open('/tmp/somefile', 'rb', 0)
smart_open_object.__iter__()
# called with the correct expanded path?
mock_smart_open.assert_called_with('/tmp/somefile', 'rb', buffering=0)
# couldn't find any project for mocking up HDFS data
# TODO: we want to test also a content of the files, not just fnc call params
@mock.patch('smart_open.hdfs.subprocess')
def test_hdfs(self, mock_subprocess):
"""Is HDFS line iterator called correctly?"""
mock_subprocess.PIPE.return_value = "test"
smart_open_object = smart_open.open("hdfs:///tmp/test.txt")
smart_open_object.__iter__()
# called with the correct params?
mock_subprocess.Popen.assert_called_with(
["hdfs", "dfs", "-cat", "/tmp/test.txt"],
stdout=mock_subprocess.PIPE,
)
# second possibility of schema
smart_open_object = smart_open.open("hdfs://tmp/test.txt")
smart_open_object.__iter__()
mock_subprocess.Popen.assert_called_with(
["hdfs", "dfs", "-cat", "/tmp/test.txt"],
stdout=mock_subprocess.PIPE,
)
@responses.activate
def test_webhdfs(self):
"""Is webhdfs line iterator called correctly"""
responses.add(responses.GET, "http://127.0.0.1:8440/webhdfs/v1/path/file",
body='line1\nline2')
smart_open_object = smart_open.open("webhdfs://127.0.0.1:8440/path/file", 'rb')
iterator = iter(smart_open_object)
self.assertEqual(next(iterator).decode("utf-8"), "line1\n")
self.assertEqual(next(iterator).decode("utf-8"), "line2")
@responses.activate
def test_webhdfs_encoding(self):
"""Is HDFS line iterator called correctly?"""
input_url = "webhdfs://127.0.0.1:8440/path/file"
actual_url = 'http://127.0.0.1:8440/webhdfs/v1/path/file'
text = u'не для меня прийдёт весна, не для меня дон разольётся'
body = text.encode('utf-8')
responses.add(responses.GET, actual_url, body=body)
actual = smart_open.open(input_url, encoding='utf-8').read()
self.assertEqual(text, actual)
@responses.activate
def test_webhdfs_read(self):
"""Does webhdfs read method work correctly"""
responses.add(responses.GET, "http://127.0.0.1:8440/webhdfs/v1/path/file",
body='line1\nline2')
smart_open_object = smart_open.open("webhdfs://127.0.0.1:8440/path/file", 'rb')
self.assertEqual(smart_open_object.read().decode("utf-8"), "line1\nline2")
@mock_s3
def test_s3_iter_moto(self):
"""Are S3 files iterated over correctly?"""
# a list of strings to test with
expected = [b"*" * 5 * 1024**2] + [b'0123456789'] * 1024 + [b"test"]
# create fake bucket and fake key
s3 = _resource('s3')
s3.create_bucket(Bucket='mybucket')
tp = dict(s3_min_part_size=5 * 1024**2)
with smart_open.open("s3://mybucket/mykey", "wb", transport_params=tp) as fout:
# write a single huge line (=full multipart upload)
fout.write(expected[0] + b'\n')
# write lots of small lines
for lineno, line in enumerate(expected[1:-1]):
fout.write(line + b'\n')
# ...and write the last line too, no newline at the end
fout.write(expected[-1])
# connect to fake s3 and read from the fake key we filled above
smart_open_object = smart_open.open("s3://mybucket/mykey", 'rb')
output = [line.rstrip(b'\n') for line in smart_open_object]
self.assertEqual(output, expected)
# same thing but using a context manager
with smart_open.open("s3://mybucket/mykey", 'rb') as smart_open_object:
output = [line.rstrip(b'\n') for line in smart_open_object]
self.assertEqual(output, expected)
@mock_s3
def test_s3_read_moto(self):
"""Are S3 files read correctly?"""
s3 = _resource('s3')
s3.create_bucket(Bucket='mybucket')
# write some bogus key so we can check it below
content = u"hello wořld\nhow are you?".encode('utf8')
with smart_open.open("s3://mybucket/mykey", "wb") as fout:
fout.write(content)
smart_open_object = smart_open.open("s3://mybucket/mykey", 'rb')
self.assertEqual(content[:6], smart_open_object.read(6))
self.assertEqual(content[6:14], smart_open_object.read(8)) # ř is 2 bytes
self.assertEqual(content[14:], smart_open_object.read()) # read the rest
@mock_s3
def test_s3_seek_moto(self):
"""Does seeking in S3 files work correctly?"""
s3 = _resource('s3')
s3.create_bucket(Bucket='mybucket')
# write some bogus key so we can check it below
content = u"hello wořld\nhow are you?".encode('utf8')
with smart_open.open("s3://mybucket/mykey", "wb") as fout:
fout.write(content)
smart_open_object = smart_open.open("s3://mybucket/mykey", 'rb')
self.assertEqual(content[:6], smart_open_object.read(6))
self.assertEqual(content[6:14], smart_open_object.read(8)) # ř is 2 bytes
smart_open_object.seek(0)
self.assertEqual(content, smart_open_object.read()) # no size given => read whole file
smart_open_object.seek(0)
self.assertEqual(content, smart_open_object.read(-1)) # same thing
@mock_s3
def test_s3_tell(self):
"""Does tell() work when S3 file is opened for text writing? """
s3 = _resource('s3')
s3.create_bucket(Bucket='mybucket')
with smart_open.open("s3://mybucket/mykey", "w") as fout:
fout.write(u"test")
# Note that tell() in general returns an opaque number for text files.
# See https://docs.python.org/3/library/io.html#io.TextIOBase.tell
self.assertEqual(fout.tell(), 4)
class SmartOpenS3KwargsTest(unittest.TestCase):
@mock.patch('boto3.client')
def test_no_kwargs(self, mock_client):
smart_open.open('s3://mybucket/mykey', transport_params=dict(defer_seek=True))
mock_client.assert_called_with('s3', config=mock_client.call_args.kwargs['config'])
@mock.patch('boto3.client')
def test_credentials(self, mock_client):
smart_open.open('s3://access_id:access_secret@mybucket/mykey', transport_params=dict(defer_seek=True))
mock_client.assert_called_with(
's3',
aws_access_key_id='access_id',
aws_secret_access_key='access_secret',
config=mock_client.call_args.kwargs['config'],
)
@mock.patch('boto3.client')
def test_host(self, mock_client):
tp = {
'client_kwargs': {
'S3.Client': {'endpoint_url': 'http://aa.domain.com'},
},
'defer_seek': True,
}
smart_open.open("s3://access_id:access_secret@mybucket/mykey", transport_params=tp)
mock_client.assert_called_with(
's3',
aws_access_key_id='access_id',
aws_secret_access_key='access_secret',
endpoint_url='http://aa.domain.com',
config=mock_client.call_args.kwargs['config'],
)
@mock.patch('boto3.client')
def test_s3_upload(self, mock_client):
tp = {
'client_kwargs': {
'S3.Client.create_multipart_upload': {
'ServerSideEncryption': 'AES256',
'ContentType': 'application/json',
}
}
}
smart_open.open("s3://bucket/key", 'wb', transport_params=tp)
mock_client.return_value.create_multipart_upload.assert_called_with(
Bucket='bucket',
Key='key',
ServerSideEncryption='AES256',
ContentType='application/json',
)
class SmartOpenTest(unittest.TestCase):
"""
Test reading and writing from/into files.
"""
def setUp(self):
self.as_text = u'куда идём мы с пятачком - большой большой секрет'
self.as_bytes = self.as_text.encode('utf-8')
self.stringio = io.StringIO(self.as_text)
self.bytesio = io.BytesIO(self.as_bytes)
def test_file_mode_mock(self):
"""Are file:// open modes passed correctly?"""
# correct read modes
#
# We always open files in binary mode first, but engage
# encoders/decoders as necessary. Instead of checking how the file
# _initially_ got opened, we now also check the end result: if the
# contents got decoded correctly.
#
def test_text(self):
with mock.patch(_BUILTIN_OPEN, mock.Mock(return_value=self.stringio)) as mock_open:
with smart_open.open("blah", "r", encoding='utf-8') as fin:
self.assertEqual(fin.read(), self.as_text)
mock_open.assert_called_with("blah", "r", buffering=-1, encoding='utf-8')
def test_binary(self):
with mock.patch(_BUILTIN_OPEN, mock.Mock(return_value=self.bytesio)) as mock_open:
with smart_open.open("blah", "rb") as fin:
self.assertEqual(fin.read(), self.as_bytes)
mock_open.assert_called_with("blah", "rb", buffering=-1)
def test_expanded_path(self):
short_path = "~/blah"
full_path = os.path.expanduser(short_path)
with mock.patch(_BUILTIN_OPEN, mock.Mock(return_value=self.stringio)) as mock_open:
with smart_open.open(short_path, "rb"):
mock_open.assert_called_with(full_path, "rb", buffering=-1)
def test_incorrect(self):
# incorrect file mode
self.assertRaises(NotImplementedError, smart_open.smart_open, "s3://bucket/key", "x")
# correct write modes, incorrect scheme
self.assertRaises(NotImplementedError, smart_open.smart_open, "hdfs:///blah.txt", "wb+")
self.assertRaises(NotImplementedError, smart_open.smart_open, "http:///blah.txt", "w")
self.assertRaises(NotImplementedError, smart_open.smart_open, "s3://bucket/key", "wb+")
def test_write_utf8(self):
# correct write mode, correct file:// URI
with mock.patch(_BUILTIN_OPEN, mock.Mock(return_value=self.stringio)) as mock_open:
with smart_open.open("blah", "w", encoding='utf-8') as fout:
mock_open.assert_called_with("blah", "w", buffering=-1, encoding='utf-8')
fout.write(self.as_text)
def test_write_utf8_absolute_path(self):
with mock.patch(_BUILTIN_OPEN, mock.Mock(return_value=self.stringio)) as mock_open:
with smart_open.open("/some/file.txt", "w", encoding='utf-8') as fout:
mock_open.assert_called_with("/some/file.txt", "w", buffering=-1, encoding='utf-8')
fout.write(self.as_text)
def test_append_utf8(self):
with mock.patch(_BUILTIN_OPEN, mock.Mock(return_value=self.stringio)) as mock_open:
with smart_open.open("/some/file.txt", "w+", encoding='utf-8') as fout:
mock_open.assert_called_with("/some/file.txt", "w+", buffering=-1, encoding='utf-8')
fout.write(self.as_text)
def test_append_binary_absolute_path(self):
with mock.patch(_BUILTIN_OPEN, mock.Mock(return_value=self.bytesio)) as mock_open:
with smart_open.open("/some/file.txt", "wb+") as fout:
mock_open.assert_called_with("/some/file.txt", "wb+", buffering=-1)
fout.write(self.as_bytes)
def test_newline(self):
with mock.patch(_BUILTIN_OPEN, mock.Mock(return_value=self.bytesio)) as mock_open:
smart_open.open("/some/file.txt", "wb+", newline='\n')
mock_open.assert_called_with("/some/file.txt", "wb+", buffering=-1, newline='\n')
def test_newline_csv(self):
#
# See https://github.com/piskvorky/smart_open/issues/477
#
rows = [{'name': 'alice\u2028beatrice', 'color': 'aqua'}, {'name': 'bob', 'color': 'blue'}]
expected = 'name,color\r\nalice\u2028beatrice,aqua\r\nbob,blue\r\n'
with named_temporary_file(mode='w') as tmp:
# The csv module recommends using newline='' when opening files and letting
# the csv writer handle line endings. By default it uses the 'excel' dialect which
# emits \r\n as line terminator.
with smart_open.open(tmp.name, 'w+', encoding='utf-8', newline='') as fout:
out = csv.DictWriter(fout, fieldnames=['name', 'color'])
out.writeheader()
out.writerows(rows)
with open(tmp.name, 'r', encoding='utf-8', newline='') as fin:
content = fin.read()
assert content == expected
@mock.patch('boto3.client')
def test_s3_mode_mock(self, mock_client):
"""Are s3:// open modes passed correctly?"""
# correct write mode, correct s3 URI
transport_params = {
'client_kwargs': {
'S3.Client': {'endpoint_url': 'http://s3.amazonaws.com'},
}
}
smart_open.open("s3://mybucket/mykey", "w", transport_params=transport_params)
mock_client.assert_called_with(
's3',
endpoint_url='http://s3.amazonaws.com',
config=mock_client.call_args.kwargs['config'],
)
@mock.patch('smart_open.hdfs.subprocess')
def test_hdfs(self, mock_subprocess):
"""Is HDFS write called correctly"""
smart_open_object = smart_open.open("hdfs:///tmp/test.txt", 'wb')
smart_open_object.write("test")
# called with the correct params?
mock_subprocess.Popen.assert_called_with(
["hdfs", "dfs", "-put", "-f", "-", "/tmp/test.txt"], stdin=mock_subprocess.PIPE
)
# second possibility of schema
smart_open_object = smart_open.open("hdfs://tmp/test.txt", 'wb')
smart_open_object.write("test")
mock_subprocess.Popen.assert_called_with(
["hdfs", "dfs", "-put", "-f", "-", "/tmp/test.txt"], stdin=mock_subprocess.PIPE
)
@mock_s3
def test_s3_modes_moto(self):
"""Do s3:// open modes work correctly?"""
# fake bucket and key
s3 = _resource('s3')
s3.create_bucket(Bucket='mybucket')
raw_data = b"second test"
# correct write mode, correct s3 URI
with smart_open.open("s3://mybucket/newkey", "wb") as fout:
logger.debug('fout: %r', fout)
fout.write(raw_data)
logger.debug("write successfully completed")
output = list(smart_open.open("s3://mybucket/newkey", "rb"))
self.assertEqual(output, [raw_data])
@mock_s3
def test_s3_metadata_write(self):
# Read local file fixture
path = os.path.join(CURR_DIR, 'test_data/crime-and-punishment.txt.gz')
data = ""
with smart_open.open(path, 'rb') as fd:
data = fd.read()
# Create a test bucket
s3 = _resource('s3')
s3.create_bucket(Bucket='mybucket')
tp = {
'client_kwargs': {
'S3.Client.create_multipart_upload': {
'ContentType': 'text/plain',
'ContentEncoding': 'gzip',
}
}
}
# Write data, with multipart_upload options
write_stream = smart_open.open(
's3://mybucket/crime-and-punishment.txt.gz', 'wb',
transport_params=tp,
)
with write_stream as fout:
fout.write(data)
key = s3.Object('mybucket', 'crime-and-punishment.txt.gz')
self.assertIn('text/plain', key.content_type)
self.assertEqual(key.content_encoding, 'gzip')
@mock_s3
def test_write_bad_encoding_strict(self):
"""Should abort on encoding error."""
text = u'欲しい気持ちが成長しすぎて'
with self.assertRaises(UnicodeEncodeError):
with named_temporary_file('wb', delete=True) as infile:
with smart_open.open(infile.name, 'w', encoding='koi8-r', errors='strict') as fout:
fout.write(text)
@mock_s3
def test_write_bad_encoding_replace(self):
"""Should replace characters that failed to encode."""
text = u'欲しい気持ちが成長しすぎて'
expected = u'?' * len(text)
with named_temporary_file('wb', delete=True) as infile:
with smart_open.open(infile.name, 'w', encoding='koi8-r', errors='replace') as fout:
fout.write(text)
with smart_open.open(infile.name, 'r', encoding='koi8-r') as fin:
actual = fin.read()
self.assertEqual(expected, actual)
class WebHdfsWriteTest(unittest.TestCase):
"""
Test writing into webhdfs files.
"""
@responses.activate
def test_initialize_write(self):
def request_callback(_):
resp_body = ""
headers = {'location': 'http://127.0.0.1:8440/file'}
return 307, headers, resp_body
responses.add_callback(
responses.PUT,
"http://127.0.0.1:8440/webhdfs/v1/path/file",
callback=request_callback,
)
responses.add(
responses.PUT,
"http://127.0.0.1:8440/file",
status=201,
)
smart_open.open("webhdfs://127.0.0.1:8440/path/file", 'wb')
assert len(responses.calls) == 2
path, params = responses.calls[0].request.url.split("?")
assert path == "http://127.0.0.1:8440/webhdfs/v1/path/file"
assert params == "overwrite=True&op=CREATE" or params == "op=CREATE&overwrite=True"
assert responses.calls[1].request.url == "http://127.0.0.1:8440/file"
@responses.activate
def test_write(self):
def request_callback(_):
resp_body = ""
headers = {'location': 'http://127.0.0.1:8440/file'}
return 307, headers, resp_body
responses.add_callback(
responses.PUT,
"http://127.0.0.1:8440/webhdfs/v1/path/file",
callback=request_callback,
)
responses.add(responses.PUT, "http://127.0.0.1:8440/file", status=201)
smart_open_object = smart_open.open("webhdfs://127.0.0.1:8440/path/file", 'wb')
def write_callback(request):
assert request.body == u"žluťoučký koníček".encode('utf8')
headers = {}
return 200, headers, ""
test_string = u"žluťoučký koníček".encode('utf8')
responses.add_callback(
responses.POST,
"http://127.0.0.1:8440/webhdfs/v1/path/file",
callback=request_callback,
)
responses.add_callback(
responses.POST,
"http://127.0.0.1:8440/file",
callback=write_callback,
)
smart_open_object.write(test_string)
smart_open_object.close()
assert len(responses.calls) == 4
assert responses.calls[2].request.url == "http://127.0.0.1:8440/webhdfs/v1/path/file?op=APPEND" # noqa
assert responses.calls[3].request.url == "http://127.0.0.1:8440/file"
_DECOMPRESSED_DATA = "не слышны в саду даже шорохи".encode("utf-8")
_MOCK_TIME = mock.Mock(return_value=1620256567)
def gzip_compress(data, filename=None):
#
# gzip.compress is sensitive to the current time and the destination filename.
# This function fixes those variables for consistent compression results.
#
buf = io.BytesIO()
buf.name = filename
with mock.patch('time.time', _MOCK_TIME):
with gzip.GzipFile(fileobj=buf, mode='w') as gz:
gz.write(data)
return buf.getvalue()
class CompressionFormatTest(unittest.TestCase):
"""Test transparent (de)compression."""
def write_read_assertion(self, suffix):
with named_temporary_file(suffix=suffix) as tmp:
with smart_open.open(tmp.name, 'wb') as fout:
fout.write(SAMPLE_BYTES)
with open(tmp.name, 'rb') as fin:
assert fin.read() != SAMPLE_BYTES # is the content really compressed? (built-in fails)
with smart_open.open(tmp.name, 'rb') as fin:
assert fin.read() == SAMPLE_BYTES # ... smart_open correctly opens and decompresses
def test_open_gz(self):
"""Can open gzip?"""
fpath = os.path.join(CURR_DIR, 'test_data/crlf_at_1k_boundary.warc.gz')
with smart_open.open(fpath, 'rb') as infile:
data = infile.read()
m = hashlib.md5(data)
assert m.hexdigest() == '18473e60f8c7c98d29d65bf805736a0d', 'Failed to read gzip'
def test_write_read_gz(self):
"""Can write and read gzip?"""
self.write_read_assertion('.gz')
def test_write_read_bz2(self):
"""Can write and read bz2?"""
self.write_read_assertion('.bz2')
def test_gzip_text(self):
with named_temporary_file(suffix='.gz') as f:
with smart_open.open(f.name, 'wt') as fout:
fout.write('hello world')
with smart_open.open(f.name, 'rt') as fin:
assert fin.read() == 'hello world'
class MultistreamsBZ2Test(unittest.TestCase):
"""
Test that multistream bzip2 compressed files can be read.
"""
# note: these tests are derived from the Python 3.x tip bz2 tests.
TEXT_LINES = [
b'root:x:0:0:root:/root:/bin/bash\n',
b'bin:x:1:1:bin:/bin:\n',
b'daemon:x:2:2:daemon:/sbin:\n',
b'adm:x:3:4:adm:/var/adm:\n',
b'lp:x:4:7:lp:/var/spool/lpd:\n',
b'sync:x:5:0:sync:/sbin:/bin/sync\n',
b'shutdown:x:6:0:shutdown:/sbin:/sbin/shutdown\n',
b'halt:x:7:0:halt:/sbin:/sbin/halt\n',
b'mail:x:8:12:mail:/var/spool/mail:\n',
b'news:x:9:13:news:/var/spool/news:\n',
b'uucp:x:10:14:uucp:/var/spool/uucp:\n',
b'operator:x:11:0:operator:/root:\n',
b'games:x:12:100:games:/usr/games:\n',
b'gopher:x:13:30:gopher:/usr/lib/gopher-data:\n',
b'ftp:x:14:50:FTP User:/var/ftp:/bin/bash\n',
b'nobody:x:65534:65534:Nobody:/home:\n',
b'postfix:x:100:101:postfix:/var/spool/postfix:\n',
b'niemeyer:x:500:500::/home/niemeyer:/bin/bash\n',
b'postgres:x:101:102:PostgreSQL Server:/var/lib/pgsql:/bin/bash\n',
b'mysql:x:102:103:MySQL server:/var/lib/mysql:/bin/bash\n',
b'www:x:103:104::/var/www:/bin/false\n',
]
TEXT = b''.join(TEXT_LINES)
DATA = (
b'BZh91AY&SY.\xc8N\x18\x00\x01>_\x80\x00\x10@\x02\xff\xf0\x01\x07n\x00?\xe7\xff\xe00\x01\x99\xaa\x00'
b'\xc0\x03F\x86\x8c#&\x83F\x9a\x03\x06\xa6\xd0\xa6\x93M\x0fQ\xa7\xa8\x06\x804hh\x12$\x11\xa4i4\xf14S'
b'\xd2<Q\xb5\x0fH\xd3\xd4\xdd\xd5\x87\xbb\xf8\x94\r\x8f\xafI\x12\xe1\xc9\xf8/E\x00pu\x89\x12]\xc9'
b'\xbbDL\nQ\x0e\t1\x12\xdf\xa0\xc0\x97\xac2O9\x89\x13\x94\x0e\x1c7\x0ed\x95I\x0c\xaaJ\xa4\x18L\x10'
b'\x05#\x9c\xaf\xba\xbc/\x97\x8a#C\xc8\xe1\x8cW\xf9\xe2\xd0\xd6M\xa7\x8bXa<e\x84t\xcbL\xb3\xa7\xd9'
b'\xcd\xd1\xcb\x84.\xaf\xb3\xab\xab\xad`n}\xa0lh\tE,\x8eZ\x15\x17VH>\x88\xe5\xcd9gd6\x0b\n\xe9\x9b'
b'\xd5\x8a\x99\xf7\x08.K\x8ev\xfb\xf7xw\xbb\xdf\xa1\x92\xf1\xdd|/";\xa2\xba\x9f\xd5\xb1#A\xb6\xf6'
b'\xb3o\xc9\xc5y\\\xebO\xe7\x85\x9a\xbc\xb6f8\x952\xd5\xd7"%\x89>V,\xf7\xa6z\xe2\x9f\xa3\xdf\x11'
b'\x11"\xd6E)I\xa9\x13^\xca\xf3r\xd0\x03U\x922\xf26\xec\xb6\xed\x8b\xc3U\x13\x9d\xc5\x170\xa4\xfa^'
b'\x92\xacDF\x8a\x97\xd6\x19\xfe\xdd\xb8\xbd\x1a\x9a\x19\xa3\x80ankR\x8b\xe5\xd83]\xa9\xc6\x08'
b'\x82f\xf6\xb9"6l$\xb8j@\xc0\x8a\xb0l1..\xbak\x83ls\x15\xbc\xf4\xc1\x13\xbe\xf8E\xb8\x9d\r\xa8\x9dk'
b'\x84\xd3n\xfa\xacQ\x07\xb1%y\xaav\xb4\x08\xe0z\x1b\x16\xf5\x04\xe9\xcc\xb9\x08z\x1en7.G\xfc]\xc9'
b'\x14\xe1B@\xbb!8`'
)
def create_temp_bz2(self, streams=1):
with named_temporary_file('wb', suffix='.bz2', delete=False) as f:
f.write(self.DATA * streams)
return f.name
def cleanup_temp_bz2(self, test_file):
if os.path.isfile(test_file):
os.unlink(test_file)
def test_can_read_multistream_bz2(self):
from bz2 import BZ2File
test_file = self.create_temp_bz2(streams=5)
with BZ2File(test_file) as bz2f:
self.assertEqual(bz2f.read(), self.TEXT * 5)
self.cleanup_temp_bz2(test_file)
def test_file_smart_open_can_read_multistream_bz2(self):
test_file = self.create_temp_bz2(streams=5)
with smart_open_lib.open(test_file, 'rb') as bz2f:
self.assertEqual(bz2f.read(), self.TEXT * 5)
self.cleanup_temp_bz2(test_file)
class S3OpenTest(unittest.TestCase):
@mock_s3
def test_r(self):
"""Reading a UTF string should work."""
text = u"физкульт-привет!"
s3 = _resource('s3')
s3.create_bucket(Bucket='bucket')
key = s3.Object('bucket', 'key')
key.put(Body=text.encode('utf-8'))
with smart_open.open('s3://bucket/key', "rb") as fin:
self.assertEqual(fin.read(), text.encode('utf-8'))
with smart_open.open('s3://bucket/key', "r", encoding='utf-8') as fin:
self.assertEqual(fin.read(), text)
def test_bad_mode(self):
"""Bad mode should raise and exception."""
uri = smart_open_lib._parse_uri("s3://bucket/key")
self.assertRaises(NotImplementedError, smart_open.open, uri, "x")
@mock_s3
def test_rw_encoding(self):
"""Should read and write text, respecting encodings, etc."""
s3 = _resource('s3')
s3.create_bucket(Bucket='bucket')
key = "s3://bucket/key"
text = u"расцветали яблони и груши"
with smart_open.open(key, "w", encoding="koi8-r") as fout:
fout.write(text)
with smart_open.open(key, "r", encoding="koi8-r") as fin:
self.assertEqual(text, fin.read())
with smart_open.open(key, "rb") as fin:
self.assertEqual(text.encode("koi8-r"), fin.read())
with smart_open.open(key, "r", encoding="euc-jp") as fin:
self.assertRaises(UnicodeDecodeError, fin.read)
with smart_open.open(key, "r", encoding="euc-jp", errors="replace") as fin:
fin.read()
@mock_s3
def test_rw_gzip(self):
"""Should read/write gzip files, implicitly and explicitly."""
s3 = _resource('s3')
s3.create_bucket(Bucket='bucket')
key = "s3://bucket/key.gz"
text = u"не слышны в саду даже шорохи"
with smart_open.open(key, "wb") as fout:
fout.write(text.encode("utf-8"))
#
# Check that what we've created is a gzip.
#
with smart_open.open(key, "rb", compression='disable') as fin:
gz = gzip.GzipFile(fileobj=fin)
self.assertEqual(gz.read().decode("utf-8"), text)
#
# We should be able to read it back as well.
#
with smart_open.open(key, "rb") as fin:
self.assertEqual(fin.read().decode("utf-8"), text)
@mock_s3
@mock.patch('smart_open.smart_open_lib._inspect_kwargs', mock.Mock(return_value={}))
def test_gzip_write_mode(self):
"""Should always open in binary mode when writing through a codec."""
s3 = _resource('s3')
s3.create_bucket(Bucket='bucket')
with mock.patch('smart_open.s3.open', return_value=open(__file__, 'rb')) as mock_open:
smart_open.open("s3://bucket/key.gz", "wb")
mock_open.assert_called_with('bucket', 'key.gz', 'wb')
@mock_s3
@mock.patch('smart_open.smart_open_lib._inspect_kwargs', mock.Mock(return_value={}))
def test_gzip_read_mode(self):
"""Should always open in binary mode when reading through a codec."""
s3 = _resource('s3')
s3.create_bucket(Bucket='bucket')
key = "s3://bucket/key.gz"
text = u"если-б я был султан и имел трёх жён, то тройной красотой был бы окружён"
with smart_open.open(key, "wb") as fout:
fout.write(text.encode("utf-8"))
with mock.patch('smart_open.s3.open', return_value=open(__file__)) as mock_open:
smart_open.open(key, "r")
mock_open.assert_called_with('bucket', 'key.gz', 'rb')
@mock_s3
def test_read_encoding(self):
"""Should open the file with the correct encoding, explicit text read."""
s3 = _resource('s3')
s3.create_bucket(Bucket='bucket')
key = "s3://bucket/key.txt"
text = u'это знала ева, это знал адам, колеса любви едут прямо по нам'
with smart_open.open(key, 'wb') as fout:
fout.write(text.encode('koi8-r'))
with smart_open.open(key, 'r', encoding='koi8-r') as fin:
actual = fin.read()
self.assertEqual(text, actual)
@mock_s3
def test_read_encoding_implicit_text(self):
"""Should open the file with the correct encoding, implicit text read."""
s3 = _resource('s3')
s3.create_bucket(Bucket='bucket')
key = "s3://bucket/key.txt"
text = u'это знала ева, это знал адам, колеса любви едут прямо по нам'
with smart_open.open(key, 'wb') as fout:
fout.write(text.encode('koi8-r'))
with smart_open.open(key, encoding='koi8-r') as fin:
actual = fin.read()
self.assertEqual(text, actual)
@mock_s3
def test_write_encoding(self):
"""Should open the file for writing with the correct encoding."""
s3 = _resource('s3')
s3.create_bucket(Bucket='bucket')
key = "s3://bucket/key.txt"
text = u'какая боль, какая боль, аргентина - ямайка, 5-0'
with smart_open.open(key, 'w', encoding='koi8-r') as fout:
fout.write(text)
with smart_open.open(key, encoding='koi8-r') as fin:
actual = fin.read()
self.assertEqual(text, actual)
@mock_s3
def test_write_bad_encoding_strict(self):
"""Should open the file for writing with the correct encoding."""
s3 = _resource('s3')
s3.create_bucket(Bucket='bucket')
key = "s3://bucket/key.txt"
text = u'欲しい気持ちが成長しすぎて'
with self.assertRaises(UnicodeEncodeError):
with smart_open.open(key, 'w', encoding='koi8-r', errors='strict') as fout:
fout.write(text)
@mock_s3
def test_write_bad_encoding_replace(self):
"""Should open the file for writing with the correct encoding."""
s3 = _resource('s3')
s3.create_bucket(Bucket='bucket')
key = "s3://bucket/key.txt"
text = u'欲しい気持ちが成長しすぎて'
expected = u'?' * len(text)
with smart_open.open(key, 'w', encoding='koi8-r', errors='replace') as fout:
fout.write(text)
with smart_open.open(key, encoding='koi8-r') as fin:
actual = fin.read()
self.assertEqual(expected, actual)
@mock_s3
def test_write_text_gzip(self):
"""Should open the file for writing with the correct encoding."""
s3 = _resource('s3')
s3.create_bucket(Bucket='bucket')
key = "s3://bucket/key.txt.gz"
text = u'какая боль, какая боль, аргентина - ямайка, 5-0'
with smart_open.open(key, 'w', encoding='utf-8') as fout:
fout.write(text)
with smart_open.open(key, 'r', encoding='utf-8') as fin:
actual = fin.read()
self.assertEqual(text, actual)
@mock.patch('smart_open.s3.Reader')
def test_transport_params_is_not_mutable(self, mock_open):
smart_open.open('s3://access_key:secret_key@host@bucket/key')
actual = mock_open.call_args_list[0][1]['client_kwargs']
expected = {
'S3.Client': {
'aws_access_key_id': 'access_key',
'aws_secret_access_key': 'secret_key',
'endpoint_url': 'https://host:443',
}
}
assert actual == expected
smart_open.open('s3://bucket/key')
actual = mock_open.call_args_list[1][1].get('client_kwargs')
assert actual is None
@mock.patch('smart_open.s3.Reader')
def test_respects_endpoint_url_read(self, mock_open):
url = 's3://key_id:secret_key@play.min.io:9000@smart-open-test/README.rst'
smart_open.open(url)
expected = {
'aws_access_key_id': 'key_id',
'aws_secret_access_key': 'secret_key',
'endpoint_url': 'https://play.min.io:9000',
}
self.assertEqual(mock_open.call_args[1]['client_kwargs']['S3.Client'], expected)
@mock.patch('smart_open.s3.MultipartWriter')
def test_respects_endpoint_url_write(self, mock_open):
url = 's3://key_id:secret_key@play.min.io:9000@smart-open-test/README.rst'
smart_open.open(url, 'wb')
expected = {
'aws_access_key_id': 'key_id',
'aws_secret_access_key': 'secret_key',
'endpoint_url': 'https://play.min.io:9000',
}
self.assertEqual(mock_open.call_args[1]['client_kwargs']['S3.Client'], expected)
def function(a, b, c, foo='bar', baz='boz'):
pass
class CheckKwargsTest(unittest.TestCase):
def test(self):
kwargs = {'foo': 123, 'bad': False}
expected = {'foo': 123}
actual = smart_open.smart_open_lib._check_kwargs(function, kwargs)
self.assertEqual(expected, actual)
def initialize_bucket():
s3 = _resource("s3")
bucket = s3.create_bucket(Bucket="bucket")
bucket.wait_until_exists()
bucket.Object('gzipped').put(Body=gzip_compress(_DECOMPRESSED_DATA))
bucket.Object('bzipped').put(Body=bz2.compress(_DECOMPRESSED_DATA))
@mock_s3
@mock.patch('time.time', _MOCK_TIME)
def test_s3_gzip_compress_sanity():
"""Does our gzip_compress function actually produce gzipped data?"""
initialize_bucket()
assert gzip.decompress(gzip_compress(_DECOMPRESSED_DATA)) == _DECOMPRESSED_DATA
@mock_s3
@mock.patch('time.time', _MOCK_TIME)
@pytest.mark.parametrize(
"url,_compression",
[
("s3://bucket/gzipped", ".gz"),
("s3://bucket/bzipped", ".bz2"),
]
)
def test_s3_read_explicit(url, _compression):
"""Can we read using the explicitly specified compression?"""
initialize_bucket()
with smart_open.open(url, 'rb', compression=_compression) as fin:
assert fin.read() == _DECOMPRESSED_DATA
@mock_s3
@mock.patch('time.time', _MOCK_TIME)
@pytest.mark.parametrize(
"_compression,expected",
[
(".gz", gzip_compress(_DECOMPRESSED_DATA, 'key')),
(".bz2", bz2.compress(_DECOMPRESSED_DATA)),
],
)
def test_s3_write_explicit(_compression, expected):
"""Can we write using the explicitly specified compression?"""
initialize_bucket()
with smart_open.open("s3://bucket/key", "wb", compression=_compression) as fout:
fout.write(_DECOMPRESSED_DATA)
with smart_open.open("s3://bucket/key", "rb", compression=NO_COMPRESSION) as fin:
assert fin.read() == expected
@mock_s3
@mock.patch('time.time', _MOCK_TIME)
@pytest.mark.parametrize(
"url,_compression,expected",
[
("s3://bucket/key.gz", ".gz", gzip_compress(_DECOMPRESSED_DATA, 'key.gz')),
("s3://bucket/key.bz2", ".bz2", bz2.compress(_DECOMPRESSED_DATA)),
],
)
def test_s3_write_implicit(url, _compression, expected):
"""Can we determine the compression from the file extension?"""
initialize_bucket()
with smart_open.open(url, "wb", compression=INFER_FROM_EXTENSION) as fout:
fout.write(_DECOMPRESSED_DATA)
with smart_open.open(url, "rb", compression=NO_COMPRESSION) as fin:
assert fin.read() == expected
@mock_s3
@mock.patch('time.time', _MOCK_TIME)
@pytest.mark.parametrize(
"url,_compression,expected",
[
("s3://bucket/key.gz", ".gz", gzip_compress(_DECOMPRESSED_DATA, 'key.gz')),
("s3://bucket/key.bz2", ".bz2", bz2.compress(_DECOMPRESSED_DATA)),
],
)
def test_s3_disable_compression(url, _compression, expected):
"""Can we handle the compression parameter when reading/writing?"""
initialize_bucket()
with smart_open.open(url, "wb") as fout:
fout.write(_DECOMPRESSED_DATA)
with smart_open.open(url, "rb", compression='disable') as fin:
assert fin.read() == expected
@pytest.mark.parametrize(
'mode,expected',
[
('r', 'rb'),
('r+', 'rb+'),
('rt', 'rb'),
('rt+', 'rb+'),
('r+t', 'rb+'),
('w', 'wb'),
('w+', 'wb+'),
('wt', 'wb'),
('wt+', 'wb+'),
('w+t', 'wb+'),
('a', 'ab'),
('a+', 'ab+'),
('at', 'ab'),
('at+', 'ab+'),
('a+t', 'ab+'),
]
)
def test_get_binary_mode(mode, expected):
actual = smart_open.smart_open_lib._get_binary_mode(mode)
assert actual == expected
@pytest.mark.parametrize(
'mode',
[
('rw', ),
('rwa', ),
('rbt', ),
('r++', ),
('+', ),
('x', ),
]
)
def test_get_binary_mode_bad(mode):
with pytest.raises(ValueError):
smart_open.smart_open_lib._get_binary_mode(mode)
def test_backwards_compatibility_wrapper():
fpath = os.path.join(CURR_DIR, 'test_data/crime-and-punishment.txt')
expected = open(fpath, 'rb').readline()
with warnings.catch_warnings():
warnings.simplefilter('ignore')
actual = smart_open.smart_open(fpath).readline()
assert expected == actual
actual = smart_open.smart_open(fpath, ignore_extension=True).readline()
assert expected == actual
with pytest.raises(DeprecationWarning):
smart_open.smart_open(fpath, unsupported_keyword_param=123)
@pytest.mark.skipif(os.name == "nt", reason="this test does not work on Windows")
def test_read_file_descriptor():
with smart_open.open(__file__) as fin:
expected = fin.read()
fd = os.open(__file__, os.O_RDONLY)
with smart_open.open(fd) as fin:
actual = fin.read()
assert actual == expected
@pytest.mark.skipif(os.name == "nt", reason="this test does not work on Windows")
def test_write_file_descriptor():
with named_temporary_file() as tmp:
with smart_open.open(os.open(tmp.name, os.O_WRONLY), 'wt') as fout:
fout.write("hello world")
with smart_open.open(tmp.name, 'rt') as fin:
assert fin.read() == "hello world"
@mock_s3
def test_to_boto3():
resource = _resource('s3')
resource.create_bucket(Bucket='mybucket')
#
# If we don't specify encoding explicitly, the platform-dependent encoding
# will be used, and it may not necessarily support Unicode, breaking this
# test under Windows on github actions.
#
with smart_open.open('s3://mybucket/key.txt', 'wt', encoding='utf-8') as fout:
fout.write('я бегу по вызженной земле, гермошлем захлопнув на ходу')
obj = fout.to_boto3(resource)
assert obj.bucket_name == 'mybucket'
assert obj.key == 'key.txt'
if __name__ == '__main__':
logging.basicConfig(format='%(asctime)s : %(levelname)s : %(message)s', level=logging.DEBUG)
unittest.main()
|