GitHub API向けの新しいサードパーティPythonクライアント「ghapi」

ghapiの強力さと範囲の鍵は、GitHub APIのOpenAPI仕様です。OpenAPIはAPIの完全な機械可読仕様を提供する方法であり、それらのAPIにアクセスするライブラリの作成を自動化するために使用できます。12年の歴史と数千の機能をカバーするAPIを完全かつ正確に文書化したGitHub OpenAPI仕様の作成は、膨大な作業でした。この仕様を長期間にわたって研究してきた私は、その設計には多大な注意と思慮が払われていることがわかります。私は単一の欠落パラメータや単一のエラーにも遭遇していません。操作は合理的かつ一貫して命名されており、API全体が注意深く分類されています。 ghapiは、あらゆる言語における最初のGitHub OpenAPIライブラリの一つであり、Pythonの動的機能を完全に活用して、私たちがこれまでに見た他のREST APIライブラリでは実現できなかったことを可能にしています。例えば、ほとんどのOpenAPIライブラリは、仕様の各部分に対して個別のメソッドとデータ型を作成するためにコード生成を使用します。これは実験的なocto-goクライアントで採用されているアプローチです。この方法で用は足りますが、このようなコード生成は非常に冗長になる傾向があります。例えば、単一の操作グループ（リポジトリグループ）からのメソッドに対するocto-goラッパーは、約20,000行のコードになります！Goのような静的言語では、コンパイラにすべてのデータ型とすべての関数について知らせる必要があるため、選択肢は限られています。 一方、ghapiパッケージ全体は約40kBです！秘訣は、仕様から重要な情報を含むPythonモジュールを作成し、そのモジュールを参照してメソッドを動的に生成するクラスを書いたことです。これを機能させるには多くの巧妙な工夫が関わっており、これについては将来の投稿で詳しく説明します。 この投稿の執筆を手伝ってくれたRachel Thomasに感謝します。 ![](https://github.blog/wp-content/uploads/2020/12/3.png?w=420) ![](https://github.blog/wp-content/uploads/2020/12/4.png?w=310) ![](https://avatars2.githubusercontent.com/u/1483922?v=4&s=200)

GitHub API向けの新しいサードパーティPythonクライアント「ghapi」

背景や根拠まで確認しますか？

関連記事

調べる

選ぶ

サイト