ڎjCdZddlZddlmZmZmZddlmZmZddl m Z m Z m Z m Z ddlmZdd lmZmZd d lmZgd Zd ZGddeZGddeZdS)zThe grep tool in agentscope.N)AnyListLiteral)ToolBaseToolMiddlewareBase)PermissionContextPermissionDecisionPermissionBehaviorPermissionRule) ToolChunk) TextBlockToolResultState) BackendBase)z.gitz.svnz.hgz.bzrz.jjz.slc8eZdZdZdedeeffd ZxZS)RipgrepTimeoutErrorz(Custom error class for ripgrep timeouts.messagepartial_resultscXt|||_dSN)super__init__r)selfrr __class__s LC:\Projects\DSCons\.venv\Lib\site-packages\agentscope\tool\_builtin\_grep.pyrzRipgrepTimeoutError.__init__"s) !!!.)__name__ __module__ __qualname____doc__strlistr __classcell__rs@rrrsU22//d3i//////////rrceZdZUdZdZeed< dZeed< dddddd ddgd d d d dddddddddddddddddddddddddddddddddddddddd ddd!d"d#gd$Ze ee fed%<dZ e ed&<dZ e ed'<dZe ed(<dZe ed)<dZe ed*< dJd,eed+zd-ed+zd.d+ffd/ Zd0e ee fd1ed.efd2Zd3ed+zd0e ee fd.e fd4Zd0e ee fd.eefd5Z dKd6eed7ed+zd8ed.eeeed+zffd9Z dLd;eedZ dMd#ed?ed+zd@e d dAed+zdBed+zdCe dDe d1ed+zdEe dFed+zd8edGe dHe d.e!fdIZ"xZ#S)NGrepz8The grep tool for searching file contents using ripgrep.nameaA powerful search tool built on ripgrep Usage: - ALWAYS use Grep for search tasks. NEVER invoke `grep` or `rg` as a Bash command. The Grep tool has been optimized for correct permissions and access. - Supports full regex syntax (e.g., "log.*Error", "function\s+\w+") - Filter files with glob parameter (e.g., "*.js", "**/*.tsx") or type parameter (e.g., "js", "py", "rust") - Output modes: "content" shows matching lines, "files_with_matches" shows only file paths (default), "count" shows match counts per file - Context lines: use context parameter or -A/-B/-C for lines after/before/around matches - Case-insensitive search: set i to true - Multiline regex: set multiline to true for patterns spanning multiple lines - Limit results: use head_limit to cap the number of results returned descriptionobjectstringz>The regular expression pattern to search for in file contents.)typer+zFFile or directory to search in. Defaults to current working directory.)contentfiles_with_matchescountzOutput mode: 'content' shows matching lines (supports -A/-B/-C context, -n line numbers, head_limit), 'files_with_matches' shows file paths (supports head_limit), 'count' shows match counts (supports head_limit). Defaults to 'files_with_matches'.r0)r.enumr+defaultz:Glob pattern to filter files (e.g., '*.js', '*.{ts,tsx}').zKFile type to search (rg --type). Common types: js, py, rust, go, java, etc.integerzJNumber of lines to show after each match. Requires output_mode: 'content'.zKNumber of lines to show before each match. Requires output_mode: 'content'.zAlias for context.zZNumber of context lines to show before and after matches. Requires output_mode: 'content'.booleanzOShow line numbers in output. Requires output_mode: 'content'. Defaults to true.T)r.r+r3zCase insensitive search.Fz&Case insensitive search (alias for i).z[Enable multiline mode where . matches newlines and patterns can span lines. Default: false.z^Limit output to first N lines/entries. Defaults to 250 when unspecified. Pass 0 for unlimited.r)r.r+minimumzESkip first N lines/entries before applying head_limit. Defaults to 0.)r.r+r3r6)patternpath output_modeglobr.-A-B-Ccontextnicase_insensitive multiline head_limitoffsetr7)r. propertiesrequired input_schemais_mcp is_read_onlyis_concurrency_safeis_external_toolis_state_injectedN middlewaresbackendreturnczddlm}t||p ||_dS)aInitialize the grep tool. Args: middlewares (`List[ToolMiddlewareBase] | None`, optional): Tool middlewares wrapping the tool execution. backend (`BackendBase | None`, optional): The sandbox backend to use for shell execution. When ``None``, a :class:`LocalBackend` is created. Ripgrep is always invoked via ``exec_shell`` so that the same code path works for local, Docker, and E2B backends. r) LocalBackend)rMN)_backendrQrr)rrMrNrQrs rrz Grep.__init__sH" +***** [1111<<>> r tool_inputr>c<KttjdS)z"Check permissions for grep search.zGrep search is read-only.)behaviorr)r r PASSTHROUGH)rrSr>s rcheck_permissionszGrep.check_permissionss( "'3/    r rule_contentcK|dS|dd}|s|jd{V}tj||S)aCheck if a permission rule matches the grep search path. Matches rule_content as a glob pattern against the "path" parameter. If no path is given, falls back to the current working directory. If rule_content is None, matches all invocations (tool-name-level rule). Args: rule_content (`str | None`): Glob pattern to match against the search path (e.g., "src/**"), or None to match all invocations tool_input (`dict[str, Any]`): The tool input data containing optional "path" key Returns: `bool`: True if the glob pattern matches the search path, False otherwise NTr8)getrRgetcwdfnmatch)rrXrSr8s r match_rulezGrep.match_rulese2  4~~fb)) 0--////////Dt\222rc K|jd{V}|dp|}|j||}|ddz}t |j|tjdgS)aGenerate suggested permission rules for the grep search path. Suggests a rule based on the search path. If no path is provided, suggests a rule for the current directory. Args: tool_input (`dict[str, Any]`): The tool input data containing optional "path" key Returns: `List[PermissionRule]`: A single suggested rule covering the search directory Nr8)cwdz/\z/** suggested) tool_namerXrUsource) rRr\r[abspathrstripr r*r ALLOW)rrS backend_cwdr8abs_pathr7s rgenerate_suggestionszGrep.generate_suggestionss"!M0022222222 ~~f%%4=((;(??//%((50 )$+1"      ritemslimitrDc|dkr ||ddfS||nt}||||z}t||z |k}||r|ndfS)zuApply head_limit and offset to a list of items. Returns (sliced_items, applied_limit_if_truncated). rN)DEFAULT_HEAD_LIMITlen)rrjrkrDeffective_limitsliced was_truncateds r_apply_head_limitzGrep._apply_head_limitsl A::>4' '#(#4%%:Lv 889E V+o= =BdCCrargs search_pathtimeoutcKdg||}|j|t|d{V}|jdkr|jdkrt d|dg|jdvrH|jd d }td |jd ||j d d }d| dD}|S)a>Run ripgrep and return output lines. Builds an argument vector and dispatches it through ``backend.exec_shell`` (which runs the program directly, without a shell), so the same code path works for local, Docker, and E2B backends and needs no platform-specific argument quoting. rg)rvNs timed outzRipgrep search timed out after z8 seconds. Try searching a more specific path or pattern.)rrzutf-8ignore)errorszripgrep error (code z): cbg|],}|d|d-S) )re).0lines r z%Grep._run_ripgrep..;sE   "&T[[=N=N KK     r ) rR exec_shellfloat exit_codestderrrdecodestrip RuntimeErrorstdoutsplit) rrtrurvcommandresult error_msgrawliness r _run_ripgrepzGrep._run_ripgreps`,$, ,}// 'NN0          r ! !fm|&C&C%A'AAA   6 ) ) ,,-egg Gv'7GGIGG m""78"<<  *-))D//    rr8r9r:r.r@rArBrCr?kwargsc K|p|jd{V}| 1| dkr+ttdgtjdS| dkr+ttdgtjdSdg}t D]}|d d |g|d d g| r|d dg|s|r|d|dkr|dn|dkr|d| r|dkr|d|dkr| d}| d}| d}|%|dt|gns|%|dt|gnL|$|dt|g|$|dt|g| dr|d|gn||||d|g|| }g}|D]R}d|vrd|vr|| |d| dDS|D]}|d |g | ||d{V}n#t$rB}ttt|gtjdcYd}~Sd}~wt$rB}ttt|gtjdcYd}~Sd}~wwxYw|s.ttd |gtjdS||| | \}}d!}|d"|}| r|d#| z }|d$z }ttd%||zgtjdS)&aNExecute the grep search using ripgrep. Args: pattern: The regex pattern to search for path: The directory or file path to search in output_mode: Output mode ('content', 'files_with_matches', 'count') glob: Glob pattern to filter files type: File type to filter by (rg --type) i: Case-insensitive search (rg -i) case_insensitive: Alias for i (backward compatibility) context: Number of context lines around matches multiline: Enable multiline regex matching head_limit: Maximum number of results to return (default 250, 0=unlimited) offset: Skip first N results n: Show line numbers (content mode only, default True) **kwargs: Additional parameters (-A, -B, -C) Nrz'Error: head_limit must be non-negative.)textT)r/stateis_lastz#Error: offset must be non-negative.z--hiddenz--glob!z --max-columns500z-Uz--multiline-dotallz-ir0z-lr1z-cr/z-nr;r<r=-z-ez--type{}c3K|]}||V dSr)r~ps r zGrep.call..s'(H(Hqa(H(H(H(H(H(H(Hr,zNo matches found for pattern: rZz, [Showing results with pagination = limit: z , offset: ]r)rRr\rrrERRORVCS_DIRECTORIES_TO_EXCLUDEextendappendr[r$ startswithrrrrSUCCESSrrjoin)rr7r8r9r:r.r@rAr>rBrCrDr?rrurtvcs_dirABC raw_patterns glob_patternsrgpresultselimited applied_limitsuffixs rcallz Grep.call@sL:DM$8$8$:$:::::::  !j1nn#LMMM&+   A::#HIII&+  &,2 3 3G KK=w==1 2 2 2 2 _e,---  6 KK34 5 5 5     KK    . . . KK     G # # KK      )) KK    ) # # 4  A 4  A 4  A" T3w<<01111 T3q66N++++=KKs1vv///=KKs1vv///   c " " ! KKw ( ( ( ( KK    KK4( ) ) )  ::<8O>O)NN)r)rs) Nr0NNFFNFNrT)$r r!r"r#r*r$__annotations__r+rGdictrrHboolrIrJrKrLrrrrr r rWr^r rir%inttuplerrrrrrr&r's@rr)r)'sBBD#/ IK I I I2! ( ! 0 !BBB 4 0  ! ! ! = " 3 " 3 "3 " " < "9  "G !! " "! " ( " - eY Y tKy]$]$L$sCx.]]]~FDL$ $$$$"d"""#t###8<&*22,-42t#2  222222,  cN  #        3Dj3cN3  3333B  cN   n      L DDCyDTzD D tCy#*$ % DDDD* **3i** * c ****^ !!&"!%#h h h Djh   h Djh Djh  h h th h $Jh !h " #h $%h & 'h h h h h h h h rr))r#r]typingrrr_baserr permissionr r r r _responserrrrrRrrrm Exceptionrr)rrrrsF""%%%%%%%%%%00000000 "!!!!!11111111!!!!!!/////)///A A A A A 8A A A A A r