# django-grpc
[](https://circleci.com/gh/gluk-w/django-grpc)
Easy way to launch gRPC server with access to Django ORM and other handy stuff.
gRPC calls are much faster that traditional HTTP requests because communicate over
persistent connection and are compressed. Underlying gRPC library is written in C which
makes it work faster than any RESTful framework where a lot of time is spent on serialization/deserialization.
Note that you need this project only if you want to use Django functionality in gRPC service.
For pure python implementation [read this](https://grpc.io/docs/languages/python/quickstart/)
* Supported Python: 3.4+
* Supported Django: 2.X, 3.X and 4.X
## Installation
```bash
pip install django-grpc
```
Update settings.py
```python
INSTALLED_APPS = [
# ...
'django_grpc',
]
GRPCSERVER = {
'servicers': ['dotted.path.to.callback.eg.grpc_hook'], # see `grpc_hook()` below
'interceptors': ['dotted.path.to.interceptor_class',], # optional, interceprots are similar to middleware in Django
'maximum_concurrent_rpcs': None,
'options': [("grpc.max_receive_message_length", 1024 * 1024 * 100)], # optional, list of key-value pairs to configure the channel. The full list of available channel arguments: https://grpc.github.io/grpc/core/group__grpc__arg__keys.html
'credentials': [{
'private_key': 'private_key.pem',
'certificate_chain': 'certificate_chain.pem'
}], # required only if SSL/TLS support is required to be enabled
'async': False # Default: False, if True then gRPC server will start in ASYNC mode
}
```
The callback that initializes "servicer" must look like following:
```python
import my_pb2
import my_pb2_grpc
def grpc_hook(server):
my_pb2_grpc.add_MYServicer_to_server(MYServicer(), server)
...
class MYServicer(my_pb2_grpc.MYServicer):
def GetPage(self, request, context):
response = my_pb2.PageResponse(title="Demo object")
return response
```
## Usage
```bash
python manage.py grpcserver
```
For developer's convenience add `--autoreload` flag during development.
## Signals
The package uses Django signals to allow decoupled applications get notified when some actions occur:
* `django_grpc.signals.grpc_request_started` - sent before gRPC server begins processing a request
* `django_grpc.signals.grpc_request_finished` - sent when gRPC server finishes delivering response to the client
* `django_grpc.signals.grpc_got_request_exception` - this signal is sent whenever RPC encounters an exception while
processing an incoming request.
Note that signal names are similar to Django's built-in signals, but have "grpc_" prefix.
## Serializers
There is an easy way to serialize django model to gRPC message using `django_grpc.serializers.serialize_model`.
## Helpers
### Ratelimits
You can limit number of requests to your procedures by using decorator `django_grpc.helpers.ratelimit.ratelimit`.
```python
from tests.sampleapp import helloworld_pb2_grpc, helloworld_pb2
from django_grpc.helpers import ratelimit
class Greeter(helloworld_pb2_grpc.GreeterServicer):
@ratelimit(max_calls=10, time_period=60)
def SayHello(self, request, context):
return helloworld_pb2.HelloReply(message='Hello, %s!' % request.name)
```
> When limit is reached for given time period decorator will abort with status `grpc.StatusCode.RESOURCE_EXHAUSTED`
As storage for state of calls [Django's cache framework](https://docs.djangoproject.com/en/4.0/topics/cache/#django-s-cache-framework)
is used. By default `"default"` cache system is used but you can specify any other in settings `RATELIMIT_USE_CACHE`
#### Advanced usage
Using groups
```python
@ratelimit(max_calls=10, time_period=60, group="main")
def foo(request, context):
...
@ratelimit(max_calls=5, time_period=60, group="main")
def bar(request, context):
...
```
`foo` and `bar` will share the same counter because they are in the same group
Using keys
```python
@ratelimit(max_calls=5, time_period=10, keys=["request:dot.path.to.field"])
@ratelimit(max_calls=5, time_period=10, keys=["metadata:user-agent"])
@ratelimit(max_calls=5, time_period=10, keys=[lambda request, context: context.peer()])
```
Right now 3 type of keys are supported with prefixes `"request:"`, `"metadata:"` and as callable.
- `"request:"` allows to extract request's field value by doted path
- `"metadata:"` allows to extract metadata from `context.invocation_metadata()`
- callable function that takes request and context and returns string
> NOTE: if value of key is empty string it still will be considered a valid value
> and can cause sharing of ratelimits between different RPCs in the same group
> TIP: To use the same configuration for different RPCs use dict variable
> ```python
> MAIN_GROUP = {"max_calls": 5, "time_period": 60, "group": "main"}
>
> @ratelimit(**MAIN_GROUP)
> def foo(request, context):
> ...
>
> @ratelimit(**MAIN_GROUP)
> def bar(request, context):
> ...
> ```
## Testing
Test your RPCs just like regular python methods which return some
structure or generator. You need to provide them with only 2 parameters:
request (protobuf structure or generator) and context (use `FakeServicerContext` from the example below).
### Fake Context
You can pass instance of `django_grpc_testtools.context.FakeServicerContext` to your gRPC method
to verify how it works with context (aborts, metadata and etc.).
```python
import grpc
from django_grpc_testtools.context import FakeServicerContext
from tests.sampleapp.servicer import Greeter
from tests.sampleapp.helloworld_pb2 import HelloRequest
servicer = Greeter()
context = FakeServicerContext()
request = HelloRequest(name='Tester')
# To check metadata set by RPC
response = servicer.SayHello(request, context)
assert context.get_trailing_metadata("Header1") == '...'
# To check status code
try:
servicer.SayHello(request, context)
except Exception:
pass
assert context.abort_status == grpc.StatusCode.INVALID_ARGUMENT
assert context.abort_message == 'Cannot say hello to John'
```
In addition to standard gRPC context methods, FakeServicerContext provides:
* `.set_invocation_metadata()` allows to simulate metadata from client to server.
* `.get_trailing_metadata()` to get metadata set by your server
* `.abort_status` and `.abort_message` to check if `.abort()` was called
Raw data
{
"_id": null,
"home_page": "https://github.com/gluk-w/django-grpc",
"name": "django-grpc",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "django-grpc",
"author": "Stan Misiurev",
"author_email": "smisiurev@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/fa/4f/e8ae5c97d508c047ebf23eacabf43538c4103c484d1a1e94c16d0f1d666c/django-grpc-1.0.21.tar.gz",
"platform": null,
"description": "# django-grpc\n\n[](https://circleci.com/gh/gluk-w/django-grpc)\n\n\nEasy way to launch gRPC server with access to Django ORM and other handy stuff.\ngRPC calls are much faster that traditional HTTP requests because communicate over\npersistent connection and are compressed. Underlying gRPC library is written in C which\nmakes it work faster than any RESTful framework where a lot of time is spent on serialization/deserialization.\n\nNote that you need this project only if you want to use Django functionality in gRPC service. \nFor pure python implementation [read this](https://grpc.io/docs/languages/python/quickstart/)\n\n* Supported Python: 3.4+\n* Supported Django: 2.X, 3.X and 4.X\n\n## Installation\n\n```bash\npip install django-grpc\n``` \n\nUpdate settings.py\n```python\nINSTALLED_APPS = [\n # ...\n 'django_grpc',\n]\n\nGRPCSERVER = {\n 'servicers': ['dotted.path.to.callback.eg.grpc_hook'], # see `grpc_hook()` below\n 'interceptors': ['dotted.path.to.interceptor_class',], # optional, interceprots are similar to middleware in Django\n 'maximum_concurrent_rpcs': None,\n 'options': [(\"grpc.max_receive_message_length\", 1024 * 1024 * 100)], # optional, list of key-value pairs to configure the channel. The full list of available channel arguments: https://grpc.github.io/grpc/core/group__grpc__arg__keys.html\n 'credentials': [{\n 'private_key': 'private_key.pem',\n 'certificate_chain': 'certificate_chain.pem'\n }], # required only if SSL/TLS support is required to be enabled\n 'async': False # Default: False, if True then gRPC server will start in ASYNC mode\n}\n```\n\nThe callback that initializes \"servicer\" must look like following:\n```python\nimport my_pb2\nimport my_pb2_grpc\n\ndef grpc_hook(server):\n my_pb2_grpc.add_MYServicer_to_server(MYServicer(), server)\n\n...\nclass MYServicer(my_pb2_grpc.MYServicer):\n\n def GetPage(self, request, context):\n response = my_pb2.PageResponse(title=\"Demo object\")\n return response\n```\n\n## Usage\n```bash\npython manage.py grpcserver\n```\n\nFor developer's convenience add `--autoreload` flag during development.\n\n\n## Signals\nThe package uses Django signals to allow decoupled applications get notified when some actions occur:\n* `django_grpc.signals.grpc_request_started` - sent before gRPC server begins processing a request\n* `django_grpc.signals.grpc_request_finished` - sent when gRPC server finishes delivering response to the client\n* `django_grpc.signals.grpc_got_request_exception` - this signal is sent whenever RPC encounters an exception while\nprocessing an incoming request.\n\nNote that signal names are similar to Django's built-in signals, but have \"grpc_\" prefix.\n\n\n## Serializers\nThere is an easy way to serialize django model to gRPC message using `django_grpc.serializers.serialize_model`.\n\n## Helpers\n\n### Ratelimits\n\nYou can limit number of requests to your procedures by using decorator `django_grpc.helpers.ratelimit.ratelimit`.\n\n```python\nfrom tests.sampleapp import helloworld_pb2_grpc, helloworld_pb2\nfrom django_grpc.helpers import ratelimit\n\n\nclass Greeter(helloworld_pb2_grpc.GreeterServicer):\n \n @ratelimit(max_calls=10, time_period=60)\n def SayHello(self, request, context):\n return helloworld_pb2.HelloReply(message='Hello, %s!' % request.name)\n```\n> When limit is reached for given time period decorator will abort with status `grpc.StatusCode.RESOURCE_EXHAUSTED`\n\nAs storage for state of calls [Django's cache framework](https://docs.djangoproject.com/en/4.0/topics/cache/#django-s-cache-framework)\nis used. By default `\"default\"` cache system is used but you can specify any other in settings `RATELIMIT_USE_CACHE`\n\n#### Advanced usage\n\nUsing groups\n```python\n@ratelimit(max_calls=10, time_period=60, group=\"main\")\ndef foo(request, context):\n ...\n\n@ratelimit(max_calls=5, time_period=60, group=\"main\")\ndef bar(request, context):\n ...\n```\n`foo` and `bar` will share the same counter because they are in the same group\n\nUsing keys\n```python\n@ratelimit(max_calls=5, time_period=10, keys=[\"request:dot.path.to.field\"])\n@ratelimit(max_calls=5, time_period=10, keys=[\"metadata:user-agent\"])\n@ratelimit(max_calls=5, time_period=10, keys=[lambda request, context: context.peer()])\n```\nRight now 3 type of keys are supported with prefixes `\"request:\"`, `\"metadata:\"` and as callable.\n\n- `\"request:\"` allows to extract request's field value by doted path\n- `\"metadata:\"` allows to extract metadata from `context.invocation_metadata()`\n- callable function that takes request and context and returns string\n\n> NOTE: if value of key is empty string it still will be considered a valid value\n> and can cause sharing of ratelimits between different RPCs in the same group\n\n> TIP: To use the same configuration for different RPCs use dict variable\n> ```python\n> MAIN_GROUP = {\"max_calls\": 5, \"time_period\": 60, \"group\": \"main\"}\n> \n> @ratelimit(**MAIN_GROUP)\n> def foo(request, context):\n> ...\n>\n> @ratelimit(**MAIN_GROUP)\n> def bar(request, context):\n> ...\n> ```\n\n\n## Testing\nTest your RPCs just like regular python methods which return some \nstructure or generator. You need to provide them with only 2 parameters:\nrequest (protobuf structure or generator) and context (use `FakeServicerContext` from the example below).\n\n### Fake Context\nYou can pass instance of `django_grpc_testtools.context.FakeServicerContext` to your gRPC method\nto verify how it works with context (aborts, metadata and etc.).\n```python\nimport grpc\nfrom django_grpc_testtools.context import FakeServicerContext\nfrom tests.sampleapp.servicer import Greeter\nfrom tests.sampleapp.helloworld_pb2 import HelloRequest\n\nservicer = Greeter()\ncontext = FakeServicerContext()\nrequest = HelloRequest(name='Tester')\n\n# To check metadata set by RPC \nresponse = servicer.SayHello(request, context)\nassert context.get_trailing_metadata(\"Header1\") == '...'\n\n# To check status code\ntry:\n servicer.SayHello(request, context) \nexcept Exception:\n pass\n\nassert context.abort_status == grpc.StatusCode.INVALID_ARGUMENT\nassert context.abort_message == 'Cannot say hello to John'\n```\n\nIn addition to standard gRPC context methods, FakeServicerContext provides:\n * `.set_invocation_metadata()` allows to simulate metadata from client to server.\n * `.get_trailing_metadata()` to get metadata set by your server\n * `.abort_status` and `.abort_message` to check if `.abort()` was called \n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Easy Django based gRPC service",
"version": "1.0.21",
"project_urls": {
"Homepage": "https://github.com/gluk-w/django-grpc"
},
"split_keywords": [
"django-grpc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3dd91657550a462b1d496997cb98894f4253afc2e56a756b500d5cead73cf355",
"md5": "18b30f0209036d92dc8c5f50ff28428f",
"sha256": "898cdc58267bdca61ff3686345921d761d7c91ee67a0b8947b2e470b07255d0e"
},
"downloads": -1,
"filename": "django_grpc-1.0.21-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "18b30f0209036d92dc8c5f50ff28428f",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 14984,
"upload_time": "2023-05-10T14:27:49",
"upload_time_iso_8601": "2023-05-10T14:27:49.231455Z",
"url": "https://files.pythonhosted.org/packages/3d/d9/1657550a462b1d496997cb98894f4253afc2e56a756b500d5cead73cf355/django_grpc-1.0.21-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fa4fe8ae5c97d508c047ebf23eacabf43538c4103c484d1a1e94c16d0f1d666c",
"md5": "3d785ff7129fca7db9eba038ccc31bc4",
"sha256": "87adcfb7a20e56a5d04f9c50b820ac95e2815fb31370aa7fa5f2385a61899613"
},
"downloads": -1,
"filename": "django-grpc-1.0.21.tar.gz",
"has_sig": false,
"md5_digest": "3d785ff7129fca7db9eba038ccc31bc4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 16858,
"upload_time": "2023-05-10T14:27:51",
"upload_time_iso_8601": "2023-05-10T14:27:51.504594Z",
"url": "https://files.pythonhosted.org/packages/fa/4f/e8ae5c97d508c047ebf23eacabf43538c4103c484d1a1e94c16d0f1d666c/django-grpc-1.0.21.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-10 14:27:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gluk-w",
"github_project": "django-grpc",
"travis_ci": true,
"coveralls": true,
"github_actions": false,
"circle": true,
"requirements": [],
"tox": true,
"lcname": "django-grpc"
}
JSON
