PyPI - Python-3xui - Versions diffs - 0.0.5__tar.gz → 0.0.7__tar.gz - Mend

Python-3xui 0.0.5tar.gz → 0.0.7tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (19) hide show

{python_3xui-0.0.5 → python_3xui-0.0.7}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Python-3xui
-Version: 0.0.5
+Version: 0.0.7
 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
@@ -24,16 +24,13 @@ Requires-Dist: pytest-dependency; extra == 'testing'
 Requires-Dist: requests; extra == 'testing'
 Description-Content-Type: text/markdown
-<head>
-<title>Readme</title>
-<style>
-.welcome {
-color: rgb(1, 170, 170)
-}
-</style>
-</head>
-<h1 class="welcome">Hi! This is my example python 3x-ui wrapper!</h1>
+<h1>Hi! This is my example python 3x-ui wrapper!</h1>
 <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>
+<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.7 Release Notes</h2>
+<ul>
+<li>Purge prints and replace them with logging (except when absolutely needed)</li>
+<li>Make prod_string regEx</li>
+<li>Change the test suite</li>
+</ul>

python_3xui-0.0.7/README.md ADDED Viewed

@@ -0,0 +1,10 @@
+<h1>Hi! This is my example python 3x-ui wrapper!</h1>
+<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.7 Release Notes</h2>
+<ul>
+<li>Purge prints and replace them with logging (except when absolutely needed)</li>
+<li>Make prod_string regEx</li>
+<li>Change the test suite</li>
+</ul>

{python_3xui-0.0.5 → python_3xui-0.0.7}/pyproject.toml RENAMED Viewed

@@ -1,6 +1,6 @@
 [project]
 name = "Python-3xui"
-version = "0.0.5"
+version = "0.0.7"
 authors = [
   { name="JustMe_001", email="justme001.causation755@passinbox.com" },
 ]

{python_3xui-0.0.5 → python_3xui-0.0.7}/python_3xui/api.py RENAMED Viewed

@@ -1,5 +1,8 @@
+import logging
+import re
 import time
 from collections.abc import Sequence, Mapping
+from logging import DEBUG
 from typing import Self, Optional, Dict, Iterable, AsyncIterable, Type, Union, Any, List, Tuple, Literal
 from datetime import datetime, UTC
@@ -77,7 +80,7 @@ class XUIClient:
         """
         from . import endpoints # look, I know it's bad, but we need to evade cyclical imports
         self.connected: bool = False
-        self.PROD_STRING = custom_prod_string
+        self.PROD_STRING = re.compile(custom_prod_string)
         self.session: AsyncClient | None = None
         self.base_host: str = base_website
         self.base_port: int = base_port
@@ -105,23 +108,6 @@ class XUIClient:
             else:
                 self.totp = pyotp.TOTP(self.two_fac_secret)
-    #========================singleton pattern========================
-    def __new__(cls, *args, **kwargs):
-        """Create or return the singleton instance.
-        Args:
-            *args: Positional arguments passed to __init__.
-            **kwargs: Keyword arguments passed to __init__.
-        Returns:
-            The singleton XUIClient instance.
-        """
-        print("initializing client")
-        if cls._instance is None:
-            print("nu instance")
-            cls._instance = super(XUIClient, cls).__new__(cls)
-        return cls._instance
     #========================request stuffs========================
     async def _safe_request(self,
                             method: Literal["get", "post", "patch", "delete", "put"],
@@ -141,20 +127,21 @@ class XUIClient:
         Raises:
             RuntimeError: If max retries exceeded or session is invalid.
         """
-        print(f"SAFE REQUEST, {method}, is running to a URL of {kwargs["url"]}")
-        print(str(self.session.base_url) + str(kwargs["url"]))
+        logging.debug("Safe request is running to %s%s", str(self.session.base_url), str(kwargs["url"]))
         async for attempt in async_range(self.max_retries):
             resp = await self.session.request(method=method, **kwargs)
             if resp.status_code // 100 != 2:  #because it can return either 201 or 202
                 if resp.status_code == 404:
                     now: float = datetime.now(UTC).timestamp()
                     if self.session_start is None or now - self.session_start > self.session_duration:
-                        print("Guys, we're not logged in, fixing that rn")
+                        logging.info("Client with IP/Domain %s is not logged in, logging in...", self.base_host)
                         await self.login()
                         continue
                     else:
+                        logging.error("Server returned a status code of %s with a valid session", resp.status_code)
                         raise RuntimeError("""Server returned a 404, and the session should still be valid, likely it's a REAL 404""")
                 else:
+                    logging.error("Server returned a status code of %s", resp.status_code)
                     raise RuntimeError(f"Wrong status code: {resp.status_code}")
             status = await util.check_xui_response_validity(resp)
@@ -264,15 +251,14 @@ class XUIClient:
             "password": self.xui_password,
         }
         if self.totp:
-            if self.totp.interval - datetime.now().timestamp() % self.totp.interval < 1:
-                await asyncio.sleep(1.1) # just to not submit an invalid code
+            if self.totp.interval - datetime.now().timestamp() % self.totp.interval < 3:
+                await asyncio.sleep(3.1) # just to not submit an invalid code
             payload["twoFactorCode"] = self.totp.now()
         else:
             if self.two_fac_secret:
                 payload["twoFactorCode"] = self.two_fac_secret
-        print(self.session.base_url)
-        print("WE'RE LOGGING IN")
+        logging.info("Client is logging in with IP/Domain: %s", self.base_host)
         resp = await self.session.post("/login", data=payload)
         if resp.status_code == 200:
             resp_json = resp.json()
@@ -292,6 +278,7 @@ class XUIClient:
         Returns:
             Self: The XUIClient instance.
         """
+        logging.log(DEBUG, "Client connected with IP/domain %s", self.base_url)
         self.session = AsyncClient(base_url=self.base_url)
         self.connected = True
         return self
@@ -330,7 +317,13 @@ class XUIClient:
             exc_val: The exception value, if an exception occurred.
             exc_tb: The exception traceback, if an exception occurred.
         """
-        print("disconnectin'")
+        if exc_type is None:
+            logging.info("Client is disconnecting at time with IP/Domain %s", self.base_host)
+        else:
+            logging.warning("Client is disconnecting due to an error (may be unrelated):"
+                            "\n%s, with value %s\nStacktrace:%s",
+                            exc_type, exc_val, exc_tb)
+        print(f"Client is disconnecting: {self.base_host}")
         await self.disconnect()
         return
@@ -351,8 +344,7 @@ class XUIClient:
         inbounds = await self.inbounds_end.get_all()
         usable_inbounds: list[Inbound] = []
         for inb in inbounds:
-            #TODO: make prod_strings regex instead of STR
-            if self.PROD_STRING.lower() in inb.remark.lower():
+            if self.PROD_STRING.search(inb.remark):
                 usable_inbounds.append(inb)
         if len(usable_inbounds) == 0:
             raise RuntimeError("No production inbounds found! Change prod_string!")
@@ -371,12 +363,9 @@ class XUIClient:
             timer from 5 to 60*60*24 in the code.
         """
         while self.connected:
-            print("You're seeing this message because I forgot to remove it in api.update_inbounds() !")
-            print("Please change the timer from 5 to 60*60*24!")
             self.get_production_inbounds.cache_clear()
             await self.get_production_inbounds() #fill the cache
-            await asyncio.sleep(10)
-            #print(stat)
+            await asyncio.sleep(3600) #update every 1h
     #========================clients management========================
     async def get_client_with_tgid(self, tgid: int, inbound_id: int | None = None) -> List[ClientStats]:
@@ -513,7 +502,7 @@ class XUIClient:
             email = util.generate_email_from_tgid_inbid(telegram_id, inbound.id)
             resp = await self.clients_end.delete_client_by_email(email, inbound.id)
             responses.append(resp)
-        print("Inbound deleted")
+        logging.info("Clients of of tgid %s deleted", telegram_id)
         return responses

{python_3xui-0.0.5 → python_3xui-0.0.7}/python_3xui/base_model.py RENAMED Viewed

@@ -27,9 +27,9 @@ class BaseModel(pydantic.BaseModel):
     model_config = pydantic.ConfigDict(ignored_types=(cached_property, ))
-    def model_post_init(self, context: Any, /) -> None:
-        #print(f"Model {self.__class__}, {self} initialized")
-        ...
+    # def model_post_init(self, context: Any, /) -> None:
+    #     #print(f"Model {self.__class__}, {self} initialized")
+    #     ...
     @classmethod

{python_3xui-0.0.5 → python_3xui-0.0.7}/python_3xui/endpoints.py RENAMED Viewed

@@ -1,4 +1,5 @@
 import json
+import logging
 from datetime import datetime, UTC
 from typing import Generic, Literal, List, Dict
@@ -232,17 +233,9 @@ class Clients(BaseEndpoint):
         else:
             raise TypeError
         # send request
-        print(type(final))
-        print(final)
         data = final.model_dump(by_alias=True)
-        print(type(data))
-        print(json.dumps(data))
-        print(f"{self._url}{endpoint}")
         resp = await self.client.safe_post(f"{self._url}{endpoint}", data=data)
         #YOU NEED TO PASS SETTINGS AS A STRING, NOT AS A DICT, YOU FUCKING DUMBASS!
-        print(resp)
-        print(resp.json())
         return resp
     async def _request_update_client(self, client: models.InboundClients | models.SingleInboundClient,

{python_3xui-0.0.5 → python_3xui-0.0.7}/python_3xui/models.py RENAMED Viewed

@@ -1,13 +1,12 @@
 import json
-from types import NoneType
 from datetime import datetime, UTC
-from typing import Union, Optional, TypeAlias, Any, Annotated, Literal, List, Dict, ClassVar
+from typing import Union, TypeAlias, Any, Annotated, Literal, List, Dict, ClassVar
-from pydantic import field_validator, Field, field_serializer, AfterValidator
 import pydantic
+from pydantic import field_validator, Field, field_serializer
 from . import base_model
-from .util import JsonType, auto_s_to_ms_timestamp, s_to_ms_timestamp, ms_to_s_timestamp, auto_ms_to_s_timestamp
+from .util import JsonType, auto_s_to_ms_timestamp, auto_ms_to_s_timestamp
 timestamp_seconds: TypeAlias = int
 ip_address: TypeAlias = str

{python_3xui-0.0.5 → python_3xui-0.0.7}/python_3xui/util.py RENAMED Viewed

@@ -218,7 +218,7 @@ async def check_xui_response_validity(response: JsonType | httpx.Response) -> st
             if "database" in msg.lower() and "locked" in msg.lower() and not success:
                 logging.log(logging.WARNING, "Database is locked, retrying...")
                 return "DB_LOCKED"
-            print(f"Unsuccessful operation! Message: {json_resp["msg"]}")
+            logging.warning("Unsuccessful operation (status code 200, success = false)! Message: %s", json_resp["msg"])
             return "ERROR"
     raise RuntimeError("Validator got something very unexpected (Please don't shove responses with non-20X status codes in here...)")

{python_3xui-0.0.5 → python_3xui-0.0.7}/tests/conftest.py RENAMED Viewed

@@ -36,8 +36,9 @@ async def xui_client() -> XUIClient:
     base_path = os.getenv("BASE_PATH")
     username = os.getenv("XUI_USERNAME")
     password = os.getenv("XUI_PASSWORD")
+    two_fac = os.getenv("XUI_2FA_SECRET")
-    if not all([base_url, port_str, base_path, username, password]):
+    if not all([base_url, port_str, base_path, username, password, two_fac]):
         pytest.skip("Environment variables for XUIClient not configured (.env file required)")
     try:
@@ -48,7 +49,7 @@ async def xui_client() -> XUIClient:
     # Reset singleton for clean test state
     XUIClient._instance = None
-    client = XUIClient(base_url, port, base_path, username=username, password=password)
+    client = XUIClient(base_url, port, base_path, username=username, password=password, two_fac_code=two_fac, custom_prod_string="test3")
     client.connect()
     # Authenticate

{python_3xui-0.0.5 → python_3xui-0.0.7}/tests/test_non_idempotent_endpoints_clients.py RENAMED Viewed

@@ -36,7 +36,7 @@ class TestClientsEndpoint:
         # Try to find a suitable inbound (preferably with PROD_STRING in remark)
         test_inbound = None
         for inbound in all_inbounds:
-            if xui_client.PROD_STRING in inbound.remark.lower():
+            if xui_client.PROD_STRING.search(inbound.remark.lower()):
                 test_inbound = inbound
                 break

{python_3xui-0.0.5 → python_3xui-0.0.7}/tests/test_non_idempotent_endpoints_inbounds.py RENAMED Viewed

@@ -61,7 +61,8 @@ class TestInboundsEndpoint:
         )
         # Create the inbound
-        response = await xui_client.inbounds_end.addigga
+        pytest.skip("Not implemented yet")
+        response = await xui_client.inbounds_end.add_inbound()
         # Validate response
         assert response.status_code == 200

python_3xui-0.0.5/README.md DELETED Viewed

@@ -1,13 +0,0 @@
-<head>
-<title>Readme</title>
-<style>
-.welcome {
-color: rgb(1, 170, 170)
-}
-</style>
-</head>
-<h1 class="welcome">Hi! This is my example python 3x-ui wrapper!</h1>
-<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>

{python_3xui-0.0.5 → python_3xui-0.0.7}/.gitignore RENAMED Viewed

File without changes

{python_3xui-0.0.5 → python_3xui-0.0.7}/LICENSE RENAMED Viewed

File without changes

{python_3xui-0.0.5 → python_3xui-0.0.7}/python_3xui/__init__.py RENAMED Viewed

File without changes

{python_3xui-0.0.5 → python_3xui-0.0.7}/tests/gather_response_stubs.py RENAMED Viewed

File without changes

{python_3xui-0.0.5 → python_3xui-0.0.7}/tests/pytest.ini RENAMED Viewed

File without changes

{python_3xui-0.0.5 → python_3xui-0.0.7}/tests/test_endpoints_clients.py RENAMED Viewed

File without changes

{python_3xui-0.0.5 → python_3xui-0.0.7}/tests/test_endpoints_inbounds.py RENAMED Viewed

File without changes

Python-3xui 0.0.5__tar.gz → 0.0.7__tar.gz

Python-3xui 0.0.5tar.gz → 0.0.7tar.gz