boto3 文档很难浏览,充满了遗漏

· 说明问题

相较于保存良好的道克,同Mongo DB包的道克一样,boto3在道克中缺乏交叉引用,在源代码中也缺少静态打字,所以往往找到任何东西的唯一方法就是从源代码中取出道克字符串并在Google中搜索. 使用此页面 :

https://boto3.amazonaws.com/v1/documentation/api/latest/ reference/ services/s3.html 页面存档备份,存于互联网档案馆.

页面上没有任何链接到如何创建客户端. 仅列出"boto3.client ("s3")",即可. 在左面板中搜索 s3客户端 带回同页. 找到实际页面的唯一方法就是从“boto3.client”源头取出docstring,并通过Google搜索:

https://www.google.com/search?q=site%3 Aamazonaws.com==22Create+a+low-level+service+client+by+name.% 22

这带来了一个会话界面,因此发现一个客户端在默认会话中,所以人们需要寻找一个会话,而不是客户端.

所有植物3中缺乏静态打字也无济于事. boto3是一个非常复杂的API,在任何项目灯光中使用它来调取静态类型检查器,并带有由缺失类型而出的各种错误. 与 Mongo DB 静态打字和Docs 相比,所有东西都打入并交叉引用:

https://pymongo.readthedocs.io/en/stable/api/pymongo/mongo client.html 页面存档备份,存于互联网档案馆.

这不仅限于此页面,而是更多用于boto3 Docs的图案. 这是另一个。 s3. Client.get object ' 描述Streaming Body',即使通过搜索也找不到它。

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/ services/s3/client/get obobject.html 互联网档案馆的存檔,存档日期2014-12-21.

Google再次来救援,并返回了这页.

https://botocore.amazonaws.com/v1/documentation/api/latest/reference/response.html#botocore.response.streamining Body (中文(简体) ).

我希望boto3 docs能够相互参照所有的概念,类型,方法和属性.

链接

https://boto3.amazonaws.com/v1/documentation/api/latest/ reference/ services/s3.html 页面存档备份,存于互联网档案馆