atomicshop 2.15.6__py3-none-any.whl → 2.15.8__py3-none-any.whl

atomicshop/__init__.py

@@ -1,4 +1,4 @@
 """Atomic Basic functions and classes to make developer life easier"""
 
 __author__ = "Den Kras"
-__version__ = '2.15.6'
+__version__ = '2.15.8'

atomicshop/basics/strings.py

@@ -108,7 +108,7 @@ def is_any_string_from_list_in_string(string_list: list, check_string: str) -> b
     return any(test_string in check_string for test_string in string_list)
 
 
-def match_pattern_against_string(
+def _match_pattern_against_string(
         pattern: str,
         check_string: str,
         case_insensitive: bool = False,
@@ -214,6 +214,73 @@ def match_pattern_against_string(
     return False
 
 
+def match_pattern_against_string(
+        pattern: str,
+        check_string: str,
+        case_insensitive: bool = False,
+        prefix_suffix: bool = False
+) -> bool:
+    """
+    Function checks the 'pattern' against 'check_string' and returns 'True' if pattern matches and 'False' if not.
+
+    Example:
+        pattern_string = "*ffmpeg*full_build.zip"
+        check_string = "https://github.com/GyanD/codexffmpeg/releases/download/5.1.2/ffmpeg-5.1.2-full_build.zip"
+        match_pattern_against_string(pattern_string, check_string)
+    Result:
+        True
+
+    :param pattern: string, can include wildcards as '*'.
+    :param check_string: string, to check the pattern against.
+    :param case_insensitive: boolean, if 'True' will treat the 'pattern' and 'check_string' as case-insensitive.
+    :param prefix_suffix: boolean, that sets if the function should return 'True' also for all the cases that wildcard
+        in the beginning of the pattern and in the end of the pattern, since the default behavior of regex to return
+        'False' on these cases.
+
+        Example:
+            pattern: *test
+            check_string: testblabla
+        Default regex behavior will return 'False' with 'prefix_suffix' switch set to 'True',
+        this case will return 'True'. Same will go for:
+        pattern: test*
+            check_string: blablatest
+
+        Why this is good?
+        Let's say you have a python script 'example.py' and you want to find all the executed command lines,
+        and you want to make sure that this was executed by 'python'. Your python is installed
+        in 'c:\\Python310\\python.exe', and you want to match all the possible patterns of 'python' and 'example.py'.
+        Pattern:
+            *python*example.py
+        You want to match 'True' for the next cases:
+            python example.py
+            c:\\Python310\\python.exe example.py
+
+        Default regex behavior is to return 'False' on 'python example.py'.
+
+    :return: boolean.
+    """
+    # Determine the regex flags based on case_insensitive.
+    flags = re.IGNORECASE if case_insensitive else 0
+
+    # Escape the pattern for regex, then replace '*' with '.*' to match any characters.
+    escaped_pattern = re.escape(pattern).replace(r'\*', '.*')
+
+    # Adjust the pattern to match from the start and/or end based on prefix_suffix.
+    if prefix_suffix:
+        if not pattern.startswith('*'):
+            escaped_pattern = '.*' + escaped_pattern
+        if not pattern.endswith('*'):
+            escaped_pattern = escaped_pattern + '.*'
+    else:
+        escaped_pattern = '^' + escaped_pattern + '$'
+
+    # Compile the regex pattern with the appropriate flags.
+    regex_pattern = re.compile(escaped_pattern, flags)
+
+    # Perform the search and return the result.
+    return bool(regex_pattern.search(check_string))
+
+
 def match_list_of_patterns_against_string(
         patterns: list,
         check_string: str,

atomicshop/filesystem.py

@@ -6,7 +6,7 @@ import shutil
 import stat
 import errno
 from contextlib import contextmanager
-from typing import Literal
+from typing import Literal, Union
 import tempfile
 
 import psutil
@@ -1412,12 +1412,16 @@ def backup_folder(directory_path: str, backup_directory: str) -> None:
         move_folder(directory_path, backup_directory_path)
 
 
-def backup_file(file_path: str, backup_directory: str, timestamp_as_prefix: bool = False) -> None:
+def backup_file(
+        file_path: str,
+        backup_directory: str,
+        timestamp_as_prefix: bool = False
+) -> Union[str, None]:
     """
     Backup the specified file.
 
-    :param file_path: The file path to backup.
-    :param backup_directory: The directory to backup the file to.
+    :param file_path: The file path to back up.
+    :param backup_directory: The directory to back up the file to.
     :param timestamp_as_prefix: boolean, if
         True, then the timestamp will be added as a prefix to the file name.
         False, then the timestamp will be added as a suffix to the file name.
@@ -1454,6 +1458,10 @@ def backup_file(file_path: str, backup_directory: str, timestamp_as_prefix: bool
         backup_file_path: str = str(Path(backup_directory) / file_name)
         move_file(file_path, backup_file_path)
 
+        return backup_file_path
+    else:
+        return None
+
 
 def find_file(file_name: str, directory_path: str):
     """

atomicshop/process.py

@@ -9,11 +9,16 @@ from .print_api import print_api
 from .inspect_wrapper import get_target_function_default_args_and_combine_with_current
 from .basics import strings
 from .wrappers import ubuntu_terminal
+from .wrappers.psutilw import processes
 
 if os.name == 'nt':
     from . import get_process_list
 
 
+class MultipleProcessesFound(Exception):
+    pass
+
+
 def is_command_exists(cmd: str) -> bool:
     """
     The function checks if the command exists in the system.
@@ -247,25 +252,28 @@ def safe_terminate(popen_process: subprocess.Popen):
     popen_process.wait()
 
 
-def match_pattern_against_running_processes_cmdlines(
+def get_running_processes_by_cmdline_pattern(
         pattern: str,
-        process_name_case_insensitive: bool = False,
+        cmdline_case_insensitive: bool = False,
         first: bool = False,
         prefix_suffix: bool = False
-):
+) -> list:
     """
     The function matches specified string pattern including wildcards against all the currently running processes'
     command lines.
 
     :param pattern: string, the pattern that we will search in the command line list of currently running processes.
-    :param process_name_case_insensitive: boolean, if True, the process name will be matched case insensitive.
+    :param cmdline_case_insensitive: boolean,
+        True, the pattern and the command line will be matched case-insensitive.
     :param first: boolean, that will set if first pattern match found the iteration will stop, or we will return
         the list of all command lines that contain the pattern.
     :param prefix_suffix: boolean. Check the description in 'match_pattern_against_string' function.
+
+    :return: list, of command lines that contain the pattern.
     """
 
     # Get the list of all the currently running processes.
-    get_process_list_instance = get_process_list.GetProcessList(get_method='pywin32', connect_on_init=True)
+    get_process_list_instance = get_process_list.GetProcessList(get_method='psutil', connect_on_init=True)
     processes = get_process_list_instance.get_processes(as_dict=False)
 
     # Iterate through all the current process, while fetching executable file 'name' and the command line.
@@ -273,18 +281,30 @@ def match_pattern_against_running_processes_cmdlines(
     matched_cmdlines: list = list()
     for process in processes:
         # Check if command line isn't empty and that string pattern is matched against command line.
-        if process['cmdline'] and \
-                strings.match_pattern_against_string(
-                    pattern, process['cmdline'], case_insensitive=process_name_case_insensitive,
-                    prefix_suffix=prefix_suffix):
-            matched_cmdlines.append(process['cmdline'])
-            # If 'first' was set to 'True' we will stop, since we found the first match.
-            if first:
-                break
+        if process['cmdline']:
+            is_pattern_matched = strings.match_pattern_against_string(
+                pattern, process['cmdline'], case_insensitive=cmdline_case_insensitive, prefix_suffix=prefix_suffix)
+            if is_pattern_matched:
+                matched_cmdlines.append(process)
+                # If 'first' was set to 'True' we will stop, since we found the first match.
+                if first:
+                    break
 
     return matched_cmdlines
 
 
+def kill_process_by_filename_pattern(pattern: str):
+    running_processes = get_running_processes_by_cmdline_pattern(
+        pattern, first=False, prefix_suffix=True, cmdline_case_insensitive=True)
+
+    processes_found: int = len(running_processes)
+
+    if processes_found > 1:
+        raise MultipleProcessesFound(f"[{processes_found}] processes found with pattern '{pattern}'.")
+    elif processes_found == 1:
+        processes.kill_process_by_pid(running_processes[0]['pid'])
+
+
 def run_powershell_command(command):
     try:
         result = subprocess.run(["powershell", "-Command", command], capture_output=True, text=True, check=True)

atomicshop/wrappers/psutilw/processes.py

@@ -1,6 +1,8 @@
 import psutil
 import time
 
+from ...print_api import print_api
+
 
 def wait_for_process(pid: int):
     """
@@ -24,3 +26,20 @@ def wait_for_process(pid: int):
         print(f"No process found with PID {pid}")
     except psutil.AccessDenied:
         print(f"Access denied to process with PID {pid}")
+
+
+def kill_process_by_pid(pid: int, print_kwargs: dict = None):
+    try:
+        print_api(f"Terminating process: {pid}.", **(print_kwargs or {}))
+        proc = psutil.Process(pid)
+        proc.terminate()  # or proc.kill() if you want to forcefully kill it
+        proc.wait(timeout=5)  # Wait up to 5 seconds for the process to terminate
+    except psutil.NoSuchProcess:
+        # print(f"No process found with PID {pid}.")
+        pass
+    except psutil.AccessDenied:
+        # print(f"Access denied to terminate process with PID {pid}.")
+        pass
+    except psutil.TimeoutExpired:
+        # print(f"Process {pid} did not terminate in time.")
+        pass

atomicshop/wrappers/sysmonw.py

@@ -48,7 +48,7 @@ def is_sysmon_running():
     :return: boolean, True if Sysmon is running, False otherwise.
     """
 
-    process_list: list = process.match_pattern_against_running_processes_cmdlines(
+    process_list: list = process.get_running_processes_by_cmdline_pattern(
         pattern=SYSMON_FILE_NAME, first=True, process_name_case_insensitive=True)
 
     if process_list:

{atomicshop-2.15.6.dist-info → atomicshop-2.15.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: atomicshop
-Version: 2.15.6
+Version: 2.15.8
 Summary: Atomic functions and classes to make developer life easier
 Author: Denis Kras
 License: MIT License

{atomicshop-2.15.6.dist-info → atomicshop-2.15.8.dist-info}/RECORD

@@ -1,4 +1,4 @@
-atomicshop/__init__.py,sha256=1hdUGTA9S4fKop2fWaz_-LGGl280RKNToC4zKa_Ed7E,123
+atomicshop/__init__.py,sha256=qXSapgKOZW5gBDxm1PRQP-ON2rt7bHb-DROkBl2tcpQ,123
 atomicshop/_basics_temp.py,sha256=6cu2dd6r2dLrd1BRNcVDKTHlsHs_26Gpw8QS6v32lQ0,3699
 atomicshop/_create_pdf_demo.py,sha256=Yi-PGZuMg0RKvQmLqVeLIZYadqEZwUm-4A9JxBl_vYA,3713
 atomicshop/_patch_import.py,sha256=ENp55sKVJ0e6-4lBvZnpz9PQCt3Otbur7F6aXDlyje4,6334
@@ -14,7 +14,7 @@ atomicshop/dns.py,sha256=h4uZKoz4wbBlLOOduL1GtRcTm-YpiPnGOEGxUm7hhOI,2140
 atomicshop/domains.py,sha256=Rxu6JhhMqFZRcoFs69IoEd1PtYca0lMCG6F1AomP7z4,3197
 atomicshop/emails.py,sha256=I0KyODQpIMEsNRi9YWSOL8EUPBiWyon3HRdIuSj3AEU,1410
 atomicshop/file_types.py,sha256=-0jzQMRlmU1AP9DARjk-HJm1tVE22E6ngP2mRblyEjY,763
-atomicshop/filesystem.py,sha256=GIuRNtqUkUXrqKhvRxC9rRulK8FpgKqPcPXG1bf1fac,55030
+atomicshop/filesystem.py,sha256=Y2_ZplT591KpKDYjVdN9HF1g4eyifWFu7Sm65rpqy7c,55148
 atomicshop/functions.py,sha256=pK8hoCE9z61PtWCxQJsda7YAphrLH1wxU5x-1QJP-sY,499
 atomicshop/get_process_list.py,sha256=hi1NOG-i8S6EcyQ6LTfP4pdxqRfjEijz9SZ5nEbcM9Q,6076
 atomicshop/get_process_name_cmd_dll.py,sha256=CtaSp3mgxxJKCCVW8BLx6BJNx4giCklU_T7USiCEwfc,5162
@@ -27,7 +27,7 @@ atomicshop/on_exit.py,sha256=Wf1iy2e0b0Zu7oRxrct3VkLdQ_x9B32-z_JerKTt9Z0,5493
 atomicshop/pbtkmultifile_argparse.py,sha256=aEk8nhvoQVu-xyfZosK3ma17CwIgOjzO1erXXdjwtS4,4574
 atomicshop/permissions.py,sha256=P6tiUKV-Gw-c3ePEVsst9bqWaHJbB4ZlJB4xbDYVpEs,4436
 atomicshop/print_api.py,sha256=j0bZ9b2rFKCcr0TVx1ARraVKeEs6JaaSgIlBdndy1nI,11600
-atomicshop/process.py,sha256=U2gyRl0bw2138y-rOMABMVptRvAL81ZfX1JyfxJI_Oo,15973
+atomicshop/process.py,sha256=PeLvyixXaCfftdUF3oMbohI1L4MdLtvQVDx2V1Tz_Rk,16662
 atomicshop/python_file_patcher.py,sha256=kd3rBWvTcosLEk-7TycNdfKW9fZbe161iVwmH4niUo0,5515
 atomicshop/python_functions.py,sha256=zJg4ogUwECxrDD7xdDN5JikIUctITM5lsyabr_ZNsRw,4435
 atomicshop/question_answer_engine.py,sha256=7nM6kGDSFjQNi87b87-kP9lYM0vTjBHn1rEQGNAfdGA,825
@@ -100,7 +100,7 @@ atomicshop/basics/multiprocesses.py,sha256=nSskxJSlEdalPM_Uf8cc9kAYYlVwYM1GonBLA
 atomicshop/basics/numbers.py,sha256=ESX0z_7o_ok3sOmCKAUBoZinATklgMy2v-4RndqXlVM,1837
 atomicshop/basics/package_module.py,sha256=fBd0uVgFce25ZCVtLq83iyowRlbwdWYFj_t4Ml7LU14,391
 atomicshop/basics/randoms.py,sha256=DmYLtnIhDK29tAQrGP1Nt-A-v8WC7WIEB8Edi-nk3N4,282
-atomicshop/basics/strings.py,sha256=T4MpEpwxqsiOSnXcwYkqMKB5okHiJfvUCO7t5kcRtBg,18316
+atomicshop/basics/strings.py,sha256=YIE0q5mdpwPtGXsRgvn-HSvR3R6sU1EyBCWHQq3IlKs,21216
 atomicshop/basics/threads.py,sha256=xvgdDJdmgN0wmmARoZ-H7Kvl1GOcEbvgaeGL4M3Hcx8,2819
 atomicshop/basics/timeit_template.py,sha256=fYLrk-X_dhdVtnPU22tarrhhvlggeW6FdKCXM8zkX68,405
 atomicshop/basics/tracebacks.py,sha256=cNfh_oAwF55kSIdqtv3boHZQIoQI8TajxkTnwJwpweI,535
@@ -181,7 +181,7 @@ atomicshop/wrappers/pipw.py,sha256=mu4jnHkSaYNfpBiLZKMZxEX_E2LqW5BVthMZkblPB_c,1
 atomicshop/wrappers/process_wrapper_pbtk.py,sha256=ycPmBRnv627RWks6N8OhxJQe8Gu3h3Vwj-4HswPOw0k,599
 atomicshop/wrappers/pycharmw.py,sha256=OHcaVlyhIqhgRioPhkeS5krDZ_NezZjpBCvyRiLjWwI,2723
 atomicshop/wrappers/pyopensslw.py,sha256=OBWxA6EJ2vU_Qlf4M8m6ilcG3hyYB4yB0EsXUf7NhEU,6804
-atomicshop/wrappers/sysmonw.py,sha256=impveU8MhbD2oizBoGLuj00wuyB8l_EiRRGIESdFESs,5359
+atomicshop/wrappers/sysmonw.py,sha256=MFF8ts0gHbXn2_QeH196UncOUtm4MnM2cQBzTOnfrnk,5351
 atomicshop/wrappers/ubuntu_terminal.py,sha256=BBZD3EH6KSDORd5IZBZM-ti4U6Qh1sZwftx42s7hqB4,10917
 atomicshop/wrappers/wslw.py,sha256=AKphiHLSddL7ErevUowr3f9Y1AgGz_R3KZ3NssW07h8,6959
 atomicshop/wrappers/certauthw/certauth.py,sha256=hKedW0DOWlEigSNm8wu4SqHkCQsGJ1tJfH7s4nr3Bk0,12223
@@ -265,7 +265,7 @@ atomicshop/wrappers/psutilw/cpus.py,sha256=w6LPBMINqS-T_X8vzdYkLS2Wzuve28Ydp_Gaf
 atomicshop/wrappers/psutilw/disks.py,sha256=3ZSVoommKH1TWo37j_83frB-NqXF4Nf5q5mBCX8G4jE,9221
 atomicshop/wrappers/psutilw/memories.py,sha256=_S0aL8iaoIHebd1vOFrY_T9aROM5Jx2D5CvDh_4j0Vc,528
 atomicshop/wrappers/psutilw/networks.py,sha256=jC53QXKdZQPCLdy_iNWXeq-CwpW7H6va6bFPRmI_e7A,1507
-atomicshop/wrappers/psutilw/processes.py,sha256=XVqbr7btnT1aJioCFOBnudKGZ5-L9sTpBFWb4DHn2Rw,847
+atomicshop/wrappers/psutilw/processes.py,sha256=ZOkqEEF36NFeQg7G-baUUdTaV8DQe_jpkJg42ASUuc0,1566
 atomicshop/wrappers/psutilw/psutilw.py,sha256=q3EwgprqyrR4zLCjl4l5DHFOQoukEvQMIPjNB504oQ0,21262
 atomicshop/wrappers/psycopgw/psycopgw.py,sha256=XJvVf0oAUjCHkrYfKeFuGCpfn0Oxj3u4SbKMKA1508E,7118
 atomicshop/wrappers/pywin32w/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -294,8 +294,8 @@ atomicshop/wrappers/socketw/socket_server_tester.py,sha256=AhpurHJmP2kgzHaUbq5ey
 atomicshop/wrappers/socketw/socket_wrapper.py,sha256=aXBwlEIJhFT0-c4i8iNlFx2It9VpCEpsv--5Oqcpxao,11624
 atomicshop/wrappers/socketw/ssl_base.py,sha256=k4V3gwkbq10MvOH4btU4onLX2GNOsSfUAdcHmL1rpVE,2274
 atomicshop/wrappers/socketw/statistics_csv.py,sha256=t3dtDEfN47CfYVi0CW6Kc2QHTEeZVyYhc57IYYh5nmA,826
-atomicshop-2.15.6.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
-atomicshop-2.15.6.dist-info/METADATA,sha256=Q5MZL59GkPTmEyDcTAlcDfRmFrOs9N8yQt6r-xnCKAM,10502
-atomicshop-2.15.6.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-atomicshop-2.15.6.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
-atomicshop-2.15.6.dist-info/RECORD,,
+atomicshop-2.15.8.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
+atomicshop-2.15.8.dist-info/METADATA,sha256=3DmLuxpwvuPD30x8sV91qGlIySBzcaNhAjiX_qbBd-8,10502
+atomicshop-2.15.8.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+atomicshop-2.15.8.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
+atomicshop-2.15.8.dist-info/RECORD,,