Added python gRPC API bindings by chinmaychahar · Pull Request #618 · dragonflyoss/api

chinmaychahar · 2026-02-01T05:37:09Z

This PR adds codegen Python gRPC bindings for Dragonfly APIs

Description

Added generated Python code from existing protobuf definitions
Added pyproject.toml for packaging
Added basic README

Related Issue

Motivation and Context

This API dependency package with generated Python gRPC code based on the existing .protoc files serves as step 1 for the Python SDK design

gaius-qi

Please remove v2 path => api/*.py

Copilot

Pull request overview

This PR adds Python gRPC API bindings for Dragonfly by generating Python code from existing protobuf definitions. This serves as the foundation (step 1) for a future Python SDK.

Changes:

Added generated Python gRPC stub files from protobuf definitions for scheduler, manager, dfdaemon, common, and errordetails APIs
Added pyproject.toml for Python package configuration with setuptools backend
Added basic README documenting the package

Reviewed changes

Copilot reviewed 12 out of 20 changed files in this pull request and generated 24 comments.

Show a summary per file

File	Description
python/pyproject.toml	Package configuration defining dependencies (grpcio, protobuf) and build system
python/api/v2/*.py	Generated Python gRPC stubs for v2 API (scheduler, manager, dfdaemon, common, errordetails)
python/api/v2/pycache/*.pyc	Compiled Python bytecode files (should NOT be committed)
python/README.md	Basic documentation for the package
.gitignore	Added .venv/ pattern for Python virtual environments

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-02T02:41:17Z

python/api/v2/scheduler_pb2_grpc.py

+        raise NotImplementedError('Method not implemented!')
+
+    def DeleteCachePeer(self, request, context):
+        """DeletCacheePeer releases cache peer in scheduler.


Typo in docstring: "DeletCacheePeer" should be "DeleteCachePeer" (remove the extra 'e'). This is auto-generated code from the protobuf definition, so the typo exists in the source .proto file and should be fixed there before regenerating.

Suggested change

"""DeletCacheePeer releases cache peer in scheduler.

"""DeleteCachePeer releases cache peer in scheduler.

Copilot · 2026-02-02T02:41:17Z

python/api/v2/manager_pb2_grpc.py

+        raise NotImplementedError('Method not implemented!')
+
+    def ListSeedPeers(self, request, context):
+        """List acitve schedulers configuration.


Typo in docstring: "acitve" should be "active". This appears twice (lines 98 and 133). This is auto-generated code from the protobuf definition, so the typo exists in the source .proto file and should be fixed there before regenerating.

Copilot · 2026-02-02T02:41:17Z

python/api/v2/manager_pb2_grpc.py

+        raise NotImplementedError('Method not implemented!')
+
+    def ListSchedulers(self, request, context):
+        """List acitve schedulers configuration.


Typo in docstring: "acitve" should be "active". This is the second occurrence of the same typo. This is auto-generated code from the protobuf definition, so the typo exists in the source .proto file and should be fixed there before regenerating.

Copilot · 2026-02-02T02:41:18Z

python/README.md

+## Python Dragonfly API
+
+Generated Python gRPC bindings for Dragonfly.
+
+Source protos in https://github.com/dragonflyoss/api
+


The Python package is missing essential metadata and configuration files. Consider adding: 1) A MANIFEST.in file to ensure non-Python files (like README.md) are included in distributions, 2) Package metadata fields in pyproject.toml (authors, license, repository URL, etc.), 3) A way to specify which packages to include (either explicitly listing them or using [tool.setuptools.packages.find]). Without these, the package may not install or distribute correctly.

Copilot · 2026-02-02T02:41:18Z

python/pyproject.toml

+]
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"


The pyproject.toml is missing several important metadata fields for a proper Python package distribution: 'authors', 'readme', 'license', 'homepage', and 'repository'. Additionally, the package should specify 'packages' or use a proper package discovery mechanism to ensure the API modules are included in the distribution. Consider adding: authors = [{name = "...", email = "..."}], readme = "README.md", license = {text = "..."}, and [tool.setuptools.packages.find] to automatically discover packages.

Suggested change

]

[build-system]

requires = ["setuptools"]

build-backend = "setuptools.build_meta"

]

authors = [

{ name = "Your Name", email = "you@example.com" },

]

readme = "README.md"

license = { text = "Proprietary" }

[project.urls]

homepage = "https://example.com/dragonfly-api"

repository = "https://example.com/dragonfly-api/repository"

[build-system]

requires = ["setuptools"]

build-backend = "setuptools.build_meta"

[tool.setuptools.packages.find]

include = ["dragonfly_api*"]

Copilot · 2026-02-02T02:41:22Z

python/api/v2/scheduler_pb2.py

+
+
+from . import common_pb2 as common__pb2
+from . import errordetails_pb2 as errordetails__pb2


Import of 'errordetails__pb2' is not used.

Suggested change

from . import errordetails_pb2 as errordetails__pb2

Copilot · 2026-02-02T02:41:22Z

python/api/v2/scheduler_pb2.py

+
+from . import common_pb2 as common__pb2
+from . import errordetails_pb2 as errordetails__pb2
+from google.protobuf import duration_pb2 as google_dot_protobuf_dot_duration__pb2


Import of 'google_dot_protobuf_dot_duration__pb2' is not used.

Copilot · 2026-02-02T02:41:22Z

python/api/v2/scheduler_pb2.py

+from . import common_pb2 as common__pb2
+from . import errordetails_pb2 as errordetails__pb2
+from google.protobuf import duration_pb2 as google_dot_protobuf_dot_duration__pb2
+from google.protobuf import empty_pb2 as google_dot_protobuf_dot_empty__pb2


Import of 'google_dot_protobuf_dot_empty__pb2' is not used.

Copilot · 2026-02-02T02:41:23Z

python/api/v2/scheduler_pb2.py

+from . import errordetails_pb2 as errordetails__pb2
+from google.protobuf import duration_pb2 as google_dot_protobuf_dot_duration__pb2
+from google.protobuf import empty_pb2 as google_dot_protobuf_dot_empty__pb2
+from google.protobuf import timestamp_pb2 as google_dot_protobuf_dot_timestamp__pb2


Import of 'google_dot_protobuf_dot_timestamp__pb2' is not used.

Suggested change

from google.protobuf import timestamp_pb2 as google_dot_protobuf_dot_timestamp__pb2

Copilot · 2026-02-02T02:41:23Z

python/api/v2/scheduler_pb2_grpc.py

+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+import warnings


Import of 'warnings' is not used.

Suggested change

import warnings

gaius-qi

Please generate code by namely/protoc-all, refer to https://github.com/dragonflyoss/api/blob/main/hack/protoc.sh.

Added python gRPC API bindings

be924aa

gaius-qi requested a review from Copilot February 2, 2026 02:35

Copilot started reviewing on behalf of gaius-qi February 2, 2026 02:35 View session

gaius-qi requested changes Feb 2, 2026

View reviewed changes

Copilot AI reviewed Feb 2, 2026

View reviewed changes

gaius-qi requested changes Feb 2, 2026

View reviewed changes

	"""DeletCacheePeer releases cache peer in scheduler.
	"""DeleteCachePeer releases cache peer in scheduler.

-]
-[build-system]
-requires = ["setuptools"]
-build-backend = "setuptools.build_meta"
+]
+authors = [
+  { name = "Your Name", email = "you@example.com" },
+]
+readme = "README.md"
+license = { text = "Proprietary" }
+[project.urls]
+homepage = "https://example.com/dragonfly-api"
+repository = "https://example.com/dragonfly-api/repository"
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+[tool.setuptools.packages.find]
+include = ["dragonfly_api*"]



		from . import common_pb2 as common__pb2
		from . import errordetails_pb2 as errordetails__pb2

Conversation

chinmaychahar commented Feb 1, 2026

Description

Related Issue

Motivation and Context

Uh oh!

gaius-qi left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

gaius-qi left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants