vps搭建网站是什么意思,做网站可以不买域名和主机吗,小程序开发平台哪家比较被大家认可,建筑工程网cnasChatGLM3 tool_registry.py 代码解析 0. 背景1. tool_registry.py 0. 背景
学习 ChatGLM3 的项目内容#xff0c;过程中使用 AI 代码工具#xff0c;对代码进行解释#xff0c;帮助自己快速理解代码。这篇文章记录 ChatGLM3 tool_registry.py 的代码解析内容。
1. tool_re… ChatGLM3 tool_registry.py 代码解析 0. 背景1. tool_registry.py 0. 背景
学习 ChatGLM3 的项目内容过程中使用 AI 代码工具对代码进行解释帮助自己快速理解代码。这篇文章记录 ChatGLM3 tool_registry.py 的代码解析内容。
1. tool_registry.py
from copy import deepcopy
import inspect
from pprint import pformat
import traceback
from types import GenericAlias
from typing import get_origin, Annotated_TOOL_HOOKS {}
_TOOL_DESCRIPTIONS {}这段代码定义了几个全局变量和导入了一些模块。让我来逐个解释 from copy import deepcopy从 copy 模块导入 deepcopy 函数用于深拷贝对象。 import inspect导入 inspect 模块用于获取对象的信息。 from pprint import pformat从 pprint 模块导入 pformat 函数用于格式化打印对象。 import traceback导入 traceback 模块用于打印异常堆栈信息。 from types import GenericAlias从 types 模块导入 GenericAlias 类用于表示泛型类型。 from typing import get_origin, Annotated从 typing 模块导入 get_origin 和 Annotated 函数用于获取泛型类型的原始类型和注解信息。 _TOOL_HOOKS {}定义一个空的全局字典变量 _TOOL_HOOKS用于存储工具的钩子函数。 _TOOL_DESCRIPTIONS {}定义一个空的全局字典变量 _TOOL_DESCRIPTIONS用于存储工具的描述信息。
这段代码的作用可能是为后续的工具注册和存储钩子函数以及描述信息提供了一个全局的数据结构。
def register_tool(func: callable):tool_name func.__name__tool_description inspect.getdoc(func).strip()python_params inspect.signature(func).parameterstool_params []for name, param in python_params.items():annotation param.annotationif annotation is inspect.Parameter.empty:raise TypeError(fParameter {name} missing type annotation)if get_origin(annotation) ! Annotated:raise TypeError(fAnnotation type for {name} must be typing.Annotated)typ, (description, required) annotation.__origin__, annotation.__metadata__typ: str str(typ) if isinstance(typ, GenericAlias) else typ.__name__if not isinstance(description, str):raise TypeError(fDescription for {name} must be a string)if not isinstance(required, bool):raise TypeError(fRequired for {name} must be a bool)tool_params.append({name: name,description: description,type: typ,required: required})tool_def {name: tool_name,description: tool_description,params: tool_params}print([registered tool] pformat(tool_def))_TOOL_HOOKS[tool_name] func_TOOL_DESCRIPTIONS[tool_name] tool_defreturn func这段代码定义了一个名为 register_tool 的函数该函数接受一个可调用对象 func 作为参数。
以下是代码的详细解析
tool_name func.name获取传入函数 func 的名称并将其赋值给变量 tool_name。tool_description inspect.getdoc(func).strip()使用 inspect.getdoc 函数获取传入函数 func 的文档字符串并去除首尾的空白字符将结果赋值给变量 tool_description。python_params inspect.signature(func).parameters使用 - inspect.signature 函数获取传入函数 func 的参数签名并将其参数信息保存在变量 python_params 中。tool_params []创建一个空列表 tool_params用于存储工具的参数信息。for name, param in python_params.items():遍历 python_params 中的每个参数项其中 name 是参数名param 是参数对象。 annotation param.annotation获取参数对象的注解并将其赋值给变量 annotation。if annotation is inspect.Parameter.empty:如果注解为空则表示参数缺少类型注解抛出 TypeError 异常。if get_origin(annotation) ! Annotated:如果注解类型不是 typing.Annotated抛出 TypeError 异常。typ, (description, required) annotation.origin, annotation.metadata从注解中获取类型和元数据信息并将其分别赋值给 typ、description 和 required 变量。typ: str str(typ) if isinstance(typ, GenericAlias) else typ.name将类型转换为字符串如果类型是 GenericAlias泛型类型则将其转换为字符串形式否则保留类型的名称。if not isinstance(description, str):如果描述不是字符串类型抛出 TypeError 异常。if not isinstance(required, bool):如果 required 不是布尔类型抛出 TypeError 异常。tool_params.append({…})将参数的名称、描述、类型和是否必需组成的字典添加到 tool_params 列表中。 tool_def {…}创建一个字典 tool_def包含工具的名称、描述和参数信息。print([registered tool] pformat(tool_def))打印注册的工具的定义使用 pformat 函数格式化输出。_TOOL_HOOKS[tool_name] func将函数 func 添加到全局字典变量 _TOOL_HOOKS 中键为工具的名称。_TOOL_DESCRIPTIONS[tool_name] tool_def将工具的定义添加到全局字典变量 _TOOL_DESCRIPTIONS 中键为工具的名称。return func返回原始的函数 func。 这段代码的作用是将传入的函数作为工具进行注册并将工具的名称、描述和参数信息存储在全局字典变量中。注册的工具可以通过 _TOOL_HOOKS 全局字典变量进行调用。
def dispatch_tool(tool_name: str, tool_params: dict) - str:if tool_name not in _TOOL_HOOKS:return fTool {tool_name} not found. Please use a provided tool.tool_call _TOOL_HOOKS[tool_name]try:ret tool_call(**tool_params) except:ret traceback.format_exc()return str(ret)def get_tools() - dict:return deepcopy(_TOOL_DESCRIPTIONS)这段代码定义了两个函数dispatch_tool 和 get_tools。让我为你逐个解释
函数 dispatch_tool(tool_name: str, tool_params: dict) - str
该函数接受两个参数 tool_name 和 tool_params并返回一个字符串。
if tool_name not in _TOOL_HOOKS:检查传入的工具名称 tool_name 是否存在于全局字典变量 _TOOL_HOOKS 中。 如果工具名称不存在返回一个提示字符串表示找不到该工具。tool_call _TOOL_HOOKS[tool_name]从全局字典变量 _TOOL_HOOKS 中获取与工具名称对应的工具函数并将其赋值给变量 tool_call。try:尝试执行工具函数并捕获可能的异常。 ret tool_call(**tool_params)使用传入的参数 tool_params 调用工具函数并将返回值赋值给变量 ret。这里使用 ** 运算符将 tool_params 字典解包为关键字参数传递给工具函数。 except:捕获可能的异常。 ret traceback.format_exc()如果出现异常将异常的堆栈信息格式化为字符串并将其赋值给变量 ret。 return str(ret)返回结果无论是工具函数的返回值还是异常堆栈信息都将转换为字符串并返回。 该函数的作用是根据传入的工具名称和参数调用对应的工具函数并返回结果或异常信息的字符串表示。
函数 get_tools() - dict
该函数不接受任何参数返回一个字典。
return deepcopy(_TOOL_DESCRIPTIONS)返回全局字典变量 _TOOL_DESCRIPTIONS 的深拷贝。 该函数的作用是返回全局字典变量 _TOOL_DESCRIPTIONS 的副本以提供工具的名称、描述和参数信息。
这两个函数一起提供了工具的调度和获取工具信息的功能。dispatch_tool 函数用于调用具体的工具函数而 get_tools 函数用于获取所有已注册工具的描述信息。 deepcopy: deepcopy 是一个函数用于创建一个对象的深拷贝。深拷贝是指创建一个新对象将原始对象的所有元素递归地复制到新对象中包括嵌套的对象。换句话说它会创建一个原始对象的完全独立副本而不仅仅是引用原始对象的内存地址。 深拷贝对于需要完全独立的副本的情况非常有用尤其是在处理可变对象时。通过深拷贝可以确保修改一个对象的副本不会影响到原始对象因为它们是相互独立的。 例如假设有一个包含嵌套列表和字典的对象 obj如果直接对 obj 进行赋值操作那么新对象将只是原始对象的引用而不是副本。这意味着对新对象的修改也会反映到原始对象中。但是如果使用 deepcopy 函数创建一个新对象 new_obj那么 new_obj 将是 obj 的深拷贝副本对 new_obj 的修改不会影响到 obj。 register_tool
def random_number_generator(seed: Annotated[int, The random seed used by the generator, True], range: Annotated[tuple[int, int], The range of the generated numbers, True],
) - int:Generates a random number x, s.t. range[0] x range[1]if not isinstance(seed, int):raise TypeError(Seed must be an integer)if not isinstance(range, tuple):raise TypeError(Range must be a tuple)if not isinstance(range[0], int) or not isinstance(range[1], int):raise TypeError(Range must be a tuple of integers)import randomreturn random.Random(seed).randint(*range)这段代码定义了一个名为 random_number_generator 的函数并使用 register_tool 装饰器将其注册为一个工具。
函数接受两个参数 seed 和 range并返回一个整数。下面是对代码的详细解释 register_tool 符号是装饰器语法用于在函数定义之前修饰函数。register_tool 表示将该函数注册为一个工具。具体工具注册的逻辑在你提供的代码中没有呈现可以在其他地方找到。 def random_number_generator(seed: Annotated[int, ‘The random seed used by the generator’, True], range: Annotated[tuple[int, int], ‘The range of the generated numbers’, True]) - int:这是函数的定义部分。函数名为 random_number_generator接受两个参数 seed 和 range并指定返回类型为整数。 “” Generates a random number x, s.t. range[0] x range[1] “”这是函数的文档字符串docstring用于描述函数的功能。根据文档字符串的描述该函数生成一个介于 range[0] 和 range[1] 之间的随机整数 x。 参数验证部分在函数体内部对传入的参数进行验证确保它们具有正确的类型和值。 if not isinstance(seed, int):检查 seed 是否为整数类型如果不是则抛出 TypeError 异常提示 “Seed must be an integer”。if not isinstance(range, tuple):检查 range 是否为元组类型如果不是则抛出 TypeError 异常提示 “Range must be a tuple”。if not isinstance(range[0], int) or not isinstance(range[1], int):检查 range 的元素是否为整数类型如果不是则抛出 TypeError 异常提示 “Range must be a tuple of integers”。 import random导入 Python 标准库中的 random 模块用于生成随机数。 return random.Random(seed).randint(*range)使用 random 模块生成一个随机整数并将其作为函数的返回值。random.Random(seed) 创建了一个具有指定种子 seed 的随机数生成器对象然后使用 randint(*range) 方法生成介于 range[0] 和 range[1] 之间的随机整数。
总之这段代码定义了一个将参数验证和随机数生成结合在一起的函数。它使用装饰器将函数注册为一个工具并在调用时生成指定范围内的随机整数。
register_tool
def get_weather(city_name: Annotated[str, The name of the city to be queried, True],
) - str:Get the current weather for city_nameif not isinstance(city_name, str):raise TypeError(City name must be a string)key_selection {current_condition: [temp_C, FeelsLikeC, humidity, weatherDesc, observation_time],}import requeststry:resp requests.get(fhttps://wttr.in/{city_name}?formatj1)resp.raise_for_status()resp resp.json()ret {k: {_v: resp[k][0][_v] for _v in v} for k, v in key_selection.items()}except:import tracebackret Error encountered while fetching weather data!\n traceback.format_exc() return str(ret)这段代码定义了一个名为 get_weather 的函数并使用 register_tool 装饰器将其注册为一个工具。
函数接受一个参数 city_name并返回一个字符串。下面是对代码的详细解释 register_tool 符号是装饰器语法用于在函数定义之前修饰函数。register_tool 表示将该函数注册为一个工具。具体工具注册的逻辑在你提供的代码中没有呈现可以在其他地方找到。 def get_weather(city_name: Annotated[str, ‘The name of the city to be queried’, True]) - str:这是函数的定义部分。函数名为 get_weather接受一个 city_name 参数指定返回类型为字符串。 “” Get the current weather for city_name “”这是函数的文档字符串docstring用于描述函数的功能。根据文档字符串的描述该函数用于获取指定城市的当前天气情况。 参数验证部分在函数体内部对传入的参数进行验证确保它们具有正确的类型和值。 if not isinstance(city_name, str):检查 city_name 是否为字符串类型如果不是则抛出 TypeError 异常提示 “City name must be a string”。 key_selection {…}定义了一个字典变量 key_selection用于存储需要从 API 响应中提取的天气信息的键值选择。该字典的键代表不同的天气信息而对应的值是一个列表包含了该天气信息所对应的子键。 import requests导入 Python 第三方库 requests用于发送 HTTP 请求。 try:尝试执行一段代码并捕获可能的异常。 resp requests.get(fhttps://wttr.in/{city_name}?formatj1)使用 requests 发送一个 GET 请求获取指定城市的天气数据。URL 中的 {city_name} 部分会被替换为实际的城市名称。resp.raise_for_status()检查请求的状态码如果是错误的状态码将抛出一个异常。resp resp.json()将响应的 JSON 数据解析为 Python 字典并将其赋值给 resp 变量。ret {…}根据 key_selection 字典中的键值选择从响应中提取相应的天气信息存储在 ret 变量中。这里使用了字典推导式来生成结果。 except:捕获可能的异常。 import traceback导入 Python 标准库中的 traceback 模块用于获取异常的堆栈信息。ret “Error encountered while fetching weather data!\n” traceback.format_exc()如果发生异常将错误提示信息和堆栈信息拼接成一个字符串并将其赋值给 ret 变量。 return str(ret)返回结果将结果转换为字符串类型后返回。
总之这段代码定义了一个用于获取指定城市天气的函数。它使用 requests 库发送 HTTP 请求获取天气数据并从响应中提取指定的天气信息。如果发生任何异常它会将错误提示信息和堆栈信息返回。
请注意这段代码中的 register_tool 装饰器和 requests 库是额外的依赖项你可能需要在其他地方找到这些实现或库的定义。
完结
