Python-3xui 0.0.8__tar.gz → 0.0.8.post1__tar.gz

{python_3xui-0.0.8 → python_3xui-0.0.8.post1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Python-3xui
-Version: 0.0.8
+Version: 0.0.8.post1
 Summary: 3x-ui wrapper for python
 Project-URL: Homepage, https://github.com/Artem-Potapov/3x-py
 Project-URL: Issues, https://github.com/Artem-Potapov/3x-py/issues
@@ -28,9 +28,7 @@ Description-Content-Type: text/markdown
 <p>I'm not expecting much to be honest, so please feel free to fork it if I abandon the project and you need it!</p>
 <p>Also, if you REALLY want it I can give you the ownership if I step down, you can find my email in the pyproject.toml (I don't check it that much but trust me I do)</p>
 
-<h2>0.0.8 Release Notes</h2>
+<h2>0.0.81 Release Notes</h2>
 <ul>
-<li>Improve create_and_add_prod_client to have an expiry_time</li>
-<li>delete_client_by_tgid_all_inbounds -> revoke_client_by_tgid_all_inbounds</li>
-<li>Change vulnerable requirements</li>
+<li>Minor change: make custom sub generators available instead of the default one</li>
 </ul>

{python_3xui-0.0.8 → python_3xui-0.0.8.post1}/README.md

@@ -2,9 +2,7 @@
 <p>I'm not expecting much to be honest, so please feel free to fork it if I abandon the project and you need it!</p>
 <p>Also, if you REALLY want it I can give you the ownership if I step down, you can find my email in the pyproject.toml (I don't check it that much but trust me I do)</p>
 
-<h2>0.0.8 Release Notes</h2>
+<h2>0.0.81 Release Notes</h2>
 <ul>
-<li>Improve create_and_add_prod_client to have an expiry_time</li>
-<li>delete_client_by_tgid_all_inbounds -> revoke_client_by_tgid_all_inbounds</li>
-<li>Change vulnerable requirements</li>
+<li>Minor change: make custom sub generators available instead of the default one</li>
 </ul>

{python_3xui-0.0.8 → python_3xui-0.0.8.post1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "Python-3xui"
-version = "0.0.8"
+version = "0.0.8r1"
 authors = [
   { name="JustMe_001", email="justme001.causation755@passinbox.com" },
 ]
@@ -56,4 +56,4 @@ exclude = [
 
 
 [[tool.hatch.envs.hatch-test.matrix]]
-python = ["3.12", "3.11"]
+python = ["3.13", "3.12", "3.11"]

{python_3xui-0.0.8 → python_3xui-0.0.8.post1}/python_3xui/api.py

@@ -3,8 +3,9 @@ import logging
 import re
 import time
 from collections.abc import Sequence, Mapping
+from inspect import isawaitable
 from logging import DEBUG
-from typing import Self, Optional, Dict, Iterable, AsyncIterable, Type, Union, Any, List, Tuple, Literal
+from typing import Self, Optional, Dict, Iterable, AsyncIterable, Type, Union, Any, List, Tuple, Literal, Callable, Awaitable, Coroutine
 from datetime import datetime, UTC
 
 import pyotp
@@ -67,7 +68,9 @@ class XUIClient:
     def __init__(self, base_website: str, base_port: int, base_path: str,
                  *, username: str | None = None, password: str | None = None,
                  two_fac_code: str | None = None, session_duration: int = 3600,
-                 custom_prod_string: str = "testing") -> None:
+                 custom_prod_string: str = "testing",
+                 custom_sub_generator: Callable[[int], str]|Callable[[int], Awaitable[str]] = util.default_sub_from_tgid
+                 ) -> None:
         """Initialize the XUIClient.
 
         Args:
@@ -95,6 +98,7 @@ class XUIClient:
         self.totp: pyotp.TOTP | None = None
         self.max_retries: int = 5
         self.retry_delay: int = 1
+        self.sub_gen = custom_sub_generator
         # endpoints
         self.server_end = endpoints.Server(self)
         self.clients_end = endpoints.Clients(self)
@@ -421,6 +425,11 @@ class XUIClient:
         production_inbounds: List[Inbound] = await self.get_production_inbounds()
 
         tasks = []
+        custom_sub: str
+        if isawaitable(self.sub_gen(telegram_id)):
+            custom_sub = await self.sub_gen(telegram_id)
+        else:
+            custom_sub = self.sub_gen(telegram_id)
         for inb in production_inbounds:
             tmp_email = util.generate_email_from_tgid_inbid(telegram_id, inb.id)
             client = SingleInboundClient.model_construct(
@@ -429,7 +438,7 @@ class XUIClient:
                 email=tmp_email,
                 limit_gb=0,
                 enable=True,
-                subscription_id=util.sub_from_tgid(telegram_id),
+                subscription_id=custom_sub,
                 comment=f"{additional_remark}, created at {datetime.now(UTC)}",
                 expiry_time=expiry_time * 1000
             )
@@ -460,15 +469,15 @@ class XUIClient:
         Args:
             telegram_id: The Telegram ID of the client
             inbound_id: The ID of the inbound where the client exists
-            security: Client security setting
-            password: Client password
-            flow: VLESS flow type
-            limit_ip: IP connection limit
-            limit_gb: Data limit in GB
-            expiry_time: Client expiry time (UNIX timestamp)
-            enable: Whether the client is enabled
-            sub_id: Subscription ID
-            comment: Client comment/note
+            security: Client security setting (optional)
+            password: Client password (optional)
+            flow: VLESS flow type (optional)
+            limit_ip: IP connection limit (optional)
+            limit_gb: Data limit in GB (optional)
+            expiry_time: Client expiry time (UNIX timestamp) (optional)
+            enable: Whether the client is enabled (optional)
+            sub_id: Subscription ID (optional)
+            comment: Client comment/note (optional)
 
         Returns:
             Response from the API

{python_3xui-0.0.8 → python_3xui-0.0.8.post1}/python_3xui/util.py

@@ -79,7 +79,7 @@ def base64_from_string(string: str, omit_trailing_equals: bool = False) -> str:
     return base64.b64encode(bytes(str(string).encode("utf-8"))).decode()
 
 
-def sub_from_tgid(telegram_id: int) -> str:
+def default_sub_from_tgid(telegram_id: int) -> str:
     """Generate a subscription ID from a Telegram ID.
 
     Args:

{python_3xui-0.0.8 → python_3xui-0.0.8.post1}/tests/test_non_idempotent_endpoints_clients.py

@@ -8,7 +8,7 @@ from pydantic import ValidationError
 
 from python_3xui.api import XUIClient
 from python_3xui.models import SingleInboundClient, ClientStats
-from python_3xui.util import get_uuid_from_tgid, sub_from_tgid, s_to_ms_timestamp, datetime_now_ms, generate_email_from_tgid_inbid, \
+from python_3xui.util import get_uuid_from_tgid, s_to_ms_timestamp, datetime_now_ms, generate_email_from_tgid_inbid, \
     generate_random_email
 
 
@@ -72,7 +72,7 @@ class TestClientsEndpoint:
             expiryTime=timestamp + 86400*1000,  # Using alias 'expiryTime' for 'expiry_time'
             enable=True,
             tgId="",  # Using alias 'tgId' for 'tg_id'
-            subId=sub_from_tgid(TestClientsEndpoint.test_telegram_id),  # Using alias 'subId' for 'subscription_id'
+            subId=xui_client.sub_gen(TestClientsEndpoint.test_telegram_id),  # Using alias 'subId' for 'subscription_id'
             comment=f"Test client created at {timestamp}, TEST SUITE",
             created_at=timestamp,
             updated_at=timestamp