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
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
|
Документация Beautiful Soup
===========================
.. image:: 6.1.jpg
:align: right
:alt: "Лакей Карась начал с того, что вытащил из-под мышки огромный конверт (чуть ли не больше его самого)."
`Beautiful Soup <http://www.crummy.com/software/BeautifulSoup/>`_ — это
библиотека Python для извлечения данных из файлов HTML и XML. Она работает
с вашим любимым парсером, чтобы дать вам естественные способы навигации,
поиска и изменения дерева разбора. Она обычно экономит программистам
часы и дни работы.
Эти инструкции иллюстрируют все основные функции Beautiful Soup 4
на примерах. Я покажу вам, для чего нужна библиотека, как она работает,
как ее использовать, как заставить ее делать то, что вы хотите, и что нужно делать, когда она
не оправдывает ваши ожидания.
Примеры в этой документации работают одинаково на Python 2.7
и Python 3.2.
Возможно, вы ищете документацию для `Beautiful Soup 3
<http://www.crummy.com/software/BeautifulSoup/bs3/documentation.html>`_.
Если это так, имейте в виду, что Beautiful Soup 3 больше не
развивается, и что поддержка этой версии будет прекращена
31 декабря 2020 года или немногим позже. Если вы хотите узнать о различиях между Beautiful Soup 3
и Beautiful Soup 4, читайте раздел `Перенос кода на BS4`_.
Эта документация переведена на другие языки
пользователями Beautiful Soup:
* `这篇文档当然还有中文版. <https://www.crummy.com/software/BeautifulSoup/bs4/doc.zh/>`_
* このページは日本語で利用できます(`外部リンク <http://kondou.com/BS4/>`_)
* `이 문서는 한국어 번역도 가능합니다. <https://www.crummy.com/software/BeautifulSoup/bs4/doc.ko/>`_
* `Este documento também está disponível em Português do Brasil. <https://www.crummy.com/software/BeautifulSoup/bs4/doc.ptbr/>`_
Техническая поддержка
---------------------
Если у вас есть вопросы о Beautiful Soup или возникли проблемы,
`отправьте сообщение в дискуссионную группу
<https://groups.google.com/forum/?fromgroups#!forum/beautifulsoup>`_. Если
ваша проблема связана с разбором HTML-документа, не забудьте упомянуть,
:ref:`что говорит о нем функция diagnose() <diagnose>`.
Быстрый старт
=============
Вот HTML-документ, который я буду использовать в качестве примера в этой
документации. Это фрагмент из `«Алисы в стране чудес»`::
html_doc = """
<html><head><title>The Dormouse's story</title></head>
<body>
<p class="title"><b>The Dormouse's story</b></p>
<p class="story">Once upon a time there were three little sisters; and their names were
<a href="http://example.com/elsie" class="sister" id="link1">Elsie</a>,
<a href="http://example.com/lacie" class="sister" id="link2">Lacie</a> and
<a href="http://example.com/tillie" class="sister" id="link3">Tillie</a>;
and they lived at the bottom of a well.</p>
<p class="story">...</p>
"""
Прогон документа через Beautiful Soup дает нам
объект ``BeautifulSoup``, который представляет документ в виде
вложенной структуры данных::
from bs4 import BeautifulSoup
soup = BeautifulSoup (html_doc, 'html.parser')
print(soup.prettify())
# <html>
# <head>
# <title>
# The Dormouse's story
# </title>
# </head>
# <body>
# <p class="title">
# <b>
# The Dormouse's story
# </b>
# </p>
# <p class="story">
# Once upon a time there were three little sisters; and their names were
# <a class="sister" href="http://example.com/elsie" id="link1">
# Elsie
# </a>
# ,
# <a class="sister" href="http://example.com/lacie" id="link2">
# Lacie
# </a>
# and
# <a class="sister" href="http://example.com/tillie" id="link3">
# Tillie
# </a>
# ; and they lived at the bottom of a well.
# </p>
# <p class="story">
# ...
# </p>
# </body>
# </html>
Вот несколько простых способов навигации по этой структуре данных::
soup.title
# <title>The Dormouse's story</title>
soup.title.name
# u'title'
soup.title.string
# u'The Dormouse's story'
soup.title.parent.name
# u'head'
soup.p
# <p class="title"><b>The Dormouse's story</b></p>
soup.p['class']
# u'title'
soup.a
# <a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>
soup.find_all('a')
# [<a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>,
# <a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>,
# <a class="sister" href="http://example.com/tillie" id="link3">Tillie</a>]
soup.find(id="link3")
# <a class="sister" href="http://example.com/tillie" id="link3">Tillie</a>
Одна из распространенных задач — извлечь все URL-адреса, найденные на странице в тегах <a>::
for link in soup.find_all('a'):
print(link.get('href'))
# http://example.com/elsie
# http://example.com/lacie
# http://example.com/tillie
Другая распространенная задача — извлечь весь текст со страницы::
print(soup.get_text())
# The Dormouse's story
#
# The Dormouse's story
#
# Once upon a time there were three little sisters; and their names were
# Elsie,
# Lacie and
# Tillie;
# and they lived at the bottom of a well.
#
# ...
Это похоже на то, что вам нужно? Если да, продолжайте читать.
Установка Beautiful Soup
========================
Если вы используете последнюю версию Debian или Ubuntu Linux, вы можете
установить Beautiful Soup с помощью системы управления пакетами:
:kbd:`$ apt-get install python-bs4` (для Python 2)
:kbd:`$ apt-get install python3-bs4` (для Python 3)
Beautiful Soup 4 публикуется через PyPi, поэтому, если вы не можете установить библиотеку
с помощью системы управления пакетами, можно установить с помощью ``easy_install`` или
``pip``. Пакет называется ``beautifulsoup4``. Один и тот же пакет
работает как на Python 2, так и на Python 3. Убедитесь, что вы используете версию
``pip`` или ``easy_install``, предназначенную для вашей версии Python (их можно назвать
``pip3`` и ``easy_install3`` соответственно, если вы используете Python 3).
:kbd:`$ easy_install beautifulsoup4`
:kbd:`$ pip install beautifulsoup4`
(``BeautifulSoup`` — это, скорее всего, `не тот` пакет, который вам нужен. Это
предыдущий основной релиз, `Beautiful Soup 3`_. Многие программы используют
BS3, так что он все еще доступен, но если вы пишете новый код,
нужно установить ``beautifulsoup4``.)
Если у вас не установлены ``easy_install`` или ``pip``, вы можете
`скачать архив с исходным кодом Beautiful Soup 4
<http://www.crummy.com/software/BeautifulSoup/download/4.x/>`_ и
установить его с помощью ``setup.py``.
:kbd:`$ python setup.py install`
Если ничего не помогает, лицензия на Beautiful Soup позволяет
упаковать библиотеку целиком вместе с вашим приложением. Вы можете скачать
tar-архив, скопировать из него в кодовую базу вашего приложения каталог ``bs4``
и использовать Beautiful Soup, не устанавливая его вообще.
Я использую Python 2.7 и Python 3.2 для разработки Beautiful Soup, но библиотека
должна работать и с более поздними версиями Python.
Проблемы после установки
------------------------
Beautiful Soup упакован как код Python 2. Когда вы устанавливаете его для
использования с Python 3, он автоматически конвертируется в код Python 3. Если
вы не устанавливаете библиотеку в виде пакета, код не будет сконвертирован. Были
также сообщения об установке неправильной версии на компьютерах с
Windows.
Если выводится сообщение ``ImportError`` "No module named HTMLParser", ваша
проблема в том, что вы используете версию кода на Python 2, работая на
Python 3.
Если выводится сообщение ``ImportError`` "No module named html.parser", ваша
проблема в том, что вы используете версию кода на Python 3, работая на
Python 2.
В обоих случаях лучше всего полностью удалить Beautiful
Soup с вашей системы (включая любой каталог, созданный
при распаковке tar-архива) и запустить установку еще раз.
Если выводится сообщение ``SyntaxError`` "Invalid syntax" в строке
``ROOT_TAG_NAME = u'[document]'``, вам нужно конвертировать код из Python 2
в Python 3. Вы можете установить пакет:
:kbd:`$ python3 setup.py install`
или запустить вручную Python-скрипт ``2to3``
в каталоге ``bs4``:
:kbd:`$ 2to3-3.2 -w bs4`
.. _parser-installation:
Установка парсера
-----------------
Beautiful Soup поддерживает парсер HTML, включенный в стандартную библиотеку Python,
а также ряд сторонних парсеров на Python.
Одним из них является `парсер lxml <http://lxml.de/>`_. В зависимости от ваших настроек,
вы можете установить lxml с помощью одной из следующих команд:
:kbd:`$ apt-get install python-lxml`
:kbd:`$ easy_install lxml`
:kbd:`$ pip install lxml`
Другая альтернатива — написанный исключительно на Python `парсер html5lib
<http://code.google.com/p/html5lib/>`_, который разбирает HTML таким же образом,
как это делает веб-браузер. В зависимости от ваших настроек, вы можете установить html5lib
с помощью одной из этих команд:
:kbd:`$ apt-get install python-html5lib`
:kbd:`$ easy_install html5lib`
:kbd:`$ pip install html5lib`
Эта таблица суммирует преимущества и недостатки каждого парсера:
+----------------------+--------------------------------------------+--------------------------------+--------------------------+
| Парсер | Типичное использование | Преимущества | Недостатки |
+----------------------+--------------------------------------------+--------------------------------+--------------------------+
| html.parser от Python| ``BeautifulSoup(markup, "html.parser")`` | * Входит в комплект | * Не такой быстрый, как |
| | | * Приличная скорость | lxml, более строгий, |
| | | * Нестрогий (по крайней мере, | чем html5lib. |
| | | в Python 2.7.3 и 3.2.) | |
+----------------------+--------------------------------------------+--------------------------------+--------------------------+
| HTML-парсер в lxml | ``BeautifulSoup(markup, "lxml")`` | * Очень быстрый | * Внешняя зависимость |
| | | * Нестрогий | от C |
+----------------------+--------------------------------------------+--------------------------------+--------------------------+
| XML-парсер в lxml | ``BeautifulSoup(markup, "lxml-xml")`` | * Очень быстрый | * Внешняя зависимость |
| | ``BeautifulSoup(markup, "xml")`` | * Единственный XML-парсер, | от C |
| | | который сейчас поддерживается| |
+----------------------+--------------------------------------------+--------------------------------+--------------------------+
| html5lib | ``BeautifulSoup(markup, "html5lib")`` | * Очень нестрогий | * Очень медленный |
| | | * Разбирает страницы так же, | * Внешняя зависимость |
| | | как это делает браузер | от Python |
| | | * Создает валидный HTML5 | |
+----------------------+--------------------------------------------+--------------------------------+--------------------------+
Я рекомендую по возможности установить и использовать lxml для быстродействия. Если вы
используете версию Python 2 более раннюю, чем 2.7.3, или версию Python 3
более раннюю, чем 3.2.2, `необходимо` установить lxml или
html5lib, потому что встроенный в Python парсер HTML просто недостаточно хорош в старых
версиях.
Обратите внимание, что если документ невалиден, различные парсеры будут генерировать
дерево Beautiful Soup для этого документа по-разному. Ищите подробности в разделе `Различия
между парсерами`_.
Приготовление супа
==================
Чтобы разобрать документ, передайте его в
конструктор ``BeautifulSoup``. Вы можете передать строку или открытый дескриптор файла::
from bs4 import BeautifulSoup
with open("index.html") as fp:
soup = BeautifulSoup(fp)
soup = BeautifulSoup("<html>data</html>")
Первым делом документ конвертируется в Unicode, а HTML-мнемоники
конвертируются в символы Unicode::
BeautifulSoup("Sacré bleu!")
<html><head></head><body>Sacré bleu!</body></html>
Затем Beautiful Soup анализирует документ, используя лучший из доступных
парсеров. Библиотека будет использовать HTML-парсер, если вы явно не укажете,
что нужно использовать XML-парсер. (См. `Разбор XML`_.)
Виды объектов
=============
Beautiful Soup превращает сложный HTML-документ в сложное дерево
объектов Python. Однако вам придется иметь дело только с четырьмя
`видами` объектов: ``Tag``, ``NavigableString``, ``BeautifulSoup``
и ``Comment``.
.. _Tag:
``Tag``
-------
Объект ``Tag`` соответствует тегу XML или HTML в исходном документе::
soup = BeautifulSoup('<b class="boldest">Extremely bold</b>')
tag = soup.b
type(tag)
# <class 'bs4.element.Tag'>
У объекта Tag (далее «тег») много атрибутов и методов, и я расскажу о большинстве из них
в разделах `Навигация по дереву`_ и `Поиск по дереву`_. На данный момент наиболее
важными особенностями тега являются его имя и атрибуты.
Имя
^^^
У каждого тега есть имя, доступное как ``.name``::
tag.name
# u'b'
Если вы измените имя тега, это изменение будет отражено в любой HTML-
разметке, созданной Beautiful Soup::
tag.name = "blockquote"
tag
# <blockquote class="boldest">Extremely bold</blockquote>
Атрибуты
^^^^^^^^
У тега может быть любое количество атрибутов. Тег ``<b
id = "boldest">`` имеет атрибут "id", значение которого равно
"boldest". Вы можете получить доступ к атрибутам тега, обращаясь с тегом как
со словарем::
tag['id']
# u'boldest'
Вы можете получить доступ к этому словарю напрямую как к ``.attrs``::
tag.attrs
# {u'id': 'boldest'}
Вы можете добавлять, удалять и изменять атрибуты тега. Опять же, это
делается путем обращения с тегом как со словарем::
tag['id'] = 'verybold'
tag['another-attribute'] = 1
tag
# <b another-attribute="1" id="verybold"></b>
del tag['id']
del tag['another-attribute']
tag
# <b></b>
tag['id']
# KeyError: 'id'
print(tag.get('id'))
# None
.. _multivalue:
Многозначные атрибуты
&&&&&&&&&&&&&&&&&&&&&
В HTML 4 определено несколько атрибутов, которые могут иметь множество значений. В HTML 5
пара таких атрибутов удалена, но определено еще несколько. Самый распространённый из
многозначных атрибутов — это ``class`` (т. е. тег может иметь более
одного класса CSS). Среди прочих ``rel``, ``rev``, ``accept-charset``,
``headers`` и ``accesskey``. Beautiful Soup представляет значение(я)
многозначного атрибута в виде списка::
css_soup = BeautifulSoup('<p class="body"></p>')
css_soup.p['class']
# ["body"]
css_soup = BeautifulSoup('<p class="body strikeout"></p>')
css_soup.p['class']
# ["body", "strikeout"]
Если атрибут `выглядит` так, будто он имеет более одного значения, но это не
многозначный атрибут, определенный какой-либо версией HTML-
стандарта, Beautiful Soup оставит атрибут как есть::
id_soup = BeautifulSoup('<p id="my id"></p>')
id_soup.p['id']
# 'my id'
Когда вы преобразовываете тег обратно в строку, несколько значений атрибута
объединяются::
rel_soup = BeautifulSoup('<p>Back to the <a rel="index">homepage</a></p>')
rel_soup.a['rel']
# ['index']
rel_soup.a['rel'] = ['index', 'contents']
print(rel_soup.p)
# <p>Back to the <a rel="index contents">homepage</a></p>
Вы можете отключить объединение, передав ``multi_valued_attributes = None`` в качестве
именованного аргумента в конструктор ``BeautifulSoup``::
no_list_soup = BeautifulSoup('<p class="body strikeout"></p>', 'html', multi_valued_attributes=None)
no_list_soup.p['class']
# u'body strikeout'
Вы можете использовать ``get_attribute_list``, того чтобы получить значение в виде списка,
независимо от того, является ли атрибут многозначным или нет::
id_soup.p.get_attribute_list('id')
# ["my id"]
Если вы разбираете документ как XML, многозначных атрибутов не будет::
xml_soup = BeautifulSoup('<p class="body strikeout"></p>', 'xml')
xml_soup.p['class']
# u'body strikeout'
Опять же, вы можете поменять настройку, используя аргумент ``multi_valued_attributes``::
class_is_multi= { '*' : 'class'}
xml_soup = BeautifulSoup('<p class="body strikeout"></p>', 'xml', multi_valued_attributes=class_is_multi)
xml_soup.p['class']
# [u'body', u'strikeout']
Вряд ли вам это пригодится, но если все-таки будет нужно, руководствуйтесь значениями
по умолчанию. Они реализуют правила, описанные в спецификации HTML::
from bs4.builder import builder_registry
builder_registry.lookup('html').DEFAULT_CDATA_LIST_ATTRIBUTES
``NavigableString``
-------------------
Строка соответствует фрагменту текста в теге. Beautiful Soup
использует класс ``NavigableString`` для хранения этих фрагментов текста::
tag.string
# u'Extremely bold'
type(tag.string)
# <class 'bs4.element.NavigableString'>
``NavigableString`` похожа на строку Unicode в Python, не считая того,
что она также поддерживает некоторые функции, описанные в
разделах `Навигация по дереву`_ и `Поиск по дереву`_. Вы можете конвертировать
``NavigableString`` в строку Unicode с помощью ``unicode()``::
unicode_string = unicode(tag.string)
unicode_string
# u'Extremely bold'
type(unicode_string)
# <type 'unicode'>
Вы не можете редактировать строку непосредственно, но вы можете заменить одну строку
другой, используя :ref:`replace_with()`::
tag.string.replace_with("No longer bold")
tag
# <blockquote>No longer bold</blockquote>
``NavigableString`` поддерживает большинство функций, описанных в
разделах `Навигация по дереву`_ и `Поиск по дереву`_, но
не все. В частности, поскольку строка не может ничего содержать (в том смысле,
в котором тег может содержать строку или другой тег), строки не поддерживают
атрибуты ``.contents`` и ``.string`` или метод ``find()``.
Если вы хотите использовать ``NavigableString`` вне Beautiful Soup,
вам нужно вызвать метод ``unicode()``, чтобы превратить ее в обычную для Python
строку Unicode. Если вы этого не сделаете, ваша строка будет тащить за собой
ссылку на все дерево разбора Beautiful Soup, даже когда вы
закончите использовать Beautiful Soup. Это большой расход памяти.
``BeautifulSoup``
-----------------
Объект ``BeautifulSoup`` представляет разобранный документ как единое
целое. В большинстве случаев вы можете рассматривать его как объект
:ref:`Tag`. Это означает, что он поддерживает большинство методов, описанных
в разделах `Навигация по дереву`_ и `Поиск по дереву`_.
Вы также можете передать объект ``BeautifulSoup`` в один из методов,
перечисленных в разделе `Изменение дерева`_, по аналогии с передачей объекта :ref:`Tag`. Это
позволяет вам делать такие вещи, как объединение двух разобранных документов::
doc = BeautifulSoup("<document><content/>INSERT FOOTER HERE</document", "xml")
footer = BeautifulSoup("<footer>Here's the footer</footer>", "xml")
doc.find(text="INSERT FOOTER HERE").replace_with(footer)
# u'INSERT FOOTER HERE'
print(doc)
# <?xml version="1.0" encoding="utf-8"?>
# <document><content/><footer>Here's the footer</footer></document>
Поскольку объект ``BeautifulSoup`` не соответствует действительному
HTML- или XML-тегу, у него нет имени и атрибутов. Однако иногда
бывает полезно взглянуть на ``.name`` объекта ``BeautifulSoup``, поэтому ему было присвоено специальное «имя»
``.name`` "[document]"::
soup.name
# u'[document]'
Комментарии и другие специфичные строки
---------------------------------------
``Tag``, ``NavigableString`` и ``BeautifulSoup`` охватывают почти
все, с чем вы столкнётесь в файле HTML или XML, но осталось
ещё немного. Пожалуй, единственное, о чем стоит волноваться,
это комментарий::
markup = "<b><!--Hey, buddy. Want to buy a used parser?--></b>"
soup = BeautifulSoup(markup)
comment = soup.b.string
type(comment)
# <class 'bs4.element.Comment'>
Объект ``Comment`` — это просто особый тип ``NavigableString``::
comment
# u'Hey, buddy. Want to buy a used parser'
Но когда он появляется как часть HTML-документа, ``Comment``
отображается со специальным форматированием::
print(soup.b.prettify())
# <b>
# <!--Hey, buddy. Want to buy a used parser?-->
# </b>
Beautiful Soup определяет классы для всего, что может появиться в
XML-документе: ``CData``, ``ProcessingInstruction``,
``Declaration`` и ``Doctype``. Как и ``Comment``, эти классы
являются подклассами ``NavigableString``, которые добавляют что-то еще к
строке. Вот пример, который заменяет комментарий блоком
CDATA::
from bs4 import CData
cdata = CData("A CDATA block")
comment.replace_with(cdata)
print(soup.b.prettify())
# <b>
# <![CDATA[A CDATA block]]>
# </b>
Навигация по дереву
===================
Вернемся к HTML-документу с фрагментом из «Алисы в стране чудес»::
html_doc = """
<html><head><title>The Dormouse's story</title></head>
<body>
<p class="title"><b>The Dormouse's story</b></p>
<p class="story">Once upon a time there were three little sisters; and their names were
<a href="http://example.com/elsie" class="sister" id="link1">Elsie</a>,
<a href="http://example.com/lacie" class="sister" id="link2">Lacie</a> and
<a href="http://example.com/tillie" class="sister" id="link3">Tillie</a>;
and they lived at the bottom of a well.</p>
<p class="story">...</p>
"""
from bs4 import BeautifulSoup
soup = BeautifulSoup (html_doc, 'html.parser')
Я буду использовать его в качестве примера, чтобы показать, как перейти от одной части
документа к другой.
Проход сверху вниз
------------------
Теги могут содержать строки и другие теги. Эти элементы являются
дочерними (`children`) для тега. Beautiful Soup предоставляет множество различных атрибутов для
навигации и перебора дочерних элементов.
Обратите внимание, что строки Beautiful Soup не поддерживают ни один из этих
атрибутов, потому что строка не может иметь дочерних элементов.
Навигация с использованием имен тегов
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Самый простой способ навигации по дереву разбора — это указать имя
тега, который вам нужен. Если вы хотите получить тег <head>, просто напишите ``soup.head``::
soup.head
# <head><title>The Dormouse's story</title></head>
soup.title
# <title>The Dormouse's story</title>
Вы можете повторять этот трюк многократно, чтобы подробнее рассмотреть определенную часть
дерева разбора. Следующий код извлекает первый тег <b> внутри тега <body>::
soup.body.b
# <b>The Dormouse's story</b>
Использование имени тега в качестве атрибута даст вам только `первый` тег с таким
именем::
soup.a
# <a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>
Если вам нужно получить `все` теги <a> или что-нибудь более сложное,
чем первый тег с определенным именем, вам нужно использовать один из
методов, описанных в разделе `Поиск по дереву`_, такой как `find_all()`::
soup.find_all('a')
# [<a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>,
# <a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>,
# <a class="sister" href="http://example.com/tillie" id="link3">Tillie</a>]
``.contents`` и ``.children``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Дочерние элементы доступны в списке под названием ``.contents``::
head_tag = soup.head
head_tag
# <head><title>The Dormouse's story</title></head>
head_tag.contents
[<title>The Dormouse's story</title>]
title_tag = head_tag.contents[0]
title_tag
# <title>The Dormouse's story</title>
title_tag.contents
# [u'The Dormouse's story']
Сам объект ``BeautifulSoup`` имеет дочерние элементы. В этом случае
тег <html> является дочерним для объекта ``BeautifulSoup``::
len(soup.contents)
# 1
soup.contents[0].name
# u'html'
У строки нет ``.contents``, потому что она не может содержать
ничего::
text = title_tag.contents[0]
text.contents
# AttributeError: У объекта 'NavigableString' нет атрибута 'contents'
Вместо того, чтобы получать дочерние элементы в виде списка, вы можете перебирать их
с помощью генератора ``.children``::
for child in title_tag.children:
print(child)
# The Dormouse's story
``.descendants``
^^^^^^^^^^^^^^^^
Атрибуты ``.contents`` и ``.children`` применяются только в отношении
`непосредственных` дочерних элементов тега. Например, тег <head> имеет только один непосредственный
дочерний тег <title>::
head_tag.contents
# [<title>The Dormouse's story</title>]
Но у самого тега <title> есть дочерний элемент: строка "The Dormouse's
story". В некотором смысле эта строка также является дочерним элементом
тега <head>. Атрибут ``.descendants`` позволяет перебирать `все`
дочерние элементы тега рекурсивно: его непосредственные дочерние элементы, дочерние элементы
дочерних элементов и так далее::
for child in head_tag.descendants:
print(child)
# <title>The Dormouse's story</title>
# The Dormouse's story
У тега <head> есть только один дочерний элемент, но при этом у него два потомка:
тег <title> и его дочерний элемент. У объекта ``BeautifulSoup``
только один прямой дочерний элемент (тег <html>), зато множество
потомков::
len(list(soup.children))
# 1
len(list(soup.descendants))
# 25
.. _.string:
``.string``
^^^^^^^^^^^
Если у тега есть только один дочерний элемент, и это ``NavigableString``,
его можно получить через ``.string``::
title_tag.string
# u'The Dormouse's story'
Если единственным дочерним элементом тега является другой тег, и у этого `другого` тега есть строка
``.string``, то считается, что родительский тег содержит ту же строку
``.string``, что и дочерний тег::
head_tag.contents
# [<title>The Dormouse's story</title>]
head_tag.string
# u'The Dormouse's story'
Если тег содержит больше чем один элемент, то становится неясным, какая из строк
``.string`` относится и к родительскому тегу, поэтому ``.string`` родительского тега имеет значение
``None``::
print(soup.html.string)
# None
.. _string-generators:
``.strings`` и ``.stripped_strings``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Если внутри тега есть более одного элемента, вы все равно можете посмотреть только на
строки. Используйте генератор ``.strings``::
for string in soup.strings:
print(repr(string))
# u"The Dormouse's story"
# u'\n\n'
# u"The Dormouse's story"
# u'\n\n'
# u'Once upon a time there were three little sisters; and their names were\n'
# u'Elsie'
# u',\n'
# u'Lacie'
# u' and\n'
# u'Tillie'
# u';\nand they lived at the bottom of a well.'
# u'\n\n'
# u'...'
# u'\n'
В этих строках много лишних пробелов, которые вы можете
удалить, используя генератор ``.stripped_strings``::
for string in soup.stripped_strings:
print(repr(string))
# u"The Dormouse's story"
# u"The Dormouse's story"
# u'Once upon a time there were three little sisters; and their names were'
# u'Elsie'
# u','
# u'Lacie'
# u'and'
# u'Tillie'
# u';\nand they lived at the bottom of a well.'
# u'...'
Здесь строки, состоящие исключительно из пробелов, игнорируются, а
пробелы в начале и конце строк удаляются.
Проход снизу вверх
------------------
В продолжение аналогии с «семейным деревом», каждый тег и каждая строка имеет
родителя (`parent`): тег, который его содержит.
.. _.parent:
``.parent``
^^^^^^^^^^^
Вы можете получить доступ к родительскому элементу с помощью атрибута ``.parent``. В
примере документа с фрагментом из «Алисы в стране чудес» тег <head> является родительским
для тега <title>::
title_tag = soup.title
title_tag
# <title>The Dormouse's story</title>
title_tag.parent
# <head><title>The Dormouse's story</title></head>
Строка заголовка сама имеет родителя: тег <title>, содержащий
ее::
title_tag.string.parent
# <title>The Dormouse's story</title>
Родительским элементом тега верхнего уровня, такого как <html>, является сам объект
``BeautifulSoup``::
html_tag = soup.html
type(html_tag.parent)
# <class 'bs4.BeautifulSoup'>
И ``.parent`` объекта ``BeautifulSoup`` определяется как None::
print(soup.parent)
# None
.. _.parents:
``.parents``
^^^^^^^^^^^^
Вы можете перебрать всех родителей элемента с помощью
``.parents``. В следующем примере ``.parents`` используется для перемещения от тега <a>,
закопанного глубоко внутри документа, до самого верха документа::
link = soup.a
link
# <a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>
for parent in link.parents:
if parent is None:
print(parent)
else:
print(parent.name)
# p
# body
# html
# [document]
# None
Перемещение вбок
----------------
Рассмотрим простой документ::
sibling_soup = BeautifulSoup("<a><b>text1</b><c>text2</c></b></a>")
print(sibling_soup.prettify())
# <html>
# <body>
# <a>
# <b>
# text1
# </b>
# <c>
# text2
# </c>
# </a>
# </body>
# </html>
Тег <b> и тег <c> находятся на одном уровне: они оба непосредственные
дочерние элементы одного и того же тега. Мы называем их `одноуровневые`. Когда документ
красиво отформатирован, одноуровневые элементы выводятся с одинаковым отступом. Вы
также можете использовать это отношение в написанном вами коде.
``.next_sibling`` и ``.previous_sibling``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Вы можете использовать ``.next_sibling`` и ``.previous_sibling`` для навигации
между элементами страницы, которые находятся на одном уровне дерева разбора::
sibling_soup.b.next_sibling
# <c>text2</c>
sibling_soup.c.previous_sibling
# <b>text1</b>
У тега <b> есть ``.next_sibling``, но нет ``.previous_sibling``,
потому что нет ничего до тега <b> `на том же уровне
дерева`. По той же причине у тега <c> есть ``.previous_sibling``,
но нет ``.next_sibling``::
print(sibling_soup.b.previous_sibling)
# None
print(sibling_soup.c.next_sibling)
# None
Строки "text1" и "text2" `не являются` одноуровневыми, потому что они не
имеют общего родителя::
sibling_soup.b.string
# u'text1'
print(sibling_soup.b.string.next_sibling)
# None
В реальных документах ``.next_sibling`` или ``.previous_sibling``
тега обычно будет строкой, содержащей пробелы. Возвращаясь к
фрагменту из «Алисы в стране чудес»::
<a href="http://example.com/elsie" class="sister" id="link1">Elsie</a>
<a href="http://example.com/lacie" class="sister" id="link2">Lacie</a>
<a href="http://example.com/tillie" class="sister" id="link3">Tillie</a>
Вы можете подумать, что ``.next_sibling`` первого тега <a>
должен быть второй тег <a>. Но на самом деле это строка: запятая и
перевод строки, отделяющий первый тег <a> от второго::
link = soup.a
link
# <a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>
link.next_sibling
# u',\n'
Второй тег <a> на самом деле является ``.next_sibling`` запятой ::
link.next_sibling.next_sibling
# <a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>
.. _sibling-generators:
``.next_siblings`` и ``.previous_siblings``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Вы можете перебрать одноуровневые элементы данного тега с помощью ``.next_siblings`` или
``.previous_siblings``::
for sibling in soup.a.next_siblings:
print(repr(sibling))
# u',\n'
# <a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>
# u' and\n'
# <a class="sister" href="http://example.com/tillie" id="link3">Tillie</a>
# u'; and they lived at the bottom of a well.'
# None
for sibling in soup.find(id="link3").previous_siblings:
print(repr(sibling))
# ' and\n'
# <a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>
# u',\n'
# <a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>
# u'Once upon a time there were three little sisters; and their names were\n'
# None
Проход вперед и назад
---------------------
Взгляните на начало фрагмента из «Алисы в стране чудес»::
<html><head><title>The Dormouse's story</title></head>
<p class="title"><b>The Dormouse's story</b></p>
HTML-парсер берет эту строку символов и превращает ее в
серию событий: "открыть тег <html>", "открыть тег <head>", "открыть
тег <html>", "добавить строку", "закрыть тег <title>", "открыть
тег <p>" и так далее. Beautiful Soup предлагает инструменты для реконструирование
первоначального разбора документа.
.. _element-generators:
``.next_element`` и ``.previous_element``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Атрибут ``.next_element`` строки или тега указывает на то,
что было разобрано непосредственно после него. Это могло бы быть тем же, что и
``.next_sibling``, но обычно результат резко отличается.
Возьмем последний тег <a> в фрагменте из «Алисы в стране чудес». Его
``.next_sibling`` является строкой: конец предложения, которое было
прервано началом тега <a>::
last_a_tag = soup.find("a", id="link3")
last_a_tag
# <a class="sister" href="http://example.com/tillie" id="link3">Tillie</a>
last_a_tag.next_sibling
# '; and they lived at the bottom of a well.'
Но ``.next_element`` этого тега <a> — это то, что было разобрано
сразу после тега <a>, `не` остальная часть этого предложения:
это слово "Tillie"::
last_a_tag.next_element
# u'Tillie'
Это потому, что в оригинальной разметке слово «Tillie» появилось
перед точкой с запятой. Парсер обнаружил тег <a>, затем
слово «Tillie», затем закрывающий тег </a>, затем точку с запятой и оставшуюся
часть предложения. Точка с запятой находится на том же уровне, что и тег <a>, но
слово «Tillie» встретилось первым.
Атрибут ``.previous_element`` является полной противоположностью
``.next_element``. Он указывает на элемент, который был встречен при разборе
непосредственно перед текущим::
last_a_tag.previous_element
# u' and\n'
last_a_tag.previous_element.next_element
# <a class="sister" href="http://example.com/tillie" id="link3">Tillie</a>
``.next_elements`` и ``.previous_elements``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Вы уже должны были уловить идею. Вы можете использовать их для перемещения
вперед или назад по документу, в том порядке, в каком он был разобран парсером::
for element in last_a_tag.next_elements:
print(repr(element))
# u'Tillie'
# u';\nand they lived at the bottom of a well.'
# u'\n\n'
# <p class="story">...</p>
# u'...'
# u'\n'
# None
Поиск по дереву
===============
Beautiful Soup определяет множество методов поиска по дереву разбора,
но они все очень похожи. Я буду долго объяснять, как работают
два самых популярных метода: ``find()`` и ``find_all()``. Прочие
методы принимают практически те же самые аргументы, поэтому я расскажу
о них вкратце.
И опять, я буду использовать фрагмент из «Алисы в стране чудес» в качестве примера::
html_doc = """
<html><head><title>The Dormouse's story</title></head>
<body>
<p class="title"><b>The Dormouse's story</b></p>
<p class="story">Once upon a time there were three little sisters; and their names were
<a href="http://example.com/elsie" class="sister" id="link1">Elsie</a>,
<a href="http://example.com/lacie" class="sister" id="link2">Lacie</a> and
<a href="http://example.com/tillie" class="sister" id="link3">Tillie</a>;
and they lived at the bottom of a well.</p>
<p class="story">...</p>
"""
from bs4 import BeautifulSoup
soup = BeautifulSoup (html_doc, 'html.parser')
Передав фильтр в аргумент типа ``find_all()``, вы можете
углубиться в интересующие вас части документа.
Виды фильтров
-------------
Прежде чем подробно рассказывать о ``find_all()`` и подобных методах, я
хочу показать примеры различных фильтров, которые вы можете передать в эти
методы. Эти фильтры появляются снова и снова в
поисковом API. Вы можете использовать их для фильтрации по имени тега,
по его атрибутам, по тексту строки или по некоторой их
комбинации.
.. _a string:
Строка
^^^^^^
Самый простой фильтр — это строка. Передайте строку в метод поиска, и
Beautiful Soup выполнит поиск соответствия этой строке. Следующий
код находит все теги <b> в документе::
soup.find_all('b')
# [<b>The Dormouse's story</b>]
Если вы передадите байтовую строку, Beautiful Soup будет считать, что строка
кодируется в UTF-8. Вы можете избежать этого, передав вместо нее строку Unicode.
.. _a regular expression:
Регулярное выражение
^^^^^^^^^^^^^^^^^^^^
Если вы передадите объект с регулярным выражением, Beautiful Soup отфильтрует результаты
в соответствии с этим регулярным выражением, используя его метод ``search()``. Следующий код
находит все теги, имена которых начинаются с буквы "b"; в нашем
случае это теги <body> и <b>::
import re
for tag in soup.find_all(re.compile("^b")):
print(tag.name)
# body
# b
Этот код находит все теги, имена которых содержат букву "t"::
for tag in soup.find_all(re.compile("t")):
print(tag.name)
# html
# title
.. _a list:
Список
^^^^^^
Если вы передадите список, Beautiful Soup разрешит совпадение строк
с `любым` элементом из этого списка. Следующий код находит все теги <a>
`и` все теги <b>::
soup.find_all(["a", "b"])
# [<b>The Dormouse's story</b>,
# <a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>,
# <a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>,
# <a class="sister" href="http://example.com/tillie" id="link3">Tillie</a>]
.. _the value True:
``True``
^^^^^^^^
Значение ``True`` подходит везде, где возможно.. Следующий код находит `все`
теги в документе, но не текстовые строки::
for tag in soup.find_all(True):
print(tag.name)
# html
# head
# title
# body
# p
# b
# p
# a
# a
# a
# p
.. a function:
Функция
^^^^^^^
Если ничто из перечисленного вам не подходит, определите функцию, которая
принимает элемент в качестве единственного аргумента. Функция должна вернуть
``True``, если аргумент подходит, и ``False``, если нет.
Вот функция, которая возвращает ``True``, если в теге определен атрибут "class",
но не определен атрибут "id"::
def has_class_but_no_id(tag):
return tag.has_attr('class') and not tag.has_attr('id')
Передайте эту функцию в ``find_all()``, и вы получите все
теги <p>::
soup.find_all(has_class_but_no_id)
# [<p class="title"><b>The Dormouse's story</b></p>,
# <p class="story">Once upon a time there were...</p>,
# <p class="story">...</p>]
Эта функция выбирает только теги <p>. Она не выбирает теги <a>,
поскольку в них определены и атрибут "class" , и атрибут "id". Она не выбирает
теги вроде <html> и <title>, потому что в них не определен атрибут
"class".
Если вы передаете функцию для фильтрации по определенному атрибуту, такому как
``href``, аргументом, переданным в функцию, будет
значение атрибута, а не весь тег. Вот функция, которая находит все теги ``a``,
у которых атрибут ``href`` *не* соответствует регулярному выражению::
def not_lacie(href):
return href and not re.compile("lacie").search(href)
soup.find_all(href=not_lacie)
# [<a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>,
# <a class="sister" href="http://example.com/tillie" id="link3">Tillie</a>]
Функция может быть настолько сложной, насколько вам нужно. Вот
функция, которая возвращает ``True``, если тег окружен строковыми
объектами::
from bs4 import NavigableString
def surrounded_by_strings(tag):
return (isinstance(tag.next_element, NavigableString)
and isinstance(tag.previous_element, NavigableString))
for tag in soup.find_all(surrounded_by_strings):
print tag.name
# p
# a
# a
# a
# p
Теперь мы готовы подробно рассмотреть методы поиска.
``find_all()``
--------------
Сигнатура: find_all(:ref:`name <name>`, :ref:`attrs <attrs>`, :ref:`recursive
<recursive>`, :ref:`string <string>`, :ref:`limit <limit>`, :ref:`**kwargs <kwargs>`)
Метод ``find_all()`` просматривает потомков тега и
извлекает `всех` потомков, которые соответствую вашим фильтрам. Я привел несколько
примеров в разделе `Виды фильтров`_, а вот еще несколько::
soup.find_all("title")
# [<title>The Dormouse's story</title>]
soup.find_all("p", "title")
# [<p class="title"><b>The Dormouse's story</b></p>]
soup.find_all("a")
# [<a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>,
# <a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>,
# <a class="sister" href="http://example.com/tillie" id="link3">Tillie</a>]
soup.find_all(id="link2")
# [<a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>]
import re
soup.find(string=re.compile("sisters"))
# u'Once upon a time there were three little sisters; and their names were\n'
Кое-что из этого нам уже знакомо, но есть и новое. Что означает
передача значения для ``string`` или ``id``? Почему
``find_all ("p", "title")`` находит тег <p> с CSS-классом "title"?
Давайте посмотрим на аргументы ``find_all()``.
.. _name:
Аргумент ``name``
^^^^^^^^^^^^^^^^^
Передайте значение для аргумента ``name``, и вы скажете Beautiful Soup
рассматривать только теги с определенными именами. Текстовые строки будут игнорироваться, так же как и
теги, имена которых не соответствуют заданным.
Вот простейший пример использования::
soup.find_all("title")
# [<title>The Dormouse's story</title>]
В разделе `Виды фильтров`_ говорилось, что значением ``name`` может быть
`строка`_, `регулярное выражение`_, `список`_, `функция`_ или
`True`_.
.. _kwargs:
Именованные аргументы
^^^^^^^^^^^^^^^^^^^^^
Любой нераспознанный аргумент будет превращен в фильтр
по атрибуту тега. Если вы передаете значение для аргумента с именем ``id``,
Beautiful Soup будет фильтровать по атрибуту "id" каждого тега::
soup.find_all(id='link2')
# [<a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>]
Если вы передадите значение для ``href``, Beautiful Soup отфильтрует
по атрибуту "href" каждого тега::
soup.find_all(href=re.compile("elsie"))
# [<a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>]
Для фильтрации по атрибуту может использоваться `строка`_, `регулярное
выражение`_, `список`_, `функция`_ или значение `True`_.
Следующий код находит все теги, атрибут ``id`` которых имеет значение,
независимо от того, что это за значение::
soup.find_all(id=True)
# [<a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>,
# <a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>,
# <a class="sister" href="http://example.com/tillie" id="link3">Tillie</a>]
Вы можете отфильтровать несколько атрибутов одновременно, передав более одного
именованного аргумента::
soup.find_all(href=re.compile("elsie"), id='link1')
# [<a class="sister" href="http://example.com/elsie" id="link1">three</a>]
Некоторые атрибуты, такие как атрибуты data-* в HTML 5, имеют имена, которые
нельзя использовать в качестве имен именованных аргументов::
data_soup = BeautifulSoup('<div data-foo="value">foo!</div>')
data_soup.find_all(data-foo="value")
# SyntaxError: keyword can't be an expression
Вы можете использовать эти атрибуты в поиске, поместив их в
словарь и передав словарь в ``find_all()`` как
аргумент ``attrs``::
data_soup.find_all(attrs={"data-foo": "value"})
# [<div data-foo="value">foo!</div>]
Нельзя использовать именованный аргумент для поиска в HTML по элементу "name",
потому что Beautiful Soup использует аргумент ``name`` для имени
самого тега. Вместо этого вы можете передать элемент "name" вместе с его значением в
составе аргумента ``attrs``::
name_soup = BeautifulSoup('<input name="email"/>')
name_soup.find_all(name="email")
# []
name_soup.find_all(attrs={"name": "email"})
# [<input name="email"/>]
.. _attrs:
Поиск по классу CSS
^^^^^^^^^^^^^^^^^^^
Очень удобно искать тег с определенным классом CSS, но
имя атрибута CSS, "class", является зарезервированным словом в
Python. Использование ``class`` в качестве именованного аргумента приведет к синтаксической
ошибке. Начиная с Beautiful Soup 4.1.2, вы можете выполнять поиск по классу CSS, используя
именованный аргумент ``class_``::
soup.find_all("a", class_="sister")
# [<a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>,
# <a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>,
# <a class="sister" href="http://example.com/tillie" id="link3">Tillie</a>]
Как и с любым именованным аргументом, вы можете передать в качестве значения ``class_`` строку, регулярное
выражение, функцию или ``True``::
soup.find_all(class_=re.compile("itl"))
# [<p class="title"><b>The Dormouse's story</b></p>]
def has_six_characters(css_class):
return css_class is not None and len(css_class) == 6
soup.find_all(class_=has_six_characters)
# [<a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>,
# <a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>,
# <a class="sister" href="http://example.com/tillie" id="link3">Tillie</a>]
Помните, что один тег может иметь :ref:`несколько значений <multivalue>`
для атрибута "class". Когда вы ищете тег, который
соответствует определенному классу CSS, вы ищете соответствие `любому` из его
классов CSS::
css_soup = BeautifulSoup('<p class="body strikeout"></p>')
css_soup.find_all("p", class_="strikeout")
# [<p class="body strikeout"></p>]
css_soup.find_all("p", class_="body")
# [<p class="body strikeout"></p>]
Можно искать точное строковое значение атрибута ``class``::
css_soup.find_all("p", class_="body strikeout")
# [<p class="body strikeout"></p>]
Но поиск вариантов строкового значения не сработает::
css_soup.find_all("p", class_="strikeout body")
# []
Если вы хотите искать теги, которые соответствуют двум или более классам CSS,
следует использовать селектор CSS::
css_soup.select("p.strikeout.body")
# [<p class="body strikeout"></p>]
В старых версиях Beautiful Soup, в которых нет ярлыка ``class_``
можно использовать трюк с аргументом ``attrs``, упомянутый выше. Создайте
словарь, значение которого для "class" является строкой (или регулярным
выражением, или чем угодно еще), которую вы хотите найти::
soup.find_all("a", attrs={"class": "sister"})
# [<a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>,
# <a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>,
# <a class="sister" href="http://example.com/tillie" id="link3">Tillie</a>]
.. _string:
Аргумент ``string``
^^^^^^^^^^^^^^^^^^^
С помощью ``string`` вы можете искать строки вместо тегов. Как и в случае с
``name`` и именованными аргументами, передаваться может `строка`_,
`регулярное выражение`_, `список`_, `функция`_ или значения `True`_.
Вот несколько примеров::
soup.find_all(string="Elsie")
# [u'Elsie']
soup.find_all(string=["Tillie", "Elsie", "Lacie"])
# [u'Elsie', u'Lacie', u'Tillie']
soup.find_all(string=re.compile("Dormouse"))
[u"The Dormouse's story", u"The Dormouse's story"]
def is_the_only_string_within_a_tag(s):
"""Return True if this string is the only child of its parent tag."""
return (s == s.parent.string)
soup.find_all(string=is_the_only_string_within_a_tag)
# [u"The Dormouse's story", u"The Dormouse's story", u'Elsie', u'Lacie', u'Tillie', u'...']
Хотя значение типа ``string`` предназначено для поиска строк, вы можете комбинировать его с
аргументами, которые находят теги: Beautiful Soup найдет все теги, в которых
``.string`` соответствует вашему значению для ``string``. Следующий код находит все теги <a>,
у которых ``.string`` равно "Elsie"::
soup.find_all("a", string="Elsie")
# [<a href="http://example.com/elsie" class="sister" id="link1">Elsie</a>]
Аргумент ``string`` — это новое в Beautiful Soup 4.4.0. В ранних
версиях он назывался ``text``::
soup.find_all("a", text="Elsie")
# [<a href="http://example.com/elsie" class="sister" id="link1">Elsie</a>]
.. _limit:
Аргумент ``limit``
^^^^^^^^^^^^^^^^^^
``find_all()`` возвращает все теги и строки, которые соответствуют вашим
фильтрам. Это может занять некоторое время, если документ большой. Если вам не
нужны `все` результаты, вы можете указать их предельное число — ``limit``. Это
работает так же, как ключевое слово LIMIT в SQL. Оно говорит Beautiful Soup
прекратить собирать результаты после того, как их найдено определенное количество.
В фрагменте из «Алисы в стране чудес» есть три ссылки, но следующий код
находит только первые две::
soup.find_all("a", limit=2)
# [<a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>,
# <a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>]
.. _recursive:
Аргумент ``recursive``
^^^^^^^^^^^^^^^^^^^^^^
Если вы вызовете ``mytag.find_all()``, Beautiful Soup проверит всех
потомков ``mytag``: его дочерние элементы, дочерние элементы дочерних элементов, и
так далее. Если вы хотите, чтобы Beautiful Soup рассматривал только непосредственных потомков (дочерние элементы),
вы можете передать ``recursive = False``. Оцените разницу::
soup.html.find_all("title")
# [<title>The Dormouse's story</title>]
soup.html.find_all("title", recursive=False)
# []
Вот эта часть документа::
<html>
<head>
<title>
The Dormouse's story
</title>
</head>
...
Тег <title> находится под тегом <html>, но не `непосредственно`
под тегом <html>: на пути встречается тег <head>. Beautiful Soup
находит тег <title>, когда разрешено просматривать всех потомков
тега <html>, но когда ``recursive=False`` ограничивает поиск
только непосредстввенно дочерними элементами, Beautiful Soup ничего не находит.
Beautiful Soup предлагает множество методов поиска по дереву (они рассмотрены ниже),
и они в основном принимают те же аргументы, что и ``find_all()``: ``name``,
``attrs``, ``string``, ``limit`` и именованные аргументы. Но
с аргументом ``recursive`` все иначе: ``find_all()`` и ``find()`` —
это единственные методы, которые его поддерживают. От передачи ``recursive=False`` в
метод типа ``find_parents()`` не очень много пользы.
Вызов тега похож на вызов ``find_all()``
----------------------------------------
Поскольку ``find_all()`` является самым популярным методом в Beautiful
Soup API, вы можете использовать сокращенную запись. Если относиться к
объекту ``BeautifulSoup`` или объекту ``Tag`` так, будто это
функция, то это похоже на вызов ``find_all()``
с этим объектом. Эти две строки кода эквивалентны::
soup.find_all("a")
soup("a")
Эти две строки также эквивалентны::
soup.title.find_all(string=True)
soup.title(string=True)
``find()``
----------
Сигнатура: find(:ref:`name <name>`, :ref:`attrs <attrs>`, :ref:`recursive
<recursive>`, :ref:`string <string>`, :ref:`**kwargs <kwargs>`)
Метод ``find_all()`` сканирует весь документ в поиске
всех результатов, но иногда вам нужен только один. Если вы знаете,
что в документе есть только один тег <body>, нет смысла сканировать
весь документ в поиске остальных. Вместо того, чтобы передавать ``limit=1``
каждый раз, когда вы вызываете ``find_all()``, используйте
метод ``find()``. Эти две строки кода эквивалентны::
soup.find_all('title', limit=1)
# [<title>The Dormouse's story</title>]
soup.find('title')
# <title>The Dormouse's story</title>
Разница лишь в том, что ``find_all()`` возвращает список, содержащий
единственный результат, а ``find()`` возвращает только сам результат.
Если ``find_all()`` не может ничего найти, он возвращает пустой список. Если
``find()`` не может ничего найти, он возвращает ``None``::
print(soup.find("nosuchtag"))
# None
Помните трюк с ``soup.head.title`` из раздела
`Навигация с использованием имен тегов`_? Этот трюк работает на основе неоднократного вызова ``find()``::
soup.head.title
# <title>The Dormouse's story</title>
soup.find("head").find("title")
# <title>The Dormouse's story</title>
``find_parents()`` и ``find_parent()``
--------------------------------------
Сигнатура: find_parents(:ref:`name <name>`, :ref:`attrs <attrs>`, :ref:`string <string>`, :ref:`limit <limit>`, :ref:`**kwargs <kwargs>`)
Сигнатура: find_parent(:ref:`name <name>`, :ref:`attrs <attrs>`, :ref:`string <string>`, :ref:`**kwargs <kwargs>`)
Я долго объяснял, как работают ``find_all()`` и
``find()``. Beautiful Soup API определяет десяток других методов для
поиска по дереву, но пусть вас это не пугает. Пять из этих методов
в целом похожи на ``find_all()``, а другие пять в целом
похожи на ``find()``. Единственное различие в том, по каким частям
дерева они ищут.
Сначала давайте рассмотрим ``find_parents()`` и
``find_parent()``. Помните, что ``find_all()`` и ``find()`` прорабатывают
дерево сверху вниз, просматривая теги и их потомков. ``find_parents()`` и ``find_parent()``
делают наоборот: они идут `снизу вверх`, рассматривая
родительские элементы тега или строки. Давайте испытаем их, начав со строки,
закопанной глубоко в фрагменте из «Алисы в стране чудес»::
a_string = soup.find(string="Lacie")
a_string
# u'Lacie'
a_string.find_parents("a")
# [<a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>]
a_string.find_parent("p")
# <p class="story">Once upon a time there were three little sisters; and their names were
# <a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>,
# <a class="sister" href="http://example.com/lacie" id="link2">Lacie</a> and
# <a class="sister" href="http://example.com/tillie" id="link3">Tillie</a>;
# and they lived at the bottom of a well.</p>
a_string.find_parents("p", class="title")
# []
Один из трех тегов <a> является прямым родителем искомой строки,
так что наш поиск находит его. Один из трех тегов <p> является
непрямым родителем строки, и наш поиск тоже его
находит. Где-то в документе есть тег <p> с классом CSS "title",
но он не является родительским для строки, так что мы не можем найти
его с помощью ``find_parents()``.
Вы могли заметить связь между ``find_parent()``,
``find_parents()`` и атрибутами `.parent`_ и `.parents`_,
упомянутыми ранее. Связь очень сильная. Эти методы поиска
на самом деле используют ``.parents``, чтобы перебрать все родительские элементы и проверить
каждый из них на соответствие заданному фильтру.
``find_next_siblings()`` и ``find_next_sibling()``
--------------------------------------------------
Сигнатура: find_next_siblings(:ref:`name <name>`, :ref:`attrs <attrs>`, :ref:`string <string>`, :ref:`limit <limit>`, :ref:`**kwargs <kwargs>`)
Сигнатура: find_next_sibling(:ref:`name <name>`, :ref:`attrs <attrs>`, :ref:`string <string>`, :ref:`**kwargs <kwargs>`)
Эти методы используют :ref:`.next_siblings <sibling-generators>` для
перебора одноуровневых элементов для данного элемента в дереве. Метод
``find_next_siblings()`` возвращает все подходящие одноуровневые элементы,
а ``find_next_sibling()`` возвращает только первый из них::
first_link = soup.a
first_link
# <a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>
first_link.find_next_siblings("a")
# [<a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>,
# <a class="sister" href="http://example.com/tillie" id="link3">Tillie</a>]
first_story_paragraph = soup.find("p", "story")
first_story_paragraph.find_next_sibling("p")
# <p class="story">...</p>
``find_previous_siblings()`` и ``find_previous_sibling()``
----------------------------------------------------------
Сигнатура: find_previous_siblings(:ref:`name <name>`, :ref:`attrs <attrs>`, :ref:`string <string>`, :ref:`limit <limit>`, :ref:`**kwargs <kwargs>`)
Сигнатура: find_previous_sibling(:ref:`name <name>`, :ref:`attrs <attrs>`, :ref:`string <string>`, :ref:`**kwargs <kwargs>`)
Эти методы используют :ref:`.previous_siblings <sibling-generators>` для перебора тех одноуровневых элементов,
которые предшествуют данному элементу в дереве разбора. Метод ``find_previous_siblings()``
возвращает все подходящие одноуровневые элементы,, а
а ``find_next_sibling()`` только первый из них::
last_link = soup.find("a", id="link3")
last_link
# <a class="sister" href="http://example.com/tillie" id="link3">Tillie</a>
last_link.find_previous_siblings("a")
# [<a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>,
# <a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>]
first_story_paragraph = soup.find("p", "story")
first_story_paragraph.find_previous_sibling("p")
# <p class="title"><b>The Dormouse's story</b></p>
``find_all_next()`` и ``find_next()``
-------------------------------------
Сигнатура: find_all_next(:ref:`name <name>`, :ref:`attrs <attrs>`, :ref:`string <string>`, :ref:`limit <limit>`, :ref:`**kwargs <kwargs>`)
Сигнатура: find_next(:ref:`name <name>`, :ref:`attrs <attrs>`, :ref:`string <string>`, :ref:`**kwargs <kwargs>`)
Эти методы используют :ref:`.next_elements <element-generators>` для
перебора любых тегов и строк, которые встречаются в документе после
элемента. Метод ``find_all_next()`` возвращает все совпадения, а
``find_next()`` только первое::
first_link = soup.a
first_link
# <a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>
first_link.find_all_next(string=True)
# [u'Elsie', u',\n', u'Lacie', u' and\n', u'Tillie',
# u';\nand they lived at the bottom of a well.', u'\n\n', u'...', u'\n']
first_link.find_next("p")
# <p class="story">...</p>
В первом примере нашлась строка "Elsie", хотя она
содержится в теге <a>, с которого мы начали. Во втором примере
нашелся последний тег <p>, хотя он находится
в другой части дерева, чем тег <a>, с которого мы начали. Для этих
методов имеет значение только то, что элемент соответствует фильтру и
появляется в документе позже, чем тот элемент, с которого начали поиск.
``find_all_previous()`` и ``find_previous()``
---------------------------------------------
Сигнатура: find_all_previous(:ref:`name <name>`, :ref:`attrs <attrs>`, :ref:`string <string>`, :ref:`limit <limit>`, :ref:`**kwargs <kwargs>`)
Сигнатура: find_previous(:ref:`name <name>`, :ref:`attrs <attrs>`, :ref:`string <string>`, :ref:`**kwargs <kwargs>`)
Эти методы используют :ref:`.previous_elements <element-generators>` для
перебора любых тегов и строк, которые встречаются в документе до
элемента. Метод ``find_all_previous()`` возвращает все совпадения, а
``find_previous()`` только первое::
first_link = soup.a
first_link
# <a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>
first_link.find_all_previous("p")
# [<p class="story">Once upon a time there were three little sisters; ...</p>,
# <p class="title"><b>The Dormouse's story</b></p>]
first_link.find_previous("title")
# <title>The Dormouse's story</title>
Вызов ``find_all_previous ("p")`` нашел первый абзац в
документе (тот, который с ``class = "title"``), но он также находит
второй абзац, а именно тег <p>, содержащий тег <a>, с которого мы
начали. Это не так уж удивительно: мы смотрим на все теги,
которые появляются в документе раньше, чем тот, с которого мы начали. Тег
<p>, содержащий тег <a>, должен был появиться до тега <a>, который
в нем содержится.
Селекторы CSS
-------------
Начиная с версии 4.7.0, Beautiful Soup поддерживает большинство селекторов CSS4 благодаря
проекту `SoupSieve
<https://facelessuser.github.io/soupsieve/>`_. Если вы установили Beautiful Soup через ``pip``, одновременно должен был установиться SoupSieve,
так что вам больше ничего не нужно делать.
В ``BeautifulSoup`` есть метод ``.select()``, который использует SoupSieve, чтобы
запустить селектор CSS и вернуть все
подходящие элементы. ``Tag`` имеет похожий метод, который запускает селектор CSS
в отношении содержимого одного тега.
(В более ранних версиях Beautiful Soup тоже есть метод ``.select()``,
но поддерживаются только наиболее часто используемые селекторы CSS.)
В `документации SoupSieve
<https://facelessuser.github.io/soupsieve/>`_ перечислены все
селекторы CSS, которые поддерживаются на данный момент, но вот некоторые из основных:
Вы можете найти теги::
soup.select("title")
# [<title>The Dormouse's story</title>]
soup.select("p:nth-of-type(3)")
# [<p class="story">...</p>]
Найти теги под другими тегами::
soup.select("body a")
# [<a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>,
# <a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>,
# <a class="sister" href="http://example.com/tillie" id="link3">Tillie</a>]
soup.select("html head title")
# [<title>The Dormouse's story</title>]
Найти теги `непосредственно` под другими тегами::
soup.select("head > title")
# [<title>The Dormouse's story</title>]
soup.select("p > a")
# [<a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>,
# <a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>,
# <a class="sister" href="http://example.com/tillie" id="link3">Tillie</a>]
soup.select("p > a:nth-of-type(2)")
# [<a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>]
soup.select("p > #link1")
# [<a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>]
soup.select("body > a")
# []
Найти одноуровневые элементы тега::
soup.select("#link1 ~ .sister")
# [<a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>,
# <a class="sister" href="http://example.com/tillie" id="link3">Tillie</a>]
soup.select("#link1 + .sister")
# [<a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>]
Найти теги по классу CSS::
soup.select(".sister")
# [<a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>,
# <a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>,
# <a class="sister" href="http://example.com/tillie" id="link3">Tillie</a>]
soup.select("[class~=sister]")
# [<a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>,
# <a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>,
# <a class="sister" href="http://example.com/tillie" id="link3">Tillie</a>]
Найти теги по ID::
soup.select("#link1")
# [<a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>]
soup.select("a#link2")
# [<a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>]
Найти теги, которые соответствуют любому селектору из списка::
soup.select("#link1,#link2")
# [<a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>,
# <a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>]
Проверка на наличие атрибута::
soup.select('a[href]')
# [<a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>,
# <a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>,
# <a class="sister" href="http://example.com/tillie" id="link3">Tillie</a>]
Найти теги по значению атрибута::
soup.select('a[href="http://example.com/elsie"]')
# [<a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>]
soup.select('a[href^="http://example.com/"]')
# [<a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>,
# <a class="sister" href="http://example.com/lacie" id="link2">Lacie</a>,
# <a class="sister" href="http://example.com/tillie" id="link3">Tillie</a>]
soup.select('a[href$="tillie"]')
# [<a class="sister" href="http://example.com/tillie" id="link3">Tillie</a>]
soup.select('a[href*=".com/el"]')
# [<a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>]
Есть также метод ``select_one()``, который находит только
первый тег, соответствующий селектору::
soup.select_one(".sister")
# <a class="sister" href="http://example.com/elsie" id="link1">Elsie</a>
Если вы разобрали XML, в котором определены пространства имен, вы можете использовать их в
селекторах CSS::
from bs4 import BeautifulSoup
xml = """<tag xmlns:ns1="http://namespace1/" xmlns:ns2="http://namespace2/">
<ns1:child>I'm in namespace 1</ns1:child>
<ns2:child>I'm in namespace 2</ns2:child>
</tag> """
soup = BeautifulSoup(xml, "xml")
soup.select("child")
# [<ns1:child>I'm in namespace 1</ns1:child>, <ns2:child>I'm in namespace 2</ns2:child>]
soup.select("ns1|child", namespaces=namespaces)
# [<ns1:child>I'm in namespace 1</ns1:child>]
При обработке селектора CSS, который использует пространства имен, Beautiful Soup
использует сокращения пространства имен, найденные при разборе
документа. Вы можете заменить сокращения своими собственными, передав словарь
сокращений::
namespaces = dict(first="http://namespace1/", second="http://namespace2/")
soup.select("second|child", namespaces=namespaces)
# [<ns1:child>I'm in namespace 2</ns1:child>]
Все эти селекторы CSS удобны для тех, кто уже
знаком с синтаксисом селекторов CSS. Вы можете сделать все это с помощью
Beautiful Soup API. И если CSS селекторы — это все, что вам нужно, вам следует
использовать парсер lxml: так будет намного быстрее. Но вы можете
`комбинировать` селекторы CSS с Beautiful Soup API.
Изменение дерева
================
Основная сила Beautiful Soup в поиске по дереву разбора, но вы
также можете изменить дерево и записать свои изменения в виде нового HTML или
XML-документа.
Изменение имен тегов и атрибутов
--------------------------------
Я говорил об этом раньше, в разделе `Атрибуты`_, но это стоит повторить. Вы
можете переименовать тег, изменить значения его атрибутов, добавить новые
атрибуты и удалить атрибуты::
soup = BeautifulSoup('<b class="boldest">Extremely bold</b>')
tag = soup.b
tag.name = "blockquote"
tag['class'] = 'verybold'
tag['id'] = 1
tag
# <blockquote class="verybold" id="1">Extremely bold</blockquote>
del tag['class']
del tag['id']
tag
# <blockquote>Extremely bold</blockquote>
Изменение ``.string``
---------------------
Если вы замените значение атрибута ``.string`` новой строкой, содержимое тега будет
заменено на эту строку::
markup = '<a href="http://example.com/">I linked to <i>example.com</i></a>'
soup = BeautifulSoup(markup)
tag = soup.a
tag.string = "New link text."
tag
# <a href="http://example.com/">New link text.</a>
Будьте осторожны: если тег содержит другие теги, они и все их
содержимое будет уничтожено.
``append()``
------------
Вы можете добавить содержимое тега с помощью ``Tag.append()``. Это работает
точно так же, как ``.append()`` для списка в Python::
soup = BeautifulSoup("<a>Foo</a>")
soup.a.append("Bar")
soup
# <html><head></head><body><a>FooBar</a></body></html>
soup.a.contents
# [u'Foo', u'Bar']
``extend()``
------------
Начиная с версии Beautiful Soup 4.7.0, ``Tag`` также поддерживает метод
``.extend()``, который работает так же, как вызов ``.extend()`` для
списка в Python::
soup = BeautifulSoup("<a>Soup</a>")
soup.a.extend(["'s", " ", "on"])
soup
# <html><head></head><body><a>Soup's on</a></body></html>
soup.a.contents
# [u'Soup', u''s', u' ', u'on']
``NavigableString()`` и ``.new_tag()``
--------------------------------------
Если вам нужно добавить строку в документ, нет проблем — вы можете передать
строку Python в ``append()`` или вызвать
конструктор ``NavigableString``::
soup = BeautifulSoup("<b></b>")
tag = soup.b
tag.append("Hello")
new_string = NavigableString(" there")
tag.append(new_string)
tag
# <b>Hello there.</b>
tag.contents
# [u'Hello', u' there']
Если вы хотите создать комментарий или другой подкласс
``NavigableString``, просто вызовите конструктор::
from bs4 import Comment
new_comment = Comment("Nice to see you.")
tag.append(new_comment)
tag
# <b>Hello there<!--Nice to see you.--></b>
tag.contents
# [u'Hello', u' there', u'Nice to see you.']
(Это новая функция в Beautiful Soup 4.4.0.)
Что делать, если вам нужно создать совершенно новый тег? Наилучшим решением будет
вызвать фабричный метод ``BeautifulSoup.new_tag()``::
soup = BeautifulSoup("<b></b>")
original_tag = soup.b
new_tag = soup.new_tag("a", href="http://www.example.com")
original_tag.append(new_tag)
original_tag
# <b><a href="http://www.example.com"></a></b>
new_tag.string = "Link text."
original_tag
# <b><a href="http://www.example.com">Link text.</a></b>
Нужен только первый аргумент, имя тега.
``insert()``
------------
``Tag.insert()`` похож на ``Tag.append()``, за исключением того, что новый элемент
не обязательно добавляется в конец родительского
``.contents``. Он добавится в любое место, номер которого
вы укажете. Это работает в точности как ``.insert()`` в списке Python::
markup = '<a href="http://example.com/">I linked to <i>example.com</i></a>'
soup = BeautifulSoup(markup)
tag = soup.a
tag.insert(1, "but did not endorse ")
tag
# <a href="http://example.com/">I linked to but did not endorse <i>example.com</i></a>
tag.contents
# [u'I linked to ', u'but did not endorse', <i>example.com</i>]
``insert_before()`` и ``insert_after()``
----------------------------------------
Метод ``insert_before()`` вставляет теги или строки непосредственно
перед чем-то в дереве разбора::
soup = BeautifulSoup("<b>stop</b>")
tag = soup.new_tag("i")
tag.string = "Don't"
soup.b.string.insert_before(tag)
soup.b
# <b><i>Don't</i>stop</b>
Метод ``insert_after()`` вставляет теги или строки непосредственно
после чего-то в дереве разбора::
div = soup.new_tag('div')
div.string = 'ever'
soup.b.i.insert_after(" you ", div)
soup.b
# <b><i>Don't</i> you <div>ever</div> stop</b>
soup.b.contents
# [<i>Don't</i>, u' you', <div>ever</div>, u'stop']
``clear()``
-----------
``Tag.clear()`` удаляет содержимое тега::
markup = '<a href="http://example.com/">I linked to <i>example.com</i></a>'
soup = BeautifulSoup(markup)
tag = soup.a
tag.clear()
tag
# <a href="http://example.com/"></a>
``extract()``
-------------
``PageElement.extract()`` удаляет тег или строку из дерева. Он
возвращает тег или строку, которая была извлечена::
markup = '<a href="http://example.com/">I linked to <i>example.com</i></a>'
soup = BeautifulSoup(markup)
a_tag = soup.a
i_tag = soup.i.extract()
a_tag
# <a href="http://example.com/">I linked to</a>
i_tag
# <i>example.com</i>
print(i_tag.parent)
None
К этому моменту у вас фактически есть два дерева разбора: одно в
объекте ``BeautifulSoup``, который вы использовали, чтобы разобрать документ, другое в
теге, который был извлечен. Вы можете далее вызывать ``extract`` в отношении
дочернего элемента того тега, который был извлечен::
my_string = i_tag.string.extract()
my_string
# u'example.com'
print(my_string.parent)
# None
i_tag
# <i></i>
``decompose()``
---------------
``Tag.decompose()`` удаляет тег из дерева, а затем `полностью
уничтожает его вместе с его содержимым`::
markup = '<a href="http://example.com/">I linked to <i>example.com</i></a>'
soup = BeautifulSoup(markup)
a_tag = soup.a
soup.i.decompose()
a_tag
# <a href="http://example.com/">I linked to</a>
.. _replace_with():
``replace_with()``
------------------
``PageElement.extract()`` удаляет тег или строку из дерева
и заменяет его тегом или строкой по вашему выбору::
markup = '<a href="http://example.com/">I linked to <i>example.com</i></a>'
soup = BeautifulSoup(markup)
a_tag = soup.a
new_tag = soup.new_tag("b")
new_tag.string = "example.net"
a_tag.i.replace_with(new_tag)
a_tag
# <a href="http://example.com/">I linked to <b>example.net</b></a>
``replace_with()`` возвращает тег или строку, которые были заменены, так что
вы можете изучить его или добавить его обратно в другую часть дерева.
``wrap()``
----------
``PageElement.wrap()`` обертывает элемент в указанный вами тег. Он
возвращает новую обертку::
soup = BeautifulSoup("<p>I wish I was bold.</p>")
soup.p.string.wrap(soup.new_tag("b"))
# <b>I wish I was bold.</b>
soup.p.wrap(soup.new_tag("div")
# <div><p><b>I wish I was bold.</b></p></div>
Это новый метод в Beautiful Soup 4.0.5.
``unwrap()``
------------
``Tag.unwrap()`` — это противоположность ``wrap()``. Он заменяет весь тег на
его содержимое. Этим методом удобно очищать разметку::
markup = '<a href="http://example.com/">I linked to <i>example.com</i></a>'
soup = BeautifulSoup(markup)
a_tag = soup.a
a_tag.i.unwrap()
a_tag
# <a href="http://example.com/">I linked to example.com</a>
Как и ``replace_with()``, ``unwrap()`` возвращает тег,
который был заменен.
``smooth()``
------------
После вызова ряда методов, которые изменяют дерево разбора, у вас может оказаться несколько объектов ``NavigableString`` подряд. У Beautiful Soup с этим нет проблем, но поскольку такое не случается со свежеразобранным документом, вам может показаться неожиданным следующее поведение::
soup = BeautifulSoup("<p>A one</p>")
soup.p.append(", a two")
soup.p.contents
# [u'A one', u', a two']
print(soup.p.encode())
# <p>A one, a two</p>
print(soup.p.prettify())
# <p>
# A one
# , a two
# </p>
Вы можете вызвать ``Tag.smooth()``, чтобы очистить дерево разбора путем объединения смежных строк::
soup.smooth()
soup.p.contents
# [u'A one, a two']
print(soup.p.prettify())
# <p>
# A one, a two
# </p>
``smooth()`` — это новый метод в Beautiful Soup 4.8.0.
Вывод
=====
.. _.prettyprinting:
Красивое форматирование
-----------------------
Метод ``prettify()`` превратит дерево разбора Beautiful Soup в
красиво отформатированную строку Unicode, где каждый
тег и каждая строка выводятся на отдельной строчке::
markup = '<a href="http://example.com/">I linked to <i>example.com</i></a>'
soup = BeautifulSoup(markup)
soup.prettify()
# '<html>\n <head>\n </head>\n <body>\n <a href="http://example.com/">\n...'
print(soup.prettify())
# <html>
# <head>
# </head>
# <body>
# <a href="http://example.com/">
# I linked to
# <i>
# example.com
# </i>
# </a>
# </body>
# </html>
Вы можете вызвать ``prettify()`` для объекта ``BeautifulSoup`` верхнего уровня
или для любого из его объектов ``Tag``::
print(soup.a.prettify())
# <a href="http://example.com/">
# I linked to
# <i>
# example.com
# </i>
# </a>
Без красивого форматирования
----------------------------
Если вам нужна просто строка, без особого форматирования, вы можете вызвать
``unicode()`` или ``str()`` для объекта ``BeautifulSoup`` или объекта ``Tag``
внутри::
str(soup)
# '<html><head></head><body><a href="http://example.com/">I linked to <i>example.com</i></a></body></html>'
unicode(soup.a)
# u'<a href="http://example.com/">I linked to <i>example.com</i></a>'
Функция ``str()`` возвращает строку, кодированную в UTF-8. Для получения более подробной информации см.
`Кодировки`_.
Вы также можете вызвать ``encode()`` для получения байтовой строки, и ``decode()``,
чтобы получить Unicode.
.. _output_formatters:
Средства форматирования вывода
------------------------------
Если вы дадите Beautiful Soup документ, который содержит HTML-мнемоники, такие как
"&lquot;", они будут преобразованы в символы Unicode::
soup = BeautifulSoup("“Dammit!” he said.")
unicode(soup)
# u'<html><head></head><body>\u201cDammit!\u201d he said.</body></html>'
Если затем преобразовать документ в строку, символы Unicode
будет кодироваться как UTF-8. Вы не получите обратно HTML-мнемоники::
str(soup)
# '<html><head></head><body>\xe2\x80\x9cDammit!\xe2\x80\x9d he said.</body></html>'
По умолчанию единственные символы, которые экранируются при выводе — это чистые
амперсанды и угловые скобки. Они превращаются в «&», «<»
и ">", чтобы Beautiful Soup случайно не сгенерировал
невалидный HTML или XML::
soup = BeautifulSoup("<p>The law firm of Dewey, Cheatem, & Howe</p>")
soup.p
# <p>The law firm of Dewey, Cheatem, & Howe</p>
soup = BeautifulSoup('<a href="http://example.com/?foo=val1&bar=val2">A link</a>')
soup.a
# <a href="http://example.com/?foo=val1&bar=val2">A link</a>
Вы можете изменить это поведение, указав для
аргумента ``formatter`` одно из значений: ``prettify()``, ``encode()`` или
``decode()``. Beautiful Soup распознает пять возможных значений
``formatter``.
Значение по умолчанию — ``formatter="minimal"``. Строки будут обрабатываться
ровно настолько, чтобы Beautiful Soup генерировал валидный HTML / XML::
french = "<p>Il a dit <<Sacré bleu!>></p>"
soup = BeautifulSoup(french)
print(soup.prettify(formatter="minimal"))
# <html>
# <body>
# <p>
# Il a dit <<Sacré bleu!>>
# </p>
# </body>
# </html>
Если вы передадите ``formatter = "html"``, Beautiful Soup преобразует
символы Unicode в HTML-мнемоники, когда это возможно::
print(soup.prettify(formatter="html"))
# <html>
# <body>
# <p>
# Il a dit <<Sacré bleu!>>
# </p>
# </body>
# </html>
Если вы передаете ``formatter="html5"``, это то же самое, что
``formatter="html"``, только Beautiful Soup будет
пропускать закрывающую косую черту в пустых тегах HTML, таких как "br"::
soup = BeautifulSoup("<br>")
print(soup.encode(formatter="html"))
# <html><body><br/></body></html>
print(soup.encode(formatter="html5"))
# <html><body><br></body></html>
Если вы передадите ``formatter=None``, Beautiful Soup вообще не будет менять
строки на выходе. Это самый быстрый вариант, но он может привести
к тому, что Beautiful Soup будет генерировать невалидный HTML / XML::
print(soup.prettify(formatter=None))
# <html>
# <body>
# <p>
# Il a dit <<Sacré bleu!>>
# </p>
# </body>
# </html>
link_soup = BeautifulSoup('<a href="http://example.com/?foo=val1&bar=val2">A link</a>')
print(link_soup.a.encode(formatter=None))
# <a href="http://example.com/?foo=val1&bar=val2">A link</a>
Если вам нужен более сложный контроль над выводом, вы можете
использовать класс ``Formatter`` из Beautiful Soup. Вот как можно
преобразовать строки в верхний регистр, независимо от того, находятся ли они в текстовом узле или в
значении атрибута::
from bs4.formatter import HTMLFormatter
def uppercase(str):
return str.upper()
formatter = HTMLFormatter(uppercase)
print(soup.prettify(formatter=formatter))
# <html>
# <body>
# <p>
# IL A DIT <<SACRÉ BLEU!>>
# </p>
# </body>
# </html>
print(link_soup.a.prettify(formatter=formatter))
# <a href="HTTP://EXAMPLE.COM/?FOO=VAL1&BAR=VAL2">
# A LINK
# </a>
Подклассы ``HTMLFormatter`` или ``XMLFormatter`` дают еще
больший контроль над выводом. Например, Beautiful Soup сортирует
атрибуты в каждом теге по умолчанию::
attr_soup = BeautifulSoup(b'<p z="1" m="2" a="3"></p>')
print(attr_soup.p.encode())
# <p a="3" m="2" z="1"></p>
Чтобы выключить сортировку по умолчанию, вы можете создать подкласс на основе метода ``Formatter.attributes()``,
который контролирует, какие атрибуты выводятся и в каком
порядке. Эта реализация также отфильтровывает атрибут с именем "m",
где бы он ни появился::
class UnsortedAttributes(HTMLFormatter):
def attributes(self, tag):
for k, v in tag.attrs.items():
if k == 'm':
continue
yield k, v
print(attr_soup.p.encode(formatter=UnsortedAttributes()))
# <p z="1" a="3"></p>
Последнее предостережение: если вы создаете объект ``CData``, текст внутри
этого объекта всегда представлен `как есть, без какого-либо
форматирования`. Beautiful Soup вызовет вашу функцию для замены мнемоник,
на тот случай, если вы написали функцию, которая подсчитывает
все строки в документе или что-то еще, но он будет игнорировать
возвращаемое значение::
from bs4.element import CData
soup = BeautifulSoup("<a></a>")
soup.a.string = CData("one < three")
print(soup.a.prettify(formatter="xml"))
# <a>
# <![CDATA[one < three]]>
# </a>
``get_text()``
--------------
Если вам нужна только текстовая часть документа или тега, вы можете использовать
метод ``get_text()``. Он возвращает весь текст документа или
тега в виде единственной строки Unicode::
markup = '<a href="http://example.com/">\nI linked to <i>example.com</i>\n</a>'
soup = BeautifulSoup(markup)
soup.get_text()
u'\nI linked to example.com\n'
soup.i.get_text()
u'example.com'
Вы можете указать строку, которая будет использоваться для объединения текстовых фрагментов
в единую строку::
# soup.get_text("|")
u'\nI linked to |example.com|\n'
Вы можете сказать Beautiful Soup удалять пробелы в начале и
конце каждого текстового фрагмента::
# soup.get_text("|", strip=True)
u'I linked to|example.com'
Но в этом случае вы можете предпочесть использовать генератор :ref:`.stripped_strings <string-generators>`
и затем обработать текст самостоятельно::
[text for text in soup.stripped_strings]
# [u'I linked to', u'example.com']
Указание парсера
================
Если вам нужно просто разобрать HTML, вы можете скинуть разметку в
конструктор ``BeautifulSoup``, и, скорее всего, все будет в порядке. Beautiful
Soup подберет для вас парсер и проанализирует данные. Но есть
несколько дополнительных аргументов, которые вы можете передать конструктору, чтобы изменить
используемый парсер.
Первым аргументом конструктора ``BeautifulSou`` является строка или
открытый дескриптор файла — сама разметка, которую вы хотите разобрать. Второй аргумент — это
`как` вы хотите, чтобы разметка была разобрана.
Если вы ничего не укажете, будет использован лучший HTML-парсер из тех,
которые установлены. Beautiful Soup оценивает парсер lxml как лучший, за ним идет
html5lib, затем встроенный парсер Python. Вы можете переопределить используемый парсер,
указав что-то из следующего:
* Какой тип разметки вы хотите разобрать. В данный момент поддерживаются:
"html", "xml" и "html5".
* Имя библиотеки парсера, которую вы хотите использовать. В данный момент поддерживаются
"lxml", "html5lib" и "html.parser" (встроенный в Python
парсер HTML).
В разделе `Установка парсера`_ вы найдете сравнительную таблицу поддерживаемых парсеров.
Если у вас не установлен соответствующий парсер, Beautiful Soup
проигнорирует ваш запрос и выберет другой парсер. На текущий момент единственный
поддерживаемый парсер XML — это lxml. Если у вас не установлен lxml, запрос на
парсер XML ничего не даст, и запрос "lxml" тоже
не сработает.
Различия между парсерами
------------------------
Beautiful Soup представляет один интерфейс для разных
парсеров, но парсеры неодинаковы. Разные парсеры создадут
различные деревья разбора из одного и того же документа. Самые большие различия будут
между парсерами HTML и парсерами XML. Вот короткий
документ, разобранный как HTML::
BeautifulSoup("<a><b /></a>")
# <html><head></head><body><a><b></b></a></body></html>
Поскольку пустой тег <b /> не является валидным кодом HTML, парсер превращает его в
пару тегов <b></b>.
Вот тот же документ, который разобран как XML (для его запуска нужно, чтобы был
установлен lxml). Обратите внимание, что пустой тег <b /> остается, и
что в документ добавляется объявление XML вместо
тега <html>::
BeautifulSoup("<a><b /></a>", "xml")
# <?xml version="1.0" encoding="utf-8"?>
# <a><b/></a>
Есть также различия между парсерами HTML. Если вы даете Beautiful
Soup идеально оформленный документ HTML, эти различия не будут
иметь значения. Один парсер будет быстрее другого, но все они будут давать
структуру данных, которая выглядит точно так же, как оригинальный
документ HTML.
Но если документ оформлен неидеально, различные парсеры
дадут разные результаты. Вот короткий невалидный документ, разобранный с помощью
HTML-парсера lxml. Обратите внимание, что висячий тег </p> просто
игнорируется::
BeautifulSoup("<a></p>", "lxml")
# <html><body><a></a></body></html>
Вот тот же документ, разобранный с помощью html5lib::
BeautifulSoup("<a></p>", "html5lib")
# <html><head></head><body><a><p></p></a></body></html>
Вместо того, чтобы игнорировать висячий тег </p>, html5lib добавляет
открывающй тег <p>. Этот парсер также добавляет пустой тег <head> в
документ.
Вот тот же документ, разобранный с помощью встроенного в Python
парсера HTML::
BeautifulSoup("<a></p>", "html.parser")
# <a></a>
Как и html5lib, этот парсер игнорирует закрывающий тег </p>. В отличие от
html5lib, этот парсер не делает попытки создать правильно оформленный HTML-
документ, добавив тег <body>. В отличие от lxml, он даже не
добавляет тег <html>.
Поскольку документ ``<a></p>`` невалиден, ни один из этих способов
нельзя назвать "правильным". Парсер html5lib использует способы,
которые являются частью стандарта HTML5, поэтому он может претендовать на то, что его подход
самый "правильный", но правомерно использовать любой из трех методов.
Различия между парсерами могут повлиять на ваш скрипт. Если вы планируете
распространять ваш скрипт или запускать его на нескольких
машинах, вам нужно указать парсер в
конструкторе ``BeautifulSoup``. Это уменьшит вероятность того, что ваши пользователи при разборе
документа получат результат, отличный от вашего.
Кодировки
=========
Любой документ HTML или XML написан в определенной кодировке, такой как ASCII
или UTF-8. Но когда вы загрузите этот документ в Beautiful Soup, вы
обнаружите, что он был преобразован в Unicode::
markup = "<h1>Sacr\xc3\xa9 bleu!</h1>"
soup = BeautifulSoup(markup)
soup.h1
# <h1>Sacré bleu!</h1>
soup.h1.string
# u'Sacr\xe9 bleu!'
Это не волшебство. (Хотя это было бы здорово, конечно.) Beautiful Soup использует
подбиблиотеку под названием `Unicode, Dammit`_ для определения кодировки документа
и преобразования ее в Unicode. Кодировка, которая была автоматически определена, содержится в значении
атрибута ``.original_encoding`` объекта ``BeautifulSoup``::
soup.original_encoding
'utf-8'
Unicode, Dammit чаще всего угадывает правильно, но иногда
делает ошибки. Иногда он угадывает правильно только после
побайтового поиска по документу, что занимает очень много времени. Если
вы вдруг уже знаете кодировку документа, вы можете избежать
ошибок и задержек, передав кодировку конструктору ``BeautifulSoup``
как аргумент ``from_encoding``.
Вот документ, написанный на ISO-8859-8. Документ настолько короткий, что
Unicode, Dammit не может разобраться и неправильно идентифицирует кодировку как
ISO-8859-7::
markup = b"<h1>\xed\xe5\xec\xf9</h1>"
soup = BeautifulSoup(markup)
soup.h1
<h1>νεμω</h1>
soup.original_encoding
'ISO-8859-7'
Мы можем все исправить, передав правильный ``from_encoding``::
soup = BeautifulSoup(markup, from_encoding="iso-8859-8")
soup.h1
<h1>םולש</h1>
soup.original_encoding
'iso8859-8'
Если вы не знаете правильную кодировку, но видите, что
Unicode, Dammit определяет ее неправильно, вы можете передать ошибочные варианты в
``exclude_encodings``::
soup = BeautifulSoup(markup, exclude_encodings=["ISO-8859-7"])
soup.h1
<h1>םולש</h1>
soup.original_encoding
'WINDOWS-1255'
Windows-1255 не на 100% подходит, но это совместимое
надмножество ISO-8859-8, так что догадка почти верна. (``exclude_encodings``
— это новая функция в Beautiful Soup 4.4.0.)
В редких случаях (обычно когда документ UTF-8 содержит текст в
совершенно другой кодировке) единственным способом получить Unicode может оказаться
замена некоторых символов специальным символом Unicode
"REPLACEMENT CHARACTER" (U+FFFD, �). Если Unicode, Dammit приходится это сделать,
он установит атрибут ``.contains_replacement_characters``
в ``True`` для объектов ``UnicodeDammit`` или ``BeautifulSoup``. Это
даст понять, что представление в виде Unicode не является точным
представление оригинала, и что некоторые данные потерялись. Если документ
содержит �, но ``.contains_replacement_characters`` равен ``False``,
вы будете знать, что � был в тексте изначально (как в этом
параграфе), а не служит заменой отсутствующим данным.
Кодировка вывода
----------------
Когда вы пишете документ из Beautiful Soup, вы получаете документ в UTF-8,
даже если он изначально не был в UTF-8. Вот
документ в кодировке Latin-1::
markup = b'''
<html>
<head>
<meta content="text/html; charset=ISO-Latin-1" http-equiv="Content-type" />
</head>
<body>
<p>Sacr\xe9 bleu!</p>
</body>
</html>
'''
soup = BeautifulSoup(markup)
print(soup.prettify())
# <html>
# <head>
# <meta content="text/html; charset=utf-8" http-equiv="Content-type" />
# </head>
# <body>
# <p>
# Sacré bleu!
# </p>
# </body>
# </html>
Обратите внимание, что тег <meta> был переписан, чтобы отразить тот факт, что
теперь документ кодируется в UTF-8.
Если вы не хотите кодировку UTF-8, вы можете передать другую в ``prettify()``::
print(soup.prettify("latin-1"))
# <html>
# <head>
# <meta content="text/html; charset=latin-1" http-equiv="Content-type" />
# ...
Вы также можете вызвать encode() для объекта ``BeautifulSoup`` или любого
элемента в супе, как если бы это была строка Python::
soup.p.encode("latin-1")
# '<p>Sacr\xe9 bleu!</p>'
soup.p.encode("utf-8")
# '<p>Sacr\xc3\xa9 bleu!</p>'
Любые символы, которые не могут быть представлены в выбранной вами кодировке, будут
преобразованы в числовые коды мнемоник XML. Вот документ,
который включает в себя Unicode-символ SNOWMAN (снеговик)::
markup = u"<b>\N{SNOWMAN}</b>"
snowman_soup = BeautifulSoup(markup)
tag = snowman_soup.b
Символ SNOWMAN может быть частью документа UTF-8 (он выглядит
так: ☃), но в ISO-Latin-1 или
ASCII нет представления для этого символа, поэтому для этих кодировок он конвертируется в "☃":
print(tag.encode("utf-8"))
# <b>☃</b>
print tag.encode("latin-1")
# <b>☃</b>
print tag.encode("ascii")
# <b>☃</b>
Unicode, Dammit
---------------
Вы можете использовать Unicode, Dammit без Beautiful Soup. Он полезен в тех случаях.
когда у вас есть данные в неизвестной кодировке, и вы просто хотите, чтобы они
преобразовались в Unicode::
from bs4 import UnicodeDammit
dammit = UnicodeDammit("Sacr\xc3\xa9 bleu!")
print(dammit.unicode_markup)
# Sacré bleu!
dammit.original_encoding
# 'utf-8'
Догадки Unicode, Dammit станут намного точнее, если вы установите
библиотеки Python ``chardet`` или ``cchardet``. Чем больше данных вы
даете Unicode, Dammit, тем точнее он определит кодировку. Если у вас есть
собственные предположения относительно возможных кодировок, вы можете передать
их в виде списка::
dammit = UnicodeDammit("Sacr\xe9 bleu!", ["latin-1", "iso-8859-1"])
print(dammit.unicode_markup)
# Sacré bleu!
dammit.original_encoding
# 'latin-1'
В Unicode, Dammit есть две специальные функции, которые Beautiful Soup не
использует.
Парные кавычки
^^^^^^^^^^^^^^
Вы можете использовать Unicode, Dammit, чтобы конвертировать парные кавычки (Microsoft smart quotes) в
мнемоники HTML или XML::
markup = b"<p>I just \x93love\x94 Microsoft Word\x92s smart quotes</p>"
UnicodeDammit(markup, ["windows-1252"], smart_quotes_to="html").unicode_markup
# u'<p>I just “love” Microsoft Word’s smart quotes</p>'
UnicodeDammit(markup, ["windows-1252"], smart_quotes_to="xml").unicode_markup
# u'<p>I just “love” Microsoft Word’s smart quotes</p>'
Вы также можете конвертировать парные кавычки в обычные кавычки ASCII::
UnicodeDammit(markup, ["windows-1252"], smart_quotes_to="ascii").unicode_markup
# u'<p>I just "love" Microsoft Word\'s smart quotes</p>'
Надеюсь, вы найдете эту функцию полезной, но Beautiful Soup не
использует ее. Beautiful Soup по умолчанию
конвертирует парные кавычки в символы Unicode, как и
все остальное::
UnicodeDammit(markup, ["windows-1252"]).unicode_markup
# u'<p>I just \u201clove\u201d Microsoft Word\u2019s smart quotes</p>'
Несогласованные кодировки
^^^^^^^^^^^^^^^^^^^^^^^^^
Иногда документ кодирован в основном в UTF-8, но содержит символы Windows-1252,
такие как, опять-таки, парные кавычки. Такое бывает,
когда веб-сайт содержит данные из нескольких источников. Вы можете использовать
``UnicodeDammit.detwingle()``, чтобы превратить такой документ в чистый
UTF-8. Вот простой пример::
snowmen = (u"\N{SNOWMAN}" * 3)
quote = (u"\N{LEFT DOUBLE QUOTATION MARK}I like snowmen!\N{RIGHT DOUBLE QUOTATION MARK}")
doc = snowmen.encode("utf8") + quote.encode("windows_1252")
В этом документе бардак. Снеговики в UTF-8, а парные кавычки
в Windows-1252. Можно отображать или снеговиков, или кавычки, но не
то и другое одновременно::
print(doc)
# ☃☃☃�I like snowmen!�
print(doc.decode("windows-1252"))
# ☃☃☃“I like snowmen!”
Декодирование документа как UTF-8 вызывает ``UnicodeDecodeError``, а
декодирование его как Windows-1252 выдаст тарабарщину. К счастью,
``UnicodeDammit.detwingle()`` преобразует строку в чистый UTF-8,
позволяя затем декодировать его в Unicode и отображать снеговиков и кавычки
одновременно::
new_doc = UnicodeDammit.detwingle(doc)
print(new_doc.decode("utf8"))
# ☃☃☃“I like snowmen!”
``UnicodeDammit.detwingle()`` знает только, как обрабатывать Windows-1252,
встроенный в UTF-8 (и наоборот, мне кажется), но это наиболее
общий случай.
Обратите внимание, что нужно вызывать ``UnicodeDammit.detwingle()`` для ваших данных
перед передачей в конструктор ``BeautifulSoup`` или
``UnicodeDammit``. Beautiful Soup предполагает, что документ имеет единую
кодировку, какой бы она ни была. Если вы передадите ему документ, который
содержит как UTF-8, так и Windows-1252, скорее всего, он решит, что весь
документ кодируется в Windows-1252, и это будет выглядеть как
``☃☃☃“I like snowmen!”``.
``UnicodeDammit.detwingle()`` — это новое в Beautiful Soup 4.1.0.
Нумерация строк
===============
Парсеры ``html.parser`` и ``html5lib`` могут отслеживать, где в
исходном документе был найден каждый тег. Вы можете получить доступ к этой
информации через ``Tag.sourceline`` (номер строки) и ``Tag.sourcepos``
(позиция начального тега в строке)::
markup = "<p\n>Paragraph 1</p>\n <p>Paragraph 2</p>"
soup = BeautifulSoup(markup, 'html.parser')
for tag in soup.find_all('p'):
print(tag.sourceline, tag.sourcepos, tag.string)
# (1, 0, u'Paragraph 1')
# (2, 3, u'Paragraph 2')
Обратите внимание, что два парсера понимают
``sourceline`` и ``sourcepos`` немного по-разному. Для html.parser эти числа
представляет позицию начального знака "<". Для html5lib
эти числа представляют позицию конечного знака ">"::
soup = BeautifulSoup(markup, 'html5lib')
for tag in soup.find_all('p'):
print(tag.sourceline, tag.sourcepos, tag.string)
# (2, 1, u'Paragraph 1')
# (3, 7, u'Paragraph 2')
Вы можете отключить эту функцию, передав ``store_line_numbers = False``
в конструктор ``BeautifulSoup``::
markup = "<p\n>Paragraph 1</p>\n <p>Paragraph 2</p>"
soup = BeautifulSoup(markup, 'html.parser', store_line_numbers=False)
soup.p.sourceline
# None
Эта функция является новой в 4.8.1, и парсеры, основанные на lxml, не
поддерживают ее.
Проверка объектов на равенство
==============================
Beautiful Soup считает, что два объекта ``NavigableString`` или ``Tag``
равны, если они представлены в одинаковой разметке HTML или XML. В этом
примере два тега <b> рассматриваются как равные, даже если они находятся
в разных частях дерева объекта, потому что они оба выглядят как
``<b>pizza</b>``::
markup = "<p>I want <b>pizza</b> and more <b>pizza</b>!</p>"
soup = BeautifulSoup(markup, 'html.parser')
first_b, second_b = soup.find_all('b')
print first_b == second_b
# True
print first_b.previous_element == second_b.previous_element
# False
Если вы хотите выяснить, указывают ли две переменные на один и тот же
объект, используйте `is`::
print first_b is second_b
# False
Копирование объектов Beautiful Soup
===================================
Вы можете использовать ``copy.copy()`` для создания копии любого ``Tag`` или
``NavigableString``::
import copy
p_copy = copy.copy(soup.p)
print p_copy
# <p>I want <b>pizza</b> and more <b>pizza</b>!</p>
Копия считается равной оригиналу, так как у нее
такая же разметка, что и у оригинала, но это другой объект::
print soup.p == p_copy
# True
print soup.p is p_copy
# False
Единственная настоящая разница в том, что копия полностью отделена от
исходного дерева объекта Beautiful Soup, как если бы в отношении нее вызвали
метод ``extract()``::
print p_copy.parent
# None
Это потому, что два разных объекта ``Tag`` не могут занимать одно и то же
пространство в одно и то же время.
Разбор части документа
======================
Допустим, вы хотите использовать Beautiful Soup, чтобы посмотреть на
теги <a> в документе. Было бы бесполезной тратой времени и памяти разобирать весь документ и
затем снова проходить по нему в поисках тегов <a>. Намного быстрее
изначательно игнорировать все, что не является тегом <a>. Класс
``SoupStrainer`` позволяет выбрать, какие части входящего
документ разбирать. Вы просто создаете ``SoupStrainer`` и передаете его в
конструктор ``BeautifulSoup`` в качестве аргумента ``parse_only``.
(Обратите внимание, что *эта функция не будет работать, если вы используете парсер html5lib*.
Если вы используете html5lib, будет разобран весь документ, независимо
от обстоятельств. Это потому что html5lib постоянно переставляет части дерева разбора
в процессе работы, и если какая-то часть документа не
попала в дерево разбора, все рухнет. Чтобы избежать путаницы, в
примерах ниже я принудительно использую встроенный в Python
парсер HTML.)
``SoupStrainer``
----------------
Класс ``SoupStrainer`` принимает те же аргументы, что и типичный
метод из раздела `Поиск по дереву`_: :ref:`name <name>`, :ref:`attrs
<attrs>`, :ref:`string <string>` и :ref:`**kwargs <kwargs>`. Вот
три объекта ``SoupStrainer``::
from bs4 import SoupStrainer
only_a_tags = SoupStrainer("a")
only_tags_with_id_link2 = SoupStrainer(id="link2")
def is_short_string(string):
return len(string) < 10
only_short_strings = SoupStrainer(string=is_short_string)
Вернемся к фрагменту из «Алисы в стране чудес»
и увидим, как выглядит документ, когда он разобран с этими
тремя объектами ``SoupStrainer``::
html_doc = """
<html><head><title>The Dormouse's story</title></head>
<body>
<p class="title"><b>The Dormouse's story</b></p>
<p class="story">Once upon a time there were three little sisters; and their names were
<a href="http://example.com/elsie" class="sister" id="link1">Elsie</a>,
<a href="http://example.com/lacie" class="sister" id="link2">Lacie</a> and
<a href="http://example.com/tillie" class="sister" id="link3">Tillie</a>;
and they lived at the bottom of a well.</p>
<p class="story">...</p>
"""
print(BeautifulSoup(html_doc, "html.parser", parse_only=only_a_tags).prettify())
# <a class="sister" href="http://example.com/elsie" id="link1">
# Elsie
# </a>
# <a class="sister" href="http://example.com/lacie" id="link2">
# Lacie
# </a>
# <a class="sister" href="http://example.com/tillie" id="link3">
# Tillie
# </a>
print(BeautifulSoup(html_doc, "html.parser", parse_only=only_tags_with_id_link2).prettify())
# <a class="sister" href="http://example.com/lacie" id="link2">
# Lacie
# </a>
print(BeautifulSoup(html_doc, "html.parser", parse_only=only_short_strings).prettify())
# Elsie
# ,
# Lacie
# and
# Tillie
# ...
#
Вы также можете передать ``SoupStrainer`` в любой из методов. описанных в разделе
`Поиск по дереву`_. Может, это не безумно полезно, но я
решил упомянуть::
soup = BeautifulSoup(html_doc)
soup.find_all(only_short_strings)
# [u'\n\n', u'\n\n', u'Elsie', u',\n', u'Lacie', u' and\n', u'Tillie',
# u'\n\n', u'...', u'\n']
Устранение неисправностей
=========================
.. _diagnose:
``diagnose()``
--------------
Если у вас возникли проблемы с пониманием того, что Beautiful Soup делает с
документом, передайте документ в функцию ``Diagnose()``. (Новое в
Beautiful Soup 4.2.0.) Beautiful Soup выведет отчет, показывающий,
как разные парсеры обрабатывают документ, и сообщит вам, если
отсутствует парсер, который Beautiful Soup мог бы использовать::
from bs4.diagnose import diagnose
with open("bad.html") as fp:
data = fp.read()
diagnose(data)
# Diagnostic running on Beautiful Soup 4.2.0
# Python version 2.7.3 (default, Aug 1 2012, 05:16:07)
# I noticed that html5lib is not installed. Installing it may help.
# Found lxml version 2.3.2.0
#
# Trying to parse your data with html.parser
# Here's what html.parser did with the document:
# ...
Простой взгляд на вывод diagnose() может показать, как решить
проблему. Если это и не поможет, вы можете скопировать вывод ``Diagnose()``, когда
обратитесь за помощью.
Ошибки при разборе документа
----------------------------
Существует два вида ошибок разбора. Есть сбои,
когда вы подаете документ в Beautiful Soup, и это поднимает
исключение, обычно ``HTMLParser.HTMLParseError``. И есть
неожиданное поведение, когда дерево разбора Beautiful Soup сильно
отличается от документа, использованного для создания дерева.
Практически никогда источником этих проблемы не бывает Beautiful
Soup. Это не потому, что Beautiful Soup так прекрасно
написан. Это потому, что Beautiful Soup не содержит
кода, который бы разбирал документ. Beautiful Soup опирается на внешние парсеры. Если один парсер
не подходит для разбора документа, лучшим решением будет попробовать
другой парсер. В разделе `Установка парсера`_ вы найдете больше информации
и таблицу сравнения парсеров.
Наиболее распространенные ошибки разбора — это ``HTMLParser.HTMLParseError:
malformed start tag`` и ``HTMLParser.HTMLParseError: bad end
tag``. Они оба генерируются встроенным в Python парсером HTML,
и решением будет :ref:`установить lxml или
html5lib. <parser-installation>`
Наиболее распространенный тип неожиданного поведения — когда вы не можете найти
тег, который точно есть в документе. Вы видели его на входе, но
``find_all()`` возвращает ``[]``, или ``find()`` возвращает ``None``. Это
еще одна распространенная проблема со встроенным в Python парсером HTML, который
иногда пропускает теги, которые он не понимает. Опять же, решение заключается в
:ref:`установке lxml или html5lib <parser-installation>`.
Проблемы несоответствия версий
------------------------------
* ``SyntaxError: Invalid syntax`` (в строке ``ROOT_TAG_NAME =
u'[document]'``) — вызвано запуском версии Beautiful Soup на Python 2
под Python 3 без конвертации кода.
* ``ImportError: No module named HTMLParser`` — вызвано запуском
версия Beautiful Soup на Python 3 под Python 2.
* ``ImportError: No module named html.parser`` — вызвано запуском
версия Beautiful Soup на Python 2 под Python 3.
* ``ImportError: No module named BeautifulSoup`` — вызвано запуском
кода Beautiful Soup 3 в системе, где BS3
не установлен. Или код писали на Beautiful Soup 4, не зная, что
имя пакета сменилось на ``bs4``.
* ``ImportError: No module named bs4`` — вызвано запуском
кода Beautiful Soup 4 в системе, где BS4 не установлен.
.. _parsing-xml:
Разбор XML
----------
По умолчанию Beautiful Soup разбирает документы как HTML. Чтобы разобрать
документ в виде XML, передайте "xml" в качестве второго аргумента
в конструктор ``BeautifulSoup``::
soup = BeautifulSoup(markup, "xml")
Вам также нужно будет :ref:`установить lxml <parser-installation>`.
Другие проблемы с парсерами
---------------------------
* Если ваш скрипт работает на одном компьютере, но не работает на другом, или работает в одной
виртуальной среде, но не в другой, или работает вне виртуальной
среды, но не внутри нее, это, вероятно, потому что в двух
средах разные библиотеки парсеров. Например,
вы могли разработать скрипт на компьютере с установленным lxml,
а затем попытались запустить его на компьютере, где установлен только
html5lib. Читайте в разделе `Различия между парсерами`_, почему это
важно, и исправляйте проблемы, указывая конкретную библиотеку парсера
в конструкторе ``BeautifulSoup``.
* Поскольку `HTML-теги и атрибуты нечувствительны к регистру
<http://www.w3.org/TR/html5/syntax.html#syntax>`_, все три HTML-
парсера конвертируют имена тегов и атрибутов в нижний регистр. Таким образом,
разметка <TAG></TAG> преобразуется в <tag></tag>. Если вы хотите
сохранить смешанный или верхний регистр тегов и атрибутов, вам нужно
:ref:`разобрать документ как XML <parsing-xml>`.
.. _misc:
Прочие ошибки
-------------
* ``UnicodeEncodeError: 'charmap' codec can't encode character
u'\xfoo' in position bar`` (или практически любая другая ошибка
``UnicodeEncodeError``) — это не проблема с Beautiful Soup.
Эта проблема проявляется в основном в двух ситуациях. Во-первых, когда вы пытаетесь
вывести символ Unicode, который ваша консоль не может отобразить, потому что не знает, как.
(Смотрите `эту страницу в Python вики
<http://wiki.python.org/moin/PrintFails>`_.) Во-вторых, когда
вы пишете в файл и передаете символ Unicode, который
не поддерживается вашей кодировкой по умолчанию. В этом случае самым простым
решением будет явное кодирование строки Unicode в UTF-8 с помощью
``u.encode("utf8")``.
* ``KeyError: [attr]`` — вызывается при обращении к ``tag['attr']``, когда
в искомом теге не определен атрибут ``attr``. Наиболее
типичны ошибки ``KeyError: 'href'`` и ``KeyError:
'class'``. Используйте ``tag.get('attr')``, если вы не уверены, что ``attr``
определен — так же, как если бы вы работали со словарем Python.
* ``AttributeError: 'ResultSet' object has no attribute 'foo'`` — это
обычно происходит тогда, когда вы ожидаете, что ``find_all()`` вернет
один тег или строку. Но ``find_all()`` возвращает *список* тегов
и строк в объекте ``ResultSet``. Вам нужно перебрать
список и поискать ``.foo`` в каждом из элементов. Или, если вам действительно
нужен только один результат, используйте ``find()`` вместо
``find_all()``.
* ``AttributeError: 'NoneType' object has no attribute 'foo'`` — это
обычно происходит, когда вы вызываете ``find()`` и затем пытаетесь
получить доступ к атрибуту ``.foo``. Но в вашем случае
``find()`` не нашел ничего, поэтому вернул ``None`` вместо
того, чтобы вернуть тег или строку. Вам нужно выяснить, почему
``find()`` ничего не возвращает.
Повышение производительности
----------------------------
Beautiful Soup никогда не будет таким же быстрым, как парсеры, на основе которых он
работает. Если время отклика критично, если вы платите за компьютерное время
по часам, или если есть какая-то другая причина, почему компьютерное время
важнее программистского, стоит забыть о Beautiful Soup
и работать непосредственно с `lxml <http://lxml.de/>`_.
Тем не менее, есть вещи, которые вы можете сделать, чтобы ускорить Beautiful Soup. Если
вы не используете lxml в качестве основного парсера, самое время
:ref:`начать <parser-installation>`. Beautiful Soup разбирает документы
значительно быстрее с lxml, чем с html.parser или html5lib.
Вы можете значительно ускорить распознавание кодировок, установив
библиотеку `cchardet <http://pypi.python.org/pypi/cchardet/>`_.
`Разбор части документа`_ не сэкономит много времени в процессе разбора,
но может сэкономить много памяти, что сделает
`поиск` по документу намного быстрее.
Beautiful Soup 3
================
Beautiful Soup 3 — предыдущая версия, и она больше
активно не развивается. На текущий момент Beautiful Soup 3 поставляется со всеми основными
дистрибутивами Linux:
:kbd:`$ apt-get install python-beautifulsoup`
Он также публикуется через PyPi как ``BeautifulSoup``:
:kbd:`$ easy_install BeautifulSoup`
:kbd:`$ pip install BeautifulSoup`
Вы можете скачать `tar-архив Beautiful Soup 3.2.0
<http://www.crummy.com/software/BeautifulSoup/bs3/download/3.x/BeautifulSoup-3.2.0.tar.gz>`_.
Если вы запустили ``easy_install beautifulsoup`` или ``easy_install
BeautifulSoup``, но ваш код не работает, значит, вы ошибочно установили Beautiful
Soup 3. Вам нужно запустить ``easy_install beautifulsoup4``.
Архивная документация для Beautiful Soup 3 доступна `онлайн
<http://www.crummy.com/software/BeautifulSoup/bs3/documentation.html>`_.
Перенос кода на BS4
-------------------
Большая часть кода, написанного для Beautiful Soup 3, будет работать и в Beautiful
Soup 4 с одной простой заменой. Все, что вам нужно сделать, это изменить
имя пакета c ``BeautifulSoup`` на ``bs4``. Так что это::
from BeautifulSoup import BeautifulSoup
становится этим::
from bs4 import BeautifulSoup
* Если выводится сообщение ``ImportError`` "No module named BeautifulSoup", ваша
проблема в том, что вы пытаетесь запустить код Beautiful Soup 3, в то время как
у вас установлен Beautiful Soup 4.
* Если выводится сообщение ``ImportError`` "No module named bs4", ваша проблема
в том, что вы пытаетесь запустить код Beautiful Soup 4, в то время как
у вас установлен Beautiful Soup 3.
Хотя BS4 в основном обратно совместим с BS3, большинство
методов BS3 устарели и получили новые имена, чтобы `соответствовать PEP 8
<http://www.python.org/dev/peps/pep-0008/>`_. Некоторые
из переименований и изменений нарушают обратную совместимость.
Вот что нужно знать, чтобы перейти с BS3 на BS4:
Вам нужен парсер
^^^^^^^^^^^^^^^^
Beautiful Soup 3 использовал модуль Python ``SGMLParser``, который теперь
устарел и был удален в Python 3.0. Beautiful Soup 4 по умолчанию использует
``html.parser``, но вы можете подключить lxml или html5lib
вместо него. Вы найдете таблицу сравнения парсеров в разделе `Установка парсера`_.
Поскольку ``html.parser`` — это не то же, что ``SGMLParser``, вы
можете обнаружить, что Beautiful Soup 4 дает другое дерево разбора, чем
Beautiful Soup 3. Если вы замените html.parser
на lxml или html5lib, может оказаться, что дерево разбора опять
изменилось. Если такое случится, вам придется обновить код,
чтобы разобраться с новым деревом.
Имена методов
^^^^^^^^^^^^^
* ``renderContents`` -> ``encode_contents``
* ``replaceWith`` -> ``replace_with``
* ``replaceWithChildren`` -> ``unwrap``
* ``findAll`` -> ``find_all``
* ``findAllNext`` -> ``find_all_next``
* ``findAllPrevious`` -> ``find_all_previous``
* ``findNext`` -> ``find_next``
* ``findNextSibling`` -> ``find_next_sibling``
* ``findNextSiblings`` -> ``find_next_siblings``
* ``findParent`` -> ``find_parent``
* ``findParents`` -> ``find_parents``
* ``findPrevious`` -> ``find_previous``
* ``findPreviousSibling`` -> ``find_previous_sibling``
* ``findPreviousSiblings`` -> ``find_previous_siblings``
* ``getText`` -> ``get_text``
* ``nextSibling`` -> ``next_sibling``
* ``previousSibling`` -> ``previous_sibling``
Некоторые аргументы конструктора Beautiful Soup были переименованы по
той же причине:
* ``BeautifulSoup(parseOnlyThese=...)`` -> ``BeautifulSoup(parse_only=...)``
* ``BeautifulSoup(fromEncoding=...)`` -> ``BeautifulSoup(from_encoding=...)``
Я переименовал один метод для совместимости с Python 3:
* ``Tag.has_key()`` -> ``Tag.has_attr()``
Я переименовал один атрибут, чтобы использовать более точную терминологию:
* ``Tag.isSelfClosing`` -> ``Tag.is_empty_element``
Я переименовал три атрибута, чтобы избежать использования зарезервированных слов
в Python. В отличие от других, эти изменения *не являются обратно
совместимыми*. Если вы использовали эти атрибуты в BS3, ваш код не сработает
на BS4, пока вы их не измените.
* ``UnicodeDammit.unicode`` -> ``UnicodeDammit.unicode_markup``
* ``Tag.next`` -> ``Tag.next_element``
* ``Tag.previous`` -> ``Tag.previous_element``
Генераторы
^^^^^^^^^^
Я дал генераторам PEP 8-совместимые имена и преобразовал их в
свойства:
* ``childGenerator()`` -> ``children``
* ``nextGenerator()`` -> ``next_elements``
* ``nextSiblingGenerator()`` -> ``next_siblings``
* ``previousGenerator()`` -> ``previous_elements``
* ``previousSiblingGenerator()`` -> ``previous_siblings``
* ``recursiveChildGenerator()`` -> ``descendants``
* ``parentGenerator()`` -> ``parents``
Так что вместо этого::
for parent in tag.parentGenerator():
...
Вы можете написать это::
for parent in tag.parents:
...
(Хотя старый код тоже будет работать.)
Некоторые генераторы выдавали ``None`` после их завершения и
останавливались. Это была ошибка. Теперь генераторы просто останавливаются.
Добавились два генератора: :ref:`.strings и
.stripped_strings <string-generators>`.
``.strings`` выдает
объекты NavigableString, а ``.stripped_strings`` выдает строки Python,
у которых удалены пробелы.
XML
^^^
Больше нет класса ``BeautifulStoneSoup`` для разбора XML. Чтобы
разобрать XML, нужно передать "xml" в качестве второго аргумента
в конструктор ``BeautifulSoup``. По той же причине
конструктор ``BeautifulSoup`` больше не распознает
аргумент ``isHTML``.
Улучшена обработка пустых тегов
XML. Ранее при разборе XML нужно было явно указать,
какие теги считать пустыми элементами. Аргумент ``SelfClosingTags``
больше не распознается. Вместо этого
Beautiful Soup считает пустым элементом любой тег без содержимого. Если
вы добавляете в тег дочерний элемент, тег больше не считается
пустым элементом.
Мнемоники
^^^^^^^^^
Входящие мнемоники HTML или XML всегда преобразуются в
соответствующие символы Unicode. В Beautiful Soup 3 было несколько
перекрывающих друг друга способов взаимодействия с мнемониками. Эти способы
удалены. Конструктор ``BeautifulSoup`` больше не распознает
аргументы ``smartQuotesTo`` и ``convertEntities``. (В `Unicode,
Dammit`_ все еще присутствует ``smart_quotes_to``, но по умолчанию парные кавычки
преобразуются в Unicode). Константы ``HTML_ENTITIES``,
``XML_ENTITIES`` и ``XHTML_ENTITIES`` были удалены, так как они
служили для настройки функции, которой больше нет (преобразование отдельных мнемоник в
символы Unicode).
Если вы хотите на выходе преобразовать символы Unicode обратно в мнемоники HTML,
а не превращать Unicode в символы UTF-8, вам нужно
использовать :ref:`средства форматирования вывода <output_formatters>`.
Прочее
^^^^^^
:ref:`Tag.string <.string>` теперь работает рекурсивно. Если тег А
содержит только тег B и ничего больше, тогда значение A.string будет таким же, как
B.string. (Раньше это был None.)
`Многозначные атрибуты`_, такие как ``class``, теперь в качестве значений имеют списки строк,
а не строки. Это может повлиять на поиск
по классу CSS.
Если вы передадите в один из методов ``find*`` одновременно :ref:`string <string>` `и`
специфичный для тега аргумент, такой как :ref:`name <name>`, Beautiful Soup будет
искать теги, которые, во-первых, соответствуют специфичным для тега критериям, и, во-вторых, имеют
:ref:`Tag.string <.string>`, соответствующий заданному вами значению :ref:`string
<string>`. Beautiful Soup `не` найдет сами строки. Ранее
Beautiful Soup игнорировал аргументы, специфичные для тегов, и искал
строки.
Конструктор ``BeautifulSoup`` больше не распознает
аргумент `markupMassage`. Теперь это задача парсера —
обрабатывать разметку правильно.
Редко используемые альтернативные классы парсеров, такие как
``ICantBelieveItsBeautifulSoup`` и ``BeautifulSOAP``,
удалены. Теперь парсер решает, что делать с неоднозначной
разметкой.
Метод ``prettify()`` теперь возвращает строку Unicode, а не байтовую строку.
Перевод документации
====================
Переводы документации Beautiful Soup очень
приветствуются. Перевод должен быть лицензирован по лицензии MIT,
так же, как сам Beautiful Soup и англоязычная документация к нему.
Есть два способа передать ваш перевод:
1. Создайте ветку репозитория Beautiful Soup, добавьте свой
перевод и предложите слияние с основной веткой — так же,
как вы предложили бы изменения исходного кода.
2. Отправьте `в дискуссионную группу Beautiful Soup <https://groups.google.com/forum/?fromgroups#!forum/beautifulsoup>`_
сообщение со ссылкой на
ваш перевод, или приложите перевод к сообщению.
Используйте существующие переводы документации на китайский или португальский в качестве образца. В
частности, переводите исходный файл ``doc/source/index.rst`` вместо
того, чтобы переводить HTML-версию документации. Это позволяет
публиковать документацию в разных форматах, не
только в HTML.
Об этом переводе
----------------
Перевод на русский язык: `authoress <mailto:geekwriter@yandex.ru>`_
Дата перевода: февраль 2020
Перевод выполнен с `оригинала на английском языке <https://www.crummy.com/software/BeautifulSoup/bs4/doc/>`_.
|
