Document
Document
סקירה כללית
Document היא מחלקה ב-Aspose.Html FOSS ל-Python. יורשת מ: Node.
שורש של עץ DOM.
מחלקה זו מספקת 66 שיטות לעבודה עם אובייקטי Document בתוכניות Python. השיטות הזמינות כוללות: __init__, add_event_listener, adopt_node, append, append_child, attach_style_sheet, clone_node, close, compare_document_position, contains, create_attribute, create_attribute_ns, ו-54 שיטות נוספות. כל החברים הציבוריים נגשים לכל יישום Python לאחר התקנת חבילת Aspose.Html FOSS ל-Python. מאפיינים: a_link_color, active_element, adopted_style_sheets, all, anchors, applets, ו-67 נוספים.
מאפיינים
| שם | סוג | גישה | תיאור |
|---|---|---|---|
default_view | `` | קריאה | אובייקט Window לכל מסמך (עצלי, במטמון). |
location | `` | קריאה | החזר את אובייקט Location של ה-Window המשויך, או None. |
implementation | "DOMImplementation" | קריאה | אובייקט DOMImplementation לכל מסמך (עצלי, במטמון). |
dom_config | DOMConfiguration | קריאה | אובייקט DOMConfiguration לכל מסמך (בצורה עצלנית, במטמון). |
url | str | קריאה | כתובת URL של המסמך (WHATWG Document.URL), ברירת מחדל "about:blank". |
document_uri | str | קריאה | כתובת ה-URL של המסמך כמחרוזת (WHATWG DOM §4.5 documentURI). |
base_uri | str | קריאה | כתובת בסיס שנפתרה עבור מסמך זה (WHATWG DOM Node.baseURI). |
referrer | str | קריאה | כתובת המסמך המתייחס (WHATWG HTML Standard §document). |
domain | str | קריאה | רכיב שם המארח של כתובת ה-URL של המסמך (WHATWG HTML Standard §document). |
last_modified | str | קריאה | מחרוזת חותמת זמן של עדכון אחרון (WHATWG HTML Standard §document). |
cookie | str | קריאה/כתיבה | תבנית מחרוזת עוגייה לקריאה בלבד — תמיד מחזירה "" (WHATWG HTML §8.11.1). |
hidden | bool | קריאה | האם המסמך מוסתר — תמיד False במצב headless. |
visibility_state | str | קריאה | מצב נראות המסמך — תמיד "visible" במצב headless. |
design_mode | str | קריאה/כתיבה | האם המסמך נמצא במצב עיצוב (WHATWG HTML §7.6.4). |
dir | str | קריאה/כתיבה | כיוון הטקסט של המסמך (WHATWG HTML §3.3.2). |
current_script | None | קריאה | אלמנט הסקריפט המבוצע כעת (WHATWG HTML §8.1.3.4). |
character_set | str | קריאה | קידוד תווים המשמש במהלך פענוח (WHATWG DOM §3.1). |
charset | str | קריאה | כינוי ל :attr:character_set (HTML שם תקני). |
input_encoding | str | קריאה | כינוי ל :attr:character_set (שם התאמה ל-WHATWG DOM). |
content_type | str | קריאה | סוג MIME של המסמך; תמיד "text/html" עבור מסמכי HTML. |
style_sheets | "StyleSheetList" | קריאה | רשימת גיליונות סגנון של מסמך חי. |
adopted_style_sheets | list["CSSStyleSheet"] | קריאה/כתיבה | רשימת אימוץ גיליונות סגנון ברמת המסמך שניתן לבנייה. |
node_name | str | קריאה | '#document' |
document_element | `Element | None` | קריאה |
document_type | `DocumentType | None` | קריאה |
compat_mode | str | קריאה/כתיבה | 'BackCompat' (quirks) או 'CSS1Compat' (no-quirks). |
ready_state | str | קריאה | מצב טעינת המסמך. |
parse_errors | list[ParseError] | קריאה | שגיאות ניתוח מהפעולה האחרונה. |
head | `Element | None` | קריאה |
body | `Element | None` | קריאה |
forms | "HTMLCollection" | קריאה | אוסף בזמן אמת של כל רכיבי <form> במסמך. |
images | "HTMLCollection" | קריאה | אוסף בזמן אמת של כל רכיבי <img> במסמך. |
links | "HTMLCollection" | קריאה | אוסף בזמן אמת של רכיבי <a href> ו-<area href>. |
scripts | "HTMLCollection" | קריאה | אוסף חי של כל מרכיבי <script> במסמך. |
embeds | "HTMLCollection" | קריאה | אוסף חי של כל הצאצאים של <embed>. |
applets | "HTMLCollection" | קריאה | אוסף חי של כל הצאצאים של <applet>. |
anchors | "HTMLCollection" | קריאה | אוסף חי של רכיבי <a name=...> (עוגנים ממותגים מדור קודם). |
title | str | קריאה/כתיבה | תכולת הטקסט של האלמנט הראשון מסוג <title> ב-<head>. |
compatible_mode | str | קריאה | מחוון מצב קווירקס (WHATWG HTML §3.2.1). |
strict_error_checking | bool | קריאה/כתיבה | תמיד True במצב ללא ממשק (DOM3 Core §1.1.1). |
first_element_child | `“Element | None”` | קריאה |
last_element_child | `“Element | None”` | קריאה |
child_element_count | int | קריאה | מספר הילדים הישירים שהם צמתים מסוג Element. |
active_element | `“Element | None”` | קריאה |
full_screen_enabled | bool | קריאה | תמיד False — אין תצוגה במצב ללא ראש (Fullscreen API §7). |
fullscreen_element | None | קריאה | תמיד None — אין אלמנט מסך מלא במצב ללא ראש (Fullscreen API §7). |
pointer_lock_element | None | קריאה | תמיד None — אין נעילת מצביע במצב ללא ראש (Pointer Lock API §4). |
timeline | "_DocumentTimeline" | קריאה | Document timeline stub; current_time is always 0.0 (Web Animations API §6.2). |
all | "_AllCollection" | קריאה | All elements in tree order (WHATWG HTML §legacy document layout interface). |
plugins | "HTMLCollection" | קריאה | Alias for :attr:embeds per WHATWG HTML §4.1 legacy interface. |
children | "HTMLCollection" | קריאה | אלמנטים ילדים ישירים של המסמך (WHATWG DOM §4.2.6 ParentNode). |
origin | str | קריאה | מחרוזת מקור אטומה — תמיד 'null' במצב ללא ראש (WHATWG DOM §4.5). |
fg_color | str | קריאה/כתיבה | משקף תכונה ברמת המסמך fgColor מיושנת דרך תכונת <body> text. |
bg_color | str | קריאה/כתיבה | משקף תכונה ישנה ברמת המסמך bgColor באמצעות תכונת <body> bgcolor. |
link_color | str | קריאה/כתיבה | משקף תכונה ישנה ברמת המסמך linkColor באמצעות תכונת <body> link. |
v_link_color | str | קריאה/כתיבה | משקף תכונה ישנה ברמת המסמך vlinkColor באמצעות תכונת <body> vlink. |
a_link_color | str | קריאה/כתיבה | משקף תכונה ברמת מסמך alinkColor מיושנת דרך תכונה <body> alink. |
fonts | `` | קריאה | תמיד None במצב ללא ראש. |
picture_in_picture_enabled | bool | קריאה | תמיד False במצב ללא ראש. |
picture_in_picture_element | `` | קריאה | תמיד None במצב ללא ממשק. |
prerendering | bool | קריאה | תמיד False במצב ללא ממשק. |
node_type | int | קריאה | קבוע של סוג צומת של מספר שלם מ-NodeType. |
node_value | `str | None` | קריאה/כתיבה |
text_content | `str | None` | קריאה/כתיבה |
parent_node | `Node | None` | קריאה |
parent_element | `Element | None` | קריאה |
is_connected | bool | קריאה | האם צומת זה הוא חלק מעץ הצמתים של המסמך (WHATWG DOM §4.4). |
owner_document | `Document | None` | קריאה |
child_nodes | NodeList | קריאה | תצוגה חיה של NodeList של כל הצמתים הבנים. |
first_child | `Node | None` | קריאה |
last_child | `Node | None` | קריאה |
previous_sibling | `Node | None` | קריאה |
next_sibling | `Node | None` | קריאה |
שיטות
| חתימה | תיאור |
|---|---|
__init__() | Calls init במופע ה-Document הזה. |
normalize_document() | נרמל את המסמך הזה באמצעות תחביר Node.normalize קיים. |
has_focus() → bool | החזר האם למסמך יש פוקוס — תמיד False במצב headless. |
open(type: str, replace: str) → "Document" | פתח את המסמך לכתיבה (WHATWG HTML §7.7). |
close() | סגור את המסמך לאחר הכתיבה (WHATWG HTML §7.7). |
write() | כתוב מחרוזת לזרם המסמך (WHATWG HTML §7.7). |
writeln() | כתוב מחרוזת ולאחריה שורה חדשה (WHATWG HTML §7.7). |
attach_style_sheet(sheet: "CSSStyleSheet") | צרף גיליון סגנון למסמך זה. |
detach_style_sheet(sheet: "CSSStyleSheet") | נתק גיליון סגנון שמוצמד בעבר. |
| `save(path: “str | pathlib.Path”, encoding: str)` |
create_element(tag_name: str) → "HTMLElement" | צור HTMLElement שבבעלות המסמך הזה. |
create_element_ns(namespace_uri: str, qualified_name: str) → Element | צור Element במרחב שם ספציפי, שבבעלות המסמך הזה. |
create_text_node(data: str) → Text | צור צומת טקסט עם נתוני התווים הנתונים. |
create_comment(data: str) → Comment | צור צומת תגובה עם נתוני התווים הנתונים. |
create_cdata_section(data: str) → "CDATASection" | צור צומת CDATASection שבבעלות המסמך הזה. |
create_document_fragment() → DocumentFragment | צור DocumentFragment ריק שבבעלות המסמך הזה. |
create_event(interface: str) → "Event" | צור אובייקט אירוע legacy עבור interface. |
create_range() → "Range" | צור Range חדש שמכווץ במסמך זה. |
get_selection() → "Selection" | החזר את אובייקט הבחירה היחיד של מסמך זה. |
create_processing_instruction(target: str, data: str) → "ProcessingInstruction" | צור צומת ProcessingInstruction השייך למסמך זה. |
create_attribute(local_name: str) → "Attr" | צור Attr ללא מרחב שם השייך למסמך זה. |
| `create_attribute_ns(namespace_uri: str | None, qualified_name: str)→“Attr”` |
| `create_tree_walker(root: “Node”, what_to_show: int, node_filter: “Callable[[Node], int] | None”)→“TreeWalker”` |
| `create_node_iterator(root: “Node”, what_to_show: int, node_filter: “Callable[[Node], int] | None”)→“NodeIterator”` |
adopt_node(node: Node) → Node | Adopt node אל המסמך הזה, תוך העברתו מהעץ הנוכחי שלו. |
import_node(node: Node, deep: bool) → Node | החזר עותק של node שייך למסמך זה. |
get_element_by_id(id: str) → `Element | None` |
get_elements_by_tag_name(name: str) → HTMLCollection | החזר את כל האלמנטים הצאצאים עם שם התג הנתון. |
get_elements_by_class_name(names: str) → HTMLCollection | החזר את כל האלמנטים הצאצאים עם כל שמות המחלקה הנתונים. |
filter_fn(el: Element) → bool | קורא ל-filter_fn(el) במופע ה-Document הזה. |
get_elements_by_name(name: str) → NodeList | החזר את כל רכיבי הצאצא שה name התכונה שווה ל name. |
| `get_elements_by_tag_name_ns(namespace: “str | None”, local_name: str)→list` |
prepend() | Insert nodes לפני הילד הראשון של מסמך זה. |
append() | Append nodes כאשר הילדים האחרונים של מסמך זה. |
replace_children() | הסר את כל הילדים של מסמך זה, ואז הוסף nodes. |
query_selector(selector: str) → `Element | None` |
query_selector_all(selector: str) → NodeList | החזר NodeList סטטי של כל האלמנטים המתאימים לבורר CSS. |
get_animations() → list[object] | החזר אנימציות ברמת המסמך (headless stub: always []). |
element_from_point(x: float, y: float) | תמיד None — headless אין מנוע פריסה לבדיקת פגיעה (CSSOM View §11.6). |
elements_from_point(x: float, y: float) → list | תמיד [] — headless אין מנוע פריסה לבדיקת פגיעה (CSSOM View §11.6). |
exec_command(command_id: str, show_ui: bool, value: str) → bool | תמיד False — פקודת עריכה מיושנת; אין צינור ב-headless (WHATWG HTML §8.6.1). |
query_command_enabled(command_id: str) → bool | תמיד False — ללא צינור עריכה ב-headless (WHATWG HTML §8.6.1). |
has_storage_access() → bool | תמיד True — מקור headless מטופל כמקור זהה (Storage Access API). |
request_storage_access() | Stub ללא פעולה — headless תמיד יש גישה לאחסון; אין צורך במתן אסינכרוני (Storage Access API). |
get_root_node(composed: bool) → "Node" | החזר את השורש של עץ הצומת. |
has_child_nodes() → bool | החזר האם לצומת זה יש לפחות ילד ישיר אחד. |
| `lookup_namespace_uri(prefix: str | None)→str |
| `lookup_prefix(namespace_uri: str | None)→str |
| `is_default_namespace(namespace_uri: str | None)→bool` |
| `is_supported(feature: str, version: str | None)→bool` |
| `get_feature(feature: str, version: str | None)→object |
| `set_user_data(key: str, data: object | None, handler: object |
get_user_data(key: str) → `object | None` |
append_child(node: Node) → Node | Append node כילד האחרון של צומת זה. |
| `insert_before(node: Node, reference: Node | None)→Node` |
remove_child(node: Node) → Node | Remove node מתוך רשימת הילדים והחזר אותו. |
replace_child(new_child: Node, old_child: Node) → Node | Replace old_child with new_child. |
clone_node(deep: bool) → Node | החזר עותק של הצומת הזה. |
normalize() | הציב צומת זה ואת כל תת-העץ שלו בצורה מנורמלת. |
| `contains(other: Node | None)→bool` |
compare_document_position(other: "Node") → int | החזר מסכת ביט המתארת את המיקום של other ביחס לצומת זה. |
| `is_equal_node(other: Node | None)→bool` |
| `is_same_node(other_node: Node | None)→bool` |
add_event_listener(type: str, listener: Callable, capture: bool, once: bool) | Register listener לאירועים של type. |
remove_event_listener(type: str, listener: Callable, capture: bool) | הסר רישום של מאזין שנרשם קודם. |
dispatch_event(event: "Event") → bool | Dispatch event דרך עץ האבות. |