webscout 8.2.7__py3-none-any.whl → 8.2.9__py3-none-any.whl

webscout/scout/core/scout.py

@@ -0,0 +1,607 @@
+"""
+Scout Main Module - HTML Parsing and Traversal
+"""
+import hashlib
+import json
+import re
+import unicodedata
+import urllib.parse
+from typing import Any, Dict, List, Optional
+
+from ..element import NavigableString, Tag
+from ..parsers import ParserRegistry
+from ..utils import decode_markup
+from .search_result import ScoutSearchResult
+from .text_analyzer import ScoutTextAnalyzer
+from .text_utils import SentenceTokenizer
+from .web_analyzer import ScoutWebAnalyzer
+
+
+class Scout:
+    """
+    Scout - Making web scraping a breeze! 🌊
+    A comprehensive HTML parsing and traversal library.
+    Enhanced with advanced features and intelligent parsing.
+    """
+
+    def __init__(self, markup="", features='html.parser', from_encoding=None, **kwargs):
+        """
+        Initialize Scout with HTML content.
+
+        Args:
+            markup (str): HTML content to parse
+            features (str): Parser to use ('html.parser', 'lxml', 'html5lib', 'lxml-xml')
+            from_encoding (str): Source encoding (if known)
+            **kwargs: Additional parsing options
+        """
+        # Intelligent markup handling
+        self.markup = self._preprocess_markup(markup, from_encoding)
+        self.features = features
+        self.from_encoding = from_encoding
+
+        # Get the right parser for the job
+        if features not in ParserRegistry.list_parsers():
+            raise ValueError(
+                f"Invalid parser '{features}'! Choose from: {', '.join(ParserRegistry.list_parsers().keys())}"
+            )
+
+        parser_class = ParserRegistry.get_parser(features)
+        self.parser = parser_class
+
+        # Parse that HTML! 🎯
+        self._soup = self.parser.parse(self.markup)
+
+        # BeautifulSoup-like attributes
+        self.name = self._soup.name if hasattr(self._soup, 'name') else None
+        self.attrs = self._soup.attrs if hasattr(self._soup, 'attrs') else {}
+
+        # Advanced parsing options
+        self._cache = {}
+
+        # Text and web analyzers
+        self.text_analyzer = ScoutTextAnalyzer()
+        self.web_analyzer = ScoutWebAnalyzer()
+
+    def normalize_text(self, text: str, form='NFKD') -> str:
+        """
+        Normalize text using Unicode normalization.
+
+        Args:
+            text (str): Input text
+            form (str, optional): Normalization form
+
+        Returns:
+            str: Normalized text
+        """
+        return unicodedata.normalize(form, text)
+
+    def url_parse(self, url: str) -> Dict[str, str]:
+        """
+        Parse and analyze a URL.
+
+        Args:
+            url (str): URL to parse
+
+        Returns:
+            Dict[str, str]: Parsed URL components
+        """
+        parsed = urllib.parse.urlparse(url)
+        return {
+            'scheme': parsed.scheme,
+            'netloc': parsed.netloc,
+            'path': parsed.path,
+            'params': parsed.params,
+            'query': parsed.query,
+            'fragment': parsed.fragment
+        }
+
+    def analyze_page_structure(self) -> Dict[str, Any]:
+        """
+        Analyze the structure of the parsed page.
+
+        Returns:
+            Dict[str, Any]: Page structure analysis
+        """
+        return self.web_analyzer.analyze_page_structure(self)
+
+    def analyze_text(self, text: Optional[str] = None) -> Dict[str, Any]:
+        """
+        Perform advanced text analysis.
+
+        Args:
+            text (str, optional): Text to analyze. If None, uses page text.
+
+        Returns:
+            Dict[str, Any]: Text analysis results
+        """
+        if text is None:
+            text = self.get_text()
+
+        return {
+            'word_count': self.text_analyzer.count_words(text),
+            'entities': self.text_analyzer.extract_entities(text),
+            'tokens': self.text_analyzer.tokenize(text)
+        }
+
+    def extract_semantic_info(self) -> Dict[str, Any]:
+        """
+        Extract semantic information from the document.
+
+        Returns:
+            Dict[str, Any]: Semantic information
+        """
+        semantic_info = {
+            'headings': {
+                'h1': [h.get_text(strip=True) for h in self.find_all('h1')],
+                'h2': [h.get_text(strip=True) for h in self.find_all('h2')],
+                'h3': [h.get_text(strip=True) for h in self.find_all('h3')]
+            },
+            'lists': {
+                'ul': [ul.find_all('li') for ul in self.find_all('ul')],
+                'ol': [ol.find_all('li') for ol in self.find_all('ol')]
+            },
+            'tables': {
+                'count': len(self.find_all('table')),
+                'headers': [table.find_all('th') for table in self.find_all('table')]
+            }
+        }
+        return semantic_info
+
+    def cache(self, key: str, value: Any = None) -> Any:
+        """
+        Manage a cache for parsed content.
+
+        Args:
+            key (str): Cache key
+            value (Any, optional): Value to cache
+
+        Returns:
+            Any: Cached value or None
+        """
+        if value is not None:
+            self._cache[key] = value
+        return self._cache.get(key)
+
+    def hash_content(self, method='md5') -> str:
+        """
+        Generate a hash of the parsed content.
+
+        Args:
+            method (str, optional): Hashing method
+
+        Returns:
+            str: Content hash
+        """
+        hash_methods = {
+            'md5': hashlib.md5,
+            'sha1': hashlib.sha1,
+            'sha256': hashlib.sha256
+        }
+
+        if method not in hash_methods:
+            raise ValueError(f"Unsupported hash method: {method}")
+
+        hasher = hash_methods[method]()
+        hasher.update(str(self._soup).encode('utf-8'))
+        return hasher.hexdigest()
+
+    def extract_links(self, base_url: Optional[str] = None) -> List[Dict[str, str]]:
+        """
+        Extract all links from the document.
+
+        Args:
+            base_url (str, optional): Base URL for resolving relative links
+
+        Returns:
+            List[Dict[str, str]]: List of link dictionaries
+        """
+        links = []
+        for link in self.find_all(['a', 'link']):
+            href = link.get('href')
+            if href:
+                # Resolve relative URLs if base_url is provided
+                if base_url and not href.startswith(('http://', 'https://', '//')):
+                    href = f"{base_url.rstrip('/')}/{href.lstrip('/')}"
+
+                links.append({
+                    'href': href,
+                    'text': link.get_text(strip=True),
+                    'rel': link.get('rel', [None])[0],
+                    'type': link.get('type')
+                })
+        return links
+
+    def extract_metadata(self) -> Dict[str, Any]:
+        """
+        Extract metadata from HTML document.
+
+        Returns:
+            Dict[str, Any]: Extracted metadata
+        """
+        metadata = {
+            'title': self.find('title').texts()[0] if self.find('title').texts() else None,
+            'description': self.find('meta', attrs={'name': 'description'}).attrs('content')[0] if self.find('meta', attrs={'name': 'description'}).attrs('content') else None,
+            'keywords': self.find('meta', attrs={'name': 'keywords'}).attrs('content')[0].split(',') if self.find('meta', attrs={'name': 'keywords'}).attrs('content') else [],
+            'og_metadata': {},
+            'twitter_metadata': {}
+        }
+
+        # Open Graph metadata
+        for meta in self.find_all('meta', attrs={'property': re.compile(r'^og:')}):
+            key = meta.attrs('property')[0][3:]
+            metadata['og_metadata'][key] = meta.attrs('content')[0]
+
+        # Twitter Card metadata
+        for meta in self.find_all('meta', attrs={'name': re.compile(r'^twitter:')}):
+            key = meta.attrs('name')[0][8:]
+            metadata['twitter_metadata'][key] = meta.attrs('content')[0]
+
+        return metadata
+
+    def to_json(self, indent=2) -> str:
+        """
+        Convert parsed content to JSON.
+
+        Args:
+            indent (int, optional): JSON indentation
+
+        Returns:
+            str: JSON representation of the document
+        """
+        def _tag_to_dict(tag):
+            if isinstance(tag, NavigableString):
+                return str(tag)
+
+            result = {
+                'name': tag.name,
+                'attrs': tag.attrs,
+                'text': tag.get_text(strip=True)
+            }
+
+            if tag.contents:
+                result['children'] = [_tag_to_dict(child) for child in tag.contents]
+
+            return result
+
+        return json.dumps(_tag_to_dict(self._soup), indent=indent)
+
+    def find(self, name=None, attrs={}, recursive=True, text=None, **kwargs) -> ScoutSearchResult:
+        """
+        Find the first matching element.
+
+        Args:
+            name (str, optional): Tag name to search for
+            attrs (dict, optional): Attributes to match
+            recursive (bool, optional): Search recursively
+            text (str, optional): Text content to match
+
+        Returns:
+            ScoutSearchResult: First matching element
+        """
+        result = self._soup.find(name, attrs, recursive, text, **kwargs)
+        return ScoutSearchResult([result]) if result else ScoutSearchResult([])
+
+    def find_all(self, name=None, attrs={}, recursive=True, text=None, limit=None, **kwargs) -> ScoutSearchResult:
+        """
+        Find all matching elements.
+
+        Args:
+            name (str, optional): Tag name to search for
+            attrs (dict, optional): Attributes to match
+            recursive (bool, optional): Search recursively
+            text (str, optional): Text content to match
+            limit (int, optional): Maximum number of results
+
+        Returns:
+            ScoutSearchResult: List of matching elements
+        """
+        results = self._soup.find_all(name, attrs, recursive, text, limit, **kwargs)
+        return ScoutSearchResult(results)
+
+    def find_parent(self, name=None, attrs={}, **kwargs) -> Optional[Tag]:
+        """
+        Find the first parent matching given criteria.
+
+        Args:
+            name (str, optional): Tag name to search for
+            attrs (dict, optional): Attributes to match
+
+        Returns:
+            Tag or None: First matching parent
+        """
+        current = self._soup.parent
+        while current:
+            if (name is None or current.name == name) and \
+               all(current.get(k) == v for k, v in attrs.items()):
+                return current
+            current = current.parent
+        return None
+
+    def find_parents(self, name=None, attrs={}, limit=None, **kwargs) -> List[Tag]:
+        """
+        Find all parents matching given criteria.
+
+        Args:
+            name (str, optional): Tag name to search for
+            attrs (dict, optional): Attributes to match
+            limit (int, optional): Maximum number of results
+
+        Returns:
+            List[Tag]: List of matching parents
+        """
+        parents = []
+        current = self._soup.parent
+        while current and (limit is None or len(parents) < limit):
+            if (name is None or current.name == name) and \
+               all(current.get(k) == v for k, v in attrs.items()):
+                parents.append(current)
+            current = current.parent
+        return parents
+
+    def find_next_sibling(self, name=None, attrs={}, **kwargs) -> Optional[Tag]:
+        """
+        Find the next sibling matching given criteria.
+
+        Args:
+            name (str, optional): Tag name to search for
+            attrs (dict, optional): Attributes to match
+
+        Returns:
+            Tag or None: First matching next sibling
+        """
+        if not self._soup.parent:
+            return None
+
+        siblings = self._soup.parent.contents
+        try:
+            current_index = siblings.index(self._soup)
+            for sibling in siblings[current_index + 1:]:
+                if isinstance(sibling, Tag):
+                    if (name is None or sibling.name == name) and \
+                       all(sibling.get(k) == v for k, v in attrs.items()):
+                        return sibling
+        except ValueError:
+            pass
+        return None
+
+    def find_next_siblings(self, name=None, attrs={}, limit=None, **kwargs) -> List[Tag]:
+        """
+        Find all next siblings matching given criteria.
+
+        Args:
+            name (str, optional): Tag name to search for
+            attrs (dict, optional): Attributes to match
+            limit (int, optional): Maximum number of results
+
+        Returns:
+            List[Tag]: List of matching next siblings
+        """
+        if not self._soup.parent:
+            return []
+
+        siblings = []
+        siblings_list = self._soup.parent.contents
+        try:
+            current_index = siblings_list.index(self._soup)
+            for sibling in siblings_list[current_index + 1:]:
+                if isinstance(sibling, Tag):
+                    if (name is None or sibling.name == name) and \
+                       all(sibling.get(k) == v for k, v in attrs.items()):
+                        siblings.append(sibling)
+                        if limit and len(siblings) == limit:
+                            break
+        except ValueError:
+            pass
+        return siblings
+
+    def find_previous_sibling(self, name=None, attrs={}, **kwargs) -> Optional[Tag]:
+        """Find the previous sibling matching given criteria."""
+        if not self._soup.parent:
+            return None
+
+        siblings = self._soup.parent.contents
+        try:
+            current_index = siblings.index(self._soup)
+            for sibling in reversed(siblings[:current_index]):
+                if isinstance(sibling, Tag):
+                    if (name is None or sibling.name == name) and all(
+                        sibling.get(k) == v for k, v in attrs.items()
+                    ):
+                        return sibling
+        except ValueError:
+            pass
+        return None
+
+    def find_previous_siblings(self, name=None, attrs={}, limit=None, **kwargs) -> List[Tag]:
+        """Find all previous siblings matching given criteria."""
+        if not self._soup.parent:
+            return []
+
+        siblings = []
+        siblings_list = self._soup.parent.contents
+        try:
+            current_index = siblings_list.index(self._soup)
+            for sibling in reversed(siblings_list[:current_index]):
+                if isinstance(sibling, Tag):
+                    if (name is None or sibling.name == name) and all(
+                        sibling.get(k) == v for k, v in attrs.items()
+                    ):
+                        siblings.append(sibling)
+                        if limit and len(siblings) == limit:
+                            break
+        except ValueError:
+            pass
+        return siblings
+
+    def select(self, selector: str) -> List[Tag]:
+        """
+        Select elements using CSS selector.
+
+        Args:
+            selector (str): CSS selector string
+
+        Returns:
+            List[Tag]: List of matching elements
+        """
+        return self._soup.select(selector)
+
+    def select_one(self, selector: str) -> Optional[Tag]:
+        """
+        Select the first element matching the CSS selector.
+
+        Args:
+            selector (str): CSS selector string
+
+        Returns:
+            Tag or None: First matching element
+        """
+        return self._soup.select_one(selector)
+
+    def get_text(self, separator=' ', strip=False, types=None) -> str:
+        """
+        Extract all text from the parsed document.
+
+        Args:
+            separator (str, optional): Text separator
+            strip (bool, optional): Strip whitespace
+            types (list, optional): Types of content to extract
+
+        Returns:
+            str: Extracted text
+        """
+        tokenizer = SentenceTokenizer()
+        text = self._soup.get_text(separator, strip, types)
+        sentences = tokenizer.tokenize(text)
+        return "\n\n".join(sentences)
+
+    def remove_tags(self, tags: List[str]) -> None:
+        """
+        Remove specified tags and their contents from the document.
+
+        Args:
+            tags (List[str]): List of tag names to remove
+        """
+        for tag_name in tags:
+            for tag in self._soup.find_all(tag_name):
+                tag.decompose()
+
+    def prettify(self, formatter='minimal') -> str:
+        """
+        Return a formatted, pretty-printed version of the HTML.
+
+        Args:
+            formatter (str, optional): Formatting style
+
+        Returns:
+            str: Prettified HTML
+        """
+        return self._soup.prettify(formatter)
+
+    def decompose(self, tag: Tag = None) -> None:
+        """
+        Remove a tag and its contents from the document.
+
+        Args:
+            tag (Tag, optional): Tag to remove. If None, removes the root tag.
+        """
+        if tag is None:
+            tag = self._soup
+        tag.decompose()
+
+    def extract(self, tag: Tag = None) -> Tag:
+        """
+        Remove a tag from the document and return it.
+
+        Args:
+            tag (Tag, optional): Tag to extract. If None, extracts the root tag.
+
+        Returns:
+            Tag: Extracted tag
+        """
+        if tag is None:
+            tag = self._soup
+        return tag.extract()
+
+    def clear(self, tag: Tag = None) -> None:
+        """
+        Remove a tag's contents while keeping the tag itself.
+
+        Args:
+            tag (Tag, optional): Tag to clear. If None, clears the root tag.
+        """
+        if tag is None:
+            tag = self._soup
+        tag.clear()
+
+    def replace_with(self, old_tag: Tag, new_tag: Tag) -> None:
+        """
+        Replace one tag with another.
+
+        Args:
+            old_tag (Tag): Tag to replace
+            new_tag (Tag): Replacement tag
+        """
+        old_tag.replace_with(new_tag)
+
+    def encode(self, encoding='utf-8') -> bytes:
+        """
+        Encode the document to a specific encoding.
+
+        Args:
+            encoding (str, optional): Encoding to use
+
+        Returns:
+            bytes: Encoded document
+        """
+        return str(self._soup).encode(encoding)
+
+    def decode(self, encoding='utf-8') -> str:
+        """
+        Decode the document from a specific encoding.
+
+        Args:
+            encoding (str, optional): Encoding to use
+
+        Returns:
+            str: Decoded document
+        """
+        return str(self._soup)
+
+    def __str__(self) -> str:
+        """
+        String representation of the parsed document.
+
+        Returns:
+            str: HTML content
+        """
+        return str(self._soup)
+
+    def __repr__(self) -> str:
+        """
+        Detailed representation of the Scout object.
+
+        Returns:
+            str: Scout object description
+        """
+        return f"Scout(features='{self.features}', content_length={len(self.markup)})"
+
+    def _preprocess_markup(self, markup: str, encoding: Optional[str] = None) -> str:
+        """
+        Preprocess markup before parsing.
+
+        Args:
+            markup (str): Input markup
+            encoding (str, optional): Encoding to use
+
+        Returns:
+            str: Preprocessed markup
+        """
+        # Decode markup
+        decoded_markup = decode_markup(markup, encoding)
+
+        # Basic HTML cleaning
+        # Remove comments, normalize whitespace, etc.
+        decoded_markup = re.sub(r'<!--.*?-->', '', decoded_markup, flags=re.DOTALL)
+        decoded_markup = re.sub(r'\s+', ' ', decoded_markup)
+
+        return decoded_markup

webscout/scout/core/search_result.py

@@ -0,0 +1,96 @@
+"""
+Scout Search Result Module
+"""
+
+from typing import List, Union, Callable, Any, Dict, Iterator
+from ..element import Tag
+from .text_analyzer import ScoutTextAnalyzer
+
+
+class ScoutSearchResult:
+    """
+    Represents a search result with advanced querying capabilities.
+    Enhanced with more intelligent filtering and processing.
+    """
+    def __init__(self, results: List[Tag]):
+        """
+        Initialize a search result collection.
+        
+        Args:
+            results (List[Tag]): List of matching tags
+        """
+        self._results = results
+    
+    def __len__(self) -> int:
+        return len(self._results)
+    
+    def __iter__(self) -> Iterator[Tag]:
+        return iter(self._results)
+    
+    def __getitem__(self, index: Union[int, slice]) -> Union[Tag, List[Tag]]:
+        return self._results[index]
+    
+    def texts(self, separator=' ', strip=True) -> List[str]:
+        """
+        Extract texts from all results.
+        
+        Args:
+            separator (str, optional): Text separator
+            strip (bool, optional): Strip whitespace
+        
+        Returns:
+            List[str]: List of extracted texts
+        """
+        return [tag.get_text(separator, strip) for tag in self._results]
+    
+    def attrs(self, attr_name: str) -> List[Any]:
+        """
+        Extract a specific attribute from all results.
+        
+        Args:
+            attr_name (str): Attribute name to extract
+        
+        Returns:
+            List[Any]: List of attribute values
+        """
+        return [tag.get(attr_name) for tag in self._results]
+    
+    def filter(self, predicate: Callable[[Tag], bool]) -> 'ScoutSearchResult':
+        """
+        Filter results using a predicate function.
+        
+        Args:
+            predicate (Callable[[Tag], bool]): Filtering function
+        
+        Returns:
+            ScoutSearchResult: Filtered search results
+        """
+        return ScoutSearchResult([tag for tag in self._results if predicate(tag)])
+    
+    def map(self, transform: Callable[[Tag], Any]) -> List[Any]:
+        """
+        Transform results using a mapping function.
+        
+        Args:
+            transform (Callable[[Tag], Any]): Transformation function
+        
+        Returns:
+            List[Any]: Transformed results
+        """
+        return [transform(tag) for tag in self._results]
+    
+    def analyze_text(self) -> Dict[str, Any]:
+        """
+        Perform text analysis on search results.
+        
+        Returns:
+            Dict[str, Any]: Text analysis results
+        """
+        texts = self.texts(strip=True)
+        full_text = ' '.join(texts)
+        
+        return {
+            'total_results': len(self._results),
+            'word_count': ScoutTextAnalyzer.count_words(full_text),
+            'entities': ScoutTextAnalyzer.extract_entities(full_text)
+        }