{"id":15014253,"url":"https://github.com/ruanhao/py-netty","last_synced_at":"2026-01-07T23:03:40.081Z","repository":{"id":195004730,"uuid":"692091619","full_name":"ruanhao/py-netty","owner":"ruanhao","description":"TCP framework in flavor of  Netty","archived":false,"fork":false,"pushed_at":"2024-07-29T13:19:05.000Z","size":8038,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-19T21:06:42.823Z","etag":null,"topics":["epoll","event-driven","netty","tcp","tcp-server"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ruanhao.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-15T14:38:06.000Z","updated_at":"2025-03-03T11:59:16.000Z","dependencies_parsed_at":"2023-09-28T10:03:01.593Z","dependency_job_id":"a3737676-6158-4acb-af5b-a340f36fbf30","html_url":"https://github.com/ruanhao/py-netty","commit_stats":{"total_commits":61,"total_committers":1,"mean_commits":61.0,"dds":0.0,"last_synced_commit":"7a15801ea15ead2258c58ebcbaf7ccb7b89c91e2"},"previous_names":["ruanhao/py-netty"],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruanhao%2Fpy-netty","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruanhao%2Fpy-netty/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruanhao%2Fpy-netty/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ruanhao%2Fpy-netty/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ruanhao","download_url":"https://codeload.github.com/ruanhao/py-netty/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246223267,"owners_count":20743158,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["epoll","event-driven","netty","tcp","tcp-server"],"created_at":"2024-09-24T19:45:22.645Z","updated_at":"2026-01-07T23:03:35.048Z","avatar_url":"https://github.com/ruanhao.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# py-netty :rocket:\n\nAn event-driven TCP networking framework.\n\nIdeas and concepts under the hood are build upon those of [Netty](https://netty.io/), especially the IO and executor model.\n\nAPIs are intuitive to use if you are a Netty alcoholic.\n\n\n# Features\n\n- callback based application invocation\n- non blocking IO\n- recv/write is performed only in IO thread\n- adaptive read buffer \n- low/higher water mark to indicate writability (default low water mark is 32K and high water mark is 64K)\n- all platform supported (linux: epoll, mac: kqueue, windows: select)\n\n## Installation\n\n```bash\npip install py-netty\n```\n\n## Getting Started\n\nStart an echo server:\n\n```python\nfrom py_netty import ServerBootstrap\nServerBootstrap().bind(address='0.0.0.0', port=8080).close_future().sync()\n```\n\nStart an echo server (TLS):\n\n```python\nfrom py_netty import ServerBootstrap\nServerBootstrap(certfile='/path/to/cert/file', keyfile='/path/to/cert/file').bind(address='0.0.0.0', port=9443).close_future().sync()\n```\n\nAs TCP client:\n\n```python\nfrom py_netty import Bootstrap, ChannelHandlerAdapter\n\n\nclass HttpHandler(ChannelHandlerAdapter):\n    def channel_read(self, ctx, buffer):\n        print(buffer.decode('utf-8'))\n        \n\nremote_address, remote_port = 'www.google.com', 80\nb = Bootstrap(handler_initializer=HttpHandler)\nchannel = b.connect(remote_address, remote_port).sync().channel()\nrequest = f'GET / HTTP/1.1\\r\\nHost: {remote_address}\\r\\n\\r\\n'\nchannel.write(request.encode('utf-8'))\ninput() # pause\nchannel.close()\n```\n\n\nAs TCP client (TLS):\n\n```python\nfrom py_netty import Bootstrap, ChannelHandlerAdapter\n\n\nclass HttpHandler(ChannelHandlerAdapter):\n    def channel_read(self, ctx, buffer):\n        print(buffer.decode('utf-8'))\n        \n\nremote_address, remote_port = 'www.google.com', 443\nb = Bootstrap(handler_initializer=HttpHandler, tls=True, verify=True)\nchannel = b.connect(remote_address, remote_port).sync().channel()\nrequest = f'GET / HTTP/1.1\\r\\nHost: {remote_address}\\r\\n\\r\\n'\nchannel.write(request.encode('utf-8'))\ninput() # pause\nchannel.close()\n```\n\nTCP port forwarding:\n\n```python\nfrom py_netty import ServerBootstrap, Bootstrap, ChannelHandlerAdapter, EventLoopGroup\n\n\nclass ProxyChannelHandler(ChannelHandlerAdapter):\n\n    def __init__(self, remote_host, remote_port, client_eventloop_group):\n        self._remote_host = remote_host\n        self._remote_port = remote_port\n        self._client_eventloop_group = client_eventloop_group\n        self._client = None\n\n    def _client_channel(self, ctx0):\n\n        class __ChannelHandler(ChannelHandlerAdapter):\n            def channel_read(self, ctx, bytebuf):\n                ctx0.write(bytebuf)\n\n            def channel_inactive(self, ctx):\n                ctx0.close()\n\n        if self._client is None:\n            self._client = Bootstrap(\n                eventloop_group=self._client_eventloop_group,\n                handler_initializer=__ChannelHandler\n            ).connect(self._remote_host, self._remote_port).sync().channel()\n        return self._client\n\n    def exception_caught(self, ctx, exception):\n        ctx.close()\n\n    def channel_read(self, ctx, bytebuf):\n        self._client_channel(ctx).write(bytebuf)\n\n    def channel_inactive(self, ctx):\n        if self._client:\n            self._client.close()\n\n\nproxied_server, proxied_port = 'www.google.com', 443\nclient_eventloop_group = EventLoopGroup(1, 'ClientEventloopGroup')\nsb = ServerBootstrap(\n    parant_group=EventLoopGroup(1, 'Acceptor'),\n    child_group=EventLoopGroup(1, 'Worker'),\n    child_handler_initializer=lambda: ProxyChannelHandler(proxied_server, proxied_port, client_eventloop_group)\n)\nsb.bind(port=8443).close_future().sync()\n```\n\n## Event-driven callbacks\n\nCreate handler with callbacks for interested events:\n\n``` python\nfrom py_netty import ChannelHandlerAdapter\n\n\nclass MyChannelHandler(ChannelHandlerAdapter):\n    def channel_active(self, ctx: 'ChannelHandlerContext') -\u003e None:\n        # invoked when channel is active (TCP connection ready)\n        pass\n\n    def channel_read(self, ctx: 'ChannelHandlerContext', msg: Union[bytes, socket.socket]) -\u003e None:\n        # invoked when there is data ready to process\n        pass\n\n    def channel_inactive(self, ctx: 'ChannelHandlerContext') -\u003e None:\n        # invoked when channel is inactive (TCP connection is broken)\n        pass\n\n    def channel_registered(self, ctx: 'ChannelHandlerContext') -\u003e None:\n        # invoked when the channel is registered with a eventloop\n        pass\n\n    def channel_unregistered(self, ctx: 'ChannelHandlerContext') -\u003e None:\n        # invoked when the channel is unregistered from a eventloop\n        pass\n\n    def channel_handshake_complete(self, ctx: 'ChannelHandlerContext') -\u003e None:\n        # invoked when ssl handshake is complete, this only applies to client side\n        pass\n\n    def channel_writability_changed(self, ctx: 'ChannelHandlerContext') -\u003e None:\n        # invoked when pending data \u003e high water mark or \u003c low water mark\n        pass\n\n    def exception_caught(self, ctx: 'ChannelHandlerContext', exception: Exception) -\u003e None:\n        # invoked when there is any exception raised during process\n        pass\n```\n\n\n## Benchmark\n\nTest is performed using echo client/server mechanism on a 1-Core 2.0GHz Intel(R) Xeon(R) Platinum 8452Y with 4GB memory, Ubuntu 22.04.\n(Please see `bm_echo_server.py` for details.)\n\n3 methods are tested: \n1. BIO (Traditional thread based blocking IO)\n2. Asyncio (Python built-in async IO)\n3. NIO (py-netty with 1 eventloop)\n\n3 metrics are collected:\n1. Throughput (of each connection) to indicate overall stability\n2. Average throughput (of all connections) to indicate overall performance\n3. Ramp up time (seconds consumed after all connections established) to indicate responsiveness\n\n### Case 1: Concurrent 64 connections with 32K/s \n![Throughput](https://raw.githubusercontent.com/ruanhao/py-netty/master/img/64_concurrent_32K_throuput.png)\n![Average Speed](https://raw.githubusercontent.com/ruanhao/py-netty/master/img/64_concurrent_32K_average.png)\n![Ramp Up Time](https://raw.githubusercontent.com/ruanhao/py-netty/master/img/64_concurrent_32K_rampup.png)\n\n### Case 2: Concurrent 64 connections with 4M/s \n![Throughput](https://raw.githubusercontent.com/ruanhao/py-netty/master/img/64_concurrent_4M_throuput.png)\n![Average Speed](https://raw.githubusercontent.com/ruanhao/py-netty/master/img/64_concurrent_4M_average.png)\n![Ramp Up Time](https://raw.githubusercontent.com/ruanhao/py-netty/master/img/64_concurrent_4M_rampup.png)\n\n### Case 3: Concurrent 128 connections with 4M/s \n![Throughput](https://raw.githubusercontent.com/ruanhao/py-netty/master/img/128_concurrent_4M_throuput.png)\n![Average Speed](https://raw.githubusercontent.com/ruanhao/py-netty/master/img/128_concurrent_4M_average.png)\n![Ramp Up Time](https://raw.githubusercontent.com/ruanhao/py-netty/master/img/128_concurrent_4M_rampup.png)\n\n### Case 4: Concurrent 128 connections with 8M/s \n![Throughput](https://raw.githubusercontent.com/ruanhao/py-netty/master/img/128_concurrent_8M_throuput.png)\n![Average Speed](https://raw.githubusercontent.com/ruanhao/py-netty/master/img/128_concurrent_8M_average.png)\n![Ramp Up Time](https://raw.githubusercontent.com/ruanhao/py-netty/master/img/128_concurrent_8M_rampup.png)\n\n\n### Case 5: Concurrent 256 connections with 8M/s \n![Throughput](https://raw.githubusercontent.com/ruanhao/py-netty/master/img/256_concurrent_8M_throuput.png)\n![Average Speed](https://raw.githubusercontent.com/ruanhao/py-netty/master/img/256_concurrent_8M_average.png)\n![Ramp Up Time](https://raw.githubusercontent.com/ruanhao/py-netty/master/img/256_concurrent_8M_rampup.png)\n\n### CPU Usage\n![32K/s](https://raw.githubusercontent.com/ruanhao/py-netty/master/img/cpu_usage_32k.png)\n![2M/s](https://raw.githubusercontent.com/ruanhao/py-netty/master/img/cpu_usage_2m.png)\n\n## Caveats\n\n- No pipeline, supports only one handler FOR NOW\n- No batteries-included codecs FOR NOW\n- No pool or refcnt for bytes buffer, bytes objects are created and consumed at your disposal\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fruanhao%2Fpy-netty","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fruanhao%2Fpy-netty","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fruanhao%2Fpy-netty/lists"}