Legacy singbox protobuf gencode prevents further loading
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 42/100
Research direction
Reproduce the import failure in a python:3.13.2-alpine3.21 container using protobuf-5.28.3 without C descriptors. Start with xtlsapi/init.py, singbox_api/stats_pb2.py, and singbox_api/extensions_pb2.py from the traceback. Done means importing XrayClient succeeds in that environment while the singbox API remains available.
Written by the indexing model from the issue text.
Description
Describe the bug
Hi team hiddify,
It's an awesome xtlsapi you created. It works well on windows, but there were issues when I tried to deploy it on docker. I encountered the following problem in python:alpine container, causing the container to fail to start:
>>> from xtlsapi import XrayClient
Traceback (most recent call last):
File "<python-input-0>", line 1, in <module>
from xtlsapi import XrayClient
File "/usr/local/lib/python3.13/site-packages/xtlsapi/__init__.py", line 2, in <module>
from xtlsapi.client.SingboxClient import SingboxClient
File "/usr/local/lib/python3.13/site-packages/xtlsapi/client/SingboxClient.py", line 3, in <module>
from xtlsapi.singbox_api_services import APIService
File "/usr/local/lib/python3.13/site-packages/xtlsapi/singbox_api_services/__init__.py", line 1, in <module>
from .stats import StatsAPIService
File "/usr/local/lib/python3.13/site-packages/xtlsapi/singbox_api_services/stats/__init__.py", line 1, in <module>
from .get_client_upload_traffic import GetClientUploadTraffic
File "/usr/local/lib/python3.13/site-packages/xtlsapi/singbox_api_services/stats/get_client_upload_traffic.py", line 2, in <module>
from xtlsapi.singbox_api import stats_pb2
File "/usr/local/lib/python3.13/site-packages/xtlsapi/singbox_api/stats_pb2.py", line 14, in <module>
from . import extensions_pb2 as extensions__pb2
File "/usr/local/lib/python3.13/site-packages/xtlsapi/singbox_api/extensions_pb2.py", line 22, in <module>
google_dot_protobuf_dot_descriptor__pb2.MessageOptions.RegisterExtension(message_opt)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
AttributeError: type object 'MessageOptions' has no attribute 'RegisterExtension'
This seems to be related to https://github.com/mlflow/mlflow/issues/11811. Legacy singbox protobuf gencode prevents further loading when using protobuf without C descriptors, even if not singbox module is imported.
To Reproduce
It's easy to reproduce:
docker run -it python:alpine /bin/sh
pip install xtlsapi
from xtlsapi import XrayClient
Expected behavior
Upgrade singbox protobuf gencode, or lazy import singbox part.
Desktop (please complete the following information):
- docker image python:3.13.2-alpine3.21
- OS: Alpine Linux 3.21
- Python 3.13.2
- using protobuf without C descriptors, like protobuf-5.28.3-py3-none-any.whl
- Dominant language
- Python
- Stars
- 64
- Forks
- 20
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from hiddify/xtlsapi
-
bug help wanted
Difficulty 4/5 3-5 days Newbie friendliness 15/100
-
bug help wanted
Difficulty 3/5 1-2 days Newbie friendliness 48/100
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
-
enhancement question
Difficulty 4/5 3-5 days Newbie friendliness 35/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
Install the skills as a Claude Code pluginPossibly taken @ruban-24 claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 6 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
FAIRmat-NFDI/pynxtools#874 ·
-
Eval: PublicationOpendata
Difficulty 2/5 1-3 hours Newbie friendliness 66/100