3fi2dZddlmZmZmZmZmZddlmZddl m Z m Z ddl m Z ddlmZGdd e ZGd d e Zy ) zETool for retrieving Google Sheets metadata and structure information.)AnyDictListOptionalType)CallbackManagerForToolRun) BaseModelField)SheetsBaseTool)validate_spreadsheet_idceZdZUdZeddZeed<eddZe ed <edd Z e ed <edd Z e ed <eddZ e eeed<eddZe eed<y)GetSpreadsheetInfoSchemaz0Input schema for `SheetsGetSpreadsheetInfoTool`..zjThe ID of the Google Spreadsheet to get information about. Can be extracted from URL or provided directly.) descriptionspreadsheet_idFzyWhether to include detailed grid data (cell properties, formatting). Note: This can significantly increase response size.)defaultrinclude_grid_datazNWhether to include cell formatting information when include_grid_data is True.include_formattingzHWhether to include data validation rules when include_grid_data is True.include_validationNzLSpecific ranges to get information about. If None, gets info for all sheets.rangesz}Specific fields to return (e.g., 'sheets.properties.title,sheets.properties.sheetId'). If None, returns all available fields.fields)__name__ __module__ __qualname____doc__r rstr__annotations__rboolrrrrrrt/var/www/auto_recruiter/arenv/lib/python3.12/site-packages/langchain_google_community/sheets/get_spreadsheet_info.pyrr s: :NC $ Ct %%  %%  #(-#FHT#Y  "1FHSMr rceZdZUdZdZeed<dZeed<eZ e eed< dded e d e d e d e e ed e ede edeeeffdZ dded e d e defdZde ede e efdZde ede e efdZde ede e efdZy)SheetsGetSpreadsheetInfoToola4 Tool for retrieving Google Sheets metadata and structure information. Inherits from [`SheetsBaseTool`][langchain_google_community.sheets.base.SheetsBaseTool]. Retrieves spreadsheet properties, sheet details, named ranges, and organizational structure. Essential for understanding spreadsheet contents before reading data. Tool Output: success (bool): Whether operation succeeded. spreadsheet_id (str): The spreadsheet ID. title (str): Spreadsheet title. locale (str): Spreadsheet locale (e.g., 'en_US'). time_zone (str): Spreadsheet timezone (e.g., 'America/New_York'). auto_recalc (str): Auto-recalculation setting. default_format (dict): Default cell format. sheets (list): List of sheet information with properties. named_ranges (list): List of named ranges with locations. developer_metadata (list): Developer metadata entries. grid_data (list): Detailed cell data (when `include_grid_data=True`). ??? example "Basic Usage" Get basic spreadsheet information: ```python from langchain_google_community.sheets import SheetsGetSpreadsheetInfoTool tool = SheetsGetSpreadsheetInfoTool(api_key="your_api_key") result = tool.run( {"spreadsheet_id": "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms"} ) print(f"Title: {result['title']}") print(f"Sheets: {[s['title'] for s in result['sheets']]}") ``` ??? example "With Specific Fields" Get only specific fields to reduce response size: ```python result = tool.run( { "spreadsheet_id": "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms", "fields": "properties.title,sheets.properties", } ) ``` ??? example "Include Grid Data" Get detailed cell data and formatting: ```python result = tool.run( { "spreadsheet_id": "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms", "include_grid_data": True, "include_formatting": True, "ranges": ["Sheet1!A1:D10"], } ) ``` Raises: ValueError: If spreadsheet_id is invalid. Exception: For API errors or connection issues. sheets_get_spreadsheet_infonameaRetrieve comprehensive metadata information from Google Sheets including spreadsheet properties, sheet details, named ranges, and organizational structure. Essential for understanding spreadsheet contents before reading data and exploring spreadsheet structure.r args_schemaNrrrrrr run_managerreturnc0 t|}|j} ||d} |r|| d<|r|| d<| jjdi| j } |j | ||} d| d<| S#t $r} t d| | d} ~ wwxYw) aPGet spreadsheet metadata and structure information. Args: spreadsheet_id: ID of the spreadsheet to retrieve information about. include_grid_data: Whether to include detailed grid data. include_formatting: Whether to include cell formatting. include_validation: Whether to include data validation rules. ranges: Specific ranges to get information about. fields: Specific fields to return (reduces response size). run_manager: Optional callback manager. Returns: success (bool): Whether operation succeeded. spreadsheet_id (str): The spreadsheet ID. title (str): Spreadsheet title. locale (str): Spreadsheet locale. time_zone (str): Spreadsheet timezone. auto_recalc (str): Auto-recalculation setting. default_format (dict): Default cell format. sheets (list): List of sheet information with properties. named_ranges (list): List of named ranges with locations. developer_metadata (list): Developer metadata entries. grid_data (list): Detailed cell data (when `include_grid_data=True`). Raises: ValueError: If `spreadsheet_id` is invalid. Exception: For API errors or connection issues. ) spreadsheetIdincludeGridDatarrTsuccessz Error getting spreadsheet info: Nr)r _get_service spreadsheetsgetexecute_process_spreadsheet_info Exception)selfrrrrrrr'validated_spreadsheet_idservicerequest_paramsresponseprocessed_infoerrors r!_runz!SheetsGetSpreadsheetInfoTool._runsL S'>~'N $'')G":#4N +1x(+1x(2w++-11CNCKKMH";;,.@N )-N9 %! ! S>ugFGU R SsA5A88 BBBr7c  |jd|jdijd|jdijd|jdijd|jdijd|jdijdigggd }|jd g}|D]S}|jdijd |jdijd|jdijd |jdijd i|jdijd i|jdijdd|jdijddd}d|vr|j|d|d<|rd|vr|j|d|d<|rd|vr|j|d|d<|d j |V|jdg}|D]I} | jd| jd| jdd} |dj | K|jdg} | D]j} | jd| jd| jd| jd | jd!id"} |d#j | l|S)$z*Process the raw spreadsheet info response.r* propertiestitlelocaletimeZone autoRecalc defaultFormat) rr=r> time_zone auto_recalcdefault_formatsheets named_rangesdeveloper_metadatarEsheetId sheetTypegridPropertiestabColorhiddenF rightToLeft)sheet_idr= sheet_typegrid_properties tab_colorrL right_to_leftdata grid_data formatting validation namedRangesr%range namedRangeId)r%rXnamed_range_idrFdeveloperMetadata metadataIdkeyvalue visibilitylocation) metadata_idr]r^r_r`rG)r/_process_grid_data_extract_formatting_extract_validationappend)r3r7rrspreadsheet_inforEsheet sheet_inforF named_range range_inforGmetadata metadata_infos r!r1z6SheetsGetSpreadsheetInfoTool._process_spreadsheet_infos'll?;\\,377@ll<488B!lB7;;JG#<< b9==lK&ll<<@@RTU"$  h+ :E!IIlB7;;IF<488A#ii b9==kJ#(99\2#>#B#B$b$#YY|R8<&--b1 2  &&~6 7 7r )FFFNNN)FF)rrrrr%rrrrr&rrrrrrrr:dictr1rbrcrdrr r!r#r#7sfCJ.D#- 43KK./J #(#(#(&* $;?FSFS FS! FS ! FS c# FS FS78FS c3hFSV$)#( G G !G ! G  G RDJ4S ?,T$ZDdrs5K22>% *(y(V^>^r