atomicshop 2.10.6__py3-none-any.whl → 2.10.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.10.6'
+__version__ = '2.10.8'

atomicshop/basics/strings.py

@@ -1,7 +1,10 @@
 import fnmatch
 import re
+from pathlib import Path
+import argparse
 
 from . import lists
+from ..print_api import print_api
 
 
 def get_nth_character_from_start(input_string: str, nth: int):
@@ -411,21 +414,76 @@ def convert_string_to_colon_separated(string: str, number_of_characters: int = 2
     return ':'.join([string[i:i+number_of_characters] for i in range(0, len(string), number_of_characters)])
 
 
-def replace_string_in_file(file_path: str, old_string: str, new_string: str):
+def replace_string_in_file(
+        file_path: str,
+        old_string: str,
+        new_string: str = None,
+        find_only: bool = False,
+        print_kwargs: dict = None
+) -> list[int]:
     """
     Function replaces 'old_string' with 'new_string' in the file.
     :param file_path: string, path to the file.
     :param old_string: string, to replace.
     :param new_string: string, to replace with.
+    :param find_only: boolean, if 'True' will only find the 'old_string' and return line numbers where it was found.
+    :param print_kwargs: dict, the print_api arguments.
+    :return: list of integers, line numbers where the 'old_string' was found.
     """
 
-    # Read in the file
-    with open(file_path, 'r') as file:
-        filedata = file.read()
+    if not find_only and new_string is None:
+        raise ValueError("The 'new_string' string must be provided if 'find_only' is False.")
 
-    # Replace the target string
-    filedata = filedata.replace(old_string, new_string)
+    changed_lines = []
 
-    # Write the file out again
-    with open(file_path, 'w') as file:
-        file.write(filedata)
+    # Read the file content
+    with open(file_path, 'r', encoding='utf-8') as file:
+        lines = file.readlines()
+
+    # Search for the old string and either replace or just track line numbers
+    for index, line in enumerate(lines, start=1):
+        if old_string in line:
+            changed_lines.append(index)
+            if not find_only:
+                lines[index - 1] = line.replace(old_string, new_string)
+
+    # If not in find-only mode, overwrite the file with the replaced content
+    if not find_only:
+        with open(file_path, 'w', encoding='utf-8') as file:
+            file.writelines(lines)
+
+    # Output the relevant line numbers
+    print_api(f"Target string found on the following lines: {changed_lines}", **(print_kwargs or {}))
+    return changed_lines
+
+
+def replace_string_in_file_main_argparse():
+    """
+    Main function for the 'replace_string_in_file' function.
+    You can use this function as a command line tool.
+    Example:
+        Create a file 'replace_string_in_file.py' with the next content:
+        ```
+        from atomicshop.basics import strings
+
+        if __name__ == '__main__':
+            strings.replace_string_in_file_main_argparse()
+        ```
+    """
+
+    parser = argparse.ArgumentParser(description="Replace string in file.")
+    parser.add_argument("file_path", type=Path, help="Path to the file.")
+    parser.add_argument("old_string", type=str, help="Old string to replace.")
+    parser.add_argument("--new_string", '-n', help="New string to replace with.")
+    parser.add_argument(
+        '--find_only', '-f', action='store_true',
+        help='Only output lines where the old string is found, without replacing.')
+
+    args = parser.parse_args()
+
+    replace_string_in_file(
+        file_path=args.file_path,
+        old_string=args.old_string,
+        new_string=args.new_string,
+        find_only=args.find_only
+    )

atomicshop/file_io/docxs.py

@@ -19,7 +19,7 @@ def get_hyperlinks(docx_path):
     # If the file is empty, it will raise an exception.
     # The same exception will rise if the file is opened in Word.
     except PackageNotFoundError:
-        print_api(f"File is empty or opened in Word: {docx_path}", color="red", error_type=True)
+        print_api(f"File is not DOCX format or opened in Word: {docx_path}", color="red", error_type=True)
         return hyperlinks
 
     for paragraph in doc.paragraphs:
@@ -67,7 +67,7 @@ def search_for_hyperlink_in_files(directory_path: str, hyperlink: str, relative_
 
     # Get all the docx files in the specified directory.
     files = filesystem.get_file_paths_from_directory(
-        directory_path, file_name_check_pattern="*.docx",
+        directory_path, file_name_check_pattern="*\.docx",
         add_relative_directory=True, relative_file_name_as_directory=True)
 
     found_in_files: list = list()
@@ -98,14 +98,23 @@ def search_for_hyperlink_in_files_interface_main(script_directory: str = None):
         def main():
             docxs.search_for_hyperlink_in_files_interface_main()
 
+        # Create the 'config.toml' file if it doesn't exist.
+        # Run the script the first time in order to create empty TOML.
+        # Note: 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'.
+        # hyperlink = 'https://www.example.com'
+        # directory_path = 'C:/where/to/look/for/docxs'
+        # relative_paths = True
+
         if __name__ == '__main__':
             main()
     """
 
     # Create the 'config.toml' file if it doesn't exist. Manually constructing the TOML content.
     toml_dict = {
-        'directory_path': '',
         'hyperlink': '',
+        'directory_path': '',
         'relative_paths': True
     }
 
@@ -117,7 +126,10 @@ def search_for_hyperlink_in_files_interface_main(script_directory: str = None):
     found_in_files = search_for_hyperlink_in_files(
         config['directory_path'], config['hyperlink'], relative_paths=config['relative_paths'])
 
-    for found_file in found_in_files:
-        print(found_file)
+    print_api(f"Found in [{len(found_in_files)}] files:", color="blue")
+
+    for index, found_file in enumerate(found_in_files):
+        print_api(f"[{index+1}]", print_end="", color="green")
+        print_api(f" {found_file}")
 
-    input('press Enter')
+    input('[*] Press [Enter] to exit...')

atomicshop/filesystem.py

@@ -569,6 +569,9 @@ def get_file_paths_from_directory(
     :param file_name_check_pattern: string, if specified, the function will return only files that match the pattern.
         The string can contain part of file name to check or full file name with extension.
         Can contain wildcards.
+        If you need to specify a "." in the pattern, you need to escape it with a backslash:
+        Example: "*\.txt" will return all files with the extension ".txt".
+        While "*.txt" will return all files that contain "txt" in the name.
     :param add_relative_directory: boolean, if
         'True', then the function will add relative directory to the output list.
             In this case the output list will contain dictionaries with keys 'path' and 'relative_dir'.

atomicshop/wrappers/dockerw/install_docker.py

@@ -59,10 +59,14 @@ def add_current_user_to_docker_group(print_kwargs: dict = None):
         return False
 
 
-def install_docker_ubuntu(add_current_user_to_docker_group_bool: bool = True):
+def install_docker_ubuntu(rootless: bool = True, add_current_user_to_docker_group_bool: bool = False):
     """
     The function will install docker on ubuntu.
+    :param rootless: bool, if True, the rootless installation will be performed.
+        Meaning, you will be able to run the 'docker' command without sudo and you will not need to add the
+        current user to the docker group.
     :param add_current_user_to_docker_group_bool: bool, if True, the current user will be added to the docker group.
+        So the user will be able to run the 'docker' command without sudo.
 
     Usage in main.py (run with sudo):
         from atomicshop.wrappers.dockerw import install_docker

atomicshop/wrappers/factw/install/install_after_restart.py

@@ -32,4 +32,4 @@ def install_after_restart(
     process.execute_with_live_output(cmd=install_command, verbose=True)
     # Remove the FACT_core installation log.
     working_directory_path: str = filesystem.get_working_directory()
-    filesystem.remove_file(str(Path(working_directory_path, config_install.INSTALL_LOG_FILE_NAME)))
+    # filesystem.remove_file(str(Path(working_directory_path, config_install.INSTALL_LOG_FILE_NAME)))

{atomicshop-2.10.6.dist-info → atomicshop-2.10.8.dist-info}/METADATA

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

{atomicshop-2.10.6.dist-info → atomicshop-2.10.8.dist-info}/RECORD

@@ -1,4 +1,4 @@
-atomicshop/__init__.py,sha256=tFi0pykEUI0rTZZH1Vg6SdcRfzQTZKkiN45riWXH6hE,123
+atomicshop/__init__.py,sha256=jLebawbp1INbR4X9mVO70IY6_95wF8u3eJf77Id2Cis,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=bNZOo5jVPzq7OT2qCPukXoK3zb1oOsyaelUwQEyK1SA,2500
 atomicshop/domains.py,sha256=Rxu6JhhMqFZRcoFs69IoEd1PtYca0lMCG6F1AomP7z4,3197
 atomicshop/emails.py,sha256=I0KyODQpIMEsNRi9YWSOL8EUPBiWyon3HRdIuSj3AEU,1410
 atomicshop/file_types.py,sha256=-0jzQMRlmU1AP9DARjk-HJm1tVE22E6ngP2mRblyEjY,763
-atomicshop/filesystem.py,sha256=FFOEUZygGvPrIdedq4DVaXhMX2YFaFovB2xhDVMCgM4,43813
+atomicshop/filesystem.py,sha256=I72yd_-G1y7aWtD7IzgUQn5BBg8Dpri8o7Jrb_-kfW4,44060
 atomicshop/functions.py,sha256=pK8hoCE9z61PtWCxQJsda7YAphrLH1wxU5x-1QJP-sY,499
 atomicshop/hashing.py,sha256=Le8qGFyt3_wX-zGTeQShz7L2HL_b6nVv9PnawjglyHo,3474
 atomicshop/http_parse.py,sha256=nrf2rZcprLqtW8HVrV7TCZ1iTBcWRRy-mXIlAOzcaJs,9703
@@ -90,7 +90,7 @@ atomicshop/basics/lists.py,sha256=pLpYPSu0BjJIAe_Ar55XhLsH2YBhftn7b-tTAdkK1sw,39
 atomicshop/basics/multiprocesses.py,sha256=nSskxJSlEdalPM_Uf8cc9kAYYlVwYM1GonBLAhCL2mM,18831
 atomicshop/basics/numbers.py,sha256=ESX0z_7o_ok3sOmCKAUBoZinATklgMy2v-4RndqXlVM,1837
 atomicshop/basics/randoms.py,sha256=DmYLtnIhDK29tAQrGP1Nt-A-v8WC7WIEB8Edi-nk3N4,282
-atomicshop/basics/strings.py,sha256=aQ92AJPvb3U0O6n2FMqRUqEsPCiklwGX--jPmB9M0_s,15418
+atomicshop/basics/strings.py,sha256=9DH1190jgSpSRPgcywSysJ0iovqPOWjSokumP6ng2BI,17686
 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
@@ -99,7 +99,7 @@ atomicshop/etw/dns_trace.py,sha256=RaREpwJETAMZSd1Lhbg0sO3ugBMw3y1fSKdvP5NfTqM,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=3IFtaurVhvntcuCL59bpFlzGyKxvDmVUjUQTHWluOMY,4369
+atomicshop/file_io/docxs.py,sha256=6tcYFGp0vRsHR47VwcRqwhdt2DQOwrAUYhrwN996n9U,5117
 atomicshop/file_io/file_io.py,sha256=FR84ihjGlr7Eqejo-_js4nBICVst31axD0bwX19S2eM,6385
 atomicshop/file_io/jsons.py,sha256=q9ZU8slBKnHLrtn3TnbK1qxrRpj5ZvCm6AlsFzoANjo,5303
 atomicshop/file_io/tomls.py,sha256=oa0Wm8yMkPRXKN9jgBuTnKbioSOee4mABW5IMUFCYyU,3041
@@ -155,7 +155,7 @@ atomicshop/wrappers/certauthw/certauthw.py,sha256=4WvhjANI7Kzqrr_nKmtA8Kf7B6rute
 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=w8zSJr5C7cbvbuG09ORCpAe0BOcibqqL_Z2EKEBHYK4,6266
-atomicshop/wrappers/dockerw/install_docker.py,sha256=eF0raR1EO9Xk1MVH7CvtkFI2Fgu9zL12MIYV_1vPTQk,4799
+atomicshop/wrappers/dockerw/install_docker.py,sha256=glX5UKReRc8rUrBQUKqIQb7HnLiG2QlPXxC-qemNpAc,5133
 atomicshop/wrappers/elasticsearchw/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/wrappers/elasticsearchw/config_basic.py,sha256=fDujtrjEjbWiYh_WQ3OcYp_8mXhXPYeKLy4wSPL5qM0,1177
 atomicshop/wrappers/elasticsearchw/elasticsearchw.py,sha256=7TqFdEFznO8NlligJhEKk1vm641ALpCYdaRl1uoXdzM,9768
@@ -177,7 +177,7 @@ atomicshop/wrappers/factw/fact_extractor/__init__.py,sha256=47DEQpj8HBSa-_TImW-5
 atomicshop/wrappers/factw/fact_extractor/docker_image.py,sha256=jJAoJNQ4aoATjn3x_va031Obb4oBtcqCY40hydghm0s,2504
 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=roM1W2hkDynpEKda55xd7AsZxodsFj8i4wmFGt_HHzA,1558
+atomicshop/wrappers/factw/install/install_after_restart.py,sha256=-VXC3KDX2BzF0oi0ELCmfch55vLk-3t16KxlmYyUGD8,1560
 atomicshop/wrappers/factw/install/pre_install_and_install_before_restart.py,sha256=7Yk1xZXFXoPZVsSvgZzOLMoZza9OFIB5HplLQxY-7Bs,4251
 atomicshop/wrappers/factw/postgresql/__init__.py,sha256=xMBn2d3Exo23IPP2F_9-SXmOlhFbwWDgS9KwozSTjA0,162
 atomicshop/wrappers/factw/postgresql/analysis.py,sha256=2Rxzy2jyq3zEKIo53z8VkjuslKE_i5mq2ZpmJAvyd6U,716
@@ -233,8 +233,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.10.6.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
-atomicshop-2.10.6.dist-info/METADATA,sha256=mwost6XyCI5vs7r3uag442WjE7EudZ3K8Hp429Wj9fs,10423
-atomicshop-2.10.6.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-atomicshop-2.10.6.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
-atomicshop-2.10.6.dist-info/RECORD,,
+atomicshop-2.10.8.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
+atomicshop-2.10.8.dist-info/METADATA,sha256=35z6a8qlF_O0hPLHYCDfdrqRN_5nx52xrhoaQ0BbCqk,10423
+atomicshop-2.10.8.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+atomicshop-2.10.8.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
+atomicshop-2.10.8.dist-info/RECORD,,