python超实用插件REST Client、autoDocstring、Better Comments

news2024/11/24 15:10:59

1. autoDocstring

1.1 features

快速生成可以通过制表符浏览的文档字符串片段。
在几种不同类型的文档字符串格式之间进行选择。
通过pep484类型提示、默认值和变量名称推断参数类型。
支持args、kwargs、装饰器、错误和参数类型。

1.2 用法

光标必须位于定义正下方的行上，以生成完全自动填充的文档字符串

在用三个引号（可配置为"""或’‘’）打开文档字符串后按Enter
键盘快捷键：ctrl+shift+2或mac上的cmd+shift+2
可以在首选项->键盘快捷键->extension.generateDocstring中更改
命令：生成文档字符串
右键菜单：生成文档字符串

2. Better Comments

Better Comments扩展将帮助您在代码中创建更加人性化的注释。

在这里插入图片描述
有了这个扩展，您将能够将您的注释分类为：

警告
查询
待办事项
亮点
注释掉的代码也可以进行样式设置，以便清楚地表明代码不应该在那里
您还可以在设置中指定其他任何您喜欢的注释样式。

3. REST Client

REST客户端允许您直接在Visual Studio Code中发送HTTP请求并查看响应。
在这里插入图片描述
主要功能

在编辑器中发送/取消/重新运行HTTP请求，并在单独的窗格中查看带有语法高亮的响应
在编辑器中发送GraphQL查询并编写GraphQL变量
在编辑器中发送cURL命令并将HTTP请求复制为cURL命令
自动保存和查看/清除请求历史记录
在单个文件中组合多个请求（以###分隔）
直接在窗格中查看图像响应
将原始响应和仅响应主体保存到本地磁盘
折叠和展开响应主体
自定义响应预览中的字体（大小/系列/粗细）
使用以下内容进行身份验证：基本身份验证, 摘要身份验证, SSL客户端证书, Azure活动目录, Microsoft身份平台, AWS签名v4
等等…

3.1 get request website

GET http://example.com HTTP/1.1

点击代码头上的 Send Request 就可以发送网页请求，右侧就是response
在这里插入图片描述

3.2 get request json

以### 分割上个请求

###

GET http://httpbin.org/json HTTP/1.1

在这里插入图片描述

3.3 post with header and boy

###

POST http://httpbin.org/post HTTP/1.1
x-my-name: zgpeace

{
    "arg1" : "value1"
}

可以看到header 是 zgpeace， body设置 value1，点击右上角还可以保存response数据
在这里插入图片描述

3.4 根据请求生成任意语言的代码电视线

选择需要生成的代码，右键 Generate Code Snippet
在这里插入图片描述
可以生成的语言列表Go, Java, Python, C, Swift… 这里选择Python

选择http.client lib

import http.client

conn = http.client.HTTPConnection("httpbin.org")

payload = "{\"arg1\" : \"value1\"}"

headers = {
    'user-agent': "vscode-restclient",
    'x-my-name': "zgpeace"
    }

conn.request("POST", "/post", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

运行结果如下

(.venv) 17:04:15 zgpeace@zgpeaces-MacBook-Pro.local langchain-llm-app develop ? python HTTP/TestPost.py 
{
  "args": {}, 
  "data": "{\"arg1\" : \"value1\"}", 
  "files": {}, 
  "form": {}, 
  "headers": {
    "Accept-Encoding": "identity", 
    "Content-Length": "19", 
    "Host": "httpbin.org", 
    "User-Agent": "vscode-restclient", 
    "X-Amzn-Trace-Id": "Root=1-6583ff96-5783744b06279eb675fc4ad9", 
    "X-My-Name": "zgpeace"
  }, 
  "json": {
    "arg1": "value1"
  }, 
  "origin": "61.140.244.138", 
  "url": "http://httpbin.org/post"
}