Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

--params option not sufficient for global configuration

未关闭
#93 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
35/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
停滞
技术栈
python
领域
api

调研方向

从 TspClient.post_configuration() 开始,目前请求会在此构建一个仅包含参数映射的 body。将其与使用 JSON 文件 POST 的输出配置提供用户自定义名称的方式进行比较,然后验证 configuration POST body 是否包含 backend 所需的该名称。

由索引模型根据 Issue 内容生成。

描述

Bug Description:

--params option not sufficient for global configuration because it's only for the parameters passed as parameters map in the ConfigurationQueryParameters. There is no way to add the name to ConfigurationQueryParameters which is passed in the post_configuration() method of the TspClient. The "post_configuration" method() creates the query parameters without name:

def post_configuration(self, type_id, params):
        api_url = '{0}config/types/{1}/configs'.format(self.base_url, type_id)
        parameters = {'parameters': params}
        response = requests.post(api_url, json=parameters, headers=headers)
...

The handwritten python client doesn't verify if name is passed to the body of HTTP post call. However, generated clients will verify it because it's a required field.

Moreover, backend implemenation of a configuration source will rely on it because it's required. Note, that the XMLConfigurationSource of the Trace Compass server is the sole implementation in Trace Compass so far and it doesn't require a name and ignores it. The filename of the xml file configured in the path variable is assigned as name.

Change python code to pass a user defined name similarly when posting output configurations using a json file.

Steps to Reproduce:

No easy way to reproduce. Just debug the client code (TspClient.post_configuration()) and see that the name is not passed.

Additional Information
  • Operating System:
主要语言
Python
星标
6
派生
16
PR 合并指标
30 天内没有已合并 PR

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

eclipse-cdt-cloud/tsp-python-client 的其他 Issue

查看 eclipse-cdt-cloud/tsp-python-client 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。