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
|
from __future__ import annotations
from typing import Any, Iterator, Literal, NoReturn, Optional, TypeVar, overload
DefaultT = TypeVar("DefaultT")
class LexborAttributes:
"""A dict-like object that represents attributes."""
@staticmethod
def create(node: LexborAttributes) -> LexborAttributes: ...
def keys(self) -> Iterator[str]: ...
def items(self) -> Iterator[tuple[str, str | None]]: ...
def values(self) -> Iterator[str | None]: ...
def __iter__(self) -> Iterator[str]: ...
def __len__(self) -> int: ...
def __getitem__(self, key: str) -> str | None: ...
def __setitem__(self, key: str, value: Optional[str]) -> None: ...
def __delitem__(self, key: str) -> None: ...
def __contains__(self, key: str) -> bool: ...
def __repr__(self) -> str: ...
@overload
def get(self, key: str, default: DefaultT) -> DefaultT | str | None: ...
@overload
def get(self, key: str, default: None = ...) -> str | None: ...
@overload
def sget(self, key: str, default: str | DefaultT) -> str | DefaultT: ...
@overload
def sget(self, key: str, default: str = "") -> str: ...
class LexborSelector:
"""An advanced CSS selector that supports additional operations.
Think of it as a toolkit that mimics some of the features of XPath.
Please note, this is an experimental feature that can change in the future.
"""
def __init__(self, node: LexborNode, query: str): ...
def css(self, query: str) -> NoReturn: ...
@property
def matches(self) -> list[LexborNode]:
"""Returns all possible matches"""
...
@property
def any_matches(self) -> bool:
"""Returns True if there are any matches"""
...
def text_contains(
self, text: str, deep: bool = True, separator: str = "", strip: bool = False
) -> LexborSelector:
"""Filter all current matches given text."""
...
def any_text_contains(
self, text: str, deep: bool = True, separator: str = "", strip: bool = False
) -> bool:
"""Returns True if any node in the current search scope contains specified text"""
...
def attribute_longer_than(
self, attribute: str, length: int, start: str | None = None
) -> LexborSelector:
"""Filter all current matches by attribute length.
Similar to string-length in XPath.
"""
...
def any_attribute_longer_than(
self, attribute: str, length: int, start: str | None = None
) -> bool:
"""Returns True any href attribute longer than a specified length.
Similar to string-length in XPath.
"""
...
@property
def inner_html(self) -> str | None:
"""Return HTML representation of the child nodes.
Works similar to innerHTML in JavaScript.
Unlike the `.html` property, does not include the current node.
Can be used to set HTML as well. See the setter docstring.
Returns
-------
text : str or None
"""
...
@inner_html.setter
def inner_html(self, html: str):
"""Set inner HTML to the specified HTML.
Replaces existing data inside the node.
Works similar to innerHTML in JavaScript.
Parameters
----------
html : str
"""
...
class LexborCSSSelector:
def __init__(self): ...
def find(self, query: str, node: LexborNode) -> list[LexborNode]: ...
def any_matches(self, query: str, node: LexborNode) -> bool: ...
class LexborNode:
"""A class that represents HTML node (element)."""
parser: LexborHTMLParser
@property
def mem_id(self) -> int: ...
@property
def child(self) -> LexborNode | None:
"""Alias for the `first_child` property.
**Deprecated**. Please use `first_child` instead.
"""
...
@property
def first_child(self) -> LexborNode | None:
"""Return the first child node."""
...
@property
def parent(self) -> LexborNode | None:
"""Return the parent node."""
...
@property
def next(self) -> LexborNode | None:
"""Return next node."""
...
@property
def prev(self) -> LexborNode | None:
"""Return previous node."""
...
@property
def last_child(self) -> LexborNode | None:
"""Return last child node."""
...
@property
def html(self) -> str | None:
"""Return HTML representation of the current node including all its child nodes.
Returns
-------
text : str
"""
...
def __hash__(self) -> int: ...
def text_lexbor(self) -> str:
"""Returns the text of the node including text of all its child nodes.
Uses builtin method from lexbor.
"""
...
def text(
self,
deep: bool = True,
separator: str = "",
strip: bool = False,
skip_empty: bool = False,
) -> str:
"""Return concatenated text from this node.
Parameters
----------
deep : bool, optional
When ``True`` (default), include text from all descendant nodes; when
``False``, only include direct children.
separator : str, optional
String inserted between successive text fragments.
strip : bool, optional
If ``True``, apply ``str.strip()`` to each fragment before joining to
remove surrounding whitespace. Defaults to ``False``.
skip_empty : bool, optional
Exclude text nodes whose content is only ASCII whitespace (space,
tab, newline, form feed or carriage return) when ``True``.
Defaults to ``False``.
Returns
-------
text : str
Combined textual content assembled according to the provided options.
"""
...
def css(self, query: str) -> list[LexborNode]:
"""Evaluate CSS selector against current node and its child nodes.
Matches pattern `query` against HTML tree.
`CSS selectors reference <https://www.w3schools.com/cssref/css_selectors.asp>`_.
Special selectors:
- parser.css('p:lexbor-contains("awesome" i)') -- case-insensitive contains
- parser.css('p:lexbor-contains("awesome")') -- case-sensitive contains
Parameters
----------
query : str
CSS selector (e.g. "div > :nth-child(2n+1):not(:has(a))").
Returns
-------
selector : list of `Node` objects
"""
...
@overload
def css_first(
self, query: str, default: Any = ..., strict: Literal[True] = ...
) -> LexborNode:
"""Same as `css` but returns only the first match.
Parameters
----------
query : str
default : bool, default None
Default value to return if there is no match.
strict: bool, default False
Set to True if you want to check if there is strictly only one match in the document.
Returns
-------
selector : `LexborNode` object
"""
...
@overload
def css_first(
self, query: str, default: DefaultT, strict: bool = False
) -> LexborNode | DefaultT:
"""Same as `css` but returns only the first match.
Parameters
----------
query : str
default : bool, default None
Default value to return if there is no match.
strict: bool, default False
Set to True if you want to check if there is strictly only one match in the document.
Returns
-------
selector : `LexborNode` object
"""
...
@overload
def css_first(
self, query: str, default: None = ..., strict: bool = False
) -> LexborNode | None:
"""Same as `css` but returns only the first match.
Parameters
----------
query : str
default : bool, default None
Default value to return if there is no match.
strict: bool, default False
Set to True if you want to check if there is strictly only one match in the document.
Returns
-------
selector : `LexborNode` object
"""
...
def any_css_matches(self, selectors: tuple[str]) -> bool:
"""Returns True if any of CSS selectors matches a node"""
...
def css_matches(self, selector: str) -> bool:
"""Returns True if CSS selector matches a node."""
...
@property
def tag_id(self) -> int: ...
@property
def tag(self) -> str | None:
"""Return the name of the current tag (e.g. div, p, img).
For for non-tag nodes, returns the following names:
* `-text` - text node
* `-document` - document node
* `-comment` - comment node
Returns
-------
text : str
"""
...
def decompose(self, recursive: bool = True) -> None:
"""Remove the current node from the tree.
Parameters
----------
recursive : bool, default True
Whenever to delete all its child nodes
Examples
--------
>>> tree = LexborHTMLParser(html)
>>> for tag in tree.css('script'):
>>> tag.decompose()
"""
...
def strip_tags(self, tags: list[str], recursive: bool = False) -> None:
"""Remove specified tags from the HTML tree.
Parameters
----------
tags : list
List of tags to remove.
recursive : bool, default True
Whenever to delete all its child nodes
Examples
--------
>>> tree = LexborHTMLParser('<html><head></head><body><script></script><div>Hello world!</div></body></html>')
>>> tags = ['head', 'style', 'script', 'xmp', 'iframe', 'noembed', 'noframes']
>>> tree.strip_tags(tags)
>>> tree.html
'<html><body><div>Hello world!</div></body></html>'
"""
...
@property
def attributes(self) -> dict[str, str | None]:
"""Get all attributes that belong to the current node.
The value of empty attributes is None.
Returns
-------
attributes : dictionary of all attributes.
Examples
--------
>>> tree = LexborHTMLParser("<div data id='my_id'></div>")
>>> node = tree.css_first('div')
>>> node.attributes
{'data': None, 'id': 'my_id'}
"""
...
@property
def attrs(self) -> LexborAttributes:
"""A dict-like object that is similar to the ``attributes`` property, but operates directly on the Node data.
.. warning:: Use ``attributes`` instead, if you don't want to modify Node attributes.
Returns
-------
attributes : Attributes mapping object.
Examples
--------
>>> tree = LexborHTMLParser("<div id='a'></div>")
>>> node = tree.css_first('div')
>>> node.attrs
<div attributes, 1 items>
>>> node.attrs['id']
'a'
>>> node.attrs['foo'] = 'bar'
>>> del node.attrs['id']
>>> node.attributes
{'foo': 'bar'}
>>> node.attrs['id'] = 'new_id'
>>> node.html
'<div foo="bar" id="new_id"></div>'
"""
...
@property
def id(self) -> str | None:
"""Get the id attribute of the node.
Returns None if id does not set.
Returns
-------
text : str
"""
...
def iter(
self, include_text: bool = False, skip_empty: bool = False
) -> Iterator[LexborNode]:
"""Iterate over direct children of this node.
Parameters
----------
include_text : bool, optional
When ``True``, yield text nodes in addition to element nodes. Defaults
to ``False``.
skip_empty : bool, optional
When ``include_text`` is ``True``, ignore text nodes made up solely
of ASCII whitespace (space, tab, newline, form feed or carriage
return). Defaults to ``False``.
Yields
------
LexborNode
Child nodes on the same tree level as this node, filtered according
to the provided options.
"""
...
def unwrap(self, delete_empty: bool = False) -> None:
"""Replace node with whatever is inside this node.
Does nothing if you perform unwrapping second time on the same node.
Parameters
----------
delete_empty : bool, default False
If True, removes empty tags.
Examples
--------
>>> tree = LexborHTMLParser("<div>Hello <i>world</i>!</div>")
>>> tree.css_first('i').unwrap()
>>> tree.html
'<html><head></head><body><div>Hello world!</div></body></html>'
Note: by default, empty tags are ignored, use "delete_empty" to change this.
"""
...
def unwrap_tags(self, tags: list[str], delete_empty: bool = False) -> None:
"""Unwraps specified tags from the HTML tree.
Works the same as the ``unwrap`` method, but applied to a list of tags.
Parameters
----------
tags : list
List of tags to remove.
delete_empty : bool, default False
If True, removes empty tags.
Examples
--------
>>> tree = LexborHTMLParser("<div><a href="">Hello</a> <i>world</i>!</div>")
>>> tree.body.unwrap_tags(['i','a'])
>>> tree.body.html
'<body><div>Hello world!</div></body>'
Note: by default, empty tags are ignored, use "delete_empty" to change this.
"""
...
def merge_text_nodes(self) -> None:
"""Iterates over all text nodes and merges all text nodes that are close to each other.
This is useful for text extraction.
Use it when you need to strip HTML tags and merge "dangling" text.
Examples
--------
>>> tree = LexborHTMLParser("<div><p><strong>J</strong>ohn</p><p>Doe</p></div>")
>>> node = tree.css_first('div')
>>> tree.unwrap_tags(["strong"])
>>> tree.text(deep=True, separator=" ", strip=True)
"J ohn Doe" # Text extraction produces an extra space because the strong tag was removed.
>>> node.merge_text_nodes()
>>> tree.text(deep=True, separator=" ", strip=True)
"John Doe"
"""
...
def traverse(
self, include_text: bool = False, skip_empty: bool = False
) -> Iterator[LexborNode]:
"""Depth-first traversal starting at the current node.
Parameters
----------
include_text : bool, optional
When ``True``, include text nodes in the traversal sequence. Defaults
to ``False``.
skip_empty : bool, optional
Skip text nodes that contain only ASCII whitespace (space, tab,
newline, form feed or carriage return) when ``include_text`` is
``True``. Defaults to ``False``.
Yields
------
LexborNode
Nodes encountered in depth-first order beginning with the current
node, filtered according to the provided options.
"""
...
def replace_with(self, value: bytes | str | LexborNode) -> None:
"""Replace current Node with specified value.
Parameters
----------
value : str, bytes or Node
The text or Node instance to replace the Node with.
When a text string is passed, it's treated as text. All HTML tags will be escaped.
Convert and pass the ``Node`` object when you want to work with HTML.
Does not clone the ``Node`` object.
All future changes to the passed ``Node`` object will also be taken into account.
Examples
--------
>>> tree = LexborHTMLParser('<div>Get <img src="" alt="Laptop"></div>')
>>> img = tree.css_first('img')
>>> img.replace_with(img.attributes.get('alt', ''))
>>> tree.body.child.html
'<div>Get Laptop</div>'
>>> html_parser = LexborHTMLParser('<div>Get <span alt="Laptop"><img src="/jpg"> <div></div></span></div>')
>>> html_parser2 = LexborHTMLParser('<div>Test</div>')
>>> img_node = html_parser.css_first('img')
>>> img_node.replace_with(html_parser2.body.child)
'<div>Get <span alt="Laptop"><div>Test</div> <div></div></span></div>'
"""
...
def insert_before(self, value: bytes | str | LexborNode) -> None:
"""Insert a node before the current Node.
Parameters
----------
value : str, bytes or Node
The text or Node instance to insert before the Node.
When a text string is passed, it's treated as text. All HTML tags will be escaped.
Convert and pass the ``Node`` object when you want to work with HTML.
Does not clone the ``Node`` object.
All future changes to the passed ``Node`` object will also be taken into account.
Examples
--------
>>> tree = LexborHTMLParser('<div>Get <img src="" alt="Laptop"></div>')
>>> img = tree.css_first('img')
>>> img.insert_before(img.attributes.get('alt', ''))
>>> tree.body.child.html
'<div>Get Laptop<img src="" alt="Laptop"></div>'
>>> html_parser = LexborHTMLParser('<div>Get <span alt="Laptop"><img src="/jpg"> <div></div></span></div>')
>>> html_parser2 = LexborHTMLParser('<div>Test</div>')
>>> img_node = html_parser.css_first('img')
>>> img_node.insert_before(html_parser2.body.child)
<div>Get <span alt="Laptop"><div>Test</div><img src="/jpg"> <div></div></span></div>'
"""
...
def insert_after(self, value: bytes | str | LexborNode) -> None:
"""Insert a node after the current Node.
Parameters
----------
value : str, bytes or Node
The text or Node instance to insert after the Node.
When a text string is passed, it's treated as text. All HTML tags will be escaped.
Convert and pass the ``Node`` object when you want to work with HTML.
Does not clone the ``Node`` object.
All future changes to the passed ``Node`` object will also be taken into account.
Examples
--------
>>> tree = LexborHTMLParser('<div>Get <img src="" alt="Laptop"></div>')
>>> img = tree.css_first('img')
>>> img.insert_after(img.attributes.get('alt', ''))
>>> tree.body.child.html
'<div>Get <img src="" alt="Laptop">Laptop</div>'
>>> html_parser = LexborHTMLParser('<div>Get <span alt="Laptop"><img src="/jpg"> <div></div></span></div>')
>>> html_parser2 = LexborHTMLParser('<div>Test</div>')
>>> img_node = html_parser.css_first('img')
>>> img_node.insert_after(html_parser2.body.child)
<div>Get <span alt="Laptop"><img src="/jpg"><div>Test</div> <div></div></span></div>'
"""
...
def insert_child(self, value: bytes | str | LexborNode) -> None:
"""Insert a node inside (at the end of) the current Node.
Parameters
----------
value : str, bytes or Node
The text or Node instance to insert inside the Node.
When a text string is passed, it's treated as text. All HTML tags will be escaped.
Convert and pass the ``Node`` object when you want to work with HTML.
Does not clone the ``Node`` object.
All future changes to the passed ``Node`` object will also be taken into account.
Examples
--------
>>> tree = LexborHTMLParser('<div>Get <img src=""></div>')
>>> div = tree.css_first('div')
>>> div.insert_child('Laptop')
>>> tree.body.child.html
'<div>Get <img src="">Laptop</div>'
>>> html_parser = LexborHTMLParser('<div>Get <span alt="Laptop"> <div>Laptop</div> </span></div>')
>>> html_parser2 = LexborHTMLParser('<div>Test</div>')
>>> span_node = html_parser.css_first('span')
>>> span_node.insert_child(html_parser2.body.child)
<div>Get <span alt="Laptop"> <div>Laptop</div> <div>Test</div> </span></div>'
"""
...
@property
def raw_value(self) -> NoReturn:
"""Return the raw (unparsed, original) value of a node.
Currently, works on text nodes only.
Returns
-------
raw_value : bytes
Examples
--------
>>> html_parser = LexborHTMLParser('<div><test></div>')
>>> selector = html_parser.css_first('div')
>>> selector.child.html
'<test>'
>>> selector.child.raw_value
b'<test>'
"""
...
def scripts_contain(self, query: str) -> bool:
"""Returns True if any of the script tags contain specified text.
Caches script tags on the first call to improve performance.
Parameters
----------
query : str
The query to check.
"""
...
def script_srcs_contain(self, queries: tuple[str]) -> bool:
"""Returns True if any of the script SRCs attributes contain on of the specified text.
Caches values on the first call to improve performance.
Parameters
----------
queries : tuple of str
"""
...
def remove(self, recursive: bool = True) -> None:
"""An alias for the decompose method."""
...
def select(self, query: str | None = None) -> LexborSelector:
"""Select nodes given a CSS selector.
Works similarly to the the ``css`` method, but supports chained filtering and extra features.
Parameters
----------
query : str or None
The CSS selector to use when searching for nodes.
Returns
-------
selector : The `Selector` class.
"""
...
@property
def text_content(self) -> str | None:
"""Returns the text of the node if it is a text node.
Returns None for other nodes.
Unlike the ``text`` method, does not include child nodes.
Returns
-------
text : str or None.
"""
...
@property
def comment_content(self) -> str | None:
"""Extract the textual content of an HTML comment node.
Returns
-------
str or None
Comment text with surrounding whitespace removed, or ``None`` if
the current node is not a comment or the comment markup cannot be
parsed.
Examples
--------
>>> parse_fragment("<!-- hello -->")[0].comment_content
'hello'
>>> parse_fragment("<div>not a comment</div>")[0].comment_content is None
True
"""
...
@property
def inner_html(self) -> str | None:
"""Return HTML representation of the child nodes.
Works similar to innerHTML in JavaScript.
Unlike the `.html` property, does not include the current node.
Can be used to set HTML as well. See the setter docstring.
Returns
-------
text : str or None
"""
...
@inner_html.setter
def inner_html(self, html: str):
"""Set inner HTML to the specified HTML.
Replaces existing data inside the node.
Works similar to innerHTML in JavaScript.
Parameters
----------
html : str
"""
...
def clone(self) -> LexborNode:
"""Clone the current node.
You can it use to do temporary modifications without affecting the original HTML tree.
It is tied to the current parser instance.
Gets destroyed when parser instance is destroyed.
"""
...
@property
def is_element_node(self) -> bool:
"""Return True if the node represents an element node."""
...
@property
def is_text_node(self) -> bool:
"""Return True if the node represents a text node."""
...
@property
def is_comment_node(self) -> bool:
"""Return True if the node represents a comment node."""
...
@property
def is_document_node(self) -> bool:
"""Return True if the node represents a document node."""
...
@property
def is_empty_text_node(self) -> bool:
"""Check whether the current node is an empty text node.
Returns
-------
bool
``True`` when the node is a text node whose data consists solely of
ASCII whitespace characters (space, tab, newline, form feed or
carriage return).
"""
...
class LexborHTMLParser:
"""The lexbor HTML parser.
Use this class to parse raw HTML.
This parser mimics most of the stuff from ``HTMLParser`` but not inherits it directly.
Parameters
----------
html : str (unicode) or bytes
"""
raw_html: bytes
def __init__(self, html: str | bytes, is_fragment: bool = False) -> None:
"""Create a parser and load HTML.
Parameters
----------
html : str or bytes
HTML content to parse.
is_fragment : bool, optional
When ``False`` (default), the input is parsed as a full HTML document.
If the input is only a fragment, the parser still accepts it and inserts any missing required elements,
(such as `<html>`, `<head>`, and `<body>`) into the tree,
according to the HTML parsing rules in the HTML Standard.
This matches how browsers construct the DOM when they load an HTML page.
When ``True``, the input is parsed as an HTML fragment.
The parser does not insert any missing required HTML elements.
Behaves the same way as `DocumentFragment` in browsers.
When `<html>`, `<head>` or `<body>` are present, ignores them entirely.
As per the HTML Standard.
"""
...
def __repr__(self) -> str:
"""Return a concise representation of the parsed document.
Returns
-------
str
A string showing the number of characters in the parsed HTML.
"""
...
@property
def selector(self) -> LexborCSSSelector:
"""Return a lazily created CSS selector helper.
Returns
-------
LexborCSSSelector
Selector instance bound to this parser.
"""
...
@property
def root(self) -> LexborNode | None:
"""Return the document root node.
Returns
-------
LexborNode or None
Root of the parsed document, or ``None`` if unavailable.
"""
...
@property
def body(self) -> LexborNode | None:
"""Return document body.
Returns
-------
LexborNode or None
``<body>`` element when present, otherwise ``None``.
"""
...
@property
def head(self) -> LexborNode | None:
"""Return document head.
Returns
-------
LexborNode or None
``<head>`` element when present, otherwise ``None``.
"""
...
def tags(self, name: str) -> list[LexborNode]:
"""Return all tags that match the provided name.
Parameters
----------
name : str
Tag name to search for (e.g., ``"div"``).
Returns
-------
list of LexborNode
Matching elements in document order.
Raises
------
ValueError
If ``name`` is empty or longer than 100 characters.
SelectolaxError
If Lexbor cannot locate the elements.
"""
...
def text(
self,
deep: bool = True,
separator: str = "",
strip: bool = False,
skip_empty: bool = False,
) -> str:
"""Returns the text of the node including text of all its child nodes.
Parameters
----------
strip : bool, default False
If true, calls ``str.strip()`` on each text part to remove extra white spaces.
separator : str, default ''
The separator to use when joining text from different nodes.
deep : bool, default True
If True, includes text from all child nodes.
skip_empty : bool, optional
Exclude text nodes whose content is only ASCII whitespace (space,
tab, newline, form feed or carriage return) when ``True``.
Defaults to ``False``.
Returns
-------
text : str
Combined textual content assembled according to the provided options.
"""
...
@property
def html(self) -> str | None:
"""Return HTML representation of the page.
Returns
-------
str or None
Serialized HTML of the current document.
"""
...
def css(self, query: str) -> list[LexborNode]:
"""A CSS selector.
Matches pattern `query` against HTML tree.
`CSS selectors reference <https://www.w3schools.com/cssref/css_selectors.asp>`_.
Special selectors:
- parser.css('p:lexbor-contains("awesome" i)') -- case-insensitive contains
- parser.css('p:lexbor-contains("awesome")') -- case-sensitive contains
Parameters
----------
query : str
CSS selector (e.g. "div > :nth-child(2n+1):not(:has(a))").
Returns
-------
selector : list of `Node` objects
"""
...
@overload
def css_first(
self, query: str, default: Any = ..., strict: Literal[True] = ...
) -> LexborNode:
"""Same as `css` but returns only the first match.
Parameters
----------
query : str
default : Any, default None
Default value to return if there is no match.
strict: bool, default False
Set to True if you want to check if there is strictly only one match in the document.
Returns
-------
selector : `LexborNode` object
"""
...
@overload
def css_first(
self, query: str, default: DefaultT, strict: bool = False
) -> LexborNode | DefaultT:
"""Same as `css` but returns only the first match.
Parameters
----------
query : str
default : Any, default None
Default value to return if there is no match.
strict: bool, default False
Set to True if you want to check if there is strictly only one match in the document.
Returns
-------
selector : `LexborNode` object
"""
...
@overload
def css_first(
self, query: str, default: None = ..., strict: bool = False
) -> LexborNode | None:
"""Same as `css` but returns only the first match.
Parameters
----------
query : str
default : Any, default None
Default value to return if there is no match.
strict: bool, default False
Set to True if you want to check if there is strictly only one match in the document.
Returns
-------
selector : `LexborNode` object
"""
...
def strip_tags(self, tags: list[str], recursive: bool = False) -> None:
"""Remove specified tags from the node.
Parameters
----------
tags : list of str
List of tags to remove.
recursive : bool, default False
Whenever to delete all its child nodes
Examples
--------
>>> tree = LexborHTMLParser('<html><head></head><body><script></script><div>Hello world!</div></body></html>')
>>> tags = ['head', 'style', 'script', 'xmp', 'iframe', 'noembed', 'noframes']
>>> tree.strip_tags(tags)
>>> tree.html
'<html><body><div>Hello world!</div></body></html>'
Returns
-------
None
"""
...
def select(self, query: str | None = None) -> LexborSelector | None:
"""Select nodes given a CSS selector.
Works similarly to the ``css`` method, but supports chained filtering and extra features.
Parameters
----------
query : str or None
The CSS selector to use when searching for nodes.
Returns
-------
LexborSelector or None
Selector bound to the root node, or ``None`` if the document is empty.
"""
...
def any_css_matches(self, selectors: tuple[str]) -> bool:
"""Return ``True`` if any of the specified CSS selectors match.
Parameters
----------
selectors : tuple[str]
CSS selectors to evaluate.
Returns
-------
bool
``True`` when at least one selector matches.
"""
...
def scripts_contain(self, query: str) -> bool:
"""Return ``True`` if any script tag contains the given text.
Caches script tags on the first call to improve performance.
Parameters
----------
query : str
Text to search for within script contents.
Returns
-------
bool
``True`` when a matching script tag is found.
"""
...
def script_srcs_contain(self, queries: tuple[str]) -> bool:
"""Return ``True`` if any script ``src`` contains one of the strings.
Caches values on the first call to improve performance.
Parameters
----------
queries : tuple of str
Strings to look for inside ``src`` attributes.
Returns
-------
bool
``True`` when a matching source value is found.
"""
...
def css_matches(self, selector: str) -> bool:
"""Return ``True`` if the document matches the selector at least once.
Parameters
----------
selector : str
CSS selector to test.
Returns
-------
bool
``True`` when a match exists.
"""
...
def merge_text_nodes(self) -> None:
"""Iterates over all text nodes and merges all text nodes that are close to each other.
This is useful for text extraction.
Use it when you need to strip HTML tags and merge "dangling" text.
Examples
--------
>>> tree = LexborHTMLParser("<div><p><strong>J</strong>ohn</p><p>Doe</p></div>")
>>> node = tree.css_first('div')
>>> tree.unwrap_tags(["strong"])
>>> tree.text(deep=True, separator=" ", strip=True)
"J ohn Doe" # Text extraction produces an extra space because the strong tag was removed.
>>> node.merge_text_nodes()
>>> tree.text(deep=True, separator=" ", strip=True)
"John Doe"
Returns
-------
None
"""
...
def clone(self) -> LexborHTMLParser:
"""Clone the current document tree.
You can use it to do temporary modifications without affecting the original HTML tree.
It is tied to the current parser instance.
Gets destroyed when the parser instance is destroyed.
Returns
-------
LexborHTMLParser
A parser instance backed by a deep-copied document.
"""
...
def unwrap_tags(self, tags: list[str], delete_empty: bool = False) -> None:
"""Unwraps specified tags from the HTML tree.
Works the same as the ``unwrap`` method, but applied to a list of tags.
Parameters
----------
tags : list
List of tags to remove.
delete_empty : bool
Whenever to delete empty tags.
Examples
--------
>>> tree = LexborHTMLParser("<div><a href="">Hello</a> <i>world</i>!</div>")
>>> tree.body.unwrap_tags(['i','a'])
>>> tree.body.html
'<body><div>Hello world!</div></body>'
Returns
-------
None
"""
...
@property
def inner_html(self) -> str:
"""Return HTML representation of the child nodes.
Works similar to innerHTML in JavaScript.
Unlike the `.html` property, does not include the current node.
Can be used to set HTML as well. See the setter docstring.
Returns
-------
text : str | None
"""
...
@inner_html.setter
def inner_html(self, html: str) -> None:
"""Set inner HTML to the specified HTML.
Replaces existing data inside the node.
Works similar to innerHTML in JavaScript.
Parameters
----------
html : str
Returns
-------
None
"""
...
def create_node(self, tag: str) -> LexborNode:
"""Given an HTML tag name, e.g. `"div"`, create a single empty node for that tag,
e.g. `"<div></div>"`.
Parameters
----------
tag : str
Name of the tag to create.
Returns
-------
LexborNode
Newly created element node.
Raises
------
SelectolaxError
If the element cannot be created.
Examples
--------
>>> parser = LexborHTMLParser("<div></div>")
>>> new_node = parser.create_node("span")
>>> new_node.tag_name
'span'
>>> parser.css_first("div").append_child(new_node)
>>> parser.html
'<html><head></head><body><div><span></span></div></body></html>'
"""
def create_tag(tag: str) -> LexborNode:
"""
Given an HTML tag name, e.g. `"div"`, create a single empty node for that tag,
e.g. `"<div></div>"`.
Use `LexborHTMLParser().create_node(..)` if you need to create a node tied to a specific parser instance.
"""
...
def parse_fragment(html: str) -> list[LexborNode]:
"""
Given HTML, parse it into a list of Nodes, such that the nodes
correspond to the given HTML.
For contrast, HTMLParser adds `<html>`, `<head>`, and `<body>` tags
if they are missing. This function does not add these tags.
"""
...
class SelectolaxError(Exception):
"""An exception that indicates error."""
pass
|