From 4bb4cb4e6c49226740e80a8dd1639274e0719b53 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81rni=20Dagur?= Date: Sun, 21 Jun 2020 16:41:21 -0400 Subject: Add type stubs to project (#7) --- adblock/adblock.pyi | 78 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 adblock/adblock.pyi (limited to 'adblock/adblock.pyi') diff --git a/adblock/adblock.pyi b/adblock/adblock.pyi new file mode 100644 index 0000000..50a61e8 --- /dev/null +++ b/adblock/adblock.pyi @@ -0,0 +1,78 @@ +from typing import Optional, Dict, List, Set + +class BlockerResult: + matched: bool + explicit_cancel: bool + important: bool + redirect: Optional[str] + exception: Optional[str] + filter: Optional[str] + error: Optional[str] + def __repr__(self) -> str: + pass + +class HostnameSpecificResources: + hide_selectors: Set[str] + style_selectors: Dict[str, List[str]] + exceptions: Set[str] + injected_script: str + def __repr__(self) -> str: + pass + +class Engine: + def __init__( + self, + network_filters: Optional[List[str]] = None, + load_network: bool = True, + load_cosmetic: bool = False, + debug: bool = False, + ) -> None: + pass + def check_network_urls( + self, url: str, source_url: str, request_type: str + ) -> BlockerResult: + pass + def check_network_urls_with_hostnames( + self, + url: str, + hostname: str, + source_hostname: str, + request_type: str, + third_party_request: Optional[bool], + ) -> BlockerResult: + pass + def check_network_urls_with_hostnames_subset( + self, + url: str, + hostname: str, + source_hostname: str, + request_type: str, + third_party_request: Optional[bool], + previously_matched_rule: bool, + force_check_exceptions: bool, + ) -> BlockerResult: + pass + def serialize(self) -> bytes: + pass + def serialize_to_file(self, file: str) -> None: + pass + def deserialize(self, serialized: bytes) -> None: + pass + def deserialize_from_file(self, file: str) -> None: + pass + def add_filter_list(self, filter_list: str) -> None: + pass + def filter_exists(self, filter: str) -> bool: + pass + def tags_enable(self, tags: List[str]) -> None: + pass + def tags_disable(self, tags: List[str]) -> None: + pass + def tag_exists(self, tag: str) -> bool: + pass + def hostname_cosmetic_resources(self, hostname: str) -> HostnameSpecificResources: + pass + def hidden_class_id_selectors( + self, classes: List[str], ids: List[str], exceptions: Set[str] + ) -> List[str]: + pass -- cgit v1.2.3