ڎj*dZddlZddlmZmZddlmZmZddlm Z m Z m Z m Z ddl mZdd lmZmZdd lmZd d lmZmZGd deZdS)zThe read tool in agentscope.N)AnyList)ToolBaseToolMiddlewareBase)PermissionContextPermissionDecisionPermissionBehaviorPermissionRule) ToolChunk) TextBlockToolResultState) AgentState) BackendBase_normalize_newlinesc eZdZUdZdZeed< dZeed< ddddd d d d d d d ddd dddgdZe ee fed<dZ e ed<dZ e ed<dZe ed<dZe ed<dZe ed< d+dedeedzdedzddffd Zd!e ee fd"edefd#Zd$edzd!e ee fde fd%Zd!e ee fdeefd&Z d,ded'ed(ed)edzdef d*ZxZS)-ReadzThe read tool.nameaReads a file from the local filesystem. You can access any file directly by using this tool. Assume this tool is able to read all files on the machine. If the User provides a path to a file assume that path is valid. It is okay to read a file that does not exist; an error will be returned. Usage: - The file_path parameter must be an absolute path, not a relative path - By default, it reads up to 2000 lines starting from the beginning of the file - You can optionally specify a line offset and limit (especially handy for long files), but it's recommended to read the whole file by not providing these parameters - Results are returned using cat -n format, with line numbers starting at 1 - This tool allows you to read images (eg PNG, JPG, etc). When reading an image file the contents are presented visually as you're a multimodal LLM. - This tool can read PDF files (.pdf). For large PDFs (more than 10 pages), you MUST provide the pages parameter to read specific pages. descriptionobjectstringz&The absolute path to the file to read.)typerintegerz?Optional 1-based line number to start reading from (default: 1)r)rrdefaultminimumzCOptional maximum number of lines to read (default: 2000, max: 2000))rrrmaximumr) file_pathoffsetlimitr )r propertiesrequired input_schemaFis_mcpT is_read_onlyis_concurrency_safeis_external_toolis_state_injectedNmax_line_characters middlewaresbackendreturncddlm}t|||_|p ||_dS)aInitialize the read tool. Args: max_line_characters (`int`, defaults to 2000): The maximum number of characters to include for each line when reading files. Lines longer than this will be truncated with a "[truncated]" suffix. This prevents overwhelming the agent with excessively long lines while still providing useful content. middlewares (`List[ToolMiddlewareBase] | None`, optional): Tool middlewares wrapping the tool execution. backend (`BackendBase | None`, optional): The sandbox backend to use for file I/O. When ``None``, a :class:`LocalBackend` is created. r) LocalBackend)r,N)_backendr0super__init___max_line_characters)selfr+r,r-r0 __class__s LC:\Projects\DSCons\.venv\Lib\site-packages\agentscope\tool\_builtin\_read.pyr3z Read.__init__FsP* +***** [111$7!1<<>> tool_inputcontextc<KttjdS)zCheck permissions for file reading. Read is a read-only tool. In EXPLORE mode the engine already handles the ALLOW via _check_explore_mode, so here we just return PASSTHROUGH to let the engine continue with rule matching. zFile reading is read-only.)behaviormessage)r r PASSTHROUGH)r5r9r:s r7check_permissionszRead.check_permissionsas("'30    r8 rule_contentclK|dS|dd}|sdStj||S)aCheck if a permission rule matches the file path. Matches rule_content as a glob pattern against the "file_path" parameter using fnmatch. If rule_content is None, matches all invocations (tool-name-level rule). Args: rule_content (`str | None`): Glob pattern to match against the file path (e.g., "src/**"), or None to match all invocations tool_input (`dict[str, Any]`): The tool input data containing "file_path" key Returns: `bool`: True if the glob pattern matches the file path, False otherwise NTr F)getfnmatch)r5r@r9r s r7 match_rulezRead.match_ruleqsE.  4NN;33  5y,777r8cK|dd}|sgS|j|}|r|ddznd}t |j|t jdgS)a Generate suggested permission rules for the file path. Suggests a glob pattern covering the parent directory of the file, allowing the user to grant permission for the entire directory at once. Args: tool_input (`dict[str, Any]`): The tool input data containing "file_path" key Returns: `List[PermissionRule]`: A single suggested rule covering the parent directory (e.g., file "/src/main.py" -> rule "src/**") r rBz/\z/**z** suggested) tool_namer@r<source)rCr1dirnamerstripr rr ALLOW)r5r9r parentpatterns r7generate_suggestionszRead.generate_suggestionss$NN;33  I&&y115;D6==''%// )$+1"      r8r!r" _agent_statec dK|j|s.ttd|gtjdS|j|d{Vs.ttd|gtjdS|j|d{Vr.ttd|gtjdS d}|)|j |d{V}||j }||j |d{V}| dd }t|}|d }|"|j|| d{V|d z } | |z} || | } g} t!| |D]a\} }|d}t%||jkr|d|jdz}| dd|}| |bd| }tt|gtjdS#t.$rE}ttdt1|gtjdcYd}~Sd}~wwxYw)z7Read the file and return the content with line numbers.z0Error: file_path must be an absolute path, got: )textT)contentstateis_lastNzError: File does not exist: z(Error: Path is a directory, not a file: zutf-8replace)errors)keepends)r linesr)startz z [truncated]6d  zError reading file: )r1isabsr rrERROR file_existsis_dir tool_context get_cacherY read_filedecoder splitlines cache_file enumeraterKlenr4appendjoinRUNNING Exceptionstr)r5r r!r"rPrYcacheraw content_str start_idxend_idxselected_linesformatted_linesiline line_contentformatted_lineresultes r7callz Read.calls}""9-- , ),, &+    ]..y99999999 #M)#M#MNNN&+  %%i00 0 0 0 0 0 0 '$'' &+    < E'*7AA)LLLLLLLL$!KE} M33I>>>>>>>>!jjjCC 2+>> #...== +&3>>"+#?  I%'G"9W#45N!O$^6BBB 7 74#{{622 |$$t'@@@$%@t'@%@A'(! %&!:!:!:L!:!:&&~6666YY//F"///0%-     "(Gs1vv(G(GHHHI%+       s(E7I J/*:J*$J/*J/)rNN)rrN) __name__ __module__ __qualname____doc__rrn__annotations__rr%dictrr&boolr'r(r)r*intrrrr3r r r?rEr rOrr r| __classcell__)r6s@r7rrsD#/ LK L L L2!G " $ " -   *!M/$$L$sCx.4FDL$ $$$$"d""""t"""$(7;&* 22 2,-42t# 2  2222226 cN #       8Dj8cN8  8888>" cN"  n " " " " N*. iiii i !4' i  iiiiiiiir8r)rrDtypingrr_baserr permissionr r r r _responser r=rrrTrr1rrrr8r7rs""00000000 "!!!!!1111111166666666JJJJJ8JJJJJr8