/usr/share/doc/python-rdflib-doc/html/_modules/rdflib/plugins/parsers/pyRdfa/extras/httpheader.html is in python-rdflib-doc 4.1.2-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>rdflib.plugins.parsers.pyRdfa.extras.httpheader — rdflib 4.1.2 documentation</title>
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"/>
<link rel="stylesheet" href="../../../../../../_static/rtd.css" type="text/css" />
<link rel="stylesheet" href="../../../../../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../../../../',
VERSION: '4.1.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../../../../../../../../../../_static/searchtools.js"></script>
<link rel="top" title="rdflib 4.1.2 documentation" href="../../../../../../index.html" />
<link rel="up" title="rdflib.plugins.parsers.pyRdfa" href="../../pyRdfa.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../../../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../../../../../index.html">rdflib 4.1.2 documentation</a> »</li>
<li><a href="../../../../../index.html" >Module code</a> »</li>
<li><a href="../../pyRdfa.html" accesskey="U">rdflib.plugins.parsers.pyRdfa</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for rdflib.plugins.parsers.pyRdfa.extras.httpheader</h1><div class="highlight"><pre>
<span class="c">#!/usr/bin/env python</span>
<span class="c"># -*- coding: utf-8 -*-</span>
<span class="c">#</span>
<span class="sd">""" Utility functions to work with HTTP headers.</span>
<span class="sd"> This module provides some utility functions useful for parsing</span>
<span class="sd"> and dealing with some of the HTTP 1.1 protocol headers which</span>
<span class="sd"> are not adequately covered by the standard Python libraries.</span>
<span class="sd"> Requires Python 2.2 or later.</span>
<span class="sd"> The functionality includes the correct interpretation of the various</span>
<span class="sd"> Accept-* style headers, content negotiation, byte range requests,</span>
<span class="sd"> HTTP-style date/times, and more.</span>
<span class="sd"> There are a few classes defined by this module:</span>
<span class="sd"> * class content_type -- media types such as 'text/plain'</span>
<span class="sd"> * class language_tag -- language tags such as 'en-US'</span>
<span class="sd"> * class range_set -- a collection of (byte) range specifiers</span>
<span class="sd"> * class range_spec -- a single (byte) range specifier</span>
<span class="sd"> The primary functions in this module may be categorized as follows:</span>
<span class="sd"> * Content negotiation functions...</span>
<span class="sd"> * acceptable_content_type()</span>
<span class="sd"> * acceptable_language()</span>
<span class="sd"> * acceptable_charset()</span>
<span class="sd"> * acceptable_encoding()</span>
<span class="sd"> * Mid-level header parsing functions...</span>
<span class="sd"> * parse_accept_header()</span>
<span class="sd"> * parse_accept_language_header()</span>
<span class="sd"> * parse_range_header()</span>
<span class="sd"> </span>
<span class="sd"> * Date and time...</span>
<span class="sd"> * http_datetime()</span>
<span class="sd"> * parse_http_datetime()</span>
<span class="sd"> * Utility functions...</span>
<span class="sd"> * quote_string()</span>
<span class="sd"> * remove_comments()</span>
<span class="sd"> * canonical_charset()</span>
<span class="sd"> * Low level string parsing functions...</span>
<span class="sd"> * parse_comma_list()</span>
<span class="sd"> * parse_comment()</span>
<span class="sd"> * parse_qvalue_accept_list()</span>
<span class="sd"> * parse_media_type()</span>
<span class="sd"> * parse_number()</span>
<span class="sd"> * parse_parameter_list()</span>
<span class="sd"> * parse_quoted_string()</span>
<span class="sd"> * parse_range_set()</span>
<span class="sd"> * parse_range_spec()</span>
<span class="sd"> * parse_token()</span>
<span class="sd"> * parse_token_or_quoted_string()</span>
<span class="sd"> And there are some specialized exception classes:</span>
<span class="sd"> * RangeUnsatisfiableError</span>
<span class="sd"> * RangeUnmergableError</span>
<span class="sd"> * ParseError</span>
<span class="sd"> See also:</span>
<span class="sd"> * RFC 2616, "Hypertext Transfer Protocol -- HTTP/1.1", June 1999.</span>
<span class="sd"> <http://www.ietf.org/rfc/rfc2616.txt></span>
<span class="sd"> Errata at <http://purl.org/NET/http-errata></span>
<span class="sd"> * RFC 2046, "(MIME) Part Two: Media Types", November 1996.</span>
<span class="sd"> <http://www.ietf.org/rfc/rfc2046.txt></span>
<span class="sd"> * RFC 3066, "Tags for the Identification of Languages", January 2001.</span>
<span class="sd"> <http://www.ietf.org/rfc/rfc3066.txt></span>
<span class="sd"> </span>
<span class="sd"> </span>
<span class="sd"> Note: I have made a small modification on the regexp for internet date, </span>
<span class="sd"> to make it more liberal (ie, accept a time zone string of the form +0000)</span>
<span class="sd"> Ivan Herman <http://www.ivan-herman.net>, March 2011.</span>
<span class="sd"> </span>
<span class="sd"> Have added statements to make it (hopefully) Python 3 compatible.</span>
<span class="sd"> Ivan Herman <http://www.ivan-herman.net>, August 2012.</span>
<span class="sd">"""</span>
<span class="n">__author__</span> <span class="o">=</span> <span class="s">"Deron Meranda <http://deron.meranda.us/>"</span>
<span class="n">__date__</span> <span class="o">=</span> <span class="s">"2012-08-31"</span>
<span class="n">__version__</span> <span class="o">=</span> <span class="s">"1.02"</span>
<span class="n">__credits__</span> <span class="o">=</span> <span class="s">"""Copyright (c) 2005 Deron E. Meranda <http://deron.meranda.us/></span>
<span class="s">Licensed under GNU LGPL 2.1 or later. See <http://www.fsf.org/>.</span>
<span class="s">This library is free software; you can redistribute it and/or</span>
<span class="s">modify it under the terms of the GNU Lesser General Public</span>
<span class="s">License as published by the Free Software Foundation; either</span>
<span class="s">version 2.1 of the License, or (at your option) any later version.</span>
<span class="s">This library is distributed in the hope that it will be useful,</span>
<span class="s">but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<span class="s">MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<span class="s">Lesser General Public License for more details.</span>
<span class="s">You should have received a copy of the GNU Lesser General Public</span>
<span class="s">License along with this library; if not, write to the Free Software</span>
<span class="s">Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span>
<span class="s">"""</span>
<span class="c"># Character classes from RFC 2616 section 2.2</span>
<span class="n">SEPARATORS</span> <span class="o">=</span> <span class="s">'()<>@,;:</span><span class="se">\\</span><span class="s">"/[]?={} </span><span class="se">\t</span><span class="s">'</span>
<span class="n">LWS</span> <span class="o">=</span> <span class="s">' </span><span class="se">\t\n\r</span><span class="s">'</span> <span class="c"># linear white space</span>
<span class="n">CRLF</span> <span class="o">=</span> <span class="s">'</span><span class="se">\r\n</span><span class="s">'</span>
<span class="n">DIGIT</span> <span class="o">=</span> <span class="s">'0123456789'</span>
<span class="n">HEX</span> <span class="o">=</span> <span class="s">'0123456789ABCDEFabcdef'</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="n">PY3</span> <span class="o">=</span> <span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">>=</span> <span class="mi">3</span><span class="p">)</span>
<span class="c"># Try to get a set/frozenset implementation if possible</span>
<span class="k">try</span><span class="p">:</span>
<span class="nb">type</span><span class="p">(</span><span class="nb">frozenset</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">NameError</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="c"># The demset.py module is available at http://deron.meranda.us/</span>
<span class="kn">from</span> <span class="nn">demset</span> <span class="kn">import</span> <span class="nb">set</span><span class="p">,</span> <span class="nb">frozenset</span>
<span class="n">__emulating_set</span> <span class="o">=</span> <span class="bp">True</span> <span class="c"># So we can clean up global namespace later</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">try</span><span class="p">:</span>
<span class="c"># Turn character classes into set types (for Python 2.4 or greater)</span>
<span class="n">SEPARATORS</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">([</span><span class="n">c</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">SEPARATORS</span><span class="p">])</span>
<span class="n">LWS</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">([</span><span class="n">c</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">LWS</span><span class="p">])</span>
<span class="n">CRLF</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">([</span><span class="n">c</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">CRLF</span><span class="p">])</span>
<span class="n">DIGIT</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">([</span><span class="n">c</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">DIGIT</span><span class="p">])</span>
<span class="n">HEX</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">([</span><span class="n">c</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">HEX</span><span class="p">])</span>
<span class="k">del</span> <span class="n">c</span>
<span class="k">except</span> <span class="ne">NameError</span><span class="p">:</span>
<span class="c"># Python 2.3 or earlier, leave as simple strings</span>
<span class="k">pass</span>
<span class="k">def</span> <span class="nf">_is_string</span><span class="p">(</span> <span class="n">obj</span> <span class="p">):</span>
<span class="sd">"""Returns True if the object is a string or unicode type."""</span>
<span class="k">if</span> <span class="n">PY3</span> <span class="p">:</span>
<span class="k">return</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span><span class="nb">str</span><span class="p">)</span>
<span class="k">else</span> <span class="p">:</span>
<span class="k">return</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span><span class="nb">str</span><span class="p">)</span> <span class="ow">or</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span><span class="nb">unicode</span><span class="p">)</span>
<div class="viewcode-block" id="http_datetime"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.http_datetime">[docs]</a><span class="k">def</span> <span class="nf">http_datetime</span><span class="p">(</span> <span class="n">dt</span><span class="o">=</span><span class="bp">None</span> <span class="p">):</span>
<span class="sd">"""Formats a datetime as an HTTP 1.1 Date/Time string.</span>
<span class="sd"> Takes a standard Python datetime object and returns a string</span>
<span class="sd"> formatted according to the HTTP 1.1 date/time format.</span>
<span class="sd"> If no datetime is provided (or None) then the current</span>
<span class="sd"> time is used.</span>
<span class="sd"> </span>
<span class="sd"> ABOUT TIMEZONES: If the passed in datetime object is naive it is</span>
<span class="sd"> assumed to be in UTC already. But if it has a tzinfo component,</span>
<span class="sd"> the returned timestamp string will have been converted to UTC</span>
<span class="sd"> automatically. So if you use timezone-aware datetimes, you need</span>
<span class="sd"> not worry about conversion to UTC.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">dt</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">datetime</span>
<span class="n">dt</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">utcnow</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">dt</span> <span class="o">=</span> <span class="n">dt</span> <span class="o">-</span> <span class="n">dt</span><span class="o">.</span><span class="n">utcoffset</span><span class="p">()</span>
<span class="k">except</span><span class="p">:</span>
<span class="k">pass</span> <span class="c"># no timezone offset, just assume already in UTC</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">dt</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s">'%a, </span><span class="si">%d</span><span class="s"> %b %Y %H:%M:%S GMT'</span><span class="p">)</span>
<span class="k">return</span> <span class="n">s</span>
</div>
<div class="viewcode-block" id="parse_http_datetime"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.parse_http_datetime">[docs]</a><span class="k">def</span> <span class="nf">parse_http_datetime</span><span class="p">(</span> <span class="n">datestring</span><span class="p">,</span> <span class="n">utc_tzinfo</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">strict</span><span class="o">=</span><span class="bp">False</span> <span class="p">):</span>
<span class="sd">"""Returns a datetime object from an HTTP 1.1 Date/Time string.</span>
<span class="sd"> Note that HTTP dates are always in UTC, so the returned datetime</span>
<span class="sd"> object will also be in UTC.</span>
<span class="sd"> You can optionally pass in a tzinfo object which should represent</span>
<span class="sd"> the UTC timezone, and the returned datetime will then be</span>
<span class="sd"> timezone-aware (allowing you to more easly translate it into</span>
<span class="sd"> different timzeones later).</span>
<span class="sd"> If you set 'strict' to True, then only the RFC 1123 format</span>
<span class="sd"> is recognized. Otherwise the backwards-compatible RFC 1036</span>
<span class="sd"> and Unix asctime(3) formats are also recognized.</span>
<span class="sd"> </span>
<span class="sd"> Please note that the day-of-the-week is not validated.</span>
<span class="sd"> Also two-digit years, although not HTTP 1.1 compliant, are</span>
<span class="sd"> treated according to recommended Y2K rules.</span>
<span class="sd"> """</span>
<span class="kn">import</span> <span class="nn">re</span><span class="o">,</span> <span class="nn">datetime</span>
<span class="n">m</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">r'(?P<DOW>[a-z]+), (?P<D>\d+) (?P<MON>[a-z]+) (?P<Y>\d+) (?P<H>\d+):(?P<M>\d+):(?P<S>\d+(\.\d+)?) (?P<TZ>[a-zA-Z0-9_+]+)$'</span><span class="p">,</span>
<span class="n">datestring</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">IGNORECASE</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">m</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">strict</span><span class="p">:</span>
<span class="n">m</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">r'(?P<DOW>[a-z]+) (?P<MON>[a-z]+) (?P<D>\d+) (?P<H>\d+):(?P<M>\d+):(?P<S>\d+) (?P<Y>\d+)$'</span><span class="p">,</span>
<span class="n">datestring</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">IGNORECASE</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">m</span><span class="p">:</span>
<span class="n">m</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">r'(?P<DOW>[a-z]+), (?P<D>\d+)-(?P<MON>[a-z]+)-(?P<Y>\d+) (?P<H>\d+):(?P<M>\d+):(?P<S>\d+(\.\d+)?) (?P<TZ>\w+)$'</span><span class="p">,</span>
<span class="n">datestring</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">IGNORECASE</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">m</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">'HTTP date is not correctly formatted'</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">tz</span> <span class="o">=</span> <span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s">'TZ'</span><span class="p">)</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
<span class="k">except</span><span class="p">:</span>
<span class="n">tz</span> <span class="o">=</span> <span class="s">'GMT'</span>
<span class="k">if</span> <span class="n">tz</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span><span class="s">'GMT'</span><span class="p">,</span><span class="s">'UTC'</span><span class="p">,</span><span class="s">'0000'</span><span class="p">,</span><span class="s">'00:00'</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">'HTTP date is not in GMT timezone'</span><span class="p">)</span>
<span class="n">monname</span> <span class="o">=</span> <span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s">'MON'</span><span class="p">)</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
<span class="n">mdict</span> <span class="o">=</span> <span class="p">{</span><span class="s">'JAN'</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span> <span class="s">'FEB'</span><span class="p">:</span><span class="mi">2</span><span class="p">,</span> <span class="s">'MAR'</span><span class="p">:</span><span class="mi">3</span><span class="p">,</span> <span class="s">'APR'</span><span class="p">:</span><span class="mi">4</span><span class="p">,</span> <span class="s">'MAY'</span><span class="p">:</span><span class="mi">5</span><span class="p">,</span> <span class="s">'JUN'</span><span class="p">:</span><span class="mi">6</span><span class="p">,</span>
<span class="s">'JUL'</span><span class="p">:</span><span class="mi">7</span><span class="p">,</span> <span class="s">'AUG'</span><span class="p">:</span><span class="mi">8</span><span class="p">,</span> <span class="s">'SEP'</span><span class="p">:</span><span class="mi">9</span><span class="p">,</span> <span class="s">'OCT'</span><span class="p">:</span><span class="mi">10</span><span class="p">,</span> <span class="s">'NOV'</span><span class="p">:</span><span class="mi">11</span><span class="p">,</span> <span class="s">'DEC'</span><span class="p">:</span><span class="mi">12</span><span class="p">}</span>
<span class="n">month</span> <span class="o">=</span> <span class="n">mdict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">monname</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">month</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">'HTTP date has an unrecognizable month'</span><span class="p">)</span>
<span class="n">y</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s">'Y'</span><span class="p">))</span>
<span class="k">if</span> <span class="n">y</span> <span class="o"><</span> <span class="mi">100</span><span class="p">:</span>
<span class="n">century</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">utcnow</span><span class="p">()</span><span class="o">.</span><span class="n">year</span> <span class="o">/</span> <span class="mi">100</span>
<span class="k">if</span> <span class="n">y</span> <span class="o"><</span> <span class="mi">50</span><span class="p">:</span>
<span class="n">y</span> <span class="o">=</span> <span class="n">century</span> <span class="o">*</span> <span class="mi">100</span> <span class="o">+</span> <span class="n">y</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">y</span> <span class="o">=</span> <span class="p">(</span><span class="n">century</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="mi">100</span> <span class="o">+</span> <span class="n">y</span>
<span class="n">d</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s">'D'</span><span class="p">))</span>
<span class="n">hour</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s">'H'</span><span class="p">))</span>
<span class="n">minute</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s">'M'</span><span class="p">))</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">second</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s">'S'</span><span class="p">))</span>
<span class="k">except</span><span class="p">:</span>
<span class="n">second</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s">'S'</span><span class="p">))</span>
<span class="n">dt</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="p">(</span> <span class="n">y</span><span class="p">,</span> <span class="n">month</span><span class="p">,</span> <span class="n">d</span><span class="p">,</span> <span class="n">hour</span><span class="p">,</span> <span class="n">minute</span><span class="p">,</span> <span class="n">second</span><span class="p">,</span> <span class="n">tzinfo</span><span class="o">=</span><span class="n">utc_tzinfo</span> <span class="p">)</span>
<span class="k">return</span> <span class="n">dt</span>
</div>
<div class="viewcode-block" id="RangeUnsatisfiableError"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.RangeUnsatisfiableError">[docs]</a><span class="k">class</span> <span class="nc">RangeUnsatisfiableError</span><span class="p">(</span><span class="ne">ValueError</span><span class="p">):</span>
<span class="sd">"""Exception class when a byte range lies outside the file size boundaries."""</span>
<div class="viewcode-block" id="RangeUnsatisfiableError.__init__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.RangeUnsatisfiableError.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">reason</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">reason</span><span class="p">:</span>
<span class="n">reason</span> <span class="o">=</span> <span class="s">'Range is unsatisfiable'</span>
<span class="ne">ValueError</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">reason</span><span class="p">)</span>
</div></div>
<div class="viewcode-block" id="RangeUnmergableError"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.RangeUnmergableError">[docs]</a><span class="k">class</span> <span class="nc">RangeUnmergableError</span><span class="p">(</span><span class="ne">ValueError</span><span class="p">):</span>
<span class="sd">"""Exception class when byte ranges are noncontiguous and can not be merged together."""</span>
<div class="viewcode-block" id="RangeUnmergableError.__init__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.RangeUnmergableError.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">reason</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">reason</span><span class="p">:</span>
<span class="n">reason</span> <span class="o">=</span> <span class="s">'Ranges can not be merged together'</span>
<span class="ne">ValueError</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">reason</span><span class="p">)</span>
</div></div>
<div class="viewcode-block" id="ParseError"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.ParseError">[docs]</a><span class="k">class</span> <span class="nc">ParseError</span><span class="p">(</span><span class="ne">ValueError</span><span class="p">):</span>
<span class="sd">"""Exception class representing a string parsing error."""</span>
<div class="viewcode-block" id="ParseError.__init__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.ParseError.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">input_string</span><span class="p">,</span> <span class="n">at_position</span><span class="p">):</span>
<span class="ne">ValueError</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">input_string</span> <span class="o">=</span> <span class="n">input_string</span>
<span class="bp">self</span><span class="o">.</span><span class="n">at_position</span> <span class="o">=</span> <span class="n">at_position</span></div>
<div class="viewcode-block" id="ParseError.__str__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.ParseError.__str__">[docs]</a> <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">at_position</span> <span class="o">>=</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">input_string</span><span class="p">):</span>
<span class="k">return</span> <span class="s">'</span><span class="si">%s</span><span class="se">\n\t</span><span class="s">Occured at end of string'</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="s">'</span><span class="si">%s</span><span class="se">\n\t</span><span class="s">Occured near </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">input_string</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">at_position</span><span class="p">:</span><span class="bp">self</span><span class="o">.</span><span class="n">at_position</span><span class="o">+</span><span class="mi">16</span><span class="p">]))</span>
</div></div>
<div class="viewcode-block" id="is_token"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.is_token">[docs]</a><span class="k">def</span> <span class="nf">is_token</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="sd">"""Determines if the string is a valid token."""</span>
<span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">s</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">ord</span><span class="p">(</span><span class="n">c</span><span class="p">)</span> <span class="o"><</span> <span class="mi">32</span> <span class="ow">or</span> <span class="nb">ord</span><span class="p">(</span><span class="n">c</span><span class="p">)</span> <span class="o">></span> <span class="mi">128</span> <span class="ow">or</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">SEPARATORS</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">return</span> <span class="bp">True</span>
</div>
<div class="viewcode-block" id="parse_comma_list"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.parse_comma_list">[docs]</a><span class="k">def</span> <span class="nf">parse_comma_list</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">element_parser</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">min_count</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">max_count</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="sd">"""Parses a comma-separated list with optional whitespace.</span>
<span class="sd"> Takes an optional callback function `element_parser`, which</span>
<span class="sd"> is assumed to be able to parse an individual element. It</span>
<span class="sd"> will be passed the string and a `start` argument, and</span>
<span class="sd"> is expected to return a tuple (parsed_result, chars_consumed).</span>
<span class="sd"> If no element_parser is given, then either single tokens or</span>
<span class="sd"> quoted strings will be parsed.</span>
<span class="sd"> If min_count > 0, then at least that many non-empty elements</span>
<span class="sd"> must be in the list, or an error is raised.</span>
<span class="sd"> If max_count > 0, then no more than that many non-empty elements</span>
<span class="sd"> may be in the list, or an error is raised.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">min_count</span> <span class="o">></span> <span class="mi">0</span> <span class="ow">and</span> <span class="n">start</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Comma-separated list must contain some elements'</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">start</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">start</span> <span class="o">>=</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Starting position is beyond the end of the string'</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">start</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">element_parser</span><span class="p">:</span>
<span class="n">element_parser</span> <span class="o">=</span> <span class="n">parse_token_or_quoted_string</span>
<span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">pos</span> <span class="o">=</span> <span class="n">start</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="n">e</span> <span class="o">=</span> <span class="n">element_parser</span><span class="p">(</span> <span class="n">s</span><span class="p">,</span> <span class="n">pos</span> <span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">e</span> <span class="ow">or</span> <span class="n">e</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">break</span> <span class="c"># end of data?</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span> <span class="n">e</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="p">)</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="n">e</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="ow">in</span> <span class="n">LWS</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="o">!=</span> <span class="s">','</span><span class="p">:</span>
<span class="k">break</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="o">==</span> <span class="s">','</span><span class="p">:</span>
<span class="c"># skip comma and any "empty" elements</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span> <span class="c"># skip comma</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="ow">in</span> <span class="n">LWS</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">results</span><span class="p">)</span> <span class="o"><</span> <span class="n">min_count</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Comma-separated list does not have enough elements'</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">pos</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">max_count</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">results</span><span class="p">)</span> <span class="o">></span> <span class="n">max_count</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Comma-separated list has too many elements'</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">pos</span><span class="p">)</span>
<span class="k">return</span> <span class="p">(</span><span class="n">results</span><span class="p">,</span> <span class="n">pos</span><span class="o">-</span><span class="n">start</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="parse_token"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.parse_token">[docs]</a><span class="k">def</span> <span class="nf">parse_token</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="sd">"""Parses a token.</span>
<span class="sd"> A token is a string defined by RFC 2616 section 2.2 as:</span>
<span class="sd"> token = 1*<any CHAR except CTLs or separators></span>
<span class="sd"> Returns a tuple (token, chars_consumed), or ('',0) if no token</span>
<span class="sd"> starts at the given string position. On a syntax error, a</span>
<span class="sd"> ParseError exception will be raised.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">parse_token_or_quoted_string</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">allow_quoted</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">allow_token</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="quote_string"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.quote_string">[docs]</a><span class="k">def</span> <span class="nf">quote_string</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">always_quote</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
<span class="sd">"""Produces a quoted string according to HTTP 1.1 rules.</span>
<span class="sd"> If always_quote is False and if the string is also a valid token,</span>
<span class="sd"> then this function may return a string without quotes.</span>
<span class="sd"> """</span>
<span class="n">need_quotes</span> <span class="o">=</span> <span class="bp">False</span>
<span class="n">q</span> <span class="o">=</span> <span class="s">''</span>
<span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">s</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">ord</span><span class="p">(</span><span class="n">c</span><span class="p">)</span> <span class="o"><</span> <span class="mi">32</span> <span class="ow">or</span> <span class="nb">ord</span><span class="p">(</span><span class="n">c</span><span class="p">)</span> <span class="o">></span> <span class="mi">127</span> <span class="ow">or</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">SEPARATORS</span><span class="p">:</span>
<span class="n">q</span> <span class="o">+=</span> <span class="s">'</span><span class="se">\\</span><span class="s">'</span> <span class="o">+</span> <span class="n">c</span>
<span class="n">need_quotes</span> <span class="o">=</span> <span class="bp">True</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">q</span> <span class="o">+=</span> <span class="n">c</span>
<span class="k">if</span> <span class="n">need_quotes</span> <span class="ow">or</span> <span class="n">always_quote</span><span class="p">:</span>
<span class="k">return</span> <span class="s">'"'</span> <span class="o">+</span> <span class="n">q</span> <span class="o">+</span> <span class="s">'"'</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">q</span>
</div>
<div class="viewcode-block" id="parse_quoted_string"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.parse_quoted_string">[docs]</a><span class="k">def</span> <span class="nf">parse_quoted_string</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="sd">"""Parses a quoted string.</span>
<span class="sd"> Returns a tuple (string, chars_consumed). The quote marks will</span>
<span class="sd"> have been removed and all \-escapes will have been replaced with</span>
<span class="sd"> the characters they represent.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">parse_token_or_quoted_string</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">allow_quoted</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">allow_token</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="parse_token_or_quoted_string"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.parse_token_or_quoted_string">[docs]</a><span class="k">def</span> <span class="nf">parse_token_or_quoted_string</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">allow_quoted</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">allow_token</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
<span class="sd">"""Parses a token or a quoted-string.</span>
<span class="sd"> 's' is the string to parse, while start is the position within the</span>
<span class="sd"> string where parsing should begin. It will returns a tuple</span>
<span class="sd"> (token, chars_consumed), with all \-escapes and quotation already</span>
<span class="sd"> processed.</span>
<span class="sd"> Syntax is according to BNF rules in RFC 2161 section 2.2,</span>
<span class="sd"> specifically the 'token' and 'quoted-string' declarations.</span>
<span class="sd"> Syntax errors in the input string will result in ParseError</span>
<span class="sd"> being raised.</span>
<span class="sd"> If allow_quoted is False, then only tokens will be parsed instead</span>
<span class="sd"> of either a token or quoted-string.</span>
<span class="sd"> If allow_token is False, then only quoted-strings will be parsed</span>
<span class="sd"> instead of either a token or quoted-string.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">allow_quoted</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">allow_token</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">'Parsing can not continue with options provided'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">start</span> <span class="o">>=</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Starting position is beyond the end of the string'</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">start</span><span class="p">)</span>
<span class="n">has_quote</span> <span class="o">=</span> <span class="p">(</span><span class="n">s</span><span class="p">[</span><span class="n">start</span><span class="p">]</span> <span class="o">==</span> <span class="s">'"'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">has_quote</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">allow_quoted</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'A quoted string was not expected'</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="n">start</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">has_quote</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">allow_token</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Expected a quotation mark'</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="n">start</span><span class="p">)</span>
<span class="n">s2</span> <span class="o">=</span> <span class="s">''</span>
<span class="n">pos</span> <span class="o">=</span> <span class="n">start</span>
<span class="k">if</span> <span class="n">has_quote</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="n">c</span> <span class="o">=</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span>
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s">'</span><span class="se">\\</span><span class="s">'</span> <span class="ow">and</span> <span class="n">has_quote</span><span class="p">:</span>
<span class="c"># Note this is NOT C-style escaping; the character after the \ is</span>
<span class="c"># taken literally.</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">pos</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">"End of string while expecting a character after '</span><span class="se">\\</span><span class="s">'"</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">pos</span><span class="p">)</span>
<span class="n">s2</span> <span class="o">+=</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">elif</span> <span class="n">c</span> <span class="o">==</span> <span class="s">'"'</span> <span class="ow">and</span> <span class="n">has_quote</span><span class="p">:</span>
<span class="k">break</span>
<span class="k">elif</span> <span class="ow">not</span> <span class="n">has_quote</span> <span class="ow">and</span> <span class="p">(</span><span class="n">c</span> <span class="ow">in</span> <span class="n">SEPARATORS</span> <span class="ow">or</span> <span class="nb">ord</span><span class="p">(</span><span class="n">c</span><span class="p">)</span><span class="o"><</span><span class="mi">32</span> <span class="ow">or</span> <span class="nb">ord</span><span class="p">(</span><span class="n">c</span><span class="p">)</span><span class="o">></span><span class="mi">127</span><span class="p">):</span>
<span class="k">break</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">s2</span> <span class="o">+=</span> <span class="n">c</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">has_quote</span><span class="p">:</span>
<span class="c"># Make sure we have a closing quote mark</span>
<span class="k">if</span> <span class="n">pos</span> <span class="o">>=</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">or</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="o">!=</span> <span class="s">'"'</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Quoted string is missing closing quote mark'</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">pos</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">return</span> <span class="n">s2</span><span class="p">,</span> <span class="p">(</span><span class="n">pos</span> <span class="o">-</span> <span class="n">start</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="remove_comments"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.remove_comments">[docs]</a><span class="k">def</span> <span class="nf">remove_comments</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">collapse_spaces</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
<span class="sd">"""Removes any ()-style comments from a string.</span>
<span class="sd"> In HTTP, ()-comments can nest, and this function will correctly</span>
<span class="sd"> deal with that.</span>
<span class="sd"> If 'collapse_spaces' is True, then if there is any whitespace</span>
<span class="sd"> surrounding the comment, it will be replaced with a single space</span>
<span class="sd"> character. Whitespace also collapses across multiple comment</span>
<span class="sd"> sequences, so that "a (b) (c) d" becomes just "a d".</span>
<span class="sd"> Otherwise, if 'collapse_spaces' is False then all whitespace which</span>
<span class="sd"> is outside any comments is left intact as-is.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="s">'('</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">s</span><span class="p">:</span>
<span class="k">return</span> <span class="n">s</span> <span class="c"># simple case</span>
<span class="n">A</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">dostrip</span> <span class="o">=</span> <span class="bp">False</span>
<span class="n">added_comment_space</span> <span class="o">=</span> <span class="bp">False</span>
<span class="n">pos</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">if</span> <span class="n">collapse_spaces</span><span class="p">:</span>
<span class="c"># eat any leading spaces before a comment</span>
<span class="n">i</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s">'('</span><span class="p">)</span>
<span class="k">if</span> <span class="n">i</span> <span class="o">>=</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="n">i</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="ow">in</span> <span class="n">LWS</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">pos</span> <span class="o">!=</span> <span class="n">i</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">dostrip</span> <span class="o">=</span> <span class="bp">True</span>
<span class="n">added_comment_space</span> <span class="o">=</span> <span class="bp">True</span> <span class="c"># lie</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">if</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="o">==</span> <span class="s">'('</span><span class="p">:</span>
<span class="n">cmt</span><span class="p">,</span> <span class="n">k</span> <span class="o">=</span> <span class="n">parse_comment</span><span class="p">(</span> <span class="n">s</span><span class="p">,</span> <span class="n">pos</span> <span class="p">)</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="n">k</span>
<span class="k">if</span> <span class="n">collapse_spaces</span><span class="p">:</span>
<span class="n">dostrip</span> <span class="o">=</span> <span class="bp">True</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">added_comment_space</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">A</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span> <span class="ow">and</span> <span class="n">A</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="ow">and</span> <span class="n">A</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">][</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="ow">in</span> <span class="n">LWS</span><span class="p">:</span>
<span class="c"># previous part ended with whitespace</span>
<span class="n">A</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">=</span> <span class="n">A</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">rstrip</span><span class="p">()</span>
<span class="n">A</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">' '</span><span class="p">)</span> <span class="c"># comment becomes one space</span>
<span class="n">added_comment_space</span> <span class="o">=</span> <span class="bp">True</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">i</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">find</span><span class="p">(</span> <span class="s">'('</span><span class="p">,</span> <span class="n">pos</span> <span class="p">)</span>
<span class="k">if</span> <span class="n">i</span> <span class="o">==</span> <span class="o">-</span><span class="mi">1</span><span class="p">:</span>
<span class="k">if</span> <span class="n">dostrip</span><span class="p">:</span>
<span class="n">text</span> <span class="o">=</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">:]</span><span class="o">.</span><span class="n">lstrip</span><span class="p">()</span>
<span class="k">if</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="ow">in</span> <span class="n">LWS</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">added_comment_space</span><span class="p">:</span>
<span class="n">A</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">' '</span><span class="p">)</span>
<span class="n">added_comment_space</span> <span class="o">=</span> <span class="bp">True</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">text</span> <span class="o">=</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">:]</span>
<span class="k">if</span> <span class="n">text</span><span class="p">:</span>
<span class="n">A</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
<span class="n">dostrip</span> <span class="o">=</span> <span class="bp">False</span>
<span class="n">added_comment_space</span> <span class="o">=</span> <span class="bp">False</span>
<span class="k">break</span> <span class="c"># end of string</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="n">dostrip</span><span class="p">:</span>
<span class="n">text</span> <span class="o">=</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">:</span><span class="n">i</span><span class="p">]</span><span class="o">.</span><span class="n">lstrip</span><span class="p">()</span>
<span class="k">if</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="ow">in</span> <span class="n">LWS</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">added_comment_space</span><span class="p">:</span>
<span class="n">A</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">' '</span><span class="p">)</span>
<span class="n">added_comment_space</span> <span class="o">=</span> <span class="bp">True</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">text</span> <span class="o">=</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">:</span><span class="n">i</span><span class="p">]</span>
<span class="k">if</span> <span class="n">text</span><span class="p">:</span>
<span class="n">A</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
<span class="n">dostrip</span> <span class="o">=</span> <span class="bp">False</span>
<span class="n">added_comment_space</span> <span class="o">=</span> <span class="bp">False</span>
<span class="n">pos</span> <span class="o">=</span> <span class="n">i</span>
<span class="k">if</span> <span class="n">dostrip</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">A</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span> <span class="ow">and</span> <span class="n">A</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="ow">and</span> <span class="n">A</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">][</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="ow">in</span> <span class="n">LWS</span><span class="p">:</span>
<span class="n">A</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">=</span> <span class="n">A</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">rstrip</span><span class="p">()</span>
<span class="k">return</span> <span class="s">''</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">A</span><span class="p">)</span>
</div>
<span class="k">def</span> <span class="nf">_test_comments</span><span class="p">():</span>
<span class="sd">"""A self-test on comment processing. Returns number of test failures."""</span>
<span class="k">def</span> <span class="nf">_testrm</span><span class="p">(</span> <span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">collapse</span> <span class="p">):</span>
<span class="n">b2</span> <span class="o">=</span> <span class="n">remove_comments</span><span class="p">(</span> <span class="n">a</span><span class="p">,</span> <span class="n">collapse</span> <span class="p">)</span>
<span class="k">if</span> <span class="n">b</span> <span class="o">!=</span> <span class="n">b2</span><span class="p">:</span>
<span class="k">print</span><span class="p">(</span> <span class="s">'Comment test failed:'</span> <span class="p">)</span>
<span class="k">print</span><span class="p">(</span> <span class="s">' remove_comments( </span><span class="si">%s</span><span class="s">, collapse_spaces=</span><span class="si">%s</span><span class="s"> ) -> </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="n">a</span><span class="p">),</span> <span class="nb">repr</span><span class="p">(</span><span class="n">collapse</span><span class="p">),</span> <span class="nb">repr</span><span class="p">(</span><span class="n">b2</span><span class="p">))</span> <span class="p">)</span>
<span class="k">print</span><span class="p">(</span> <span class="s">' expected </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="nb">repr</span><span class="p">(</span><span class="n">b</span><span class="p">)</span> <span class="p">)</span>
<span class="k">return</span> <span class="mi">1</span>
<span class="k">return</span> <span class="mi">0</span>
<span class="n">failures</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">failures</span> <span class="o">+=</span> <span class="n">_testrm</span><span class="p">(</span> <span class="s">r''</span><span class="p">,</span> <span class="s">''</span><span class="p">,</span> <span class="bp">False</span> <span class="p">)</span>
<span class="n">failures</span> <span class="o">+=</span> <span class="n">_testrm</span><span class="p">(</span> <span class="s">r'(hello)'</span><span class="p">,</span> <span class="s">''</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
<span class="n">failures</span> <span class="o">+=</span> <span class="n">_testrm</span><span class="p">(</span> <span class="s">r'abc (hello) def'</span><span class="p">,</span> <span class="s">'abc def'</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
<span class="n">failures</span> <span class="o">+=</span> <span class="n">_testrm</span><span class="p">(</span> <span class="s">r'abc (he(xyz)llo) def'</span><span class="p">,</span> <span class="s">'abc def'</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
<span class="n">failures</span> <span class="o">+=</span> <span class="n">_testrm</span><span class="p">(</span> <span class="s">r'abc (he\(xyz)llo) def'</span><span class="p">,</span> <span class="s">'abc llo) def'</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
<span class="n">failures</span> <span class="o">+=</span> <span class="n">_testrm</span><span class="p">(</span> <span class="s">r'abc(hello)def'</span><span class="p">,</span> <span class="s">'abcdef'</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span>
<span class="n">failures</span> <span class="o">+=</span> <span class="n">_testrm</span><span class="p">(</span> <span class="s">r'abc (hello) def'</span><span class="p">,</span> <span class="s">'abc def'</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span>
<span class="n">failures</span> <span class="o">+=</span> <span class="n">_testrm</span><span class="p">(</span> <span class="s">r'abc (hello)def'</span><span class="p">,</span> <span class="s">'abc def'</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span>
<span class="n">failures</span> <span class="o">+=</span> <span class="n">_testrm</span><span class="p">(</span> <span class="s">r'abc(hello) def'</span><span class="p">,</span> <span class="s">'abc def'</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span>
<span class="n">failures</span> <span class="o">+=</span> <span class="n">_testrm</span><span class="p">(</span> <span class="s">r'abc(hello) (world)def'</span><span class="p">,</span> <span class="s">'abc def'</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span>
<span class="n">failures</span> <span class="o">+=</span> <span class="n">_testrm</span><span class="p">(</span> <span class="s">r'abc(hello)(world)def'</span><span class="p">,</span> <span class="s">'abcdef'</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span>
<span class="n">failures</span> <span class="o">+=</span> <span class="n">_testrm</span><span class="p">(</span> <span class="s">r' (hello) (world) def'</span><span class="p">,</span> <span class="s">'def'</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span>
<span class="n">failures</span> <span class="o">+=</span> <span class="n">_testrm</span><span class="p">(</span> <span class="s">r'abc (hello) (world) '</span><span class="p">,</span> <span class="s">'abc'</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span>
<span class="k">return</span> <span class="n">failures</span>
<div class="viewcode-block" id="parse_comment"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.parse_comment">[docs]</a><span class="k">def</span> <span class="nf">parse_comment</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="sd">"""Parses a ()-style comment from a header value.</span>
<span class="sd"> Returns tuple (comment, chars_consumed), where the comment will</span>
<span class="sd"> have had the outer-most parentheses and white space stripped. Any</span>
<span class="sd"> nested comments will still have their parentheses and whitespace</span>
<span class="sd"> left intact.</span>
<span class="sd"> All \-escaped quoted pairs will have been replaced with the actual</span>
<span class="sd"> characters they represent, even within the inner nested comments.</span>
<span class="sd"> You should note that only a few HTTP headers, such as User-Agent</span>
<span class="sd"> or Via, allow ()-style comments within the header value.</span>
<span class="sd"> A comment is defined by RFC 2616 section 2.2 as:</span>
<span class="sd"> </span>
<span class="sd"> comment = "(" *( ctext | quoted-pair | comment ) ")"</span>
<span class="sd"> ctext = <any TEXT excluding "(" and ")"></span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">start</span> <span class="o">>=</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Starting position is beyond the end of the string'</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">start</span><span class="p">)</span>
<span class="k">if</span> <span class="n">s</span><span class="p">[</span><span class="n">start</span><span class="p">]</span> <span class="o">!=</span> <span class="s">'('</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Comment must begin with opening parenthesis'</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">start</span><span class="p">)</span>
<span class="n">s2</span> <span class="o">=</span> <span class="s">''</span>
<span class="n">nestlevel</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">pos</span> <span class="o">=</span> <span class="n">start</span> <span class="o">+</span> <span class="mi">1</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="ow">in</span> <span class="n">LWS</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="n">c</span> <span class="o">=</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span>
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s">'</span><span class="se">\\</span><span class="s">'</span><span class="p">:</span>
<span class="c"># Note this is not C-style escaping; the character after the \ is</span>
<span class="c"># taken literally.</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">pos</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">"End of string while expecting a character after '</span><span class="se">\\</span><span class="s">'"</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">pos</span><span class="p">)</span>
<span class="n">s2</span> <span class="o">+=</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">elif</span> <span class="n">c</span> <span class="o">==</span> <span class="s">'('</span><span class="p">:</span>
<span class="n">nestlevel</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="n">s2</span> <span class="o">+=</span> <span class="n">c</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">elif</span> <span class="n">c</span> <span class="o">==</span> <span class="s">')'</span><span class="p">:</span>
<span class="n">nestlevel</span> <span class="o">-=</span> <span class="mi">1</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">nestlevel</span> <span class="o">>=</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">s2</span> <span class="o">+=</span> <span class="n">c</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">break</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">s2</span> <span class="o">+=</span> <span class="n">c</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">nestlevel</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'End of string reached before comment was closed'</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">pos</span><span class="p">)</span>
<span class="c"># Now rstrip s2 of all LWS chars.</span>
<span class="k">while</span> <span class="nb">len</span><span class="p">(</span><span class="n">s2</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s2</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="ow">in</span> <span class="n">LWS</span><span class="p">:</span>
<span class="n">s2</span> <span class="o">=</span> <span class="n">s2</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="k">return</span> <span class="n">s2</span><span class="p">,</span> <span class="p">(</span><span class="n">pos</span> <span class="o">-</span> <span class="n">start</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="range_spec"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_spec">[docs]</a><span class="k">class</span> <span class="nc">range_spec</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""A single contiguous (byte) range.</span>
<span class="sd"> A range_spec defines a range (of bytes) by specifying two offsets,</span>
<span class="sd"> the 'first' and 'last', which are inclusive in the range. Offsets</span>
<span class="sd"> are zero-based (the first byte is offset 0). The range can not be</span>
<span class="sd"> empty or negative (has to satisfy first <= last).</span>
<span class="sd"> The range can be unbounded on either end, represented here by the</span>
<span class="sd"> None value, with these semantics:</span>
<span class="sd"> * A 'last' of None always indicates the last possible byte</span>
<span class="sd"> (although that offset may not be known).</span>
<span class="sd"> * A 'first' of None indicates this is a suffix range, where</span>
<span class="sd"> the last value is actually interpreted to be the number</span>
<span class="sd"> of bytes at the end of the file (regardless of file size).</span>
<span class="sd"> Note that it is not valid for both first and last to be None.</span>
<span class="sd"> """</span>
<span class="n">__slots__</span> <span class="o">=</span> <span class="p">[</span><span class="s">'first'</span><span class="p">,</span><span class="s">'last'</span><span class="p">]</span>
<div class="viewcode-block" id="range_spec.__init__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_spec.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">first</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">last</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span> <span class="n">first</span><span class="p">,</span> <span class="n">last</span> <span class="p">)</span>
</div>
<div class="viewcode-block" id="range_spec.set"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_spec.set">[docs]</a> <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">first</span><span class="p">,</span> <span class="n">last</span><span class="p">):</span>
<span class="sd">"""Sets the value of this range given the first and last offsets.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">first</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="ow">and</span> <span class="n">last</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="ow">and</span> <span class="n">first</span> <span class="o">></span> <span class="n">last</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Byte range does not satisfy first <= last."</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">first</span> <span class="ow">is</span> <span class="bp">None</span> <span class="ow">and</span> <span class="n">last</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Byte range can not omit both first and last offsets."</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">first</span> <span class="o">=</span> <span class="n">first</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last</span> <span class="o">=</span> <span class="n">last</span>
</div>
<div class="viewcode-block" id="range_spec.__repr__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_spec.__repr__">[docs]</a> <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="s">'</span><span class="si">%s</span><span class="s">.</span><span class="si">%s</span><span class="s">(</span><span class="si">%s</span><span class="s">,</span><span class="si">%s</span><span class="s">)'</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__module__</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">first</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">last</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="range_spec.__str__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_spec.__str__">[docs]</a> <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Returns a string form of the range as would appear in a Range: header."""</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">first</span> <span class="ow">is</span> <span class="bp">None</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">last</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">return</span> <span class="s">''</span>
<span class="n">s</span> <span class="o">=</span> <span class="s">''</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">first</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">s</span> <span class="o">+=</span> <span class="s">'</span><span class="si">%d</span><span class="s">'</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">first</span>
<span class="n">s</span> <span class="o">+=</span> <span class="s">'-'</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">last</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">s</span> <span class="o">+=</span> <span class="s">'</span><span class="si">%d</span><span class="s">'</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">last</span>
<span class="k">return</span> <span class="n">s</span>
</div>
<div class="viewcode-block" id="range_spec.__eq__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_spec.__eq__">[docs]</a> <span class="k">def</span> <span class="nf">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="sd">"""Compare ranges for equality.</span>
<span class="sd"> Note that if non-specific ranges are involved (such as 34- and -5),</span>
<span class="sd"> they could compare as not equal even though they may represent</span>
<span class="sd"> the same set of bytes in some contexts.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">first</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">first</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">last</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">last</span>
</div>
<div class="viewcode-block" id="range_spec.__ne__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_spec.__ne__">[docs]</a> <span class="k">def</span> <span class="nf">__ne__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="sd">"""Compare ranges for inequality.</span>
<span class="sd"> Note that if non-specific ranges are involved (such as 34- and -5),</span>
<span class="sd"> they could compare as not equal even though they may represent</span>
<span class="sd"> the same set of bytes in some contexts.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">__eq__</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="range_spec.__lt__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_spec.__lt__">[docs]</a> <span class="k">def</span> <span class="nf">__lt__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="sd">"""< operator is not defined"""</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s">'Ranges can not be relationally compared'</span><span class="p">)</span></div>
<div class="viewcode-block" id="range_spec.__le__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_spec.__le__">[docs]</a> <span class="k">def</span> <span class="nf">__le__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="sd">"""<= operator is not defined"""</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s">'Ranges can not be ralationally compared'</span><span class="p">)</span></div>
<div class="viewcode-block" id="range_spec.__gt__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_spec.__gt__">[docs]</a> <span class="k">def</span> <span class="nf">__gt__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="sd">"""> operator is not defined"""</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s">'Ranges can not be relationally compared'</span><span class="p">)</span></div>
<div class="viewcode-block" id="range_spec.__ge__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_spec.__ge__">[docs]</a> <span class="k">def</span> <span class="nf">__ge__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="sd">""">= operator is not defined"""</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s">'Ranges can not be relationally compared'</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="range_spec.copy"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_spec.copy">[docs]</a> <span class="k">def</span> <span class="nf">copy</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Makes a copy of this range object."""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">first</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">last</span> <span class="p">)</span>
</div>
<div class="viewcode-block" id="range_spec.is_suffix"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_spec.is_suffix">[docs]</a> <span class="k">def</span> <span class="nf">is_suffix</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Returns True if this is a suffix range.</span>
<span class="sd"> A suffix range is one that specifies the last N bytes of a</span>
<span class="sd"> file regardless of file size.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">first</span> <span class="o">==</span> <span class="bp">None</span>
</div>
<div class="viewcode-block" id="range_spec.is_fixed"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_spec.is_fixed">[docs]</a> <span class="k">def</span> <span class="nf">is_fixed</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Returns True if this range is absolute and a fixed size.</span>
<span class="sd"> This occurs only if neither first or last is None. Converse</span>
<span class="sd"> is the is_unbounded() method.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">first</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="ow">and</span> <span class="n">last</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span>
</div>
<div class="viewcode-block" id="range_spec.is_unbounded"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_spec.is_unbounded">[docs]</a> <span class="k">def</span> <span class="nf">is_unbounded</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Returns True if the number of bytes in the range is unspecified.</span>
<span class="sd"> This can only occur if either the 'first' or the 'last' member</span>
<span class="sd"> is None. Converse is the is_fixed() method.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">first</span> <span class="ow">is</span> <span class="bp">None</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">last</span> <span class="ow">is</span> <span class="bp">None</span>
</div>
<div class="viewcode-block" id="range_spec.is_whole_file"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_spec.is_whole_file">[docs]</a> <span class="k">def</span> <span class="nf">is_whole_file</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Returns True if this range includes all possible bytes.</span>
<span class="sd"> This can only occur if the 'last' member is None and the first</span>
<span class="sd"> member is 0.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">first</span> <span class="o">==</span> <span class="mi">0</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">last</span> <span class="ow">is</span> <span class="bp">None</span>
</div>
<div class="viewcode-block" id="range_spec.__contains__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_spec.__contains__">[docs]</a> <span class="k">def</span> <span class="nf">__contains__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">offset</span><span class="p">):</span>
<span class="sd">"""Does this byte range contain the given byte offset?</span>
<span class="sd"> If the offset < 0, then it is taken as an offset from the end</span>
<span class="sd"> of the file, where -1 is the last byte. This type of offset</span>
<span class="sd"> will only work with suffix ranges.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">offset</span> <span class="o"><</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">first</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">last</span> <span class="o">>=</span> <span class="o">-</span><span class="n">offset</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">first</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">last</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">True</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">first</span> <span class="o"><=</span> <span class="n">offset</span> <span class="o"><=</span> <span class="bp">self</span><span class="o">.</span><span class="n">last</span>
</div>
<div class="viewcode-block" id="range_spec.fix_to_size"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_spec.fix_to_size">[docs]</a> <span class="k">def</span> <span class="nf">fix_to_size</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">size</span><span class="p">):</span>
<span class="sd">"""Changes a length-relative range to an absolute range based upon given file size.</span>
<span class="sd"> Ranges that are already absolute are left as is.</span>
<span class="sd"> Note that zero-length files are handled as special cases,</span>
<span class="sd"> since the only way possible to specify a zero-length range is</span>
<span class="sd"> with the suffix range "-0". Thus unless this range is a suffix</span>
<span class="sd"> range, it can not satisfy a zero-length file.</span>
<span class="sd"> If the resulting range (partly) lies outside the file size then an</span>
<span class="sd"> error is raised.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">size</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">first</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">return</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">RangeUnsatisfiableError</span><span class="p">(</span><span class="s">"Range can satisfy a zero-length file."</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">first</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="c"># A suffix range</span>
<span class="bp">self</span><span class="o">.</span><span class="n">first</span> <span class="o">=</span> <span class="n">size</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">last</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">first</span> <span class="o"><</span> <span class="mi">0</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">first</span> <span class="o">=</span> <span class="mi">0</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last</span> <span class="o">=</span> <span class="n">size</span> <span class="o">-</span> <span class="mi">1</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">first</span> <span class="o">></span> <span class="n">size</span> <span class="o">-</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">RangeUnsatisfiableError</span><span class="p">(</span><span class="s">'Range begins beyond the file size.'</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">last</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="c"># An unbounded range</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last</span> <span class="o">=</span> <span class="n">size</span> <span class="o">-</span> <span class="mi">1</span>
<span class="k">return</span>
</div>
<div class="viewcode-block" id="range_spec.merge_with"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_spec.merge_with">[docs]</a> <span class="k">def</span> <span class="nf">merge_with</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="sd">"""Tries to merge the given range into this one.</span>
<span class="sd"> The size of this range may be enlarged as a result.</span>
<span class="sd"> An error is raised if the two ranges do not overlap or are not</span>
<span class="sd"> contiguous with each other.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_whole_file</span><span class="p">()</span> <span class="ow">or</span> <span class="bp">self</span> <span class="o">==</span> <span class="n">other</span><span class="p">:</span>
<span class="k">return</span>
<span class="k">elif</span> <span class="n">other</span><span class="o">.</span><span class="n">is_whole_file</span><span class="p">():</span>
<span class="bp">self</span><span class="o">.</span><span class="n">first</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">last</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="bp">None</span>
<span class="k">return</span>
<span class="n">a1</span><span class="p">,</span> <span class="n">z1</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">first</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">last</span>
<span class="n">a2</span><span class="p">,</span> <span class="n">z2</span> <span class="o">=</span> <span class="n">other</span><span class="o">.</span><span class="n">first</span><span class="p">,</span> <span class="n">other</span><span class="o">.</span><span class="n">last</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_suffix</span><span class="p">():</span>
<span class="k">if</span> <span class="n">z1</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> <span class="c"># self is zero-length, so merge becomes a copy</span>
<span class="bp">self</span><span class="o">.</span><span class="n">first</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">last</span> <span class="o">=</span> <span class="n">a2</span><span class="p">,</span> <span class="n">z2</span>
<span class="k">return</span>
<span class="k">elif</span> <span class="n">other</span><span class="o">.</span><span class="n">is_suffix</span><span class="p">():</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="n">z1</span><span class="p">,</span> <span class="n">z2</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">RangeUnmergableError</span><span class="p">()</span>
<span class="k">elif</span> <span class="n">other</span><span class="o">.</span><span class="n">is_suffix</span><span class="p">():</span>
<span class="k">if</span> <span class="n">z2</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> <span class="c"># other is zero-length, so nothing to merge</span>
<span class="k">return</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">RangeUnmergableError</span><span class="p">()</span>
<span class="k">assert</span> <span class="n">a1</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="ow">and</span> <span class="n">a2</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span>
<span class="k">if</span> <span class="n">a2</span> <span class="o"><</span> <span class="n">a1</span><span class="p">:</span>
<span class="c"># swap ranges so a1 <= a2</span>
<span class="n">a1</span><span class="p">,</span> <span class="n">z1</span><span class="p">,</span> <span class="n">a2</span><span class="p">,</span> <span class="n">z2</span> <span class="o">=</span> <span class="n">a2</span><span class="p">,</span> <span class="n">z2</span><span class="p">,</span> <span class="n">a1</span><span class="p">,</span> <span class="n">z1</span>
<span class="k">assert</span> <span class="n">a1</span> <span class="o"><=</span> <span class="n">a2</span>
<span class="k">if</span> <span class="n">z1</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">if</span> <span class="n">z2</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="ow">and</span> <span class="n">z2</span> <span class="o">+</span> <span class="mi">1</span> <span class="o"><</span> <span class="n">a1</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">RangeUnmergableError</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">first</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">a1</span><span class="p">,</span> <span class="n">a2</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">elif</span> <span class="n">z2</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">if</span> <span class="n">z1</span> <span class="o">+</span> <span class="mi">1</span> <span class="o"><</span> <span class="n">a2</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">RangeUnmergableError</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">first</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">a1</span><span class="p">,</span> <span class="n">a2</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="n">a2</span> <span class="o">></span> <span class="n">z1</span> <span class="o">+</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">RangeUnmergableError</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">first</span> <span class="o">=</span> <span class="n">a1</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="n">z1</span><span class="p">,</span> <span class="n">z2</span><span class="p">)</span>
<span class="k">return</span>
</div></div>
<div class="viewcode-block" id="range_set"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_set">[docs]</a><span class="k">class</span> <span class="nc">range_set</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""A collection of range_specs, with units (e.g., bytes).</span>
<span class="sd"> """</span>
<span class="n">__slots__</span> <span class="o">=</span> <span class="p">[</span><span class="s">'units'</span><span class="p">,</span> <span class="s">'range_specs'</span><span class="p">]</span>
<div class="viewcode-block" id="range_set.__init__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_set.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">units</span> <span class="o">=</span> <span class="s">'bytes'</span>
<span class="bp">self</span><span class="o">.</span><span class="n">range_specs</span> <span class="o">=</span> <span class="p">[]</span> <span class="c"># a list of range_spec objects</span>
</div>
<div class="viewcode-block" id="range_set.__str__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_set.__str__">[docs]</a> <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">units</span> <span class="o">+</span> <span class="s">'='</span> <span class="o">+</span> <span class="s">', '</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="nb">str</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">range_specs</span><span class="p">])</span>
</div>
<div class="viewcode-block" id="range_set.__repr__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_set.__repr__">[docs]</a> <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="s">'</span><span class="si">%s</span><span class="s">.</span><span class="si">%s</span><span class="s">(</span><span class="si">%s</span><span class="s">)'</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__module__</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span>
<span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__str__</span><span class="p">())</span> <span class="p">)</span>
</div>
<div class="viewcode-block" id="range_set.from_str"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_set.from_str">[docs]</a> <span class="k">def</span> <span class="nf">from_str</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="n">valid_units</span><span class="o">=</span><span class="p">(</span><span class="s">'bytes'</span><span class="p">,</span><span class="s">'none'</span><span class="p">)):</span>
<span class="sd">"""Sets this range set based upon a string, such as the Range: header.</span>
<span class="sd"> You can also use the parse_range_set() function for more control.</span>
<span class="sd"> If a parsing error occurs, the pre-exising value of this range</span>
<span class="sd"> set is left unchanged.</span>
<span class="sd"> """</span>
<span class="n">r</span><span class="p">,</span> <span class="n">k</span> <span class="o">=</span> <span class="n">parse_range_set</span><span class="p">(</span> <span class="n">s</span><span class="p">,</span> <span class="n">valid_units</span><span class="o">=</span><span class="n">valid_units</span> <span class="p">)</span>
<span class="k">if</span> <span class="n">k</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">"Extra unparsable characters in range set specifier"</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">k</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">units</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">units</span>
<span class="bp">self</span><span class="o">.</span><span class="n">range_specs</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">range_specs</span>
</div>
<div class="viewcode-block" id="range_set.is_single_range"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_set.is_single_range">[docs]</a> <span class="k">def</span> <span class="nf">is_single_range</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Does this range specifier consist of only a single range set?"""</span>
<span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">range_specs</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span>
</div>
<div class="viewcode-block" id="range_set.is_contiguous"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_set.is_contiguous">[docs]</a> <span class="k">def</span> <span class="nf">is_contiguous</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Can the collection of range_specs be coalesced into a single contiguous range?"""</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">range_specs</span><span class="p">)</span> <span class="o"><=</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">True</span>
<span class="n">merged</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">range_specs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">range_specs</span><span class="p">[</span><span class="mi">1</span><span class="p">:]:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">merged</span><span class="o">.</span><span class="n">merge_with</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="k">except</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">return</span> <span class="bp">True</span>
</div>
<div class="viewcode-block" id="range_set.fix_to_size"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_set.fix_to_size">[docs]</a> <span class="k">def</span> <span class="nf">fix_to_size</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">size</span><span class="p">):</span>
<span class="sd">"""Changes all length-relative range_specs to absolute range_specs based upon given file size.</span>
<span class="sd"> If none of the range_specs in this set can be satisfied, then the</span>
<span class="sd"> entire set is considered unsatifiable and an error is raised.</span>
<span class="sd"> Otherwise any unsatisfiable range_specs will simply be removed</span>
<span class="sd"> from this set.</span>
<span class="sd"> """</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">range_specs</span><span class="p">)):</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">range_specs</span><span class="p">[</span><span class="n">i</span><span class="p">]</span><span class="o">.</span><span class="n">fix_to_size</span><span class="p">(</span> <span class="n">size</span> <span class="p">)</span>
<span class="k">except</span> <span class="n">RangeUnsatisfiableError</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">range_specs</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">range_specs</span> <span class="o">=</span> <span class="p">[</span><span class="n">s</span> <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">range_specs</span> <span class="k">if</span> <span class="n">s</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">]</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">range_specs</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">RangeUnsatisfiableError</span><span class="p">(</span><span class="s">'No ranges can be satisfied'</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="range_set.coalesce"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.range_set.coalesce">[docs]</a> <span class="k">def</span> <span class="nf">coalesce</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Collapses all consecutive range_specs which together define a contiguous range.</span>
<span class="sd"> Note though that this method will not re-sort the range_specs, so a</span>
<span class="sd"> potentially contiguous range may not be collapsed if they are</span>
<span class="sd"> not sorted. For example the ranges:</span>
<span class="sd"> 10-20, 30-40, 20-30</span>
<span class="sd"> will not be collapsed to just 10-40. However if the ranges are</span>
<span class="sd"> sorted first as with:</span>
<span class="sd"> 10-20, 20-30, 30-40</span>
<span class="sd"> then they will collapse to 10-40.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">range_specs</span><span class="p">)</span> <span class="o"><=</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">return</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">range_specs</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">):</span>
<span class="n">a</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">range_specs</span><span class="p">[</span><span class="n">i</span><span class="p">]</span>
<span class="n">b</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">range_specs</span><span class="p">[</span><span class="n">i</span><span class="o">+</span><span class="mi">1</span><span class="p">]</span>
<span class="k">if</span> <span class="n">a</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">a</span><span class="o">.</span><span class="n">merge_with</span><span class="p">(</span> <span class="n">b</span> <span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">range_specs</span><span class="p">[</span><span class="n">i</span><span class="o">+</span><span class="mi">1</span><span class="p">]</span> <span class="o">=</span> <span class="bp">None</span> <span class="c"># to be deleted later</span>
<span class="k">except</span> <span class="n">RangeUnmergableError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="bp">self</span><span class="o">.</span><span class="n">range_specs</span> <span class="o">=</span> <span class="p">[</span><span class="n">r</span> <span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">range_specs</span> <span class="k">if</span> <span class="n">r</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">]</span>
</div></div>
<div class="viewcode-block" id="parse_number"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.parse_number">[docs]</a><span class="k">def</span> <span class="nf">parse_number</span><span class="p">(</span> <span class="n">s</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">0</span> <span class="p">):</span>
<span class="sd">"""Parses a positive decimal integer number from the string.</span>
<span class="sd"> A tuple is returned (number, chars_consumed). If the</span>
<span class="sd"> string is not a valid decimal number, then (None,0) is returned.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">start</span> <span class="o">>=</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Starting position is beyond the end of the string'</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">start</span><span class="p">)</span>
<span class="k">if</span> <span class="n">s</span><span class="p">[</span><span class="n">start</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">DIGIT</span><span class="p">:</span>
<span class="k">return</span> <span class="p">(</span><span class="bp">None</span><span class="p">,</span><span class="mi">0</span><span class="p">)</span> <span class="c"># not a number</span>
<span class="n">pos</span> <span class="o">=</span> <span class="n">start</span>
<span class="n">n</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="n">c</span> <span class="o">=</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span>
<span class="k">if</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">DIGIT</span><span class="p">:</span>
<span class="n">n</span> <span class="o">*=</span> <span class="mi">10</span>
<span class="n">n</span> <span class="o">+=</span> <span class="nb">ord</span><span class="p">(</span><span class="n">c</span><span class="p">)</span> <span class="o">-</span> <span class="nb">ord</span><span class="p">(</span><span class="s">'0'</span><span class="p">)</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">break</span>
<span class="k">return</span> <span class="n">n</span><span class="p">,</span> <span class="n">pos</span><span class="o">-</span><span class="n">start</span>
</div>
<div class="viewcode-block" id="parse_range_spec"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.parse_range_spec">[docs]</a><span class="k">def</span> <span class="nf">parse_range_spec</span><span class="p">(</span> <span class="n">s</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">0</span> <span class="p">):</span>
<span class="sd">"""Parses a (byte) range_spec.</span>
<span class="sd"> Returns a tuple (range_spec, chars_consumed).</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">start</span> <span class="o">>=</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Starting position is beyond the end of the string'</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">start</span><span class="p">)</span>
<span class="k">if</span> <span class="n">s</span><span class="p">[</span><span class="n">start</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">DIGIT</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">start</span><span class="p">]</span> <span class="o">!=</span> <span class="s">'-'</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">"Invalid range, expected a digit or '-'"</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">start</span><span class="p">)</span>
<span class="n">first</span><span class="p">,</span> <span class="n">last</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span>
<span class="n">pos</span> <span class="o">=</span> <span class="n">start</span>
<span class="n">first</span><span class="p">,</span> <span class="n">k</span> <span class="o">=</span> <span class="n">parse_number</span><span class="p">(</span> <span class="n">s</span><span class="p">,</span> <span class="n">pos</span> <span class="p">)</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="n">k</span>
<span class="k">if</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="o">==</span> <span class="s">'-'</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="n">last</span><span class="p">,</span> <span class="n">k</span> <span class="o">=</span> <span class="n">parse_number</span><span class="p">(</span> <span class="n">s</span><span class="p">,</span> <span class="n">pos</span> <span class="p">)</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="n">k</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">"Byte range must include a '-'"</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">pos</span><span class="p">)</span>
<span class="k">if</span> <span class="n">first</span> <span class="ow">is</span> <span class="bp">None</span> <span class="ow">and</span> <span class="n">last</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Byte range can not omit both first and last indices.'</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">start</span><span class="p">)</span>
<span class="n">R</span> <span class="o">=</span> <span class="n">range_spec</span><span class="p">(</span> <span class="n">first</span><span class="p">,</span> <span class="n">last</span> <span class="p">)</span>
<span class="k">return</span> <span class="n">R</span><span class="p">,</span> <span class="n">pos</span><span class="o">-</span><span class="n">start</span>
</div>
<div class="viewcode-block" id="parse_range_header"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.parse_range_header">[docs]</a><span class="k">def</span> <span class="nf">parse_range_header</span><span class="p">(</span> <span class="n">header_value</span><span class="p">,</span> <span class="n">valid_units</span><span class="o">=</span><span class="p">(</span><span class="s">'bytes'</span><span class="p">,</span><span class="s">'none'</span><span class="p">)</span> <span class="p">):</span>
<span class="sd">"""Parses the value of an HTTP Range: header.</span>
<span class="sd"> The value of the header as a string should be passed in; without</span>
<span class="sd"> the header name itself.</span>
<span class="sd"> Returns a range_set object.</span>
<span class="sd"> """</span>
<span class="n">ranges</span><span class="p">,</span> <span class="n">k</span> <span class="o">=</span> <span class="n">parse_range_set</span><span class="p">(</span> <span class="n">header_value</span><span class="p">,</span> <span class="n">valid_units</span><span class="o">=</span><span class="n">valid_units</span> <span class="p">)</span>
<span class="k">if</span> <span class="n">k</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">header_value</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Range header has unexpected or unparsable characters'</span><span class="p">,</span>
<span class="n">header_value</span><span class="p">,</span> <span class="n">k</span><span class="p">)</span>
<span class="k">return</span> <span class="n">ranges</span>
</div>
<div class="viewcode-block" id="parse_range_set"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.parse_range_set">[docs]</a><span class="k">def</span> <span class="nf">parse_range_set</span><span class="p">(</span> <span class="n">s</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">valid_units</span><span class="o">=</span><span class="p">(</span><span class="s">'bytes'</span><span class="p">,</span><span class="s">'none'</span><span class="p">)</span> <span class="p">):</span>
<span class="sd">"""Parses a (byte) range set specifier.</span>
<span class="sd"> Returns a tuple (range_set, chars_consumed).</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">start</span> <span class="o">>=</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Starting position is beyond the end of the string'</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">start</span><span class="p">)</span>
<span class="n">pos</span> <span class="o">=</span> <span class="n">start</span>
<span class="n">units</span><span class="p">,</span> <span class="n">k</span> <span class="o">=</span> <span class="n">parse_token</span><span class="p">(</span> <span class="n">s</span><span class="p">,</span> <span class="n">pos</span> <span class="p">)</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="n">k</span>
<span class="k">if</span> <span class="n">valid_units</span> <span class="ow">and</span> <span class="n">units</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">valid_units</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Unsupported units type in range specifier'</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">start</span><span class="p">)</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="ow">in</span> <span class="n">LWS</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="o">==</span> <span class="s">'='</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">"Invalid range specifier, expected '='"</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">pos</span><span class="p">)</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="ow">in</span> <span class="n">LWS</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="n">range_specs</span><span class="p">,</span> <span class="n">k</span> <span class="o">=</span> <span class="n">parse_comma_list</span><span class="p">(</span> <span class="n">s</span><span class="p">,</span> <span class="n">pos</span><span class="p">,</span> <span class="n">parse_range_spec</span><span class="p">,</span> <span class="n">min_count</span><span class="o">=</span><span class="mi">1</span> <span class="p">)</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="n">k</span>
<span class="c"># Make sure no trash is at the end of the string</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="ow">in</span> <span class="n">LWS</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Unparsable characters in range set specifier'</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">pos</span><span class="p">)</span>
<span class="n">ranges</span> <span class="o">=</span> <span class="n">range_set</span><span class="p">()</span>
<span class="n">ranges</span><span class="o">.</span><span class="n">units</span> <span class="o">=</span> <span class="n">units</span>
<span class="n">ranges</span><span class="o">.</span><span class="n">range_specs</span> <span class="o">=</span> <span class="n">range_specs</span>
<span class="k">return</span> <span class="n">ranges</span><span class="p">,</span> <span class="n">pos</span><span class="o">-</span><span class="n">start</span>
</div>
<span class="k">def</span> <span class="nf">_split_at_qfactor</span><span class="p">(</span> <span class="n">s</span> <span class="p">):</span>
<span class="sd">"""Splits a string at the quality factor (;q=) parameter.</span>
<span class="sd"> Returns the left and right substrings as a two-member tuple.</span>
<span class="sd"> """</span>
<span class="c"># It may be faster, but incorrect, to use s.split(';q=',1), since</span>
<span class="c"># HTTP allows any amount of linear white space (LWS) to appear</span>
<span class="c"># between the parts, so it could also be "; q = ".</span>
<span class="c"># We do this parsing 'manually' for speed rather than using a</span>
<span class="c"># regex, which would be r';[ \t\r\n]*q[ \t\r\n]*=[ \t\r\n]*'</span>
<span class="n">pos</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">while</span> <span class="mi">0</span> <span class="o"><=</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="n">pos</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s">';'</span><span class="p">,</span> <span class="n">pos</span><span class="p">)</span>
<span class="k">if</span> <span class="n">pos</span> <span class="o"><</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">break</span> <span class="c"># no more parameters</span>
<span class="n">startpos</span> <span class="o">=</span> <span class="n">pos</span>
<span class="n">pos</span> <span class="o">=</span> <span class="n">pos</span> <span class="o">+</span> <span class="mi">1</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="ow">in</span> <span class="n">LWS</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">=</span> <span class="n">pos</span> <span class="o">+</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="o">==</span> <span class="s">'q'</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">=</span> <span class="n">pos</span> <span class="o">+</span> <span class="mi">1</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="ow">in</span> <span class="n">LWS</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">=</span> <span class="n">pos</span> <span class="o">+</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="o">==</span> <span class="s">'='</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">=</span> <span class="n">pos</span> <span class="o">+</span> <span class="mi">1</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="ow">in</span> <span class="n">LWS</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">=</span> <span class="n">pos</span> <span class="o">+</span> <span class="mi">1</span>
<span class="k">return</span> <span class="p">(</span> <span class="n">s</span><span class="p">[:</span><span class="n">startpos</span><span class="p">],</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">:]</span> <span class="p">)</span>
<span class="k">return</span> <span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="s">''</span><span class="p">)</span>
<div class="viewcode-block" id="parse_qvalue_accept_list"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.parse_qvalue_accept_list">[docs]</a><span class="k">def</span> <span class="nf">parse_qvalue_accept_list</span><span class="p">(</span> <span class="n">s</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">item_parser</span><span class="o">=</span><span class="n">parse_token</span> <span class="p">):</span>
<span class="sd">"""Parses any of the Accept-* style headers with quality factors.</span>
<span class="sd"> This is a low-level function. It returns a list of tuples, each like:</span>
<span class="sd"> (item, item_parms, qvalue, accept_parms)</span>
<span class="sd"> You can pass in a function which parses each of the item strings, or</span>
<span class="sd"> accept the default where the items must be simple tokens. Note that</span>
<span class="sd"> your parser should not consume any paramters (past the special "q"</span>
<span class="sd"> paramter anyway).</span>
<span class="sd"> The item_parms and accept_parms are each lists of (name,value) tuples.</span>
<span class="sd"> The qvalue is the quality factor, a number from 0 to 1 inclusive.</span>
<span class="sd"> """</span>
<span class="n">itemlist</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">pos</span> <span class="o">=</span> <span class="n">start</span>
<span class="k">if</span> <span class="n">pos</span> <span class="o">>=</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Starting position is beyond the end of the string'</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">pos</span><span class="p">)</span>
<span class="n">item</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="n">item</span><span class="p">,</span> <span class="n">k</span> <span class="o">=</span> <span class="n">item_parser</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">pos</span><span class="p">)</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="n">k</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="ow">in</span> <span class="n">LWS</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">pos</span> <span class="o">>=</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">or</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="ow">in</span> <span class="s">',;'</span><span class="p">:</span>
<span class="n">itemparms</span><span class="p">,</span> <span class="n">qvalue</span><span class="p">,</span> <span class="n">acptparms</span> <span class="o">=</span> <span class="p">[],</span> <span class="bp">None</span><span class="p">,</span> <span class="p">[]</span>
<span class="k">if</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="o">==</span> <span class="s">';'</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="ow">in</span> <span class="n">LWS</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="n">parmlist</span><span class="p">,</span> <span class="n">k</span> <span class="o">=</span> <span class="n">parse_parameter_list</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">pos</span><span class="p">)</span>
<span class="k">for</span> <span class="n">p</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">parmlist</span><span class="p">:</span>
<span class="k">if</span> <span class="n">p</span> <span class="o">==</span> <span class="s">'q'</span> <span class="ow">and</span> <span class="n">qvalue</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">qvalue</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'qvalue must be a floating point number'</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">pos</span><span class="p">)</span>
<span class="k">if</span> <span class="n">qvalue</span> <span class="o"><</span> <span class="mi">0</span> <span class="ow">or</span> <span class="n">qvalue</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'qvalue must be between 0 and 1, inclusive'</span><span class="p">,</span><span class="n">s</span><span class="p">,</span><span class="n">pos</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">qvalue</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">itemparms</span><span class="o">.</span><span class="n">append</span><span class="p">(</span> <span class="p">(</span><span class="n">p</span><span class="p">,</span><span class="n">v</span><span class="p">)</span> <span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">acptparms</span><span class="o">.</span><span class="n">append</span><span class="p">(</span> <span class="p">(</span><span class="n">p</span><span class="p">,</span><span class="n">v</span><span class="p">)</span> <span class="p">)</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="n">k</span>
<span class="k">if</span> <span class="n">item</span><span class="p">:</span>
<span class="c"># Add the item to the list</span>
<span class="k">if</span> <span class="n">qvalue</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">qvalue</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">itemlist</span><span class="o">.</span><span class="n">append</span><span class="p">(</span> <span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="n">itemparms</span><span class="p">,</span> <span class="n">qvalue</span><span class="p">,</span> <span class="n">acptparms</span><span class="p">)</span> <span class="p">)</span>
<span class="n">item</span> <span class="o">=</span> <span class="bp">None</span>
<span class="c"># skip commas</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="o">==</span> <span class="s">','</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="ow">in</span> <span class="n">LWS</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">break</span>
<span class="k">return</span> <span class="n">itemlist</span><span class="p">,</span> <span class="n">pos</span> <span class="o">-</span> <span class="n">start</span>
</div>
<div class="viewcode-block" id="parse_accept_header"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.parse_accept_header">[docs]</a><span class="k">def</span> <span class="nf">parse_accept_header</span><span class="p">(</span> <span class="n">header_value</span> <span class="p">):</span>
<span class="sd">"""Parses the Accept: header.</span>
<span class="sd"> The value of the header as a string should be passed in; without</span>
<span class="sd"> the header name itself.</span>
<span class="sd"> </span>
<span class="sd"> This will parse the value of any of the HTTP headers "Accept",</span>
<span class="sd"> "Accept-Charset", "Accept-Encoding", or "Accept-Language". These</span>
<span class="sd"> headers are similarly formatted, in that they are a list of items</span>
<span class="sd"> with associated quality factors. The quality factor, or qvalue,</span>
<span class="sd"> is a number in the range [0.0..1.0] which indicates the relative</span>
<span class="sd"> preference of each item.</span>
<span class="sd"> This function returns a list of those items, sorted by preference</span>
<span class="sd"> (from most-prefered to least-prefered). Each item in the returned</span>
<span class="sd"> list is actually a tuple consisting of:</span>
<span class="sd"> ( item_name, item_parms, qvalue, accept_parms )</span>
<span class="sd"> As an example, the following string,</span>
<span class="sd"> text/plain; charset="utf-8"; q=.5; columns=80</span>
<span class="sd"> would be parsed into this resulting tuple,</span>
<span class="sd"> ( 'text/plain', [('charset','utf-8')], 0.5, [('columns','80')] )</span>
<span class="sd"> The value of the returned item_name depends upon which header is</span>
<span class="sd"> being parsed, but for example it may be a MIME content or media</span>
<span class="sd"> type (without parameters), a language tag, or so on. Any optional</span>
<span class="sd"> parameters (delimited by semicolons) occuring before the "q="</span>
<span class="sd"> attribute will be in the item_parms list as (attribute,value)</span>
<span class="sd"> tuples in the same order as they appear in the header. Any quoted</span>
<span class="sd"> values will have been unquoted and unescaped.</span>
<span class="sd"> The qvalue is a floating point number in the inclusive range 0.0</span>
<span class="sd"> to 1.0, and roughly indicates the preference for this item.</span>
<span class="sd"> Values outside this range will be capped to the closest extreme.</span>
<span class="sd"> (!) Note that a qvalue of 0 indicates that the item is</span>
<span class="sd"> explicitly NOT acceptable to the user agent, and should be</span>
<span class="sd"> handled differently by the caller.</span>
<span class="sd"> The accept_parms, like the item_parms, is a list of any attributes</span>
<span class="sd"> occuring after the "q=" attribute, and will be in the list as</span>
<span class="sd"> (attribute,value) tuples in the same order as they occur.</span>
<span class="sd"> Usually accept_parms will be an empty list, as the HTTP spec</span>
<span class="sd"> allows these extra parameters in the syntax but does not</span>
<span class="sd"> currently define any possible values.</span>
<span class="sd"> All empty items will be removed from the list. However, duplicate</span>
<span class="sd"> or conflicting values are not detected or handled in any way by</span>
<span class="sd"> this function.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">parse_mt_only</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">start</span><span class="p">):</span>
<span class="n">mt</span><span class="p">,</span> <span class="n">k</span> <span class="o">=</span> <span class="n">parse_media_type</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">with_parameters</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span>
<span class="n">ct</span> <span class="o">=</span> <span class="n">content_type</span><span class="p">()</span>
<span class="n">ct</span><span class="o">.</span><span class="n">major</span> <span class="o">=</span> <span class="n">mt</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">ct</span><span class="o">.</span><span class="n">minor</span> <span class="o">=</span> <span class="n">mt</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
<span class="k">return</span> <span class="n">ct</span><span class="p">,</span> <span class="n">k</span>
<span class="n">alist</span><span class="p">,</span> <span class="n">k</span> <span class="o">=</span> <span class="n">parse_qvalue_accept_list</span><span class="p">(</span> <span class="n">header_value</span><span class="p">,</span> <span class="n">item_parser</span><span class="o">=</span><span class="n">parse_mt_only</span> <span class="p">)</span>
<span class="k">if</span> <span class="n">k</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">header_value</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Accept header is invalid'</span><span class="p">,</span><span class="n">header_value</span><span class="p">,</span><span class="n">k</span><span class="p">)</span>
<span class="n">ctlist</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">ct</span><span class="p">,</span> <span class="n">ctparms</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">acptparms</span> <span class="ow">in</span> <span class="n">alist</span><span class="p">:</span>
<span class="k">if</span> <span class="n">ctparms</span><span class="p">:</span>
<span class="n">ct</span><span class="o">.</span><span class="n">set_parameters</span><span class="p">(</span> <span class="nb">dict</span><span class="p">(</span><span class="n">ctparms</span><span class="p">)</span> <span class="p">)</span>
<span class="n">ctlist</span><span class="o">.</span><span class="n">append</span><span class="p">(</span> <span class="p">(</span><span class="n">ct</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">acptparms</span><span class="p">)</span> <span class="p">)</span>
<span class="k">return</span> <span class="n">ctlist</span>
</div>
<div class="viewcode-block" id="parse_media_type"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.parse_media_type">[docs]</a><span class="k">def</span> <span class="nf">parse_media_type</span><span class="p">(</span><span class="n">media_type</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">with_parameters</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
<span class="sd">"""Parses a media type (MIME type) designator into it's parts.</span>
<span class="sd"> Given a media type string, returns a nested tuple of it's parts.</span>
<span class="sd"> ((major,minor,parmlist), chars_consumed)</span>
<span class="sd"> where parmlist is a list of tuples of (parm_name, parm_value).</span>
<span class="sd"> Quoted-values are appropriately unquoted and unescaped.</span>
<span class="sd"> </span>
<span class="sd"> If 'with_parameters' is False, then parsing will stop immediately</span>
<span class="sd"> after the minor media type; and will not proceed to parse any</span>
<span class="sd"> of the semicolon-separated paramters.</span>
<span class="sd"> Examples:</span>
<span class="sd"> image/png -> (('image','png',[]), 9)</span>
<span class="sd"> text/plain; charset="utf-16be"</span>
<span class="sd"> -> (('text','plain',[('charset,'utf-16be')]), 30)</span>
<span class="sd"> """</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">media_type</span>
<span class="n">pos</span> <span class="o">=</span> <span class="n">start</span>
<span class="n">ctmaj</span><span class="p">,</span> <span class="n">k</span> <span class="o">=</span> <span class="n">parse_token</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">pos</span><span class="p">)</span>
<span class="k">if</span> <span class="n">k</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Media type must be of the form "major/minor".'</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="n">pos</span><span class="p">)</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="n">k</span>
<span class="k">if</span> <span class="n">pos</span> <span class="o">>=</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">or</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="o">!=</span> <span class="s">'/'</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Media type must be of the form "major/minor".'</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="n">pos</span><span class="p">)</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="n">ctmin</span><span class="p">,</span> <span class="n">k</span> <span class="o">=</span> <span class="n">parse_token</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">pos</span><span class="p">)</span>
<span class="k">if</span> <span class="n">k</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Media type must be of the form "major/minor".'</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="n">pos</span><span class="p">)</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="n">k</span>
<span class="k">if</span> <span class="n">with_parameters</span><span class="p">:</span>
<span class="n">parmlist</span><span class="p">,</span> <span class="n">k</span> <span class="o">=</span> <span class="n">parse_parameter_list</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">pos</span><span class="p">)</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="n">k</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">parmlist</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">return</span> <span class="p">((</span><span class="n">ctmaj</span><span class="p">,</span> <span class="n">ctmin</span><span class="p">,</span> <span class="n">parmlist</span><span class="p">),</span> <span class="n">pos</span> <span class="o">-</span> <span class="n">start</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="parse_parameter_list"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.parse_parameter_list">[docs]</a><span class="k">def</span> <span class="nf">parse_parameter_list</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="sd">"""Parses a semicolon-separated 'parameter=value' list.</span>
<span class="sd"> Returns a tuple (parmlist, chars_consumed), where parmlist</span>
<span class="sd"> is a list of tuples (parm_name, parm_value).</span>
<span class="sd"> The parameter values will be unquoted and unescaped as needed.</span>
<span class="sd"> Empty parameters (as in ";;") are skipped, as is insignificant</span>
<span class="sd"> white space. The list returned is kept in the same order as the</span>
<span class="sd"> parameters appear in the string.</span>
<span class="sd"> """</span>
<span class="n">pos</span> <span class="o">=</span> <span class="n">start</span>
<span class="n">parmlist</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="ow">in</span> <span class="n">LWS</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span> <span class="c"># skip whitespace</span>
<span class="k">if</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="o">==</span> <span class="s">';'</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="ow">in</span> <span class="n">LWS</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span> <span class="c"># skip whitespace</span>
<span class="k">if</span> <span class="n">pos</span> <span class="o">>=</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">break</span>
<span class="n">parmname</span><span class="p">,</span> <span class="n">k</span> <span class="o">=</span> <span class="n">parse_token</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">pos</span><span class="p">)</span>
<span class="k">if</span> <span class="n">parmname</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="n">k</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="ow">in</span> <span class="n">LWS</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span> <span class="c"># skip whitespace</span>
<span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="o">==</span> <span class="s">'='</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Expected an "=" after parameter name'</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="n">pos</span><span class="p">)</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">while</span> <span class="n">pos</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">and</span> <span class="n">s</span><span class="p">[</span><span class="n">pos</span><span class="p">]</span> <span class="ow">in</span> <span class="n">LWS</span><span class="p">:</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="mi">1</span> <span class="c"># skip whitespace</span>
<span class="n">parmval</span><span class="p">,</span> <span class="n">k</span> <span class="o">=</span> <span class="n">parse_token_or_quoted_string</span><span class="p">(</span> <span class="n">s</span><span class="p">,</span> <span class="n">pos</span> <span class="p">)</span>
<span class="n">pos</span> <span class="o">+=</span> <span class="n">k</span>
<span class="n">parmlist</span><span class="o">.</span><span class="n">append</span><span class="p">(</span> <span class="p">(</span><span class="n">parmname</span><span class="p">,</span> <span class="n">parmval</span><span class="p">)</span> <span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">break</span>
<span class="k">return</span> <span class="n">parmlist</span><span class="p">,</span> <span class="n">pos</span> <span class="o">-</span> <span class="n">start</span>
</div>
<div class="viewcode-block" id="content_type"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.content_type">[docs]</a><span class="k">class</span> <span class="nc">content_type</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""This class represents a media type (aka a MIME content type), including parameters.</span>
<span class="sd"> You initialize these by passing in a content-type declaration</span>
<span class="sd"> string, such as "text/plain; charset=ascii", to the constructor or</span>
<span class="sd"> to the set() method. If you provide no string value, the object</span>
<span class="sd"> returned will represent the wildcard */* content type.</span>
<span class="sd"> Normally you will get the value back by using str(), or optionally</span>
<span class="sd"> you can access the components via the 'major', 'minor', 'media_type',</span>
<span class="sd"> or 'parmdict' members.</span>
<span class="sd"> """</span>
<div class="viewcode-block" id="content_type.__init__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.content_type.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">content_type_string</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">with_parameters</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
<span class="sd">"""Create a new content_type object.</span>
<span class="sd"> See the set() method for a description of the arguments.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">content_type_string</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span> <span class="n">content_type_string</span><span class="p">,</span> <span class="n">with_parameters</span><span class="o">=</span><span class="n">with_parameters</span> <span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span> <span class="s">'*/*'</span> <span class="p">)</span>
</div>
<div class="viewcode-block" id="content_type.set_parameters"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.content_type.set_parameters">[docs]</a> <span class="k">def</span> <span class="nf">set_parameters</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parameter_list_or_dict</span><span class="p">):</span>
<span class="sd">"""Sets the optional paramters based upon the parameter list.</span>
<span class="sd"> The paramter list should be a semicolon-separated name=value string.</span>
<span class="sd"> Any paramters which already exist on this object will be deleted,</span>
<span class="sd"> unless they appear in the given paramter_list.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">parameter_list_or_dict</span><span class="p">,</span> <span class="s">'has_key'</span><span class="p">):</span>
<span class="c"># already a dictionary</span>
<span class="n">pl</span> <span class="o">=</span> <span class="n">parameter_list_or_dict</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">pl</span><span class="p">,</span> <span class="n">k</span> <span class="o">=</span> <span class="n">parse_parameter_list</span><span class="p">(</span><span class="n">parameter_list</span><span class="p">)</span>
<span class="k">if</span> <span class="n">k</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">parameter_list</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Invalid parameter list'</span><span class="p">,</span><span class="n">paramter_list</span><span class="p">,</span><span class="n">k</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parmdict</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">pl</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="content_type.set"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.content_type.set">[docs]</a> <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">content_type_string</span><span class="p">,</span> <span class="n">with_parameters</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
<span class="sd">"""Parses the content type string and sets this object to it's value.</span>
<span class="sd"> For a more complete description of the arguments, see the</span>
<span class="sd"> documentation for the parse_media_type() function in this module.</span>
<span class="sd"> """</span>
<span class="n">mt</span><span class="p">,</span> <span class="n">k</span> <span class="o">=</span> <span class="n">parse_media_type</span><span class="p">(</span> <span class="n">content_type_string</span><span class="p">,</span> <span class="n">with_parameters</span><span class="o">=</span><span class="n">with_parameters</span> <span class="p">)</span>
<span class="k">if</span> <span class="n">k</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">content_type_string</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Not a valid content type'</span><span class="p">,</span><span class="n">content_type_string</span><span class="p">,</span> <span class="n">k</span><span class="p">)</span>
<span class="n">major</span><span class="p">,</span> <span class="n">minor</span><span class="p">,</span> <span class="n">pdict</span> <span class="o">=</span> <span class="n">mt</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_set_major</span><span class="p">(</span> <span class="n">major</span> <span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_set_minor</span><span class="p">(</span> <span class="n">minor</span> <span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parmdict</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">pdict</span><span class="p">)</span>
</div>
<span class="k">def</span> <span class="nf">_get_major</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_major</span>
<span class="k">def</span> <span class="nf">_set_major</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">):</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="c"># case-insentive</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">is_token</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">'Major media type contains an invalid character'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_major</span> <span class="o">=</span> <span class="n">s</span>
<span class="k">def</span> <span class="nf">_get_minor</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_minor</span>
<span class="k">def</span> <span class="nf">_set_minor</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">):</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="c"># case-insentive</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">is_token</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">'Minor media type contains an invalid character'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_minor</span> <span class="o">=</span> <span class="n">s</span>
<span class="n">major</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">_get_major</span><span class="p">,</span><span class="n">_set_major</span><span class="p">,</span><span class="n">doc</span><span class="o">=</span><span class="s">"Major media classification"</span><span class="p">)</span>
<span class="n">minor</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">_get_minor</span><span class="p">,</span><span class="n">_set_minor</span><span class="p">,</span><span class="n">doc</span><span class="o">=</span><span class="s">"Minor media sub-classification"</span><span class="p">)</span>
<div class="viewcode-block" id="content_type.__str__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.content_type.__str__">[docs]</a> <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""String value."""</span>
<span class="n">s</span> <span class="o">=</span> <span class="s">'</span><span class="si">%s</span><span class="s">/</span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">major</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">minor</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">parmdict</span><span class="p">:</span>
<span class="n">extra</span> <span class="o">=</span> <span class="s">'; '</span><span class="o">.</span><span class="n">join</span><span class="p">([</span> <span class="s">'</span><span class="si">%s</span><span class="s">=</span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">a</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span><span class="n">quote_string</span><span class="p">(</span><span class="n">a</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span><span class="bp">False</span><span class="p">))</span> <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">parmdict</span><span class="o">.</span><span class="n">items</span><span class="p">()])</span>
<span class="n">s</span> <span class="o">+=</span> <span class="s">'; '</span> <span class="o">+</span> <span class="n">extra</span>
<span class="k">return</span> <span class="n">s</span>
</div>
<div class="viewcode-block" id="content_type.__unicode__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.content_type.__unicode__">[docs]</a> <span class="k">def</span> <span class="nf">__unicode__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Unicode string value."""</span>
<span class="c"># In Python 3 this is probably unnecessary in general, this is just to avoid possible syntax issues. I.H.</span>
<span class="k">if</span> <span class="n">PY3</span> <span class="p">:</span>
<span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__str__</span><span class="p">())</span>
<span class="k">else</span> <span class="p">:</span>
<span class="k">return</span> <span class="nb">unicode</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__str__</span><span class="p">())</span>
</div>
<div class="viewcode-block" id="content_type.__repr__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.content_type.__repr__">[docs]</a> <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Python representation of this object."""</span>
<span class="n">s</span> <span class="o">=</span> <span class="s">'</span><span class="si">%s</span><span class="s">(</span><span class="si">%s</span><span class="s">)'</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__str__</span><span class="p">()))</span>
<span class="k">return</span> <span class="n">s</span>
</div>
<div class="viewcode-block" id="content_type.__hash__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.content_type.__hash__">[docs]</a> <span class="k">def</span> <span class="nf">__hash__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Hash this object; the hash is dependent only upon the value."""</span>
<span class="k">return</span> <span class="nb">hash</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span>
</div>
<div class="viewcode-block" id="content_type.__getstate__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.content_type.__getstate__">[docs]</a> <span class="k">def</span> <span class="nf">__getstate__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Pickler"""</span>
<span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="content_type.__setstate__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.content_type.__setstate__">[docs]</a> <span class="k">def</span> <span class="nf">__setstate__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">state</span><span class="p">):</span>
<span class="sd">"""Unpickler"""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">state</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="content_type.__len__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.content_type.__len__">[docs]</a> <span class="k">def</span> <span class="nf">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Logical length of this media type.</span>
<span class="sd"> For example:</span>
<span class="sd"> len('*/*') -> 0</span>
<span class="sd"> len('image/*') -> 1</span>
<span class="sd"> len('image/png') -> 2</span>
<span class="sd"> len('text/plain; charset=utf-8') -> 3</span>
<span class="sd"> len('text/plain; charset=utf-8; filename=xyz.txt') -> 4</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">major</span> <span class="o">==</span> <span class="s">'*'</span><span class="p">:</span>
<span class="k">return</span> <span class="mi">0</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">minor</span> <span class="o">==</span> <span class="s">'*'</span><span class="p">:</span>
<span class="k">return</span> <span class="mi">1</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="mi">2</span> <span class="o">+</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parmdict</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="content_type.__eq__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.content_type.__eq__">[docs]</a> <span class="k">def</span> <span class="nf">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="sd">"""Equality test.</span>
<span class="sd"> Note that this is an exact match, including any parameters if any.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">major</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">major</span> <span class="ow">and</span> \
<span class="bp">self</span><span class="o">.</span><span class="n">minor</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">minor</span> <span class="ow">and</span> \
<span class="bp">self</span><span class="o">.</span><span class="n">parmdict</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">parmdict</span>
</div>
<div class="viewcode-block" id="content_type.__ne__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.content_type.__ne__">[docs]</a> <span class="k">def</span> <span class="nf">__ne__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="sd">"""Inequality test."""</span>
<span class="k">return</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">__eq__</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
</div>
<span class="k">def</span> <span class="nf">_get_media_type</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Returns the media 'type/subtype' string, without parameters."""</span>
<span class="k">return</span> <span class="s">'</span><span class="si">%s</span><span class="s">/</span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">major</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">minor</span><span class="p">)</span>
<span class="n">media_type</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">_get_media_type</span><span class="p">,</span> <span class="n">doc</span><span class="o">=</span><span class="s">"Returns the just the media type 'type/subtype' without any paramters (read-only)."</span><span class="p">)</span>
<div class="viewcode-block" id="content_type.is_wildcard"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.content_type.is_wildcard">[docs]</a> <span class="k">def</span> <span class="nf">is_wildcard</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Returns True if this is a 'something/*' media type.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">minor</span> <span class="o">==</span> <span class="s">'*'</span>
</div>
<div class="viewcode-block" id="content_type.is_universal_wildcard"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.content_type.is_universal_wildcard">[docs]</a> <span class="k">def</span> <span class="nf">is_universal_wildcard</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Returns True if this is the unspecified '*/*' media type.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">major</span> <span class="o">==</span> <span class="s">'*'</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">minor</span> <span class="o">==</span> <span class="s">'*'</span>
</div>
<div class="viewcode-block" id="content_type.is_composite"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.content_type.is_composite">[docs]</a> <span class="k">def</span> <span class="nf">is_composite</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Is this media type composed of multiple parts.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">major</span> <span class="o">==</span> <span class="s">'multipart'</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">major</span> <span class="o">==</span> <span class="s">'message'</span>
</div>
<div class="viewcode-block" id="content_type.is_xml"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.content_type.is_xml">[docs]</a> <span class="k">def</span> <span class="nf">is_xml</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Returns True if this media type is XML-based.</span>
<span class="sd"> Note this does not consider text/html to be XML, but</span>
<span class="sd"> application/xhtml+xml is.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">minor</span> <span class="o">==</span> <span class="s">'xml'</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">minor</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s">'+xml'</span><span class="p">)</span>
<span class="c"># Some common media types</span></div></div>
<span class="n">content_formdata</span> <span class="o">=</span> <span class="n">content_type</span><span class="p">(</span><span class="s">'multipart/form-data'</span><span class="p">)</span>
<span class="n">content_urlencoded</span> <span class="o">=</span> <span class="n">content_type</span><span class="p">(</span><span class="s">'application/x-www-form-urlencoded'</span><span class="p">)</span>
<span class="n">content_byteranges</span> <span class="o">=</span> <span class="n">content_type</span><span class="p">(</span><span class="s">'multipart/byteranges'</span><span class="p">)</span> <span class="c"># RFC 2616 sect 14.16</span>
<span class="n">content_opaque</span> <span class="o">=</span> <span class="n">content_type</span><span class="p">(</span><span class="s">'application/octet-stream'</span><span class="p">)</span>
<span class="n">content_html</span> <span class="o">=</span> <span class="n">content_type</span><span class="p">(</span><span class="s">'text/html'</span><span class="p">)</span>
<span class="n">content_xhtml</span> <span class="o">=</span> <span class="n">content_type</span><span class="p">(</span><span class="s">'application/xhtml+xml'</span><span class="p">)</span>
<div class="viewcode-block" id="acceptable_content_type"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.acceptable_content_type">[docs]</a><span class="k">def</span> <span class="nf">acceptable_content_type</span><span class="p">(</span> <span class="n">accept_header</span><span class="p">,</span> <span class="n">content_types</span><span class="p">,</span> <span class="n">ignore_wildcard</span><span class="o">=</span><span class="bp">True</span> <span class="p">):</span>
<span class="sd">"""Determines if the given content type is acceptable to the user agent.</span>
<span class="sd"> The accept_header should be the value present in the HTTP</span>
<span class="sd"> "Accept:" header. In mod_python this is typically obtained from</span>
<span class="sd"> the req.http_headers_in table; in WSGI it is environ["Accept"];</span>
<span class="sd"> other web frameworks may provide other methods of obtaining it.</span>
<span class="sd"> Optionally the accept_header parameter can be pre-parsed, as</span>
<span class="sd"> returned from the parse_accept_header() function in this module.</span>
<span class="sd"> The content_types argument should either be a single MIME media</span>
<span class="sd"> type string, or a sequence of them. It represents the set of</span>
<span class="sd"> content types that the caller (server) is willing to send.</span>
<span class="sd"> Generally, the server content_types should not contain any</span>
<span class="sd"> wildcarded values.</span>
<span class="sd"> This function determines which content type which is the most</span>
<span class="sd"> preferred and is acceptable to both the user agent and the server.</span>
<span class="sd"> If one is negotiated it will return a four-valued tuple like:</span>
<span class="sd"> (server_content_type, ua_content_range, qvalue, accept_parms)</span>
<span class="sd"> The first tuple value is one of the server's content_types, while</span>
<span class="sd"> the remaining tuple values descript which of the client's</span>
<span class="sd"> acceptable content_types was matched. In most cases accept_parms</span>
<span class="sd"> will be an empty list (see description of parse_accept_header()</span>
<span class="sd"> for more details).</span>
<span class="sd"> If no content type could be negotiated, then this function will</span>
<span class="sd"> return None (and the caller should typically cause an HTTP 406 Not</span>
<span class="sd"> Acceptable as a response).</span>
<span class="sd"> Note that the wildcarded content type "*/*" sent by the client</span>
<span class="sd"> will be ignored, since it is often incorrectly sent by web</span>
<span class="sd"> browsers that don't really mean it. To override this, call with</span>
<span class="sd"> ignore_wildcard=False. Partial wildcards such as "image/*" will</span>
<span class="sd"> always be processed, but be at a lower priority than a complete</span>
<span class="sd"> matching type.</span>
<span class="sd"> See also: RFC 2616 section 14.1, and</span>
<span class="sd"> <http://www.iana.org/assignments/media-types/></span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">_is_string</span><span class="p">(</span><span class="n">accept_header</span><span class="p">):</span>
<span class="n">accept_list</span> <span class="o">=</span> <span class="n">parse_accept_header</span><span class="p">(</span><span class="n">accept_header</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">accept_list</span> <span class="o">=</span> <span class="n">accept_header</span>
<span class="k">if</span> <span class="n">_is_string</span><span class="p">(</span><span class="n">content_types</span><span class="p">):</span>
<span class="n">content_types</span> <span class="o">=</span> <span class="p">[</span><span class="n">content_types</span><span class="p">]</span>
<span class="n">server_ctlist</span> <span class="o">=</span> <span class="p">[</span><span class="n">content_type</span><span class="p">(</span><span class="n">ct</span><span class="p">)</span> <span class="k">for</span> <span class="n">ct</span> <span class="ow">in</span> <span class="n">content_types</span><span class="p">]</span>
<span class="k">del</span> <span class="n">ct</span>
<span class="c">#print 'AC', repr(accept_list)</span>
<span class="c">#print 'SV', repr(server_ctlist)</span>
<span class="n">best</span> <span class="o">=</span> <span class="bp">None</span> <span class="c"># (content_type, qvalue, accept_parms, matchlen)</span>
<span class="k">for</span> <span class="n">server_ct</span> <span class="ow">in</span> <span class="n">server_ctlist</span><span class="p">:</span>
<span class="n">best_for_this</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">for</span> <span class="n">client_ct</span><span class="p">,</span> <span class="n">qvalue</span><span class="p">,</span> <span class="n">aargs</span> <span class="ow">in</span> <span class="n">accept_list</span><span class="p">:</span>
<span class="k">if</span> <span class="n">ignore_wildcard</span> <span class="ow">and</span> <span class="n">client_ct</span><span class="o">.</span><span class="n">is_universal_wildcard</span><span class="p">():</span>
<span class="k">continue</span> <span class="c"># */* being ignored</span>
<span class="n">matchlen</span> <span class="o">=</span> <span class="mi">0</span> <span class="c"># how specifically this one matches (0 is a non-match)</span>
<span class="k">if</span> <span class="n">client_ct</span><span class="o">.</span><span class="n">is_universal_wildcard</span><span class="p">():</span>
<span class="n">matchlen</span> <span class="o">=</span> <span class="mi">1</span> <span class="c"># */* is a 1</span>
<span class="k">elif</span> <span class="n">client_ct</span><span class="o">.</span><span class="n">major</span> <span class="o">==</span> <span class="n">server_ct</span><span class="o">.</span><span class="n">major</span><span class="p">:</span>
<span class="k">if</span> <span class="n">client_ct</span><span class="o">.</span><span class="n">minor</span> <span class="o">==</span> <span class="s">'*'</span><span class="p">:</span> <span class="c"># something/* is a 2</span>
<span class="n">matchlen</span> <span class="o">=</span> <span class="mi">2</span>
<span class="k">elif</span> <span class="n">client_ct</span><span class="o">.</span><span class="n">minor</span> <span class="o">==</span> <span class="n">server_ct</span><span class="o">.</span><span class="n">minor</span><span class="p">:</span> <span class="c"># something/something is a 3</span>
<span class="n">matchlen</span> <span class="o">=</span> <span class="mi">3</span>
<span class="c"># must make sure all the parms match too</span>
<span class="k">for</span> <span class="n">pname</span><span class="p">,</span> <span class="n">pval</span> <span class="ow">in</span> <span class="n">client_ct</span><span class="o">.</span><span class="n">parmdict</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">sval</span> <span class="o">=</span> <span class="n">server_ct</span><span class="o">.</span><span class="n">parmdict</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">pname</span><span class="p">)</span>
<span class="k">if</span> <span class="n">pname</span> <span class="o">==</span> <span class="s">'charset'</span><span class="p">:</span>
<span class="c"># special case for charset to match aliases</span>
<span class="n">pval</span> <span class="o">=</span> <span class="n">canonical_charset</span><span class="p">(</span><span class="n">pval</span><span class="p">)</span>
<span class="n">sval</span> <span class="o">=</span> <span class="n">canonical_charset</span><span class="p">(</span><span class="n">sval</span><span class="p">)</span>
<span class="k">if</span> <span class="n">sval</span> <span class="o">==</span> <span class="n">pval</span><span class="p">:</span>
<span class="n">matchlen</span> <span class="o">=</span> <span class="n">matchlen</span> <span class="o">+</span> <span class="mi">1</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">matchlen</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">break</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">matchlen</span> <span class="o">=</span> <span class="mi">0</span>
<span class="c">#print 'S',server_ct,' C',client_ct,' M',matchlen,'Q',qvalue</span>
<span class="k">if</span> <span class="n">matchlen</span> <span class="o">></span> <span class="mi">0</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">best_for_this</span> \
<span class="ow">or</span> <span class="n">matchlen</span> <span class="o">></span> <span class="n">best_for_this</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> \
<span class="ow">or</span> <span class="p">(</span><span class="n">matchlen</span> <span class="o">==</span> <span class="n">best_for_this</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="ow">and</span> <span class="n">qvalue</span> <span class="o">></span> <span class="n">best_for_this</span><span class="p">[</span><span class="mi">2</span><span class="p">]):</span>
<span class="c"># This match is better</span>
<span class="n">best_for_this</span> <span class="o">=</span> <span class="p">(</span><span class="n">server_ct</span><span class="p">,</span> <span class="n">client_ct</span><span class="p">,</span> <span class="n">qvalue</span><span class="p">,</span> <span class="n">aargs</span><span class="p">,</span> <span class="n">matchlen</span><span class="p">)</span>
<span class="c">#print 'BEST2 NOW', repr(best_for_this)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">best</span> <span class="ow">or</span> \
<span class="p">(</span><span class="n">best_for_this</span> <span class="ow">and</span> <span class="n">best_for_this</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="o">></span> <span class="n">best</span><span class="p">[</span><span class="mi">2</span><span class="p">]):</span>
<span class="n">best</span> <span class="o">=</span> <span class="n">best_for_this</span>
<span class="c">#print 'BEST NOW', repr(best)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">best</span> <span class="ow">or</span> <span class="n">best</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o"><=</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">None</span>
<span class="k">return</span> <span class="n">best</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="c"># Aliases of common charsets, see <http://www.iana.org/assignments/character-sets>.</span></div>
<span class="n">character_set_aliases</span> <span class="o">=</span> <span class="p">{</span>
<span class="s">'ASCII'</span><span class="p">:</span> <span class="s">'US-ASCII'</span><span class="p">,</span>
<span class="s">'ISO646-US'</span><span class="p">:</span> <span class="s">'US-ASCII'</span><span class="p">,</span>
<span class="s">'IBM367'</span><span class="p">:</span> <span class="s">'US-ASCII'</span><span class="p">,</span>
<span class="s">'CP367'</span><span class="p">:</span> <span class="s">'US-ASCII'</span><span class="p">,</span>
<span class="s">'CSASCII'</span><span class="p">:</span> <span class="s">'US-ASCII'</span><span class="p">,</span>
<span class="s">'ANSI_X3.4-1968'</span><span class="p">:</span> <span class="s">'US-ASCII'</span><span class="p">,</span>
<span class="s">'ISO_646.IRV:1991'</span><span class="p">:</span> <span class="s">'US-ASCII'</span><span class="p">,</span>
<span class="s">'UTF7'</span><span class="p">:</span> <span class="s">'UTF-7'</span><span class="p">,</span>
<span class="s">'UTF8'</span><span class="p">:</span> <span class="s">'UTF-8'</span><span class="p">,</span>
<span class="s">'UTF16'</span><span class="p">:</span> <span class="s">'UTF-16'</span><span class="p">,</span>
<span class="s">'UTF16LE'</span><span class="p">:</span> <span class="s">'UTF-16LE'</span><span class="p">,</span>
<span class="s">'UTF16BE'</span><span class="p">:</span> <span class="s">'UTF-16BE'</span><span class="p">,</span>
<span class="s">'UTF32'</span><span class="p">:</span> <span class="s">'UTF-32'</span><span class="p">,</span>
<span class="s">'UTF32LE'</span><span class="p">:</span> <span class="s">'UTF-32LE'</span><span class="p">,</span>
<span class="s">'UTF32BE'</span><span class="p">:</span> <span class="s">'UTF-32BE'</span><span class="p">,</span>
<span class="s">'UCS2'</span><span class="p">:</span> <span class="s">'ISO-10646-UCS-2'</span><span class="p">,</span>
<span class="s">'UCS_2'</span><span class="p">:</span> <span class="s">'ISO-10646-UCS-2'</span><span class="p">,</span>
<span class="s">'UCS-2'</span><span class="p">:</span> <span class="s">'ISO-10646-UCS-2'</span><span class="p">,</span>
<span class="s">'CSUNICODE'</span><span class="p">:</span> <span class="s">'ISO-10646-UCS-2'</span><span class="p">,</span>
<span class="s">'UCS4'</span><span class="p">:</span> <span class="s">'ISO-10646-UCS-4'</span><span class="p">,</span>
<span class="s">'UCS_4'</span><span class="p">:</span> <span class="s">'ISO-10646-UCS-4'</span><span class="p">,</span>
<span class="s">'UCS-4'</span><span class="p">:</span> <span class="s">'ISO-10646-UCS-4'</span><span class="p">,</span>
<span class="s">'CSUCS4'</span><span class="p">:</span> <span class="s">'ISO-10646-UCS-4'</span><span class="p">,</span>
<span class="s">'ISO_8859-1'</span><span class="p">:</span> <span class="s">'ISO-8859-1'</span><span class="p">,</span>
<span class="s">'LATIN1'</span><span class="p">:</span> <span class="s">'ISO-8859-1'</span><span class="p">,</span>
<span class="s">'CP819'</span><span class="p">:</span> <span class="s">'ISO-8859-1'</span><span class="p">,</span>
<span class="s">'IBM819'</span><span class="p">:</span> <span class="s">'ISO-8859-1'</span><span class="p">,</span>
<span class="s">'ISO_8859-2'</span><span class="p">:</span> <span class="s">'ISO-8859-2'</span><span class="p">,</span>
<span class="s">'LATIN2'</span><span class="p">:</span> <span class="s">'ISO-8859-2'</span><span class="p">,</span>
<span class="s">'ISO_8859-3'</span><span class="p">:</span> <span class="s">'ISO-8859-3'</span><span class="p">,</span>
<span class="s">'LATIN3'</span><span class="p">:</span> <span class="s">'ISO-8859-3'</span><span class="p">,</span>
<span class="s">'ISO_8859-4'</span><span class="p">:</span> <span class="s">'ISO-8859-4'</span><span class="p">,</span>
<span class="s">'LATIN4'</span><span class="p">:</span> <span class="s">'ISO-8859-4'</span><span class="p">,</span>
<span class="s">'ISO_8859-5'</span><span class="p">:</span> <span class="s">'ISO-8859-5'</span><span class="p">,</span>
<span class="s">'CYRILLIC'</span><span class="p">:</span> <span class="s">'ISO-8859-5'</span><span class="p">,</span>
<span class="s">'ISO_8859-6'</span><span class="p">:</span> <span class="s">'ISO-8859-6'</span><span class="p">,</span>
<span class="s">'ARABIC'</span><span class="p">:</span> <span class="s">'ISO-8859-6'</span><span class="p">,</span>
<span class="s">'ECMA-114'</span><span class="p">:</span> <span class="s">'ISO-8859-6'</span><span class="p">,</span>
<span class="s">'ISO_8859-6-E'</span><span class="p">:</span> <span class="s">'ISO-8859-6-E'</span><span class="p">,</span>
<span class="s">'ISO_8859-6-I'</span><span class="p">:</span> <span class="s">'ISO-8859-6-I'</span><span class="p">,</span>
<span class="s">'ISO_8859-7'</span><span class="p">:</span> <span class="s">'ISO-8859-7'</span><span class="p">,</span>
<span class="s">'GREEK'</span><span class="p">:</span> <span class="s">'ISO-8859-7'</span><span class="p">,</span>
<span class="s">'GREEK8'</span><span class="p">:</span> <span class="s">'ISO-8859-7'</span><span class="p">,</span>
<span class="s">'ECMA-118'</span><span class="p">:</span> <span class="s">'ISO-8859-7'</span><span class="p">,</span>
<span class="s">'ISO_8859-8'</span><span class="p">:</span> <span class="s">'ISO-8859-8'</span><span class="p">,</span>
<span class="s">'HEBREW'</span><span class="p">:</span> <span class="s">'ISO-8859-8'</span><span class="p">,</span>
<span class="s">'ISO_8859-8-E'</span><span class="p">:</span> <span class="s">'ISO-8859-8-E'</span><span class="p">,</span>
<span class="s">'ISO_8859-8-I'</span><span class="p">:</span> <span class="s">'ISO-8859-8-I'</span><span class="p">,</span>
<span class="s">'ISO_8859-9'</span><span class="p">:</span> <span class="s">'ISO-8859-9'</span><span class="p">,</span>
<span class="s">'LATIN5'</span><span class="p">:</span> <span class="s">'ISO-8859-9'</span><span class="p">,</span>
<span class="s">'ISO_8859-10'</span><span class="p">:</span> <span class="s">'ISO-8859-10'</span><span class="p">,</span>
<span class="s">'LATIN6'</span><span class="p">:</span> <span class="s">'ISO-8859-10'</span><span class="p">,</span>
<span class="s">'ISO_8859-13'</span><span class="p">:</span> <span class="s">'ISO-8859-13'</span><span class="p">,</span>
<span class="s">'ISO_8859-14'</span><span class="p">:</span> <span class="s">'ISO-8859-14'</span><span class="p">,</span>
<span class="s">'LATIN8'</span><span class="p">:</span> <span class="s">'ISO-8859-14'</span><span class="p">,</span>
<span class="s">'ISO_8859-15'</span><span class="p">:</span> <span class="s">'ISO-8859-15'</span><span class="p">,</span>
<span class="s">'LATIN9'</span><span class="p">:</span> <span class="s">'ISO-8859-15'</span><span class="p">,</span>
<span class="s">'ISO_8859-16'</span><span class="p">:</span> <span class="s">'ISO-8859-16'</span><span class="p">,</span>
<span class="s">'LATIN10'</span><span class="p">:</span> <span class="s">'ISO-8859-16'</span><span class="p">,</span>
<span class="p">}</span>
<div class="viewcode-block" id="canonical_charset"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.canonical_charset">[docs]</a><span class="k">def</span> <span class="nf">canonical_charset</span><span class="p">(</span> <span class="n">charset</span> <span class="p">):</span>
<span class="sd">"""Returns the canonical or preferred name of a charset.</span>
<span class="sd"> Additional character sets can be recognized by this function by</span>
<span class="sd"> altering the character_set_aliases dictionary in this module.</span>
<span class="sd"> Charsets which are not recognized are simply converted to</span>
<span class="sd"> upper-case (as charset names are always case-insensitive).</span>
<span class="sd"> </span>
<span class="sd"> See <http://www.iana.org/assignments/character-sets>.</span>
<span class="sd"> """</span>
<span class="c"># It would be nice to use Python's codecs modules for this, but</span>
<span class="c"># there is no fixed public interface to it's alias mappings.</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">charset</span><span class="p">:</span>
<span class="k">return</span> <span class="n">charset</span>
<span class="n">uc</span> <span class="o">=</span> <span class="n">charset</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
<span class="n">uccon</span> <span class="o">=</span> <span class="n">character_set_aliases</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> <span class="n">uc</span><span class="p">,</span> <span class="n">uc</span> <span class="p">)</span>
<span class="k">return</span> <span class="n">uccon</span>
</div>
<div class="viewcode-block" id="acceptable_charset"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.acceptable_charset">[docs]</a><span class="k">def</span> <span class="nf">acceptable_charset</span><span class="p">(</span> <span class="n">accept_charset_header</span><span class="p">,</span> <span class="n">charsets</span><span class="p">,</span> <span class="n">ignore_wildcard</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s">'ISO-8859-1'</span> <span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Determines if the given charset is acceptable to the user agent.</span>
<span class="sd"> The accept_charset_header should be the value present in the HTTP</span>
<span class="sd"> "Accept-Charset:" header. In mod_python this is typically</span>
<span class="sd"> obtained from the req.http_headers table; in WSGI it is</span>
<span class="sd"> environ["Accept-Charset"]; other web frameworks may provide other</span>
<span class="sd"> methods of obtaining it.</span>
<span class="sd"> Optionally the accept_charset_header parameter can instead be the</span>
<span class="sd"> list returned from the parse_accept_header() function in this</span>
<span class="sd"> module.</span>
<span class="sd"> The charsets argument should either be a charset identifier string,</span>
<span class="sd"> or a sequence of them.</span>
<span class="sd"> This function returns the charset identifier string which is the</span>
<span class="sd"> most prefered and is acceptable to both the user agent and the</span>
<span class="sd"> caller. It will return the default value if no charset is negotiable.</span>
<span class="sd"> </span>
<span class="sd"> Note that the wildcarded charset "*" will be ignored. To override</span>
<span class="sd"> this, call with ignore_wildcard=False.</span>
<span class="sd"> See also: RFC 2616 section 14.2, and</span>
<span class="sd"> <http://www.iana.org/assignments/character-sets></span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">default</span><span class="p">:</span>
<span class="n">default</span> <span class="o">=</span> <span class="n">_canonical_charset</span><span class="p">(</span><span class="n">default</span><span class="p">)</span>
<span class="k">if</span> <span class="n">_is_string</span><span class="p">(</span><span class="n">accept_charset_header</span><span class="p">):</span>
<span class="n">accept_list</span> <span class="o">=</span> <span class="n">parse_accept_header</span><span class="p">(</span><span class="n">accept_charset_header</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">accept_list</span> <span class="o">=</span> <span class="n">accept_charset_header</span>
<span class="k">if</span> <span class="n">_is_string</span><span class="p">(</span><span class="n">charsets</span><span class="p">):</span>
<span class="n">charsets</span> <span class="o">=</span> <span class="p">[</span><span class="n">_canonical_charset</span><span class="p">(</span><span class="n">charsets</span><span class="p">)]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">charsets</span> <span class="o">=</span> <span class="p">[</span><span class="n">_canonical_charset</span><span class="p">(</span><span class="n">c</span><span class="p">)</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">charsets</span><span class="p">]</span>
<span class="c"># Note per RFC that 'ISO-8859-1' is special, and is implictly in the</span>
<span class="c"># accept list with q=1; unless it is already in the list, or '*' is in the list.</span>
<span class="n">best</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">for</span> <span class="n">c</span><span class="p">,</span> <span class="n">qvalue</span><span class="p">,</span> <span class="n">junk</span> <span class="ow">in</span> <span class="n">accept_list</span><span class="p">:</span>
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="s">'*'</span><span class="p">:</span>
<span class="n">default</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">if</span> <span class="n">ignore_wildcard</span><span class="p">:</span>
<span class="k">continue</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">best</span> <span class="ow">or</span> <span class="n">qvalue</span> <span class="o">></span> <span class="n">best</span><span class="p">[</span><span class="mi">1</span><span class="p">]:</span>
<span class="n">best</span> <span class="o">=</span> <span class="p">(</span><span class="n">c</span><span class="p">,</span> <span class="n">qvalue</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">c</span> <span class="o">=</span> <span class="n">_canonical_charset</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
<span class="k">for</span> <span class="n">test_c</span> <span class="ow">in</span> <span class="n">charsets</span><span class="p">:</span>
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="n">default</span><span class="p">:</span>
<span class="n">default</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">if</span> <span class="n">c</span> <span class="o">==</span> <span class="n">test_c</span> <span class="ow">and</span> <span class="p">(</span><span class="ow">not</span> <span class="n">best</span> <span class="ow">or</span> <span class="n">best</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">==</span><span class="s">'*'</span> <span class="ow">or</span> <span class="n">qvalue</span> <span class="o">></span> <span class="n">best</span><span class="p">[</span><span class="mi">1</span><span class="p">]):</span>
<span class="n">best</span> <span class="o">=</span> <span class="p">(</span><span class="n">c</span><span class="p">,</span> <span class="n">qvalue</span><span class="p">)</span>
<span class="k">if</span> <span class="n">default</span> <span class="ow">and</span> <span class="n">default</span> <span class="ow">in</span> <span class="p">[</span><span class="n">test_c</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> <span class="k">for</span> <span class="n">test_c</span> <span class="ow">in</span> <span class="n">charsets</span><span class="p">]:</span>
<span class="n">best</span> <span class="o">=</span> <span class="p">(</span><span class="n">default</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="k">if</span> <span class="n">best</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s">'*'</span><span class="p">:</span>
<span class="n">best</span> <span class="o">=</span> <span class="p">(</span><span class="n">charsets</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">best</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
<span class="k">return</span> <span class="n">best</span>
</div>
<div class="viewcode-block" id="language_tag"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.language_tag">[docs]</a><span class="k">class</span> <span class="nc">language_tag</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""This class represents an RFC 3066 language tag.</span>
<span class="sd"> Initialize objects of this class with a single string representing</span>
<span class="sd"> the language tag, such as "en-US".</span>
<span class="sd"> </span>
<span class="sd"> Case is insensitive. Wildcarded subtags are ignored or stripped as</span>
<span class="sd"> they have no significance, so that "en-*" is the same as "en".</span>
<span class="sd"> However the universal wildcard "*" language tag is kept as-is.</span>
<span class="sd"> Note that although relational operators such as < are defined,</span>
<span class="sd"> they only form a partial order based upon specialization.</span>
<span class="sd"> Thus for example,</span>
<span class="sd"> "en" <= "en-US"</span>
<span class="sd"> but,</span>
<span class="sd"> not "en" <= "de", and</span>
<span class="sd"> not "de" <= "en".</span>
<span class="sd"> """</span>
<div class="viewcode-block" id="language_tag.__init__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.language_tag.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tagname</span><span class="p">):</span>
<span class="sd">"""Initialize objects of this class with a single string representing</span>
<span class="sd"> the language tag, such as "en-US". Case is insensitive.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">parts</span> <span class="o">=</span> <span class="n">tagname</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">'-'</span><span class="p">)</span>
<span class="k">while</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parts</span><span class="p">)</span> <span class="o">></span> <span class="mi">1</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">parts</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="s">'*'</span><span class="p">:</span>
<span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">parts</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
</div>
<div class="viewcode-block" id="language_tag.__len__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.language_tag.__len__">[docs]</a> <span class="k">def</span> <span class="nf">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Number of subtags in this tag."""</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parts</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">parts</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s">'*'</span><span class="p">:</span>
<span class="k">return</span> <span class="mi">0</span>
<span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parts</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="language_tag.__str__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.language_tag.__str__">[docs]</a> <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""The standard string form of this language tag."""</span>
<span class="n">a</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parts</span><span class="p">)</span> <span class="o">>=</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">a</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parts</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parts</span><span class="p">)</span> <span class="o">>=</span> <span class="mi">2</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parts</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="n">a</span><span class="o">.</span><span class="n">append</span><span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">parts</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> <span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">a</span><span class="o">.</span><span class="n">append</span><span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">parts</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="p">)</span>
<span class="n">a</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">parts</span><span class="p">[</span><span class="mi">2</span><span class="p">:]</span> <span class="p">)</span>
<span class="k">return</span> <span class="s">'-'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">a</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="language_tag.__unicode__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.language_tag.__unicode__">[docs]</a> <span class="k">def</span> <span class="nf">__unicode__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""The unicode string form of this language tag."""</span>
<span class="c"># Probably unnecessary in Python 3</span>
<span class="k">if</span> <span class="n">PY3</span> <span class="p">:</span>
<span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__str__</span><span class="p">())</span>
<span class="k">else</span> <span class="p">:</span>
<span class="k">return</span> <span class="nb">unicode</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__str__</span><span class="p">())</span>
</div>
<div class="viewcode-block" id="language_tag.__repr__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.language_tag.__repr__">[docs]</a> <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""The python representation of this language tag."""</span>
<span class="n">s</span> <span class="o">=</span> <span class="s">'</span><span class="si">%s</span><span class="s">("</span><span class="si">%s</span><span class="s">")'</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">__str__</span><span class="p">())</span>
<span class="k">return</span> <span class="n">s</span>
</div>
<div class="viewcode-block" id="language_tag.superior"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.language_tag.superior">[docs]</a> <span class="k">def</span> <span class="nf">superior</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Returns another instance of language_tag which is the superior.</span>
<span class="sd"> Thus en-US gives en, and en gives *.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o"><=</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="p">(</span><span class="s">'*'</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="p">(</span> <span class="s">'-'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parts</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span> <span class="p">)</span>
</div>
<div class="viewcode-block" id="language_tag.all_superiors"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.language_tag.all_superiors">[docs]</a> <span class="k">def</span> <span class="nf">all_superiors</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">include_wildcard</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
<span class="sd">"""Returns a list of this language and all it's superiors.</span>
<span class="sd"> If include_wildcard is False, then "*" will not be among the</span>
<span class="sd"> output list, unless this language is itself "*".</span>
<span class="sd"> """</span>
<span class="n">langlist</span> <span class="o">=</span> <span class="p">[</span> <span class="bp">self</span> <span class="p">]</span>
<span class="n">l</span> <span class="o">=</span> <span class="bp">self</span>
<span class="k">while</span> <span class="ow">not</span> <span class="n">l</span><span class="o">.</span><span class="n">is_universal_wildcard</span><span class="p">():</span>
<span class="n">l</span> <span class="o">=</span> <span class="n">l</span><span class="o">.</span><span class="n">superior</span><span class="p">()</span>
<span class="k">if</span> <span class="n">l</span><span class="o">.</span><span class="n">is_universal_wildcard</span><span class="p">()</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">include_wildcard</span><span class="p">:</span>
<span class="k">continue</span>
<span class="n">langlist</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">l</span><span class="p">)</span>
<span class="k">return</span> <span class="n">langlist</span>
</div>
<div class="viewcode-block" id="language_tag.is_universal_wildcard"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.language_tag.is_universal_wildcard">[docs]</a> <span class="k">def</span> <span class="nf">is_universal_wildcard</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Returns True if this language tag represents all possible</span>
<span class="sd"> languages, by using the reserved tag of "*".</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">parts</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">parts</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s">'*'</span>
</div>
<div class="viewcode-block" id="language_tag.dialect_of"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.language_tag.dialect_of">[docs]</a> <span class="k">def</span> <span class="nf">dialect_of</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">,</span> <span class="n">ignore_wildcard</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
<span class="sd">"""Is this language a dialect (or subset/specialization) of another.</span>
<span class="sd"> This method returns True if this language is the same as or a</span>
<span class="sd"> specialization (dialect) of the other language_tag.</span>
<span class="sd"> If ignore_wildcard is False, then all languages will be</span>
<span class="sd"> considered to be a dialect of the special language tag of "*".</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">ignore_wildcard</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_universal_wildcard</span><span class="p">():</span>
<span class="k">return</span> <span class="bp">True</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span> <span class="nb">min</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span> <span class="nb">len</span><span class="p">(</span><span class="n">other</span><span class="p">))</span> <span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">parts</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">!=</span> <span class="n">other</span><span class="o">.</span><span class="n">parts</span><span class="p">[</span><span class="n">i</span><span class="p">]:</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">>=</span> <span class="nb">len</span><span class="p">(</span><span class="n">other</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">True</span>
<span class="k">return</span> <span class="bp">False</span>
</div>
<div class="viewcode-block" id="language_tag.__eq__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.language_tag.__eq__">[docs]</a> <span class="k">def</span> <span class="nf">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="sd">"""== operator. Are the two languages the same?"""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">parts</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">parts</span>
</div>
<div class="viewcode-block" id="language_tag.__neq__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.language_tag.__neq__">[docs]</a> <span class="k">def</span> <span class="nf">__neq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="sd">"""!= operator. Are the two languages different?"""</span>
<span class="k">return</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">__eq__</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="language_tag.__lt__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.language_tag.__lt__">[docs]</a> <span class="k">def</span> <span class="nf">__lt__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="sd">"""< operator. Returns True if the other language is a more</span>
<span class="sd"> specialized dialect of this one."""</span>
<span class="k">return</span> <span class="n">other</span><span class="o">.</span><span class="n">dialect_of</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="ow">and</span> <span class="bp">self</span> <span class="o">!=</span> <span class="n">other</span>
</div>
<div class="viewcode-block" id="language_tag.__le__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.language_tag.__le__">[docs]</a> <span class="k">def</span> <span class="nf">__le__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="sd">"""<= operator. Returns True if the other language is the same</span>
<span class="sd"> as or a more specialized dialect of this one."""</span>
<span class="k">return</span> <span class="n">other</span><span class="o">.</span><span class="n">dialect_of</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="language_tag.__gt__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.language_tag.__gt__">[docs]</a> <span class="k">def</span> <span class="nf">__gt__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="sd">"""> operator. Returns True if this language is a more</span>
<span class="sd"> specialized dialect of the other one."""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">dialect_of</span><span class="p">(</span><span class="n">other</span><span class="p">)</span> <span class="ow">and</span> <span class="bp">self</span> <span class="o">!=</span> <span class="n">other</span>
</div>
<div class="viewcode-block" id="language_tag.__ge__"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.language_tag.__ge__">[docs]</a> <span class="k">def</span> <span class="nf">__ge__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="sd">""">= operator. Returns True if this language is the same as</span>
<span class="sd"> or a more specialized dialect of the other one."""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">dialect_of</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
</div></div>
<div class="viewcode-block" id="parse_accept_language_header"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.parse_accept_language_header">[docs]</a><span class="k">def</span> <span class="nf">parse_accept_language_header</span><span class="p">(</span> <span class="n">header_value</span> <span class="p">):</span>
<span class="sd">"""Parses the Accept-Language header.</span>
<span class="sd"> Returns a list of tuples, each like:</span>
<span class="sd"> (language_tag, qvalue, accept_parameters)</span>
<span class="sd"> """</span>
<span class="n">alist</span><span class="p">,</span> <span class="n">k</span> <span class="o">=</span> <span class="n">parse_qvalue_accept_list</span><span class="p">(</span> <span class="n">header_value</span><span class="p">)</span>
<span class="k">if</span> <span class="n">k</span> <span class="o"><</span> <span class="nb">len</span><span class="p">(</span><span class="n">header_value</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Accept-Language header is invalid'</span><span class="p">,</span><span class="n">header_value</span><span class="p">,</span><span class="n">k</span><span class="p">)</span>
<span class="n">langlist</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">token</span><span class="p">,</span> <span class="n">langparms</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">acptparms</span> <span class="ow">in</span> <span class="n">alist</span><span class="p">:</span>
<span class="k">if</span> <span class="n">langparms</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ParseError</span><span class="p">(</span><span class="s">'Language tag may not have any parameters'</span><span class="p">,</span><span class="n">header_value</span><span class="p">,</span><span class="mi">0</span><span class="p">)</span>
<span class="n">lang</span> <span class="o">=</span> <span class="n">language_tag</span><span class="p">(</span> <span class="n">token</span> <span class="p">)</span>
<span class="n">langlist</span><span class="o">.</span><span class="n">append</span><span class="p">(</span> <span class="p">(</span><span class="n">lang</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="n">acptparms</span><span class="p">)</span> <span class="p">)</span>
<span class="k">return</span> <span class="n">langlist</span>
</div>
<div class="viewcode-block" id="acceptable_language"><a class="viewcode-back" href="../../../../../../apidocs/rdflib.plugins.parsers.pyRdfa.extras.html#rdflib.plugins.parsers.pyRdfa.extras.httpheader.acceptable_language">[docs]</a><span class="k">def</span> <span class="nf">acceptable_language</span><span class="p">(</span> <span class="n">accept_header</span><span class="p">,</span> <span class="n">server_languages</span><span class="p">,</span> <span class="n">ignore_wildcard</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">assume_superiors</span><span class="o">=</span><span class="bp">True</span> <span class="p">):</span>
<span class="sd">"""Determines if the given language is acceptable to the user agent.</span>
<span class="sd"> The accept_header should be the value present in the HTTP</span>
<span class="sd"> "Accept-Language:" header. In mod_python this is typically</span>
<span class="sd"> obtained from the req.http_headers_in table; in WSGI it is</span>
<span class="sd"> environ["Accept-Language"]; other web frameworks may provide other</span>
<span class="sd"> methods of obtaining it.</span>
<span class="sd"> Optionally the accept_header parameter can be pre-parsed, as</span>
<span class="sd"> returned by the parse_accept_language_header() function defined in</span>
<span class="sd"> this module.</span>
<span class="sd"> The server_languages argument should either be a single language</span>
<span class="sd"> string, a language_tag object, or a sequence of them. It</span>
<span class="sd"> represents the set of languages that the server is willing to</span>
<span class="sd"> send to the user agent.</span>
<span class="sd"> Note that the wildcarded language tag "*" will be ignored. To</span>
<span class="sd"> override this, call with ignore_wildcard=False, and even then</span>
<span class="sd"> it will be the lowest-priority choice regardless of it's</span>
<span class="sd"> quality factor (as per HTTP spec).</span>
<span class="sd"> If the assume_superiors is True then it the languages that the</span>
<span class="sd"> browser accepts will automatically include all superior languages.</span>
<span class="sd"> Any superior languages which must be added are done so with one</span>
<span class="sd"> half the qvalue of the language which is present. For example, if</span>
<span class="sd"> the accept string is "en-US", then it will be treated as if it</span>
<span class="sd"> were "en-US, en;q=0.5". Note that although the HTTP 1.1 spec says</span>
<span class="sd"> that browsers are supposed to encourage users to configure all</span>
<span class="sd"> acceptable languages, sometimes they don't, thus the ability</span>
<span class="sd"> for this function to assume this. But setting assume_superiors</span>
<span class="sd"> to False will insure strict adherence to the HTTP 1.1 spec; which</span>
<span class="sd"> means that if the browser accepts "en-US", then it will not</span>
<span class="sd"> be acceptable to send just "en" to it.</span>
<span class="sd"> This function returns the language which is the most prefered and</span>
<span class="sd"> is acceptable to both the user agent and the caller. It will</span>
<span class="sd"> return None if no language is negotiable, otherwise the return</span>
<span class="sd"> value is always an instance of language_tag.</span>
<span class="sd"> See also: RFC 3066 <http://www.ietf.org/rfc/rfc3066.txt>, and</span>
<span class="sd"> ISO 639, links at <http://en.wikipedia.org/wiki/ISO_639>, and</span>
<span class="sd"> <http://www.iana.org/assignments/language-tags>.</span>
<span class="sd"> </span>
<span class="sd"> """</span>
<span class="c"># Note special instructions from RFC 2616 sect. 14.1:</span>
<span class="c"># "The language quality factor assigned to a language-tag by the</span>
<span class="c"># Accept-Language field is the quality value of the longest</span>
<span class="c"># language- range in the field that matches the language-tag."</span>
<span class="k">if</span> <span class="n">_is_string</span><span class="p">(</span><span class="n">accept_header</span><span class="p">):</span>
<span class="n">accept_list</span> <span class="o">=</span> <span class="n">parse_accept_language_header</span><span class="p">(</span><span class="n">accept_header</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">accept_list</span> <span class="o">=</span> <span class="n">accept_header</span>
<span class="c"># Possibly add in any "missing" languages that the browser may</span>
<span class="c"># have forgotten to include in the list. Insure list is sorted so</span>
<span class="c"># more general languages come before more specific ones.</span>
<span class="n">accept_list</span><span class="o">.</span><span class="n">sort</span><span class="p">()</span>
<span class="n">all_tags</span> <span class="o">=</span> <span class="p">[</span><span class="n">a</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">accept_list</span><span class="p">]</span>
<span class="k">if</span> <span class="n">assume_superiors</span><span class="p">:</span>
<span class="n">to_add</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">langtag</span><span class="p">,</span> <span class="n">qvalue</span><span class="p">,</span> <span class="n">aargs</span> <span class="ow">in</span> <span class="n">accept_list</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">langtag</span><span class="p">)</span> <span class="o">>=</span> <span class="mi">2</span><span class="p">:</span>
<span class="k">for</span> <span class="n">suptag</span> <span class="ow">in</span> <span class="n">langtag</span><span class="o">.</span><span class="n">all_superiors</span><span class="p">(</span> <span class="n">include_wildcard</span><span class="o">=</span><span class="bp">False</span> <span class="p">):</span>
<span class="k">if</span> <span class="n">suptag</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">all_tags</span><span class="p">:</span>
<span class="c"># Add in superior at half the qvalue</span>
<span class="n">to_add</span><span class="o">.</span><span class="n">append</span><span class="p">(</span> <span class="p">(</span><span class="n">suptag</span><span class="p">,</span> <span class="n">qvalue</span> <span class="o">/</span> <span class="mi">2</span><span class="p">,</span> <span class="s">''</span><span class="p">)</span> <span class="p">)</span>
<span class="n">all_tags</span><span class="o">.</span><span class="n">append</span><span class="p">(</span> <span class="n">suptag</span> <span class="p">)</span>
<span class="n">accept_list</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span> <span class="n">to_add</span> <span class="p">)</span>
<span class="c"># Convert server_languages to a list of language_tags</span>
<span class="k">if</span> <span class="n">_is_string</span><span class="p">(</span><span class="n">server_languages</span><span class="p">):</span>
<span class="n">server_languages</span> <span class="o">=</span> <span class="p">[</span><span class="n">language_tag</span><span class="p">(</span><span class="n">server_languages</span><span class="p">)]</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">server_languages</span><span class="p">,</span> <span class="n">language_tag</span><span class="p">):</span>
<span class="n">server_languages</span> <span class="o">=</span> <span class="p">[</span><span class="n">server_languages</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">server_languages</span> <span class="o">=</span> <span class="p">[</span><span class="n">language_tag</span><span class="p">(</span><span class="n">lang</span><span class="p">)</span> <span class="k">for</span> <span class="n">lang</span> <span class="ow">in</span> <span class="n">server_languages</span><span class="p">]</span>
<span class="c"># Select the best one</span>
<span class="n">best</span> <span class="o">=</span> <span class="bp">None</span> <span class="c"># tuple (langtag, qvalue, matchlen)</span>
<span class="k">for</span> <span class="n">langtag</span><span class="p">,</span> <span class="n">qvalue</span><span class="p">,</span> <span class="n">aargs</span> <span class="ow">in</span> <span class="n">accept_list</span><span class="p">:</span>
<span class="c"># aargs is ignored for Accept-Language</span>
<span class="k">if</span> <span class="n">qvalue</span> <span class="o"><=</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">continue</span> <span class="c"># UA doesn't accept this language</span>
<span class="k">if</span> <span class="n">ignore_wildcard</span> <span class="ow">and</span> <span class="n">langtag</span><span class="o">.</span><span class="n">is_universal_wildcard</span><span class="p">():</span>
<span class="k">continue</span> <span class="c"># "*" being ignored</span>
<span class="k">for</span> <span class="n">svrlang</span> <span class="ow">in</span> <span class="n">server_languages</span><span class="p">:</span>
<span class="c"># The best match is determined first by the quality factor,</span>
<span class="c"># and then by the most specific match.</span>
<span class="n">matchlen</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span> <span class="c"># how specifically this one matches (0 is a non-match)</span>
<span class="k">if</span> <span class="n">svrlang</span><span class="o">.</span><span class="n">dialect_of</span><span class="p">(</span> <span class="n">langtag</span><span class="p">,</span> <span class="n">ignore_wildcard</span><span class="o">=</span><span class="n">ignore_wildcard</span> <span class="p">):</span>
<span class="n">matchlen</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">langtag</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">best</span> \
<span class="ow">or</span> <span class="n">matchlen</span> <span class="o">></span> <span class="n">best</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> \
<span class="ow">or</span> <span class="p">(</span><span class="n">matchlen</span> <span class="o">==</span> <span class="n">best</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="ow">and</span> <span class="n">qvalue</span> <span class="o">></span> <span class="n">best</span><span class="p">[</span><span class="mi">1</span><span class="p">]):</span>
<span class="c"># This match is better</span>
<span class="n">best</span> <span class="o">=</span> <span class="p">(</span><span class="n">langtag</span><span class="p">,</span> <span class="n">qvalue</span><span class="p">,</span> <span class="n">matchlen</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">best</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">None</span>
<span class="k">return</span> <span class="n">best</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="c"># Clean up global namespace</span></div>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="n">__emulating_set</span><span class="p">:</span>
<span class="k">del</span> <span class="nb">set</span>
<span class="k">del</span> <span class="nb">frozenset</span>
<span class="k">except</span> <span class="ne">NameError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="c"># end of file</span>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../../../../../index.html">
<img class="logo" src="../../../../../../_static/logo.svg" alt="Logo"/>
</a></p>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../../../../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../../../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../../../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../../../../../index.html">rdflib 4.1.2 documentation</a> »</li>
<li><a href="../../../../../index.html" >Module code</a> »</li>
<li><a href="../../pyRdfa.html" >rdflib.plugins.parsers.pyRdfa</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009 - 2013, RDFLib Team.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.2.2.
<br />Theme based on <a href="http://readthedocs.org/">Read The Docs</a>
</div>
</body>
</html>
|