pseek 3.4.1__tar.gz → 3.5.0__tar.gz

{pseek-3.4.1 → pseek-3.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pseek
-Version: 3.4.1
+Version: 3.5.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -50,6 +50,7 @@ Fast and powerful command-line search tool for finding files, directories, and t
     * [Regular Expression (Regex)](#regular-expression-search)
     * [Fuzzy](#fuzzy-search)
         * [Fuzzy Similarity Threshold](#fuzzy-similarity-threshold)
+    * [Full Path](#full-path)
 * [Expression Queries](#expression-queries)
     * [Operators](#supported-operators)
         * [AND](#and)
@@ -174,6 +175,26 @@ To search for a query that starts with `-`, use `--` to mark the end of options:
 psk -- --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.
+
+All other filters still apply, including `--glob`, `--depth`, `--size`, ignore rules, and other filtering options.
+
+This makes Pseek useful as a flexible alternative to `ls` or `cat`, allowing you to inspect a filtered view of a directory tree and file contents.
+
+```bash
+# List files and directories and file contents
+psk
+
+# List only Python files
+psk --ext py
+
+# List everything up to depth 2
+psk --depth :2
+
+# List everything except the build directory
+psk --exclude build
+```
+
 ## Command Options
 
 | Option | Description |
@@ -189,6 +210,7 @@ psk -- --path
 | `--word` | Match the whole word only (except when `--expr` is enabled, in which case you can make it match whole word by putting `w` before term: `w"foo"`) |
 | `--expr` | Enable boolean query expressions. Example: `r"foo.*bar" and ("bar" or "baz") and not "qux"`. Prefixes: `r=regex`, `c=case-sensitive`, `w=whole-word`, `f=fuzzy` |
 | `--context` | Show N context lines before and after matches, or use N:M to specify before:after |
+| `--full-path` | By default, query is only matched against the filename or directory name (this applies only when searching for files or directories, not file contents). Using this flag, query is matched against the full path (and, if `--absolute-path` flag is enabled, against the absolute path) |
 | `--depth` | Limit directory traversal to given depth range. By default, there is no limit on search depth |
 | `--timeout` | Stop the search after the specified number of seconds |
 | `--fuzzy` | Enable fuzzy search (Highlighting and counting matches are disabled in this mode if `--word` is not enabled to prevent the program from slowing down). except when `--expr` is enabled, in which case you can make it fuzzy by putting `f` before term: `f"foo"` |
@@ -331,6 +353,45 @@ Examples:
 
 Default: `80`
 
+### Full Path
+
+By default, Pseek matches file and directory queries against the entry's name only. Use `--full-path` to match against its full path within the search scope instead. This option affects file and directory searches, not content searches.
+
+For example, given the relative path `pseek/utils.py`, you can match part of the path rather than just the filename:
+
+```bash
+# Match against the full relative path
+psk "seek/utils" --full-path
+```
+
+**Relative paths vs. absolute paths**
+
+`--full-path` does not automatically include the absolute path. If the file's absolute path is:
+
+```text
+/home/python/cli/pseek/utils.py
+```
+
+a query such as `python/cli` will not match unless `--absolute-path` is also enabled:
+
+```bash
+psk "python/cli" --full-path --absolute-path
+```
+
+**Nested archives**
+
+When searching nested archives, `--full-path` applies only to the path within the current archive level, not the entire nested archive chain.
+
+For example:
+
+```text
+archive.zip::folder/arc.zip::fd/file.txt
+```
+
+With `--full-path`, you can match `fd/f` against the entry `fd/file.txt` inside the innermost archive. A query such as `zip::fd` does not match across archive boundaries. Without `--full-path`, matching is limited to the entry name, `file.txt`.
+
+> **Note:** For ordinary queries without `--regex`, backslashes are treated literally, so Windows paths can be searched without additional escaping. When using `--expr`, quoted terms use JSON-style escaping; escape backslashes accordingly. For example, `"\\"` represents a single literal backslash, while `"\\n"` represents the literal sequence `\n`.
+
 ## Expression Queries
 
 Expression mode enables logical search expressions.
@@ -564,6 +625,8 @@ psk TODO \
 
 Only search inside those paths.
 
+> **Note:** Paths manually included by the user take precedence over other filters; this means that even if a path conflicts with rules related to [--glob](#globs), [--exclude](#exclude-paths), etc., it will still be included in the results.
+
 #### Exclude Paths
 
 ```bash

{pseek-3.4.1 → pseek-3.5.0}/README.md

@@ -22,6 +22,7 @@ Fast and powerful command-line search tool for finding files, directories, and t
     * [Regular Expression (Regex)](#regular-expression-search)
     * [Fuzzy](#fuzzy-search)
         * [Fuzzy Similarity Threshold](#fuzzy-similarity-threshold)
+    * [Full Path](#full-path)
 * [Expression Queries](#expression-queries)
     * [Operators](#supported-operators)
         * [AND](#and)
@@ -146,6 +147,26 @@ To search for a query that starts with `-`, use `--` to mark the end of options:
 psk -- --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.
+
+All other filters still apply, including `--glob`, `--depth`, `--size`, ignore rules, and other filtering options.
+
+This makes Pseek useful as a flexible alternative to `ls` or `cat`, allowing you to inspect a filtered view of a directory tree and file contents.
+
+```bash
+# List files and directories and file contents
+psk
+
+# List only Python files
+psk --ext py
+
+# List everything up to depth 2
+psk --depth :2
+
+# List everything except the build directory
+psk --exclude build
+```
+
 ## Command Options
 
 | Option | Description |
@@ -161,6 +182,7 @@ psk -- --path
 | `--word` | Match the whole word only (except when `--expr` is enabled, in which case you can make it match whole word by putting `w` before term: `w"foo"`) |
 | `--expr` | Enable boolean query expressions. Example: `r"foo.*bar" and ("bar" or "baz") and not "qux"`. Prefixes: `r=regex`, `c=case-sensitive`, `w=whole-word`, `f=fuzzy` |
 | `--context` | Show N context lines before and after matches, or use N:M to specify before:after |
+| `--full-path` | By default, query is only matched against the filename or directory name (this applies only when searching for files or directories, not file contents). Using this flag, query is matched against the full path (and, if `--absolute-path` flag is enabled, against the absolute path) |
 | `--depth` | Limit directory traversal to given depth range. By default, there is no limit on search depth |
 | `--timeout` | Stop the search after the specified number of seconds |
 | `--fuzzy` | Enable fuzzy search (Highlighting and counting matches are disabled in this mode if `--word` is not enabled to prevent the program from slowing down). except when `--expr` is enabled, in which case you can make it fuzzy by putting `f` before term: `f"foo"` |
@@ -303,6 +325,45 @@ Examples:
 
 Default: `80`
 
+### Full Path
+
+By default, Pseek matches file and directory queries against the entry's name only. Use `--full-path` to match against its full path within the search scope instead. This option affects file and directory searches, not content searches.
+
+For example, given the relative path `pseek/utils.py`, you can match part of the path rather than just the filename:
+
+```bash
+# Match against the full relative path
+psk "seek/utils" --full-path
+```
+
+**Relative paths vs. absolute paths**
+
+`--full-path` does not automatically include the absolute path. If the file's absolute path is:
+
+```text
+/home/python/cli/pseek/utils.py
+```
+
+a query such as `python/cli` will not match unless `--absolute-path` is also enabled:
+
+```bash
+psk "python/cli" --full-path --absolute-path
+```
+
+**Nested archives**
+
+When searching nested archives, `--full-path` applies only to the path within the current archive level, not the entire nested archive chain.
+
+For example:
+
+```text
+archive.zip::folder/arc.zip::fd/file.txt
+```
+
+With `--full-path`, you can match `fd/f` against the entry `fd/file.txt` inside the innermost archive. A query such as `zip::fd` does not match across archive boundaries. Without `--full-path`, matching is limited to the entry name, `file.txt`.
+
+> **Note:** For ordinary queries without `--regex`, backslashes are treated literally, so Windows paths can be searched without additional escaping. When using `--expr`, quoted terms use JSON-style escaping; escape backslashes accordingly. For example, `"\\"` represents a single literal backslash, while `"\\n"` represents the literal sequence `\n`.
+
 ## Expression Queries
 
 Expression mode enables logical search expressions.
@@ -536,6 +597,8 @@ psk TODO \
 
 Only search inside those paths.
 
+> **Note:** Paths manually included by the user take precedence over other filters; this means that even if a path conflicts with rules related to [--glob](#globs), [--exclude](#exclude-paths), etc., it will still be included in the results.
+
 #### Exclude Paths
 
 ```bash

{pseek-3.4.1 → pseek-3.5.0}/pseek/cli.py

@@ -306,7 +306,7 @@ def check_rar_backend(archive_enabled: bool, tool_path: str, backend: str):
 
 
 @click.command()
-@click.argument('query')
+@click.argument('query', required=False)
 @click.argument('path', type=click.Path(exists=True, file_okay=False, dir_okay=True),
                 default='.', required=False)
 # Search type options
@@ -336,12 +336,14 @@ def check_rar_backend(archive_enabled: bool, tool_path: str, backend: str):
               help='Fuzzy matching threshold (1-99). Higher values require closer matches.')
 @click.option('-C', '--context', metavar='BEFORE:AFTER',
               help='Show N context lines before and after matches, or use N:M to specify before:after.')
-@click.option('--depth', multiple=True, metavar='MIN:MAX',
+@click.option('-p', '--full-path', is_flag=True,
+              help='By default, query is only matched against the filename or directory name '
+              '(this applies only when searching for files or directories, not file contents). '
+              'Using this flag, query is matched against the full path '
+              '(and, if --absolute-path flag is enabled, against the absolute path).')
+@click.option('-D', '--depth', multiple=True, metavar='MIN:MAX',
               help='Limit directory traversal to given depth range. '
               'By default, there is no limit on search depth.')
-@click.option('--timeout', metavar='FLOAT',
-              type=click.FloatRange(min=0, min_open=True),
-              help='Stop the search after the specified number of seconds.')
 # Automatic filtering
 @click.option('-u', '--unrestricted', is_flag=True,
               help='Disable all automatic filters except the binary file filter for content search.')
@@ -419,6 +421,9 @@ def check_rar_backend(archive_enabled: bool, tool_path: str, backend: str):
 @click.option('-l', '--paths-only', is_flag=True, help='Only show matching file paths for content search.')
 @click.option('-S', '--stats', is_flag=True,
               help='Show search statistics including result counts and search time.')
+@click.option('--timeout', metavar='FLOAT',
+              type=click.FloatRange(min=0, min_open=True),
+              help='Stop the search after the specified number of seconds.')
 def search(**kwargs):
     """Search for files, directories, and file content based on the query."""
 

{pseek-3.4.1 → pseek-3.5.0}/pseek/parser.py

@@ -206,6 +206,9 @@ def parse_query_expression(config) -> ExprNode:
     If expr is False, treat the whole query as a single term.
     """
 
+    if config.query is None:
+        return None
+
     if not config.expr:
         return TermNode(
             config.query,
@@ -371,6 +374,9 @@ def evaluate_with_matches(
 def find_matches(expr: ExprNode, text: str, num: int = 0) -> list[tuple[int, int]]:
     """Find spans that contribute to a successful expression"""
 
+    if expr is None:
+        return []
+
     matched, matches = evaluate_with_matches(expr, text, num)
     # Remove duplicate ranges
     return list(dict.fromkeys(matches)) if matched else []

{pseek-3.4.1 → pseek-3.5.0}/pseek/searcher.py

@@ -60,14 +60,15 @@ 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.evaluate(p.name):
+    if match_type and (pattern is None or pattern.evaluate(p_name)):
         # Find matched query in the name
         name_matches = find_matches(
             pattern,
-            p.name,
+            p_name,
             # Calculate number of chars that come before name of file or dir
-            len(path_str) - len(p.name)
+            len(path_str) - len(p_name)
         )
 
         add_result(
@@ -83,8 +84,10 @@ def search_file_and_dir(config, matches: dict, pattern, p: Path,
     # Search for files and directories name inside archive files if archive is active
     if config.archive and p_ext in ARCHIVE_EXTS[:-3]:
         for virtual_path, name, is_dir in extract_names_from_archive(p, config):
+            name_str = str(name)
+
             if config.stats:
-                full_virtual_path = (path_str, *virtual_path, str(name))
+                full_virtual_path = (path_str, *virtual_path, name_str)
                 
                 if not is_dir and config.file:
                     add_metric(metrics, result_queue, 'files_scanned', full_virtual_path)
@@ -101,13 +104,14 @@ 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.evaluate(name.name):
+            if arc_match_type and (pattern is None or pattern.evaluate(virtual_name)):
                 name_matches = find_matches(
                     pattern,
-                    name.name,
+                    virtual_name,
                     # Calculate number of chars that come before name of file or dir
-                    len(str(name)) - len(name.name)
+                    len(name_str) - len(virtual_name)
                 )
 
                 add_result(
@@ -117,7 +121,7 @@ def search_file_and_dir(config, matches: dict, pattern, p: Path,
                     FileDirResult(
                         path=path_str,
                         matches=name_matches,
-                        virtual_path=[*virtual_path, str(name)]
+                        virtual_path=[*virtual_path, name_str]
                     )
                 )
 
@@ -231,7 +235,7 @@ def search_content(config, matches: dict, pattern, binary_pattern,
 
             collector = ContextCollector(config.context)
             for num, line in enumerate(decoded_content.splitlines(), 1):
-                matched = pattern.evaluate(line)
+                matched = pattern is None or pattern.evaluate(line)
 
                 if config.paths_only and matched:
                     add_result(
@@ -285,7 +289,7 @@ def search_content(config, matches: dict, pattern, binary_pattern,
                 # Skip lines that can't be decoded
                 continue
 
-            matched = pattern.evaluate(line_decoded)
+            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:

{pseek-3.4.1 → pseek-3.5.0}/pseek/structs.py

@@ -162,6 +162,7 @@ class SearchConfig:
     arc_size: list[tuple]
     rar_backend: str | None
     absolute_path: bool
+    full_path: bool
     paths_only: bool
     stats: bool
     context: tuple[int, int]

{pseek-3.4.1 → pseek-3.5.0}/pyproject.toml

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