atomicshop 2.5.13__py3-none-any.whl → 2.5.15__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.5.13'
+__version__ = '2.5.15'

atomicshop/addons/mains/search_for_hyperlinks_in_docx.py

@@ -0,0 +1,16 @@
+import os
+from atomicshop import filesystem
+from atomicshop.file_io import docxs, file_io
+
+# Usage
+directory_path = r"D:/directory_with_docx_files"
+script_directory: str = filesystem.get_file_directory(__file__)
+string_file_path: str = script_directory + os.sep + r"hyperlink.txt"
+hyperlink: str = file_io.read_file(string_file_path)
+
+found_in_files = docxs.search_for_hyperlink_in_files(directory_path, hyperlink, relative_paths=True)
+
+for found_file in found_in_files:
+    print(found_file)
+
+input('press Enter')

atomicshop/file_io/docxs.py

@@ -33,32 +33,35 @@ def get_hyperlinks(docx_path):
 
 
 def search_for_hyperlink_in_files(directory_path: str, hyperlink: str, relative_paths: bool = False):
+    # noinspection GrazieInspection
     """
-    Search for a hyperlink in all the docx files in the specified directory.
-    :param directory_path: string, path to the directory with docx files.
-    :param hyperlink: string, hyperlink to search for.
-    :param relative_paths: boolean, if True, the function will return relative paths to the files and not the full
-        file paths. Example: 'content\file.docx' instead of 'D:/content/file.docx' if you specified 'D:/' as
-        'directory_path'.
-    :return:
+        Search for a hyperlink in all the docx files in the specified directory.
+        :param directory_path: string, path to the directory with docx files.
+        :param hyperlink: string, hyperlink to search for.
+        :param relative_paths: boolean, if True, the function will return relative paths to the files and not the full
+            file paths. Example: 'content\file.docx' instead of 'D:/content/file.docx' if you specified 'D:/' as
+            'directory_path'.
+        :return:
 
-    Main function example:
-        from atomicshop import filesystem
-        from atomicshop.file_io import docxs
-        from atomicshop import file_io
+        Main function example:
+            import os
+            from atomicshop import filesystem
+            from atomicshop.file_io import docxs, file_io
 
-        directory_path = r"D:/directory_with_docx_files"
-        script_directory: str = filesystem.get_file_directory(__file__)
-        string_file_path: str = script_directory + r"/hyperlink.txt"
-        hyperlink: str = file_io.read_file(string_file_path)
 
-        found_in_files = docxs.search_for_hyperlink_in_files(directory_path, hyperlink, relative_paths=True)
+            # Usage
+            directory_path = r"D:/directory_with_docx_files"
+            script_directory: str = filesystem.get_file_directory(__file__)
+            string_file_path: str = script_directory + os.sep + r"hyperlink.txt"
+            hyperlink: str = file_io.read_file(string_file_path)
 
-        for found_file in found_in_files:
-            print(found_file)
+            found_in_files = docxs.search_for_hyperlink_in_files(directory_path, hyperlink, relative_paths=True)
 
-        input('press Enter')
-    """
+            for found_file in found_in_files:
+                print(found_file)
+
+            input('press Enter')
+        """
 
     if not filesystem.check_directory_existence(directory_path):
         raise NotADirectoryError(f"Directory doesn't exist: {directory_path}")

atomicshop/file_io/file_io.py

@@ -22,7 +22,7 @@ def write_file_decorator(function_name):
         print_api(message=f"Writing file: {kwargs['file_path']}", **kwargs)
 
         try:
-            with open(kwargs['file_path'], kwargs['file_mode']) as output_file:
+            with open(kwargs['file_path'], kwargs['file_mode'], encoding=kwargs['encoding']) as output_file:
                 # Pass the 'output_file' object to kwargs that will pass the object to the executing function.
                 kwargs['file_object'] = output_file
                 # Since our 'kwargs' has already all the needed arguments, we don't need 'args'.
@@ -73,24 +73,33 @@ def read_file_decorator(function_name):
 
 
 @write_file_decorator
-def write_file(content: str,
-               file_path: str,
-               file_mode: str = 'w',
-               file_object=None,
-               **kwargs) -> None:
+def write_file(
+        content: Union[str, list[str]],
+        file_path: str,
+        file_mode: str = 'w',
+        encoding: str = None,
+        file_object=None,
+        **kwargs) -> None:
     """
     Export string to text file.
 
-    :param content: string, that includes formatted text content.
+    :param content: string or list of strings, that includes formatted text content.
     :param file_path: Full file path string to the file to output. Used in the decorator, then passed to this function.
     :param file_mode: string, file writing mode. Examples: 'x', 'w', 'wb'.
         Default is 'w'.
+    :param encoding: string, write the file with encoding. Example: 'utf-8'. 'None' is default, since it is default
+        in 'open()' function.
     :param file_object: file object of the 'open()' function in the decorator. Decorator executes the 'with open()'
         statement and passes to this function. That's why the default is 'None', since we get it from the decorator.
     :return:
     """
 
-    file_object.write(content)
+    if isinstance(content, list):
+        file_object.writelines(content)
+    elif isinstance(content, str):
+        file_object.write(content)
+    else:
+        raise TypeError(f"Content type is not supported: {type(content)}")
 
 
 @read_file_decorator
@@ -122,3 +131,41 @@ def read_file(file_path: str,
         result = file_object.read()
 
     return result
+
+
+def find_and_replace_in_file(
+        file_path: str,
+        find_what: str,
+        replace_to: str,
+        encoding: str = None,
+        raise_if_more_than_one_found: bool = False,
+        **kwargs
+) -> None:
+    """
+    Find and replace string in file.
+
+    :param file_path: String with full file path to read.
+    :param find_what: String to find in the file.
+    :param replace_to: String to replace the found string.
+    :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_found: Boolean, if True, the function will raise an error if more than one string
+        instance was found in the file.
+    :return: None
+    """
+
+    # Read the file to variable.
+    file_data = read_file(file_path=file_path, read_to_list=True, encoding=encoding)
+
+    # Find and replace the string.
+    found_string_counter = 0
+    for index, line in enumerate(file_data):
+        if find_what in line:
+            file_data[index] = line.replace(find_what, replace_to)
+            found_string_counter += 1
+
+            if raise_if_more_than_one_found and found_string_counter > 1:
+                raise LookupError(f"More than one string instance was found in the file: {file_path}\n"
+                                  f"Nothing was changed.")
+
+    write_file(content=file_data, file_path=file_path, encoding=encoding)

atomicshop/permissions.py

@@ -1,5 +1,6 @@
 import os
 import ctypes
+import contextlib
 
 
 def is_admin() -> bool:
@@ -20,3 +21,37 @@ def is_admin() -> bool:
             result = False
 
     return result
+
+
+@contextlib.contextmanager
+def temporary_regular_permissions():
+    """
+    This function is used to temporarily change the effective user and group ID to the original user's.
+    This is used to run commands with the original user's permissions.
+    If you executed a script with 'sudo' and wanted certain action to execute as regular user and not root.
+
+    Example:
+        with temporary_regular_permissions():
+            # Do something with regular permissions.
+            pass
+
+    :return:
+    """
+    # Save the current effective user and group ID
+    original_euid, original_egid = os.geteuid(), os.getegid()
+
+    try:
+        # Get the original user's UID and GID
+        orig_uid = int(os.environ.get('SUDO_UID', os.getuid()))
+        orig_gid = int(os.environ.get('SUDO_GID', os.getgid()))
+
+        # Set the effective user and group ID to the original user's
+        os.setegid(orig_gid)
+        os.seteuid(orig_uid)
+
+        # Provide the context to do something with these permissions
+        yield
+    finally:
+        # Revert to the original effective user and group ID
+        os.seteuid(original_euid)
+        os.setegid(original_egid)

{atomicshop-2.5.13.dist-info → atomicshop-2.5.15.dist-info}/METADATA

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

{atomicshop-2.5.13.dist-info → atomicshop-2.5.15.dist-info}/RECORD

@@ -1,4 +1,4 @@
-atomicshop/__init__.py,sha256=EI41sLBzEv1XL9PjDvBLAUPXQiEGOfUb64ozpuMkcYE,123
+atomicshop/__init__.py,sha256=VHWnXlEZ9dAZpc3c2DWsrkxZnCkZZZQ7x9bDbQCK-1A,123
 atomicshop/_basics_temp.py,sha256=6cu2dd6r2dLrd1BRNcVDKTHlsHs_26Gpw8QS6v32lQ0,3699
 atomicshop/appointment_management.py,sha256=N3wVGJgrqJfsj_lqiRfaL3FxMEe57by5Stzanh189mk,7263
 atomicshop/archiver.py,sha256=QuDKx6bJEM29u-7r2tsizXEEGJmPuv0Xm91JQOpg__8,7152
@@ -20,7 +20,7 @@ atomicshop/inspect_wrapper.py,sha256=sGRVQhrJovNygHTydqJj0hxES-aB2Eg9KbIk3G31apw
 atomicshop/ip_addresses.py,sha256=GBG9YXEqHItmGEgKwqatx28CbWislFI2ZI2xVHGIqO4,759
 atomicshop/keyboard_press.py,sha256=1W5kRtOB75fulVx-uF2yarBhW0_IzdI1k73AnvXstk0,452
 atomicshop/pbtkmultifile_argparse.py,sha256=aEk8nhvoQVu-xyfZosK3ma17CwIgOjzO1erXXdjwtS4,4574
-atomicshop/permissions.py,sha256=CYTDVOI0jh9ks0ZLnnOuPzppgCszFEc9-92DTkVTYi4,522
+atomicshop/permissions.py,sha256=tfODaD-81zv0PrpAW-9MMULHaGe2r9TRnkP7MPhN-mQ,1735
 atomicshop/print_api.py,sha256=3n1CoiXvDcDGg00n5gEmQYInHryIhWbcpNjVobO1Gao,11468
 atomicshop/process.py,sha256=i_25PrSqSBbTcstCi_8rWVXAEYco81l6b9x1l_egTOY,14193
 atomicshop/process_name_cmd.py,sha256=TNAK6kQZm5JKWzEW6QLqVHEG98ZLNDQiSS4YwDk8V8c,3830
@@ -45,6 +45,7 @@ atomicshop/addons/a_setup_scripts/install_psycopg2_ubuntu.sh,sha256=lM7LkXQ2AxfF
 atomicshop/addons/a_setup_scripts/install_pywintrace_0.3.cmd,sha256=lEP_o6rWcBFUyup6_c-LTL3Q2LRMqryLuG3mJw080Zc,115
 atomicshop/addons/mains/install_docker_ubuntu_main_sudo.py,sha256=3VDGDO41Vubzf64DaBapLlFYX52dEdyPBNfolSsbGcM,161
 atomicshop/addons/mains/install_wsl_ubuntu_lts_admin.py,sha256=PrvZ4hMuadzj2GYKRZSwyNayJUuaSnCF9nV6ORqoPdo,123
+atomicshop/addons/mains/search_for_hyperlinks_in_docx.py,sha256=HkIdo_Sz9nPbbbJf1mwfwFkyI7vkvpH8qiIkuYopN4w,529
 atomicshop/addons/mains/FACT/factw_fact_extractor_docker_image_main_sudo.py,sha256=DDKX3Wp2SmzMCEtCIEOUbEKMob2ZQ7VEQGLEf9uYXrs,320
 atomicshop/addons/mains/FACT/update_extract.py,sha256=rvpgoBqDKlVsI9WxJfkpjbVPAWTsxC7M3MdmXJhrqo8,171
 atomicshop/addons/package_setup/CreateWheel.cmd,sha256=hq9aWBSH6iffYlZyaCNrFlA0vxMh3j1k8DQE8IARQuA,189
@@ -83,8 +84,8 @@ atomicshop/etw/dns_trace.py,sha256=ZbEf1gptnUnJwaRURUW9ENDwC9Q41Zl6NtxgMNELJcg,5
 atomicshop/etw/etw.py,sha256=xVJNbfCq4KgRfsDnul6CrIdAMl9xRBixZ-hUyqiB2g4,2403
 atomicshop/file_io/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/file_io/csvs.py,sha256=4R4Kij8FmxNwXFjDtlF_A0flAk0Hj5nZKlEnqC5VxgQ,3125
-atomicshop/file_io/docxs.py,sha256=V2jwNrDWb2xYL-qS-kYRcK-yy3JIaND8o7gVwWJSYno,4223
-atomicshop/file_io/file_io.py,sha256=kaRMSm8sNrnos1gqgAcPVkUXjXgZE-uW_STueqsFZyw,5657
+atomicshop/file_io/docxs.py,sha256=2lue7_eAz0fI8X3vCn34lHarU5xGSm4-Yqr0PeUPt84,4359
+atomicshop/file_io/file_io.py,sha256=5bLEXOhvem-k8UwbmvFugyvzt-zgIdz2RVSR4ZZNV3Y,7557
 atomicshop/file_io/jsons.py,sha256=4xCnC6MfajLouXUFl2aVXUPvftQVf2eS5DgydPZHF_c,4170
 atomicshop/file_io/tomls.py,sha256=oa0Wm8yMkPRXKN9jgBuTnKbioSOee4mABW5IMUFCYyU,3041
 atomicshop/file_io/xlsxs.py,sha256=v_dyg9GD4LqgWi6wA1QuWRZ8zG4ZwB6Dz52ytdcmmmI,2184
@@ -191,8 +192,8 @@ atomicshop/wrappers/socketw/socket_server_tester.py,sha256=VfNthyBvgI5tL9v3Qprh4
 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.5.13.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
-atomicshop-2.5.13.dist-info/METADATA,sha256=GCuGrNYefFroSpVHNZJF1ZvWP3ejrLKruqMa4hweegU,10268
-atomicshop-2.5.13.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
-atomicshop-2.5.13.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
-atomicshop-2.5.13.dist-info/RECORD,,
+atomicshop-2.5.15.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
+atomicshop-2.5.15.dist-info/METADATA,sha256=AyVvRv1KbiiTq3Nt404Vt_r12RbbmEYuCOs5oOZ_HaM,10268
+atomicshop-2.5.15.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
+atomicshop-2.5.15.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
+atomicshop-2.5.15.dist-info/RECORD,,