pseek 3.6.0__tar.gz → 3.6.2__tar.gz

{pseek-3.6.0 → pseek-3.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pseek
-Version: 3.6.0
+Version: 3.6.2
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -62,6 +62,7 @@ Fast and powerful command-line search tool for finding files, directories, and t
         * [Case Sensitive](#case-sensitive)
         * [Whole Word](#whole-word)
         * [Fuzzy](#fuzzy)
+        * [Full Path](#full-path-1)
         * [Combined Prefixes](#combined-prefixes)
 * [Automatic Filtering](#automatic-filtering)
 * [Manual Filtering](#manual-filtering)
@@ -100,17 +101,19 @@ Fast and powerful command-line search tool for finding files, directories, and t
 * Search file names
 * Search directory names
 * Search file contents
-* Search inside archive files
 * Boolean query expressions (`and`, `or`, `not`)
 * Regular expressions
 * Fuzzy matching
 * Whole-word matching
 * Case-sensitive search
+* Search inside archive files
 * Archive recursion depth control
 * Extension filters
 * Path filters
 * Size filtering
-* Full path output
+* Depth filtering
+* Automatic filtering (Supports git rules)
+* Parallel search
 * Highlight matches in output
 * Cross-platform (Linux, macOS, Windows)
 
@@ -173,7 +176,7 @@ simultaneously.
 To search for a query that starts with `-`, use `--` to mark the end of options:
 
 ```bash
-psk -- --path
+psk -- --path  # The query is "--path"
 ```
 
 Of course the search query is optional. When no query is provided, Pseek displays the files and directories and file contents within the selected scope.
@@ -289,7 +292,7 @@ Example:
 psk "hello world"
 ```
 
-> **Note:** To use case-sensitive, whole-word matching, regular expression search, and fuzzy search when `--expr` is enabled, we can use [expression prefixes](#expression-prefixes).
+> **Note:** To use case-sensitive, whole-word matching, regular expression search, fuzzy search, and full path search when `--expr` is enabled, we can use [expression prefixes](#expression-prefixes).
 
 ### Case Sensitive Search
 
@@ -316,11 +319,13 @@ Does not match: `cats`, `concatenate`
 Enable regex mode:
 
 ```bash
-psk error\d+ --regex
+psk "error\d+" --regex
 ```
 
 Example matches: `error1`, `error25`, `error999`
 
+> **Note:** Regex matching and whole word matching cannot be used at the same time, because we can use `\b` in regex to enable whole word matching: `psk "\berror\d+\b" --regex`
+
 ### Fuzzy Search
 
 Fuzzy search allows approximate matching.
@@ -444,6 +449,8 @@ Used for grouping expressions.
 
 Each term can have its own search mode.
 
+> **Note:** For more detailed information about the modes, please refer to the [query modes](#query-modes) section.
+
 #### Regex
 
 ```text
@@ -492,6 +499,18 @@ Example:
 psk 'f"apple"' --expr
 ```
 
+#### Full Path
+
+```text
+p"text"
+```
+
+Example:
+
+```bash
+psk 'p"lib"' --expr
+```
+
 #### Combined Prefixes
 
 Prefixes can be combined.
@@ -502,6 +521,7 @@ Examples:
 rc"text"
 cw"text"
 cf"text"
+pc"text"
 wcf"text"
 ```
 
@@ -518,7 +538,9 @@ Meaning:
 
 simultaneously.
 
-Allowed modes: `r`, `c`, `w`, `f`, `rc`, `cr`, `cw`, `wc`, `cf`, `fc`, `wf`, `fw`, `cwf`, `cfw`, `wcf`, `wfc`, `fcw`, `fwc`
+Allowed modes: `r`, `c`, `w`, `f`, `p`, `rp`, `pc`, `wp`, `fp`, `rc`, `cw`, `cf`, `wf`, `cwf`, `rcp`, `cwp`, `cfp`, `wfp`, `cwfp`
+
+and their permutations.
 
 > **Note:** Whole word matching and regex matching cannot be used at the same time, because we can use `\b` in regex to enable whole word matching: `r"\btext\b"`
 

{pseek-3.6.0 → pseek-3.6.2}/README.md

@@ -34,6 +34,7 @@ Fast and powerful command-line search tool for finding files, directories, and t
         * [Case Sensitive](#case-sensitive)
         * [Whole Word](#whole-word)
         * [Fuzzy](#fuzzy)
+        * [Full Path](#full-path-1)
         * [Combined Prefixes](#combined-prefixes)
 * [Automatic Filtering](#automatic-filtering)
 * [Manual Filtering](#manual-filtering)
@@ -72,17 +73,19 @@ Fast and powerful command-line search tool for finding files, directories, and t
 * Search file names
 * Search directory names
 * Search file contents
-* Search inside archive files
 * Boolean query expressions (`and`, `or`, `not`)
 * Regular expressions
 * Fuzzy matching
 * Whole-word matching
 * Case-sensitive search
+* Search inside archive files
 * Archive recursion depth control
 * Extension filters
 * Path filters
 * Size filtering
-* Full path output
+* Depth filtering
+* Automatic filtering (Supports git rules)
+* Parallel search
 * Highlight matches in output
 * Cross-platform (Linux, macOS, Windows)
 
@@ -145,7 +148,7 @@ simultaneously.
 To search for a query that starts with `-`, use `--` to mark the end of options:
 
 ```bash
-psk -- --path
+psk -- --path  # The query is "--path"
 ```
 
 Of course the search query is optional. When no query is provided, Pseek displays the files and directories and file contents within the selected scope.
@@ -261,7 +264,7 @@ Example:
 psk "hello world"
 ```
 
-> **Note:** To use case-sensitive, whole-word matching, regular expression search, and fuzzy search when `--expr` is enabled, we can use [expression prefixes](#expression-prefixes).
+> **Note:** To use case-sensitive, whole-word matching, regular expression search, fuzzy search, and full path search when `--expr` is enabled, we can use [expression prefixes](#expression-prefixes).
 
 ### Case Sensitive Search
 
@@ -288,11 +291,13 @@ Does not match: `cats`, `concatenate`
 Enable regex mode:
 
 ```bash
-psk error\d+ --regex
+psk "error\d+" --regex
 ```
 
 Example matches: `error1`, `error25`, `error999`
 
+> **Note:** Regex matching and whole word matching cannot be used at the same time, because we can use `\b` in regex to enable whole word matching: `psk "\berror\d+\b" --regex`
+
 ### Fuzzy Search
 
 Fuzzy search allows approximate matching.
@@ -416,6 +421,8 @@ Used for grouping expressions.
 
 Each term can have its own search mode.
 
+> **Note:** For more detailed information about the modes, please refer to the [query modes](#query-modes) section.
+
 #### Regex
 
 ```text
@@ -464,6 +471,18 @@ Example:
 psk 'f"apple"' --expr
 ```
 
+#### Full Path
+
+```text
+p"text"
+```
+
+Example:
+
+```bash
+psk 'p"lib"' --expr
+```
+
 #### Combined Prefixes
 
 Prefixes can be combined.
@@ -474,6 +493,7 @@ Examples:
 rc"text"
 cw"text"
 cf"text"
+pc"text"
 wcf"text"
 ```
 
@@ -490,7 +510,9 @@ Meaning:
 
 simultaneously.
 
-Allowed modes: `r`, `c`, `w`, `f`, `rc`, `cr`, `cw`, `wc`, `cf`, `fc`, `wf`, `fw`, `cwf`, `cfw`, `wcf`, `wfc`, `fcw`, `fwc`
+Allowed modes: `r`, `c`, `w`, `f`, `p`, `rp`, `pc`, `wp`, `fp`, `rc`, `cw`, `cf`, `wf`, `cwf`, `rcp`, `cwp`, `cfp`, `wfp`, `cwfp`
+
+and their permutations.
 
 > **Note:** Whole word matching and regex matching cannot be used at the same time, because we can use `\b` in regex to enable whole word matching: `r"\btext\b"`
 

{pseek-3.6.0 → pseek-3.6.2}/pseek/archive.py

@@ -30,22 +30,16 @@ def get_archive_path_size(info, file_type: str) -> int:
 def archive_should_skip(path_info: Path, config, p_size: float, file_ext, is_dir=False):
     """Check whether the file/directory inside archive files should be skipped based on various filters"""
 
-    if (config.arc_include and not any(path_info.is_relative_to(inc) for inc in config.arc_include)) \
+    path_info_str = str(path_info)
+    return (config.arc_include and not any(path_info.is_relative_to(inc) for inc in config.arc_include)) \
             or (config.arc_exclude and any(path_info.is_relative_to(exc) for exc in config.arc_exclude)) \
             or (config.arc_ext and file_ext not in config.arc_ext) \
             or (config.arc_exc_ext and file_ext in config.arc_exc_ext) \
             or (config.arc_size and (is_dir or not any(
                 minimum <= p_size <= maximum
                 for minimum, maximum in config.arc_size
-            ))):
-        return True
-
-    if config.re_include:
-        return not config.re_include.search(str(path_info))
-    if config.re_exclude:
-        return config.re_exclude.search(str(path_info)) is not None
-
-    return False
+            ))) or (config.re_include and not config.re_include.search(path_info_str)) \
+        or (config.re_exclude and config.re_exclude.search(path_info_str) is not None)
 
 
 def extract_names_from_archive(file_path: Path, config, depth: int = -1,
@@ -78,8 +72,8 @@ def extract_names_from_archive(file_path: Path, config, depth: int = -1,
             with opener(file_stream) as f:
                 for info in f.infolist():
                     name = Path(info.filename)
-                    new_path_ext = get_path_suffix(name)
                     is_dir = info.is_dir()
+                    new_path_ext = get_path_suffix(name, is_dir)
 
                     if not archive_should_skip(
                             name,
@@ -105,8 +99,8 @@ def extract_names_from_archive(file_path: Path, config, depth: int = -1,
             with py7zr.SevenZipFile(file_stream, mode='r') as z:
                 for info in z.list():
                     name = Path(info.filename)
-                    new_path_ext = get_path_suffix(name)
                     is_dir = info.is_directory
+                    new_path_ext = get_path_suffix(name, is_dir)
 
                     if not archive_should_skip(
                             name,
@@ -143,8 +137,8 @@ def extract_names_from_archive(file_path: Path, config, depth: int = -1,
             with tarfile.open(fileobj=file_stream, mode=mode) as tf:
                 for member in tf.getmembers():
                     name = Path(member.name)
-                    new_path_ext = get_path_suffix(name)
                     is_dir = member.isdir()
+                    new_path_ext = get_path_suffix(name, is_dir)
 
                     if not archive_should_skip(
                             name,
@@ -203,10 +197,10 @@ def extract_text_from_archive(file_path: Path, config, depth: int = -1,
                 for info in f.infolist():
                     if info.is_dir():
                         continue
-                    
+
                     file_name = Path(info.filename)
                     new_path_ext = get_path_suffix(file_name)
-                    
+
                     if archive_should_skip(
                         file_name,
                         config,
@@ -243,7 +237,7 @@ def extract_text_from_archive(file_path: Path, config, depth: int = -1,
 
                     file_name = Path(info.filename)
                     new_path_ext = get_path_suffix(file_name)
-                    
+
                     if archive_should_skip(
                         file_name,
                         config,
@@ -282,7 +276,7 @@ def extract_text_from_archive(file_path: Path, config, depth: int = -1,
 
                     file_name = Path(member.name)
                     new_path_ext = get_path_suffix(file_name)
-                    
+
                     if archive_should_skip(
                         file_name,
                         config,

{pseek-3.6.0 → pseek-3.6.2}/pseek/parser.py

@@ -1,5 +1,7 @@
 import json
 import re
+from itertools import permutations
+from pathlib import Path
 
 import click
 from lark import Lark, Transformer
@@ -16,7 +18,16 @@ class ExprNode:
 
 class TermNode(ExprNode):
     """Node representing a single search term"""
-    def __init__(self, term: str, regex, whole_word, case_sensitive, fuzzy, fuzzy_level):
+    def __init__(
+        self,
+        term: str,
+        regex: bool,
+        whole_word: bool,
+        case_sensitive: bool,
+        fuzzy: bool,
+        fuzzy_level: int | None,
+        full_path: bool
+    ):
         self.raw_term = term
         self.term_lower = term.lower()
         self.regex = regex
@@ -24,6 +35,7 @@ class TermNode(ExprNode):
         self.case_sensitive = case_sensitive
         self.fuzzy = fuzzy
         self.fuzzy_level = fuzzy_level
+        self.full_path = full_path
 
         if not fuzzy:
             flags = 0 if case_sensitive else re.IGNORECASE  # Adjust case sensitivity
@@ -37,7 +49,10 @@ class TermNode(ExprNode):
 
             self.pattern = compile_regex(term, flags)  # Precompile the regex pattern for performance
 
-    def evaluate(self, text: str) -> bool:
+    def evaluate(self, text: str | Path) -> bool:
+        if isinstance(text, Path):
+            text = text.name if not self.full_path else str(text)
+
         # Fuzzy search mode
         text_cmp = text if self.case_sensitive else text.lower()
         term = self.raw_term if self.case_sensitive else self.term_lower
@@ -114,8 +129,25 @@ class OrNode(ExprNode):
         return self.left.evaluate(text) or self.right.evaluate(text)
 
 
+def gvp() -> str:
+    """Generate all possible states and permutations of input prefixes
+
+    Returns:
+        str: prefixes=("f", "r", "rf") -> result="f|r|rf|fr"
+    """
+
+    prefixes = {'r','c','w','f','p','rp','pc','wp','fp','rc','cw',
+                'cf','wf','cwf','rcp','cwp','cfp','wfp','cwfp'}
+    valid_prefixes = set()
+
+    for p in prefixes:
+        valid_prefixes |= {''.join(pr) for pr in permutations(p)}
+
+    return '|'.join(valid_prefixes)
+
+
 # Lark grammar for parsing logical expressions
-query_grammar = r"""
+query_grammar = rf"""
 ?start: expr
 
 ?expr: or_expr
@@ -133,7 +165,7 @@ query_grammar = r"""
      | ESCAPED_STRING           -> string
      | "(" expr ")"
 
-PREFIXED_STRING: /(r|c|w|f|rc|cr|cw|wc|cf|fc|wf|fw|cwf|cfw|wcf|wfc|fcw|fwc)"([^"\\]|\\.)*"/
+PREFIXED_STRING: /({gvp()})"([^"\\]|\\.)*"/
 
 %import common.ESCAPED_STRING
 %import common.WS
@@ -171,7 +203,8 @@ class TreeToExpr(Transformer):
             False,
             False,
             False,
-            None
+            None,
+            False
         )
 
     def prefixed_string(self, s):
@@ -179,7 +212,7 @@ class TreeToExpr(Transformer):
         text = str(s[0])  # e.g., 'rc"pattern"'
 
         quote_index = text.index('"')
-        prefix = text[:quote_index].lower()
+        prefix = text[:quote_index]
         quoted = text[quote_index:]
 
         is_regex = 'r' in prefix
@@ -191,7 +224,8 @@ class TreeToExpr(Transformer):
             whole_word='w' in prefix,
             case_sensitive='c' in prefix,
             fuzzy='f' in prefix,
-            fuzzy_level=self.fuzzy_level
+            fuzzy_level=self.fuzzy_level,
+            full_path='p' in prefix
         )
 
     def and_expr(self, args):
@@ -220,7 +254,8 @@ def parse_query_expression(config) -> ExprNode:
             config.word,
             config.case_sensitive,
             config.fuzzy,
-            config.fuzzy_level
+            config.fuzzy_level,
+            config.full_path
         )
 
     # Otherwise, parse using Lark
@@ -232,8 +267,12 @@ def parse_query_expression(config) -> ExprNode:
         raise click.exceptions.Exit(1)
 
 
-def find_term_matches(node: TermNode, text: str, num: int) -> list[tuple[int, int]]:
+def find_term_matches(node: TermNode, text: str | Path, num: int) -> list[tuple[int, int]]:
     """Find matching spans for a single term"""
+    if isinstance(text, Path):
+        text = text.name if not node.full_path else str(text)
+        # Calculate number of chars that come before name of file or dir
+        num -= len(text)
 
     if node.fuzzy:
         # Fuzzy partial matching currently has no span extraction
@@ -270,7 +309,7 @@ def find_term_matches(node: TermNode, text: str, num: int) -> list[tuple[int, in
 
 def evaluate_with_matches(
     node: ExprNode,
-    text: str,
+    text: str | Path,
     num: int,
     positive: bool = True
 ) -> tuple[bool, list[tuple[int, int]]]:
@@ -370,12 +409,10 @@ def evaluate_with_matches(
 
         return True, matches
 
-    raise TypeError(
-        f'Unsupported expression node: {type(node).__name__}'
-    )
+    raise TypeError(f'Unsupported expression node: {type(node).__name__}')
 
 
-def find_matches(expr: ExprNode, text: str, num: int = 0) -> list[tuple[int, int]]:
+def find_matches(expr: ExprNode, text: str | Path, num: int = 0) -> list[tuple[int, int]]:
     """Find spans that contribute to a successful expression"""
 
     if expr is None:

{pseek-3.6.0 → pseek-3.6.2}/pseek/searcher.py

@@ -68,15 +68,13 @@ def search_file_and_dir(config, matches: dict, pattern, p: Path,
         'directory' if config.directory and p.is_dir() else
         None
     )
-    p_name = p.name if not config.full_path else path_str
 
-    if match_type and (pattern is None or pattern.evaluate(p_name)):
+    if match_type and (pattern is None or pattern.evaluate(p)):
         # Find matched query in the name
         name_matches = find_matches(
             pattern,
-            p_name,
-            # Calculate number of chars that come before name of file or dir
-            len(path_str) - len(p_name)
+            p,
+            len(path_str)
         )
 
         add_result(
@@ -131,14 +129,12 @@ def search_file_and_dir(config, matches: dict, pattern, p: Path,
                 'directory' if config.directory and is_dir else
                 None
             )
-            virtual_name = name.name if not config.full_path else name_str
-            
-            if arc_match_type and (pattern is None or pattern.evaluate(virtual_name)):
+
+            if arc_match_type and (pattern is None or pattern.evaluate(name)):
                 name_matches = find_matches(
                     pattern,
-                    virtual_name,
-                    # Calculate number of chars that come before name of file or dir
-                    len(name_str) - len(virtual_name)
+                    name,
+                    len(name_str)
                 )
 
                 add_result(
@@ -310,41 +306,50 @@ def search_content(config, matches: dict, pattern, binary_pattern,
         return
 
     collector = ContextCollector(config.context)
-    # Memory-map the file for efficient access
-    with open(p, 'rb') as f, mmap.mmap(f.fileno(), 0, access=mmap.ACCESS_READ) as mm:
-        head = mm[:8192]
-        if is_binary(head) or (binary_pattern and not content_contains(mm, binary_pattern)):
-            return
+    try:
+        # Memory-map the file for efficient access
+        with open(p, 'rb') as f, mmap.mmap(f.fileno(), 0, access=mmap.ACCESS_READ) as mm:
+            head = mm[:8192]
+            if is_binary(head) or (binary_pattern and not content_contains(mm, binary_pattern)):
+                return
 
-        mm.seek(0)  # Move the cursor to the beginning of the file
+            mm.seek(0)  # Move the cursor to the beginning of the file
 
-        # Iterate over each line in the file
-        for num, line in enumerate(iter(mm.readline, b''), 1):
-            try:
-                line_decoded = line.decode('utf-8').rstrip('\r\n')
-            except UnicodeDecodeError:
-                # Skip lines that can't be decoded
-                continue
+            # Iterate over each line in the file
+            for num, line in enumerate(iter(mm.readline, b''), 1):
+                if binary_pattern and not content_contains(line, binary_pattern):
+                    continue
 
-            matched = pattern is None or pattern.evaluate(line_decoded)
+                try:
+                    line_decoded = line.decode('utf-8').rstrip('\r\n')
+                except UnicodeDecodeError:
+                    # Skip lines that can't be decoded
+                    continue
 
-            # Avoid searching through the entire file content if the paths-only flag is True
-            if config.paths_only and matched:
-                add_result(
-                    matches,
-                    result_queue,
-                    'content',
-                    ContentResult(path=path_str),
-                    result_lock
-                )
-                return
+                matched = pattern is None or pattern.evaluate(line_decoded)
+
+                # Avoid searching through the entire file content if the paths-only flag is True
+                if config.paths_only and matched:
+                    add_result(
+                        matches,
+                        result_queue,
+                        'content',
+                        ContentResult(path=path_str),
+                        result_lock
+                    )
+                    return
+
+                if not any(config.context) and not matched:
+                    continue
 
-            line_instance = Line(num, line_decoded)
+                line_instance = Line(num, line_decoded)
 
-            if matched:
-                line_instance.matches = find_matches(pattern, line_decoded)
+                if matched:
+                    line_instance.matches = find_matches(pattern, line_decoded)
 
-            collector.process(line_instance, matched)
+                collector.process(line_instance, matched)
+    except OSError:
+        return
 
     groups = collector.finish()
     if groups:
@@ -452,7 +457,7 @@ def walk_logic(path: Path, config, depth: int, matcher, ancestors: set):
         ancestors.remove(dir_key)
 
 
-# TODO: Make traversal parallelize just like seek func
+# TODO: Make traversal parallel just like seek func
 def walk(config):
     """Include paths define traversal roots, avoiding unnecessary traversal 
     of unrelated parts of the tree"""

{pseek-3.6.0 → pseek-3.6.2}/pseek/utils.py

@@ -24,13 +24,19 @@ def compile_regex(txt, flags=0) -> re.Pattern | None:
             raise click.exceptions.Exit(1)
 
 
-def get_path_suffix(path: Path | str) -> str:
+def get_path_suffix(path: Path | str, is_dir: bool | None = None) -> str:
     """ If multiple file suffixes are valid, return them, otherwise return only the last suffix """
     if isinstance(path, str):
         path = Path(path)
 
-    if path.is_dir():
-        return None
+    # The paths within archive aren't physical paths,
+    # so we need to determine is_dir from their metadata.
+    if is_dir is not None:
+        if is_dir:
+            return None
+    else:
+        if path.is_dir():
+            return None
 
     suffixes = ''.join(path.suffixes)[1:].lower()
 

{pseek-3.6.0 → pseek-3.6.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "maturin"
 
 [project]
 name = "pseek"
-version = "3.6.0"
+version = "3.6.2"
 description = "Pseek is a Python CLI toolkit to search files, folders, and text"
 readme = "README.md"
 license = "MIT"