Document

نمای کلی

Document یک کلاس در Aspose.Html FOSS برای Python است. ارث‌برده از: Node.

ریشه یک درخت DOM.

این کلاس ۶۶ متد برای کار با اشیاء 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 و ۵۴ متد دیگر هستند. تمام اعضای عمومی پس از نصب بسته Aspose.Html FOSS برای Python برای هر برنامه Python قابل دسترسی هستند. ویژگی‌ها: a_link_color, active_element, adopted_style_sheets, all, anchors, applets و ۶۷ مورد دیگر.

خواص

نام	نوع	دسترسی	توضیح
`default_view`	``	خواندن	شیء Window برای هر سند (lazy, cached).
`location`	``	خواندن	شیء Location مربوط به Window مرتبط را برمی‌گرداند، یا `None`.
`implementation`	`"DOMImplementation"`	خواندن	شیء DOMImplementation برای هر سند (lazy, cached).
`dom_config`	`DOMConfiguration`	خواندن	شیء DOMConfiguration برای هر سند (تنها در زمان نیاز، کش‌شده).
`url`	`str`	خواندن	آدرس URL سند (WHATWG `Document.URL`)، پیش‌فرض `"about:blank"`.
`document_uri`	`str`	خواندن	آدرس URL سند به عنوان یک رشته (WHATWG DOM §4.5 `documentURI`).
`base_uri`	`str`	خواندن	آدرس URL پایه حل شده برای این سند (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'` (نقائص) یا `'CSS1Compat'` (بدون نقائص).
`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`	خواندن	نشانگر حالت Quirks (WHATWG HTML §3.2.1).
`strict_error_checking`	`bool`	خواندن/نوشتن	همیشه `True` در حالت headless (DOM3 Core §1.1.1).
`first_element_child`	`“Element	None”`	خواندن
`last_element_child`	`“Element	None”`	خواندن
`child_element_count`	`int`	خواندن	تعداد فرزندان مستقیم که گره‌های عنصر هستند.
`active_element`	`“Element	None”`	خواندن
`full_screen_enabled`	`bool`	خواندن	همواره `False` — بدون نمایش در حالت headless (Fullscreen API §7).
`fullscreen_element`	`None`	خواندن	همیشه `None` — در حالت headless عنصر fullscreen وجود ندارد (Fullscreen API §7).
`pointer_lock_element`	`None`	خواندن	همیشه `None` — در حالت headless Pointer Lock وجود ندارد (Pointer Lock API §4).
`timeline`	`"_DocumentTimeline"`	خواندن	قطعه‌کد زمان‌بندی سند؛ `current_time` همیشه `0.0` است (Web Animations API §6.2).
`all`	`"_AllCollection"`	خواندن	تمام عناصر به ترتیب درخت (WHATWG HTML §legacy document layout interface).
`plugins`	`"HTMLCollection"`	خواندن	نام مستعار برای :attr:`embeds` بر مبنای WHATWG HTML §4.1 رابط قدیمی.
`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` در حالت headless mode.
`picture_in_picture_enabled`	`bool`	خواندن	همیشه `False` در حالت headless mode.
`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")`	یک stylesheet را به این سند پیوست کنید.
`detach_style_sheet(sheet: "CSSStyleSheet")`	یک stylesheet پیش از این الصاق‌شده را جدا کنید.
`save(path: “str	pathlib.Path”, encoding: str)`
`create_element(tag_name: str)` → `"HTMLElement"`	یک HTMLElement متعلق به این سند ایجاد کنید.
`create_element_ns(namespace_uri: str, qualified_name: str)` → `Element`	یک عنصر را در یک فضای نام خاص ایجاد کنید که متعلق به این سند باشد.
`create_text_node(data: str)` → `Text`	یک گرهٔ Text با داده‌های کاراکتری داده‌شده ایجاد کنید.
`create_comment(data: str)` → `Comment`	یک گرهٔ Comment با داده‌های کاراکتری داده‌شده ایجاد کنید.
`create_cdata_section(data: str)` → `"CDATASection"`	یک گرهٔ CDATASection متعلق به این سند ایجاد کنید.
`create_document_fragment()` → `DocumentFragment`	یک DocumentFragment خالی ایجاد کنید که متعلق به این سند باشد.
`create_event(interface: str)` → `"Event"`	یک legacy event object ایجاد کنید برای interface.
`create_range()` → `"Range"`	یک Range جدید ایجاد کنید که در این سند جمع شده باشد.
`get_selection()` → `"Selection"`	شیء singleton selection object این سند را برگردانید.
`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 به عنوان same-origin در نظر گرفته می‌شود (Storage Access API).
`request_storage_access()`	قطعهٔ بدون عمل — 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 از طریق درخت نیاکان.

همچنین ببینید:

Aspose.HTML for Python — Enterprise API Reference