base-aux 0.0.1__py3-none-any.whl

base_aux/_NEW/__init__.py

@@ -0,0 +1,22 @@
+# =====================================================================================================================
+# VERSION = (0, 0, 1)   # use import EXACT_OBJECTS! not *
+#   from .main import *                 # INcorrect
+#   from .main import EXACT_OBJECTS     # CORRECT
+# VERSION = (0, 0, 2)   # del blank lines
+# VERSION = (0, 0, 3)   # separate all types/exx into static.py!
+
+
+# =====================================================================================================================
+# TEMPLATE
+# from .static import (
+#     # TYPES
+#     # EXX
+# )
+# from .main import (
+#     # BASE
+#     # AUX
+# )
+# ---------------------------------------------------------------------------------------------------------------------
+
+
+# =====================================================================================================================

base_aux/_NEW/main.py

@@ -0,0 +1,53 @@
+import pathlib
+from typing import *
+
+
+# =====================================================================================================================
+TYPE__PATH = Union[str, pathlib.Path]
+
+
+# =====================================================================================================================
+class NEW_CLASS____:
+    """
+    NOTE
+    ----
+
+    GOAL
+    ----
+
+    USEFUL IDEAS
+    ------------
+
+    CREATED SPECIALLY FOR 
+    ---------------------
+    REPLACE:
+
+    CONSTRAINTS
+    -----------
+
+    BEST USAGE
+    ----------
+
+    SAME AS/OTHER VARIANTS
+    ----------------------
+    DIFFERENCE:
+
+    WHY NOT: 1?
+    ----------
+
+    WHY NOT: 2?
+    ----------
+
+    REFERENCE
+    ---------
+
+    """
+    def meth(self):
+        """
+        CREATED SPECIALLY FOR
+        ---------------------
+        """
+        pass
+
+
+# =====================================================================================================================

base_aux/alerts/__init__.py

@@ -0,0 +1,20 @@
+# =====================================================================================================================
+# VERSION = (0, 0, 1)   # use import EXACT_OBJECTS! not *
+#   from .main import *                 # INcorerct
+#   from .main import EXACT_OBJECTS     # CORERCT
+
+
+# =====================================================================================================================
+from .base import AlertBase
+from .smtp import SmtpAddress, SmtpServers, AlertSmtp
+from .telegram import RecipientTgID, AlertTelegram
+
+
+# =====================================================================================================================
+# FIXME: move to main!
+class AlertSelect:
+    SMTP_DEF = AlertSmtp
+    TELEGRAM_DEF = AlertTelegram
+
+
+# =====================================================================================================================

base_aux/alerts/_examples.py

@@ -0,0 +1,103 @@
+# =========================================================================================
+### 0. BEST PRACTICE
+from base_aux.alerts import *
+
+class AlertADX(AlertSelect.TELEGRAM_DEF):
+    pass
+
+AlertADX("hello")
+AlertADX("World")
+AlertADX.threads_wait_all()
+
+# =========================================================================================
+# =========================================================================================
+# =========================================================================================
+### AlertSmtp
+#### 1. add new server if not exists
+from base_aux.alerts import *
+
+
+class SmtpServersMOD(SmtpServers):
+    EXAMPLE_RU: SmtpAddress = SmtpAddress("smtp.EXAMPLE.ru", 123)
+
+
+class AlertSmtpMOD(AlertSmtp):
+    SERVER_SMTP: SmtpAddress = SmtpServersMOD.EXAMPLE_RU  # or direct =SmtpAddress("smtp.EXAMPLE.ru", 123)
+
+# =========================================================================================
+#### 2. change authorisation data (see `privates` for details)
+from base_aux.alerts import *
+from base_aux.privates import *
+
+
+class AlertSmtpMOD(AlertSmtp):
+    AUTH: PrivateAuto = PrivateAuto(_section="AUTH_EMAIL_MOD")
+
+# =========================================================================================
+#### 3. change other settings (see source for other not mentioned)
+from base_aux.alerts import *
+
+
+class AlertSmtpMOD(AlertSmtp):
+    RECONNECT_PAUSE: int = 60
+    RECONNECT_LIMIT: int = 10
+
+    TIMEOUT_RATELIMIT: int = 600
+
+    RECIPIENT_SPECIAL: str = "my_address_2@mail.ru"
+
+# =========================================================================================
+#### 4. send
+# if no mods
+from base_aux.alerts import *
+
+AlertSmtp(_subj_name="Hello", body="World!")
+
+# with mods
+from base_aux.alerts import *
+
+
+class AlertSmtpMOD(AlertSmtp):
+    pass  # changed
+
+
+AlertSmtpMOD(_subj_name="Hello", body="World!")
+
+# =========================================================================================
+#### 5. using in class with saving alert object
+from base_aux.alerts import *
+
+class AlertSmtpMOD(AlertSmtp):
+    pass    # changed
+
+class MyMonitor:
+    ALERT = AlertSmtpMOD
+
+monitor = MyMonitor()
+monitor.ALERT("Hello")
+
+# =========================================================================================
+# =========================================================================================
+### AlertTelegram
+# All idea is similar to AlertSmtp.
+
+# add auth data
+# add pv.json or do smth else (for details see privates.PrivateJsonTgBotAddress)
+# json
+{
+    "TG_ID": {"MyTgID": 1234567890},
+    "TGBOT_DEF": {
+        "LINK_ID": "@my_bot_20230916",
+        "NAME": "my_bot",
+        "TOKEN": "9876543210xxxxxxxxxxxxxxxxxxxxxxxxx"
+    }
+}
+
+# =========================================================================================
+from base_aux.alerts import *
+
+class MyMonitor:
+    ALERT = AlertTelegram
+
+monitor = MyMonitor()
+monitor.ALERT("Hello")

base_aux/alerts/base.py

@@ -0,0 +1,266 @@
+import time
+from typing import *
+
+from PyQt5.QtCore import QThread
+
+import smtplib
+import telebot
+
+
+# =====================================================================================================================
+class _AlertInterface:
+    """Interface for Alerts
+
+    RULES:
+    - if some method cant exists (like for telegram) - just return True!
+    - Dont return None!
+    - Dont use Try sentences inside - it will be applied in upper logic!
+    - Decide inside if it was success or not, and return conclusion True/False only.
+    """
+    def _connect_unsafe(self) -> Union[bool, NoReturn]:
+        """establish connection to source
+        """
+        return True
+
+    def _login_unsafe(self) -> Union[bool, NoReturn]:
+        """authorise to source
+        """
+        return True
+
+    def _send_unsafe(self) -> Union[bool, NoReturn]:
+        """send msg
+        """
+        return True
+
+    def _msg_compose(self) -> Union[str, 'MIMEMultipart']:
+        """generate msg from existed data in attributes (passed before on init)
+        """
+        pass
+
+    def _recipient_self_get(self) -> str:
+        """RECIPIENT SelfSending, get from obvious class objects!
+        """
+        pass
+
+
+# =====================================================================================================================
+class AlertBase(_AlertInterface, QThread):     # REM: DONT ADD SINGLETON!!! SNMP WILL NOT WORK!!! and calling logic will be not simle!
+    """Base class for Alert objects.
+
+    FEATURE:
+    - send msg,
+    - threading
+        - daemons
+        - collect all active threads
+        - wait all spawned threads finished
+
+    :ivar SUBJECT_PREFIX: default prefix for subject
+    :ivar SUBJECT_NAME: default name for subject
+    :ivar body: actual msg body for alert
+    :ivar _subtype: it used to change subtype only in smtp (http)
+
+    :ivar BODY_TIMESTAMP_USE: append timestamp into the body
+    :ivar TIMESTAMP: initiation timestamp for created instance
+
+    :ivar RECONNECT_LIMIT: how many times it will try to reconnect, after - just close object
+    :ivar RECONNECT_PAUSE: pause between reconnecting in seconds
+
+    :ivar RECIPIENT_SPECIAL: recipient for sending msg
+        None - if selfSending!
+
+    :ivar _conn: actual connection object
+    :ivar _result: result for alert state
+        None - in process,
+        False - finished UnSuccess,
+        True - finished success!
+
+    :ivar _threads_active: spawned (only active) threads
+    """
+    # SETTINGS ------------------------------------
+    SUBJECT_PREFIX: Optional[str] = "[ALERT]"
+    SUBJECT_NAME: Optional[str] = None
+    body: Union[None, str, dict] = None
+    _subtype: Optional[str] = "plain"
+
+    BODY_TIMESTAMP_USE: bool = True
+    TIMESTAMP: str = None
+
+    TIMEOUT_SEND: float = 1.2
+
+    RECONNECT_LIMIT: int = 10
+    RECONNECT_PAUSE: int = 60
+    # TIMEOUT_RATELIMIT: int = 600    # when EXX 451, b'Ratelimit exceeded
+
+    RECIPIENT_SPECIAL: Optional[Any] = None
+
+    # AUX -----------------------------------------
+    _conn: Union[None, smtplib.SMTP_SSL, telebot.TeleBot] = None
+    _result: Optional[bool] = None
+
+    _threads_active: Set['AlertBase'] = set()
+
+    # =================================================================================================================
+    def __init__(self, body: Optional[Any] = None, _subj_name: Optional[str] = None, _subtype: Optional[str] = None):
+        """Send msg
+
+        :param body: define msg body
+            None - just for research! (maybe deprecated!)
+        :param _subj_name: reuse new subject name instead of default
+        :param _subtype: reuse new _subtype instead of default
+        """
+        super().__init__(daemon=True)
+        self.TIMESTAMP = time.strftime("%Y.%m.%d %H:%M:%S")
+
+        # self._mutex: threading.Lock = threading.Lock()
+        self.SUBJECT_NAME = _subj_name or self.SUBJECT_NAME
+        self._subtype = _subtype or self._subtype
+
+        # BODY ---------------
+        if body is not None:
+            body = str(body)
+            if self.BODY_TIMESTAMP_USE:
+                body += f"\n{self.TIMESTAMP}"
+            self.body = body
+
+            self.start()
+
+    # =================================================================================================================
+    def RECIPIENT(self) -> str:
+        """RECIPIENT actual/final
+        """
+        return self.RECIPIENT_SPECIAL or self._recipient_self_get()
+
+    @property
+    def SUBJECT(self) -> str:
+        """final msg subject, composed with name and prefix.
+        """
+        if self.SUBJECT_NAME is None:
+            self.SUBJECT_NAME = self.NAME
+        return self.SUBJECT_PREFIX + self.SUBJECT_NAME
+
+    @classmethod
+    @property
+    def NAME(cls) -> str:
+        """name for AlertClass.
+        Accustom ourselves to name you classes recognisable without adding new one redundant attributes.
+        """
+        return cls.__name__
+
+    # =================================================================================================================
+    def start(self):
+        """this is just add ability to collect started threads in class
+        """
+        self.__class__._threads_active.add(self)
+        super().start()
+
+    def _thread_finished(self):
+        """del thread object from collection.
+        called then thread finished.
+        """
+        self.__class__._threads_active.discard(self)
+
+    @classmethod
+    def threads_wait_all(cls):
+        """wait while all spawned active threads will finished.
+        """
+        try:
+            time.sleep(1)
+            while cls._threads_active:
+                list(cls._threads_active)[0].wait()
+        except:
+            pass
+
+    def result_wait(self) -> Optional[bool]:
+        """wait for finish thread and get succession result.
+        Created for tests mainly! but you can use!
+        """
+        self.wait()
+        return self._result
+
+    # =================================================================================================================
+    def _conn__check_exists(self) -> bool:
+        """check if connection object exists
+        """
+        return self._conn is not None
+
+    def _conn__disconnect(self) -> None:
+        """disconnect connection object
+        """
+        if self._conn:
+            self._conn.quit()
+        self._conn__clear()
+
+    def _conn__clear(self) -> None:
+        """del connection object
+        """
+        self._conn = None
+
+    def _connect(self) -> Optional[bool]:
+        """create connection object
+        """
+        result = None
+        if not self._conn__check_exists():
+            print(f"TRY _connect {self.__class__.__name__}")
+            try:
+                if self._connect_unsafe():
+                    print("[READY] connect")
+
+            except Exception as exx:
+                print(f"[CRITICAL] CONNECT [{exx!r}]")
+                self._conn__clear()
+
+        if self._conn__check_exists():
+            try:
+                result = self._login_unsafe()
+                if result:
+                    print("[READY] login")
+            except Exception as exx:
+                print(f"[CRITICAL] LOGIN [{exx!r}]")
+                self._conn__clear()
+
+        print("="*100)
+        print("="*100)
+        print("="*100)
+        print()
+
+        return result
+
+    # =================================================================================================================
+    def run(self) -> None:
+        """main logic which manage started thread
+        """
+        counter = 0
+        while not self._conn__check_exists() and counter <= self.RECONNECT_LIMIT:
+            counter += 1
+            if not self._connect():
+                print(f"[WARNING]try [{counter=}]")
+                print("=" * 100)
+                print()
+                time.sleep(self.RECONNECT_PAUSE)
+
+        print("[Try send", "-" * 80)
+        print(self._msg_compose())
+        print("Try send]", "-" * 80)
+
+        if self._conn__check_exists():
+            try:
+                result = self._send_unsafe()
+                if result:
+                    print("[READY] send")
+                    self._result = True
+            except Exception as exx:
+                msg = f"[CRITICAL]unexpected [{exx!r}]"
+                print(msg)
+                self._conn__clear()
+
+        print()
+        print()
+        print()
+
+        if self._result is None:
+            self._result = False
+
+        self._thread_finished()
+
+
+# =====================================================================================================================

base_aux/alerts/smtp.py

@@ -0,0 +1,76 @@
+from .base import *
+
+import time
+from typing import *
+
+import smtplib
+from email.mime.text import MIMEText
+from email.mime.multipart import MIMEMultipart
+
+from base_aux.privates import *
+
+
+# =====================================================================================================================
+# TODO: cant solve not to use always connecting - tried many variants!
+# make decision - use only one ability to send - only by instantiating!
+# always will connecting! but always in threads! so dont mind!
+
+
+# =====================================================================================================================
+class SmtpAddress(NamedTuple):
+    """class for keeping connection parameters/settings for exact smtp server
+
+    :ivar ADDR: smtp server address like "smtp.mail.ru"
+    :ivar PORT: smtp server port like 465
+    """
+    ADDR: str
+    PORT: int
+
+
+class SmtpServers:
+    """well known servers addresses.
+
+    Here we must collect servers like MilRu/GmailCom, and not to create it in any new project.
+    """
+    MAIL_RU: SmtpAddress = SmtpAddress("smtp.mail.ru", 465)
+
+
+# =====================================================================================================================
+class AlertSmtp(AlertBase):
+    """SMTP realisation for sending msg (email).
+    """
+    # SETTINGS ------------------------------------
+    SERVER_SMTP: SmtpAddress = SmtpServers.MAIL_RU
+    AUTH: PrivateAuth = PrivateAuto(_section="AUTH_EMAIL_DEF")
+    TIMEOUT_SEND = 5
+
+    # AUX -----------------------------------------
+    _conn:  smtplib.SMTP_SSL
+
+    def _connect_unsafe(self) -> Union[bool, NoReturn]:
+        self._conn = smtplib.SMTP_SSL(self.SERVER_SMTP.ADDR, self.SERVER_SMTP.PORT, timeout=self.TIMEOUT_SEND)
+        return True
+
+    def _login_unsafe(self) -> Union[bool, NoReturn]:
+        response = self._conn.login(self.AUTH.USER, self.AUTH.PWD)
+        print(response)
+        print("=" * 100)
+        return response and response[0] in [235, 503]
+
+    def _send_unsafe(self) -> Union[bool, NoReturn]:
+        self._conn.send_message(self._msg_compose())
+        return True
+
+    def _msg_compose(self) -> MIMEMultipart:
+        msg = MIMEMultipart()
+        msg["From"] = self.AUTH.USER
+        msg["To"] = self.RECIPIENT_SPECIAL or self.AUTH.USER
+        msg['Subject'] = self.SUBJECT
+        msg.attach(MIMEText(self.body, _subtype=self._subtype))
+        return msg
+
+    def _recipient_self_get(self) -> str:
+        return self.AUTH.USER
+
+
+# =====================================================================================================================

base_aux/alerts/telegram.py

@@ -0,0 +1,45 @@
+from .base import *
+
+import time
+from typing import *
+
+import telebot
+
+from base_aux.privates import *
+
+
+# =====================================================================================================================
+class RecipientTgID(PrivateAuto):
+    """Object to get telegram RecipientId
+    """
+    SECTION = "TG_ID"
+    MyTgID: str
+
+
+# =====================================================================================================================
+class AlertTelegram(AlertBase):
+    """realisation for sending Telegram msg
+    """
+    # SETTINGS ------------------------------------
+    SERVER_TG: PrivateTgBotAddressAuto = PrivateTgBotAddressAuto(_section="TGBOT_DEF")
+
+    # AUX -----------------------------------------
+    _conn: telebot.TeleBot
+
+    def _connect_unsafe(self) -> Union[bool, NoReturn]:
+        self._conn = telebot.TeleBot(token=self.SERVER_TG.TOKEN)
+        return True
+
+    def _send_unsafe(self) -> Union[bool, NoReturn]:
+        self._conn.send_message(chat_id=self.RECIPIENT, text=self._msg_compose())
+        return True
+
+    def _msg_compose(self) -> str:
+        msg = f"{self.SUBJECT}\n{self.body}"
+        return msg
+
+    def _recipient_self_get(self) -> str:
+        return RecipientTgID().MyTgID
+
+
+# =====================================================================================================================

base_aux/bits/__init__.py

@@ -0,0 +1,19 @@
+# =====================================================================================================================
+# VERSION = (0, 0, 1)   # use import EXACT_OBJECTS! not *
+#   from .main import *                 # INcorrect
+#   from .main import EXACT_OBJECTS     # CORRECT
+
+
+# =====================================================================================================================
+from .bits import (
+    # BASE
+    Bitfield, Flags, Bits,
+
+    # AUX
+
+    # EXX
+    Exx_BitsNoSize, Exx_BitsOutOfRange,
+)
+
+
+# =====================================================================================================================