tooluniverse.hpa_tool 模块

class tooluniverse.hpa_tool.HPASearchApiTool[源代码]

基类：BaseTool

与HPA的search_download.php API交互的基类。使用HPA的搜索和下载API获取蛋白质表达数据。

__init__(tool_config)[源代码]
class tooluniverse.hpa_tool.HPAJsonApiTool[源代码]

基类：BaseTool

与 HPA 的 /{ensembl_id}.json API 交互的基类。用于更高效地获取全面的基因数据。

__init__(tool_config)[源代码]
class tooluniverse.hpa_tool.HPAXmlApiTool[源代码]

基类：BaseTool

用于与 HPA 的 /{ensembl_id}.xml API 交互的基类。针对全面的 XML 数据提取进行了优化。

__init__(tool_config)[源代码]
class tooluniverse.hpa_tool.HPASearchTool[源代码]

基类：HPASearchApiTool

Generic search tool for Human Protein Atlas.

This tool allows custom search queries and retrieval of specific columns from the Human Protein Atlas API. It provides more flexibility than the specialized tools by allowing direct access to the search API with custom parameters.

参数:

  • search_query (str) – The search term to query for (e.g., gene name, description).

  • columns (str, optional) –

    Comma-separated list of columns to retrieve. Defaults to “g,gs,gd” (Gene, Gene synonym, Gene description).

    Available columns and their specifiers: - g: Gene name - gs: Gene synonym - gd: Gene description - e: Ensembl ID - u: UniProt ID - en: Enhanced - pe: Protein existence - r: Reliability - p: Pathology - c: Cancer - pt: Protein tissue - ptm: Predicted Transmembrane - s: Subcellular location - scml: Subcellular main location - scal: Subcellular additional location - rnat: RNA tissue specificity - rnats: RNA tissue specific score - rnatsm: RNA tissue specific nTPM - rnablm: RNA blood lineage specific nTPM - rnabrm: RNA brain region specific nTPM - rnascm: RNA single cell type specific nTPM

    See HPA API documentation for the full list of over 40 available columns.

  • format (str, optional) – Response format, “json” or “tsv”. Defaults to “json”.

返回:

A dictionary containing the search results.

If successful, returns the API response (list of entries). If failed, returns a dictionary with an “error” key.

返回类型:

dict

示例

>>> tool = HPASearchTool()
>>> result = tool.run({
...     "search_query": "p53",
...     "columns": "g,gs,scml,rnat",
...     "format": "json"
... })
>>> print(result[0]["Gene"])
TP53
run(arguments)[源代码]

Execute the search tool.

参数:

arguments (Dict[str, Any]) – Dictionary containing: - search_query (str): The term to search for. - columns (str, optional): Columns to retrieve. - format (str, optional): Response format.

返回:

Search results or error message.

返回类型:

Dict[str, Any]

class tooluniverse.hpa_tool.HPAGetRnaExpressionBySourceTool[源代码]

基类：HPASearchApiTool

使用优化的 columns 参数，从特定生物来源获取基因的 RNA 表达。本工具直接利用全面的 columns 表，实现高效查询。

__init__(tool_config)[源代码]
run(arguments)[源代码]

执行该工具。

默认的 BaseTool 实现接受一个可选的参数映射，以便与大多数具体工具实现保持一致，这些工具通常期望输入为字典形式。

参数:

  • arguments (dict, optional) – 工具专用参数

  • stream_callback (callable, optional) – 用于流式响应的回调

  • use_cache (bool, optional) – 是否启用了结果缓存

  • validate (bool, optional) – 是否已执行参数验证

备注

这些附加参数（stream_callback、use_cache、validate）由 run_one_function() 传递，用于提供有关执行的上下文。工具可以利用这些参数进行优化或特殊处理。

为了向后兼容，不接受这些参数的工具仍然可以正常工作——它们只会接收到 arguments 参数。

class tooluniverse.hpa_tool.HPAGetSubcellularLocationTool[源代码]

基类：HPASearchApiTool

使用优化的列参数获取蛋白质的注释子细胞定位。通过使用 scml（主要位置）和 scal（附加位置）列进行高效查询。

run(arguments)[源代码]

执行该工具。

默认的 BaseTool 实现接受一个可选的参数映射，以便与大多数具体工具实现保持一致，这些工具通常期望输入为字典形式。

参数:

  • arguments (dict, optional) – 工具专用参数

  • stream_callback (callable, optional) – 用于流式响应的回调

  • use_cache (bool, optional) – 是否启用了结果缓存

  • validate (bool, optional) – 是否已执行参数验证

备注

这些附加参数（stream_callback、use_cache、validate）由 run_one_function() 传递，用于提供有关执行的上下文。工具可以利用这些参数进行优化或特殊处理。

为了向后兼容，不接受这些参数的工具仍然可以正常工作——它们只会接收到 arguments 参数。

class tooluniverse.hpa_tool.HPASearchGenesTool[源代码]

基类：HPASearchApiTool

通过基因名称、关键词或细胞系名称搜索匹配基因，并返回Ensembl ID列表。这是许多查询工作流程的入口工具。

run(arguments)[源代码]

执行该工具。

默认的 BaseTool 实现接受一个可选的参数映射，以便与大多数具体工具实现保持一致，这些工具通常期望输入为字典形式。

参数:

  • arguments (dict, optional) – 工具专用参数

  • stream_callback (callable, optional) – 用于流式响应的回调

  • use_cache (bool, optional) – 是否启用了结果缓存

  • validate (bool, optional) – 是否已执行参数验证

备注

这些附加参数（stream_callback、use_cache、validate）由 run_one_function() 传递，用于提供有关执行的上下文。工具可以利用这些参数进行优化或特殊处理。

为了向后兼容，不接受这些参数的工具仍然可以正常工作——它们只会接收到 arguments 参数。

class tooluniverse.hpa_tool.HPAGetComparativeExpressionTool[源代码]

基类：HPASearchApiTool

比较特定细胞系和健康组织中的基因表达水平。通过基因名称和细胞系名称获取表达数据以进行比较。

__init__(tool_config)[源代码]
run(arguments)[源代码]

执行该工具。

默认的 BaseTool 实现接受一个可选的参数映射，以便与大多数具体工具实现保持一致，这些工具通常期望输入为字典形式。

参数:

  • arguments (dict, optional) – 工具专用参数

  • stream_callback (callable, optional) – 用于流式响应的回调

  • use_cache (bool, optional) – 是否启用了结果缓存

  • validate (bool, optional) – 是否已执行参数验证

备注

这些附加参数（stream_callback、use_cache、validate）由 run_one_function() 传递，用于提供有关执行的上下文。工具可以利用这些参数进行优化或特殊处理。

为了向后兼容，不接受这些参数的工具仍然可以正常工作——它们只会接收到 arguments 参数。

class tooluniverse.hpa_tool.HPAGetDiseaseExpressionTool[源代码]

基类：HPASearchApiTool

获取特定疾病和组织中基因的表达数据。通过基因名称、组织类型和疾病名称获取相关的表达信息。

__init__(tool_config)[源代码]
run(arguments)[源代码]

执行该工具。

默认的 BaseTool 实现接受一个可选的参数映射，以便与大多数具体工具实现保持一致，这些工具通常期望输入为字典形式。

参数:

  • arguments (dict, optional) – 工具专用参数

  • stream_callback (callable, optional) – 用于流式响应的回调

  • use_cache (bool, optional) – 是否启用了结果缓存

  • validate (bool, optional) – 是否已执行参数验证

备注

这些附加参数（stream_callback、use_cache、validate）由 run_one_function() 传递，用于提供有关执行的上下文。工具可以利用这些参数进行优化或特殊处理。

为了向后兼容，不接受这些参数的工具仍然可以正常工作——它们只会接收到 arguments 参数。

class tooluniverse.hpa_tool.HPAGetBiologicalProcessTool[源代码]

基类：HPASearchApiTool

获取与基因相关的生物学过程信息。通过基因名称获取该基因所涉及的具体生物学过程。

__init__(tool_config)[源代码]
run(arguments)[源代码]

执行该工具。

默认的 BaseTool 实现接受一个可选的参数映射，以便与大多数具体工具实现保持一致，这些工具通常期望输入为字典形式。

参数:

  • arguments (dict, optional) – 工具专用参数

  • stream_callback (callable, optional) – 用于流式响应的回调

  • use_cache (bool, optional) – 是否启用了结果缓存

  • validate (bool, optional) – 是否已执行参数验证

备注

这些附加参数（stream_callback、use_cache、validate）由 run_one_function() 传递，用于提供有关执行的上下文。工具可以利用这些参数进行优化或特殊处理。

为了向后兼容，不接受这些参数的工具仍然可以正常工作——它们只会接收到 arguments 参数。

class tooluniverse.hpa_tool.HPAGetCancerPrognosticsTool[源代码]

基类：HPAJsonApiTool

获取特定基因在多种癌症中的预后价值。使用高效的JSON API来检索癌症预后数据。

run(arguments)[源代码]

执行该工具。

默认的 BaseTool 实现接受一个可选的参数映射，以便与大多数具体工具实现保持一致，这些工具通常期望输入为字典形式。

参数:

  • arguments (dict, optional) – 工具专用参数

  • stream_callback (callable, optional) – 用于流式响应的回调

  • use_cache (bool, optional) – 是否启用了结果缓存

  • validate (bool, optional) – 是否已执行参数验证

备注

这些附加参数（stream_callback、use_cache、validate）由 run_one_function() 传递，用于提供有关执行的上下文。工具可以利用这些参数进行优化或特殊处理。

为了向后兼容，不接受这些参数的工具仍然可以正常工作——它们只会接收到 arguments 参数。

class tooluniverse.hpa_tool.HPAGetProteinInteractionsTool[源代码]

基类：HPASearchApiTool

获取基因的蛋白质-蛋白质相互作用伙伴。使用搜索API检索相互作用数据。

run(arguments)[源代码]

执行该工具。

默认的 BaseTool 实现接受一个可选的参数映射，以便与大多数具体工具实现保持一致，这些工具通常期望输入为字典形式。

参数:

  • arguments (dict, optional) – 工具专用参数

  • stream_callback (callable, optional) – 用于流式响应的回调

  • use_cache (bool, optional) – 是否启用了结果缓存

  • validate (bool, optional) – 是否已执行参数验证

备注

这些附加参数（stream_callback、use_cache、validate）由 run_one_function() 传递，用于提供有关执行的上下文。工具可以利用这些参数进行优化或特殊处理。

为了向后兼容，不接受这些参数的工具仍然可以正常工作——它们只会接收到 arguments 参数。

class tooluniverse.hpa_tool.HPAGetRnaExpressionByTissueTool[源代码]

基类：HPAJsonApiTool

查询特定组织中基因的RNA表达水平。相比于一般的组织表达查询，此方法更为精确。

run(arguments)[源代码]

执行该工具。

默认的 BaseTool 实现接受一个可选的参数映射，以便与大多数具体工具实现保持一致，这些工具通常期望输入为字典形式。

参数:

  • arguments (dict, optional) – 工具专用参数

  • stream_callback (callable, optional) – 用于流式响应的回调

  • use_cache (bool, optional) – 是否启用了结果缓存

  • validate (bool, optional) – 是否已执行参数验证

备注

这些附加参数（stream_callback、use_cache、validate）由 run_one_function() 传递，用于提供有关执行的上下文。工具可以利用这些参数进行优化或特殊处理。

为了向后兼容，不接受这些参数的工具仍然可以正常工作——它们只会接收到 arguments 参数。

class tooluniverse.hpa_tool.HPAGetContextualBiologicalProcessTool[源代码]

基类：BaseTool

在特定组织或细胞系的背景下分析基因的生物学过程。通过智能上下文验证和推荐功能进行优化。

__init__(tool_config)[源代码]
run(arguments)[源代码]

执行该工具。

默认的 BaseTool 实现接受一个可选的参数映射，以便与大多数具体工具实现保持一致，这些工具通常期望输入为字典形式。

参数:

  • arguments (dict, optional) – 工具专用参数

  • stream_callback (callable, optional) – 用于流式响应的回调

  • use_cache (bool, optional) – 是否启用了结果缓存

  • validate (bool, optional) – 是否已执行参数验证

备注

这些附加参数（stream_callback、use_cache、validate）由 run_one_function() 传递，用于提供有关执行的上下文。工具可以利用这些参数进行优化或特殊处理。

为了向后兼容，不接受这些参数的工具仍然可以正常工作——它们只会接收到 arguments 参数。

class tooluniverse.hpa_tool.HPAGetGenePageDetailsTool[源代码]

基类：HPAXmlApiTool

获取基因页面的详细信息，包括图像、蛋白质表达、抗体数据等。通过解析HPA的单基因XML端点获取最全面的数据。增强版基于优化方案改进了图像提取和全面数据解析功能。

__init__(tool_config)[源代码]
run(arguments)[源代码]

执行该工具。

默认的 BaseTool 实现接受一个可选的参数映射，以便与大多数具体工具实现保持一致，这些工具通常期望输入为字典形式。

参数:

  • arguments (dict, optional) – 工具专用参数

  • stream_callback (callable, optional) – 用于流式响应的回调

  • use_cache (bool, optional) – 是否启用了结果缓存

  • validate (bool, optional) – 是否已执行参数验证

备注

这些附加参数（stream_callback、use_cache、validate）由 run_one_function() 传递，用于提供有关执行的上下文。工具可以利用这些参数进行优化或特殊处理。

为了向后兼容，不接受这些参数的工具仍然可以正常工作——它们只会接收到 arguments 参数。

class tooluniverse.hpa_tool.HPAGetGeneJSONTool[源代码]

基类：HPAJsonApiTool

增强版传统工具 - 使用 Ensembl 基因 ID 获取基本基因信息。现改用高效的 JSON API 替代搜索 API。

run(arguments)[源代码]

执行该工具。

默认的 BaseTool 实现接受一个可选的参数映射，以便与大多数具体工具实现保持一致，这些工具通常期望输入为字典形式。

参数:

  • arguments (dict, optional) – 工具专用参数

  • stream_callback (callable, optional) – 用于流式响应的回调

  • use_cache (bool, optional) – 是否启用了结果缓存

  • validate (bool, optional) – 是否已执行参数验证

备注

这些附加参数（stream_callback、use_cache、validate）由 run_one_function() 传递，用于提供有关执行的上下文。工具可以利用这些参数进行优化或特殊处理。

为了向后兼容，不接受这些参数的工具仍然可以正常工作——它们只会接收到 arguments 参数。

class tooluniverse.hpa_tool.HPAGetGeneXMLTool[源代码]

基类：HPASearchApiTool

传统工具 - 获取基因TSV格式数据（XML的替代方案）。

run(arguments)[源代码]

执行该工具。

默认的 BaseTool 实现接受一个可选的参数映射，以便与大多数具体工具实现保持一致，这些工具通常期望输入为字典形式。

参数:

  • arguments (dict, optional) – 工具专用参数

  • stream_callback (callable, optional) – 用于流式响应的回调

  • use_cache (bool, optional) – 是否启用了结果缓存

  • validate (bool, optional) – 是否已执行参数验证

备注

这些附加参数（stream_callback、use_cache、validate）由 run_one_function() 传递，用于提供有关执行的上下文。工具可以利用这些参数进行优化或特殊处理。

为了向后兼容，不接受这些参数的工具仍然可以正常工作——它们只会接收到 arguments 参数。