用于编写lookout分析器的sdk
lookout-sdk的Python项目详细描述
了望sdk
为source{d} Lookout编写新分析器的工具包。
sdk提供了什么?
有关source{d}lookout的完整文档,请查看https://docs.sourced.tech/lookout。
有关lookout的不同部分以及它们如何交互的详细信息,可以转到Lookout architecture guide。
lookout sdk提供:
- protodefinitions。
- 为Golang和Python预生成的库,提供:
- 通过grpc服务轻松访问dataservice api 。lookout将负责处理git存储库、uast提取、编程语言检测等。
- 低层帮助处理一些protobuf/grpc警告。
- 快速启动examples分析器,检测语言和函数数(用go和python编写)。
注意事项
对于GRPC客户机和服务器,请遵循以下要求:
- 开始:使用
pb.NewServer
和pb.DialContext
。 - python:使用
lookout.sdk.grpc.create_server
和lookout.sdk.grpc.create_channel
。 - 支持RFC 3986 URI scheme;lookout sdk包括以下帮助程序:
- 开始:使用
pb.ToGoGrpcAddress
和pb.Listen
。 - python:使用
lookout.sdk.grpc.to_grpc_address
。
- 开始:使用
- 使用不安全连接:
- 目前lookout希望使用由
pb.DialContext
提供的不安全grpc连接。
- python:使用
server.add_insecure_port(address)
(example)运行服务器。
- 目前lookout希望使用由
数据服务
拨打数据服务时,您应该:
- 如果分析器在实际启动之前创建到数据服务器的连接,请启用gRPC Wait for Ready模式。这样,rpc排队,直到香奈儿准备好:
- golang:在事件时重置到数据服务器的连接回退:
如果保持与数据服务器的连接打开,则需要在分析器收到新事件时重置回退。在事件处理程序中使用^{
} 方法。重新部署后需要避免断开连接。在lookoutd
grpc服务器长时间重新启动的情况下,回退超时可能会增加很多,以至于分析器在向dataserver发出新请求之前无法重新连接。
贡献
欢迎捐款,非常感谢。
请参阅to our Contribution Guide了解更多详细信息。 source{d}拥有一个由开发人员和贡献者组成的令人惊叹的社区,他们对代码作为数据和/或代码的机器学习感兴趣。请加入我们! 源{d}项目下的所有活动都由source{d} code of conduct控制。 apache许可证2.0版,请参见LICENSE社区
行为准则
许可证
推荐PyPI第三方库