Legacy singbox protobuf gencode prevents further loading

Open
#9 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
42/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
docker, python
Domain
backend, devops

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

bug help wanted

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

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from hiddify/xtlsapi

All issues in hiddify/xtlsapi

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.