atomicshop 2.7.0__py3-none-any.whl → 2.7.2__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.7.0'
+__version__ = '2.7.2'

atomicshop/python_file_patcher.py

@@ -4,9 +4,35 @@ from .file_io import file_io
 from . import hashing
 
 
+class FindAndReplaceInfo:
+    """
+    This class is used to store information about the find and replace operation.
+    """
+    def __init__(
+            self,
+            find_what: str,
+            replace_to: str,
+            class_name: str = None,
+            function_name: str = None,
+    ):
+        """
+        :param find_what: string to find.
+        :param replace_to: string, replace to this string.
+        :param class_name: string name of the class to search in,
+            if the string to replace is not in a class, put 'None'.
+        :param function_name: string of the function name to search in,
+            if the string to replace is not in a function, put 'None'.
+            Also, if Class name and Function Name are both 'None', then it will search for the string in the whole file.
+        """
+        self.find_what: str = find_what
+        self.replace_to: str = replace_to
+        self.class_name: str = class_name
+        self.function_name: str = function_name
+
+
 def find_and_replace_in_file(
         file_path: str,
-        find_and_replace_list: list[tuple[str, str, str, str]],
+        find_and_replace_list: list[FindAndReplaceInfo],
         encoding: str = None,
         raise_if_more_than_one_string_found: bool = False,
         raise_if_more_than_one_class_or_function_found: bool = False,
@@ -16,12 +42,7 @@ def find_and_replace_in_file(
     Find and replace string in file.
 
     :param file_path: String with full file path to read.
-    :param find_and_replace_list: list of tuples. Each tuple has 4 strings.
-        1: Class name, if the string to replace is not in a class, put 'None'.
-        2: Function name, if the string to replace is not in a function, put 'None'.
-            Also, if Class name and Function Name are both 'None', then it will search for the string in the whole file.
-        3: String to find.
-        4: String to replace to.
+    :param find_and_replace_list: list of FindAndReplaceInfo instances.
     :param encoding: string, read the file with encoding. Example: 'utf-8'. 'None' is default, since it is default
         in 'open()' function.
     :param raise_if_more_than_one_string_found: Boolean, if True, the function will raise an error if more than one
@@ -48,22 +69,16 @@ def find_and_replace_in_file(
     # Initialize the cache dictionary
     block_lines_cache: dict = {}
 
-    for single_find_replace in find_and_replace_list:
-        find_class_name: str = single_find_replace[0]
-        find_function_name: str = single_find_replace[1]
-        find_what_string: str = single_find_replace[2]
-        replace_to: str = single_find_replace[3]
-
-        # list_of_blocks: list[tuple[int, int]] = list()
-        cache_key = (find_class_name, find_function_name)
+    for single_find in find_and_replace_list:
+        cache_key = (single_find.class_name, single_find.function_name)
         if cache_key in block_lines_cache:
             # Retrieve from cache
             list_of_blocks = block_lines_cache[cache_key]
         else:
             # Use AST to find the start and end lines of the class or function.
-            if find_class_name is not None or find_function_name is not None:
+            if single_find.class_name is not None or single_find.function_name is not None:
                 list_of_blocks = astw.find_code_block(
-                    file_path, class_name=find_class_name, function_name=find_function_name)
+                    file_path, class_name=single_find.class_name, function_name=single_find.function_name)
                 if raise_if_more_than_one_class_or_function_found and len(list_of_blocks) > 1:
                     raise LookupError(f"More than one class or function was found in the file: {file_path}\n"
                                       f"Nothing was changed.")
@@ -82,7 +97,7 @@ def find_and_replace_in_file(
             found_string_indexes: list = list()
             # for string_index, line in enumerate(file_data, start=start_line):
             for string_index, line in enumerations.enumerate_from_start_to_end_index(file_data, start_line, end_line):
-                if find_what_string in line:
+                if single_find.find_what in line:
                     found_string_indexes.append(string_index)
 
                     if raise_if_more_than_one_string_found and len(found_string_indexes) > 1:
@@ -96,6 +111,6 @@ def find_and_replace_in_file(
 
             # Replace the string.
             for index in found_string_indexes:
-                file_data[index] = file_data[index].replace(find_what_string, replace_to)
+                file_data[index] = file_data[index].replace(single_find.find_what, single_find.replace_to)
 
     file_io.write_file(content=file_data, file_path=file_path, encoding=encoding, convert_list_to_string=True)

atomicshop/wrappers/dockerw/dockerw.py

@@ -18,10 +18,11 @@ def get_images():
     return images
 
 
-def remove_image(image_id_or_tag: str, print_kwargs: dict = None):
+def remove_image(image_id_or_tag: str, force: bool = False, print_kwargs: dict = None):
     """
     Remove an image from the local registry by providing the image id or tag.
     :param image_id_or_tag: string, the image id or tag.
+    :param force: bool, force remove the image.
     :param print_kwargs: dict, the print arguments.
     :return:
     """
@@ -31,5 +32,138 @@ def remove_image(image_id_or_tag: str, print_kwargs: dict = None):
 
     client = docker.from_env()
 
-    client.images.remove(image_id_or_tag)
+    client.images.remove(image_id_or_tag, force=force)
     print_api(f"Removed Image {image_id_or_tag} successfully.", color='green', **print_kwargs)
+
+
+class ChangeImageByCommands(Exception):
+    pass
+
+
+class ChangeImageByCallback(Exception):
+    pass
+
+
+def change_image_content(
+        image_id_or_name: str,
+        list_of_commands: list[str] = None,
+        print_kwargs: dict = None,
+        change_callback=None, *args, **kwargs):
+    """
+    Change an image id or tag.
+    :param image_id_or_name: string, the image id or image tag name.
+    :param list_of_commands: list of strings, the commands to run in the docker container.
+    :param print_kwargs: dict, the print arguments.
+    :param change_callback: function callable, the function to change the image. The first argument of the function
+        must be the docker container object. The rest of the arguments are optional *args and **kwargs.
+        The function must return a tuple of (exit_code, output).
+    :return:
+    ----------------------
+    Example usage by providing a list of commands:
+        from atomicshop.wrappers.dockerw import dockerw
+        dockerw.change_image_content(
+            image_id_or_name="your_docker_image_id_or_name",
+            list_of_commands=[
+                "apt-get update",
+                "apt-get install -y python3"
+            ]
+        )
+    ----------------------
+    Example usage by providing a command to update execution permissions of a file:
+        from atomicshop.wrappers.dockerw import dockerw
+        dockerw.change_image_content(
+            image_id_or_name="your_docker_image_id_or_name",
+            list_of_commands=[
+                "chmod +x /your_script.py"
+            ]
+        )
+    ----------------------
+    Example usage by providing a callback function:
+        from atomicshop.wrappers.dockerw import dockerw
+        dockerw.change_image_content(
+            image_id_or_name="your_docker_image_id_or_name",
+            change_callback=your_callback_function,
+            your_callback_function_args=(your_callback_function_arg1, your_callback_function_arg2),
+            your_callback_function_kwargs={'your_callback_function_kwarg1': your_callback_function_kwarg1}
+        )
+
+        def your_callback_function(container, your_callback_function_arg1, your_callback_function_arg2,
+                                   your_callback_function_kwarg1=None):
+            # Do something with the container.
+            # Return a tuple of (exit_code, output).
+            return 0, b"Done"
+    ----------------------
+    Example of providing callback function that change permissions of a file:
+        from atomicshop.wrappers.dockerw import dockerw
+        dockerw.change_image_content(
+            image_id_or_name="your_docker_image_id_or_name",
+            change_callback=change_permissions,
+            script_path="/your_python_script.py"
+        )
+
+        def change_permissions(container, script_path):
+            return container.exec_run(f"chmod +x {script_path}")
+
+    """
+
+    if not list_of_commands and not change_callback:
+        raise ValueError("Either list_of_commands or change_callback must be provided.")
+
+    if print_kwargs is None:
+        print_kwargs = {}
+
+    client = docker.from_env()
+
+    # Create and start a container from the existing image
+    container = client.containers.run(image_id_or_name, "/bin/bash", entrypoint="", detach=True, tty=True)
+
+    try:
+        if list_of_commands:
+            # Execute the list of commands.
+            for command_index, command in enumerate(list_of_commands):
+                exit_code, output = container.exec_run(command)
+                if exit_code != 0:
+                    raise ChangeImageByCommands(
+                        f"Error in executing command [{command_index+1}]: {output.decode('utf-8')}")
+
+        if change_callback:
+            # Execute the callback function with additional arguments.
+            exit_code, output = change_callback(container, *args, **kwargs)
+            if exit_code != 0:
+                raise ChangeImageByCallback(f"Error in Updating image with callback function: {output.decode('utf-8')}")
+
+        # Commit the container
+        new_image = container.commit()
+
+        # Remove the original image
+        client.images.remove(image_id_or_name, force=True)
+
+        # Tag the new image with the original image's name
+        client.images.get(new_image.id).tag(image_id_or_name)
+
+        print_api(f"Updated image [{image_id_or_name}].", color='green', **print_kwargs)
+
+    finally:
+        # Clean up: Stop and remove the temporary container
+        container.stop()
+        container.remove()
+
+
+def add_execution_permissions_for_file(image_id_or_name: str, file_path: str, print_kwargs: dict = None):
+    """
+    Add execution permissions for a file inside docker image.
+
+    :param image_id_or_name: string, the image id or image tag name.
+    :param file_path: string, the path to the file.
+    :param print_kwargs: dict, the print arguments.
+    :return:
+    """
+
+    if print_kwargs is None:
+        print_kwargs = {}
+
+    change_image_content(
+        image_id_or_name=image_id_or_name,
+        list_of_commands=[f"chmod +x {file_path}"],
+        print_kwargs=print_kwargs
+    )

atomicshop/wrappers/factw/fact_extractor/docker_image.py

@@ -37,7 +37,6 @@ def create_docker_image_ubuntu(directory_path: str):
         # There are 2 images:
         # 'fkiecad/fact_extractor:latest' - The image that is downloaded.
         # 'fact_extractor:latest' - The image that is built.
-        test = image.tags
         for tag in image.tags:
             if 'fact_extractor' in tag:
                 dockerw.remove_image(image_id_or_tag=image.id)

{atomicshop-2.7.0.dist-info → atomicshop-2.7.2.dist-info}/METADATA

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

{atomicshop-2.7.0.dist-info → atomicshop-2.7.2.dist-info}/RECORD

@@ -1,4 +1,4 @@
-atomicshop/__init__.py,sha256=pI9HaUaffycFBm-uxjzPkctXsfbBrHNGXNLrGiv1Pv8,122
+atomicshop/__init__.py,sha256=TozzApCxU71SSLmjAZiCz1GbHRQyojy71z7Aqk7D41g,122
 atomicshop/_basics_temp.py,sha256=6cu2dd6r2dLrd1BRNcVDKTHlsHs_26Gpw8QS6v32lQ0,3699
 atomicshop/_patch_import.py,sha256=ENp55sKVJ0e6-4lBvZnpz9PQCt3Otbur7F6aXDlyje4,6334
 atomicshop/appointment_management.py,sha256=N3wVGJgrqJfsj_lqiRfaL3FxMEe57by5Stzanh189mk,7263
@@ -26,7 +26,7 @@ atomicshop/print_api.py,sha256=3n1CoiXvDcDGg00n5gEmQYInHryIhWbcpNjVobO1Gao,11468
 atomicshop/process.py,sha256=5lqepm1psRbz66J4MB43ou6HHyac9F34QJedGukwAnk,14188
 atomicshop/process_name_cmd.py,sha256=TNAK6kQZm5JKWzEW6QLqVHEG98ZLNDQiSS4YwDk8V8c,3830
 atomicshop/process_poller.py,sha256=t79SwTX_4scH2WIH_ziw27aodG1ibhEFWbsVsmTyOVA,10846
-atomicshop/python_file_patcher.py,sha256=au12o_fkWS9j4Z0gI_Z2V1mfw2S2buj72F2Eh88d18Q,5077
+atomicshop/python_file_patcher.py,sha256=kd3rBWvTcosLEk-7TycNdfKW9fZbe161iVwmH4niUo0,5515
 atomicshop/python_functions.py,sha256=zJg4ogUwECxrDD7xdDN5JikIUctITM5lsyabr_ZNsRw,4435
 atomicshop/question_answer_engine.py,sha256=DuOn7QEgKKfqZu2cR8mVeFIfFgayfBHiW-jY2VPq_Fo,841
 atomicshop/queues.py,sha256=Al0fdC3ZJmdKfv-PyBeIck9lnfLr82BYchvzr189gsI,640
@@ -149,7 +149,7 @@ atomicshop/wrappers/certauthw/certauth.py,sha256=hKedW0DOWlEigSNm8wu4SqHkCQsGJ1t
 atomicshop/wrappers/certauthw/certauthw.py,sha256=4WvhjANI7Kzqrr_nKmtA8Kf7B6rute_5wfP65gwQrjw,8082
 atomicshop/wrappers/ctyping/process_winapi.py,sha256=QcXL-ETtlSSkoT8F7pYle97ubGWsjYp8cx8HxkVMgAc,2762
 atomicshop/wrappers/dockerw/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-atomicshop/wrappers/dockerw/dockerw.py,sha256=8MZCMek6L-QpawO5hn_gxXczI6ustPGcYBFWNiuQ1cw,949
+atomicshop/wrappers/dockerw/dockerw.py,sha256=w8zSJr5C7cbvbuG09ORCpAe0BOcibqqL_Z2EKEBHYK4,6266
 atomicshop/wrappers/dockerw/install_docker.py,sha256=dpSOmD690oLukoLCo0u6Pzh5fRyCWBuSQEtG8VwC3jk,2765
 atomicshop/wrappers/elasticsearchw/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/wrappers/elasticsearchw/config_basic.py,sha256=nMtWYBlkQwzUMTLBaL3US8-f87bNPS_wzVxpLR1D6Hc,121
@@ -159,7 +159,7 @@ atomicshop/wrappers/factw/config_fact.py,sha256=J-K9Zn50WcDC7ubb-boraSZExfBk7a6M
 atomicshop/wrappers/factw/config_install.py,sha256=QRygFnZ5r1ybJQl7ftFci3kNRmU-a-w3lMG1joElvcY,417
 atomicshop/wrappers/factw/get_file_data.py,sha256=ChKC0OjgjFlNubZQBwcGhRO3L2pccc27RLRlAMIUix4,1641
 atomicshop/wrappers/factw/fact_extractor/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-atomicshop/wrappers/factw/fact_extractor/docker_image.py,sha256=v6ZSG8lnagTwOWOcPszlNRqPWuCzXScuw72XEXAq8YU,2519
+atomicshop/wrappers/factw/fact_extractor/docker_image.py,sha256=2wFzJd5iloXg5_bRDpaDpX_km8neTLuJgiqiEFQmgbk,2492
 atomicshop/wrappers/factw/fact_extractor/get_extractor.py,sha256=2mfOAftHIlCcGt1s7MWdq7DsDCuI6wX3MtvcEZ4SK-0,756
 atomicshop/wrappers/factw/install/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/wrappers/factw/install/install_after_restart.py,sha256=Wixuc-foMA0qGjzypbbQ5sdE-F72yIKmrI9c6xwLY-g,1571
@@ -212,8 +212,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.7.0.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
-atomicshop-2.7.0.dist-info/METADATA,sha256=b3_2bHYVrfgK6JoIvpAO-kuFenRKx8bRaE_Fu9je6Wg,10369
-atomicshop-2.7.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-atomicshop-2.7.0.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
-atomicshop-2.7.0.dist-info/RECORD,,
+atomicshop-2.7.2.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
+atomicshop-2.7.2.dist-info/METADATA,sha256=1Z5YAD-v2gwpnZxf7dCVNGdLRydjB5cHznkb7_TxQVA,10369
+atomicshop-2.7.2.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+atomicshop-2.7.2.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
+atomicshop-2.7.2.dist-info/RECORD,,