atomicshop 2.10.3__py3-none-any.whl → 2.10.4__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.3'
+__version__ = '2.10.4'

atomicshop/basics/numbers.py

@@ -23,14 +23,19 @@ def find_highest_number(numbers: list[float, int, str]):
     return max(numbers)
 
 
-def convert_bytes_to_readable(byte_size: Union[int, float]):
+def convert_bytes_to_readable(
+        byte_size: Union[int, float],
+        return_formatted_string=False
+) -> Union[tuple[Union[int, float], str], str]:
     """
     Convert bytes to a more readable format (KB, MB, GB, etc.) with two numbers after the decimal point.
 
     :param byte_size: Size in bytes
     :type byte_size: int or float
-    :return: A string representing the size in a readable format
-    :rtype: str
+    :param return_formatted_string: If True, return the formatted string,
+        otherwise return the size and suffix separately in a tuple.
+    :type return_formatted_string: bool
+    :return: tuple of integer or float and suffix string - representing the size in a readable format
     """
     # Define the suffixes for each unit of measurement
     suffixes = ['B', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB']
@@ -44,5 +49,9 @@ def convert_bytes_to_readable(byte_size: Union[int, float]):
         i += 1
 
     # Format the result to include two digits after the decimal point
-    readable_format = "{:.2f} {}".format(byte_size, suffixes[i])
-    return readable_format
+    if return_formatted_string:
+        readable_format: str = "{:.2f} {}".format(byte_size, suffixes[i])
+        return readable_format
+    else:
+        return byte_size, suffixes[i]
+

atomicshop/wrappers/elasticsearchw/config_basic.py

@@ -1,6 +1,7 @@
 DEFAULT_ELASTIC_PORT: str = '9200'
 DEFAULT_ELASTIC_HOST: str = 'localhost'
 DEFAULT_ELASTIC_URL: str = f"http://{DEFAULT_ELASTIC_HOST}:{DEFAULT_ELASTIC_PORT}"
+DEFAULT_ELASTIC_URL_JVM_OPTIONS: str = f"{DEFAULT_ELASTIC_URL}/_nodes?filter_path=**.jvm&pretty"
 
 DEFAULT_KIBANA_PORT: str = '5601'
 DEFAULT_KIBANA_HOST: str = 'localhost'
@@ -12,7 +13,7 @@ ELASTIC_CONFIG_FILE: str = f"{ELASTIC_SEARCH_CONFIG_DIRECTORY}/elasticsearch.yml
 XPACK_SECURITY_SETTING_NAME: str = "xpack.security.enabled"
 
 ELASTIC_JVM_OPTIONS_DIRECTORY: str = f"{ELASTIC_SEARCH_CONFIG_DIRECTORY}/jvm.options.d"
-ELASTIC_JVM_OPTIONS_CUSTOM_FILE: str = f"{ELASTIC_JVM_OPTIONS_DIRECTORY}/custom.options"
+ELASTIC_JVM_OPTIONS_4GB_CUSTOM_FILE: str = f"{ELASTIC_JVM_OPTIONS_DIRECTORY}/4gb_memory_heap.options"
 ELASTIC_JVM_OPTIONS_4GB_MEMORY_USAGE: list[str] = ['-Xms4g', '-Xmx4g']
 
 UBUNTU_DEPENDENCY_PACKAGES: list[str] = ['apt-transport-https', 'openjdk-11-jdk', 'wget']

atomicshop/wrappers/elasticsearchw/infrastructure.py

@@ -170,29 +170,35 @@ def modify_xpack_security_setting(
             print_api(f"The setting is already set to [{setting}].")
 
 
-def create_jvm_options_custom_file(file_path: str = None, options: list = None):
+def create_jvm_options_custom_file(file_path: str, options: list):
     """
     The function creates a custom JVM options file for Elasticsearch.
-    The default file path is 'config_basic.ELASTIC_JVM_OPTIONS_CUSTOM_FILE'.
-    The default options are 'config_basic.ELASTIC_JVM_OPTIONS_4GB_MEMORY_USAGE'.
-    The 4GB memory usage options are needed for the Elasticsearch to work properly and not to crash.
+    You can use the default directory path as 'config_basic.ELASTIC_JVM_OPTIONS_DIRECTORY'.
     :param file_path: str, the path to the custom JVM options file.
     :param options: list, the list of JVM options.
     :return:
     """
 
-    if not file_path:
-        file_path = config_basic.ELASTIC_JVM_OPTIONS_CUSTOM_FILE
-
-    if not options:
-        options = config_basic.ELASTIC_JVM_OPTIONS_4GB_MEMORY_USAGE
-
     # Write the options to the file.
     with open(file_path, 'w') as file:
         for option in options:
             file.write(f"{option}\n")
 
 
+def create_jvm_options_custom_4gb_memory_heap_file(file_path: str = None):
+    """
+    The function creates a custom JVM options file with 4GB memory heap usage.
+    The 4GB memory usage options are needed for the Elasticsearch to work properly and not to crash.
+    :param file_path: str, the path to the custom JVM options file.
+    :return:
+    """
+
+    if not file_path:
+        file_path = config_basic.ELASTIC_JVM_OPTIONS_4GB_CUSTOM_FILE
+
+    create_jvm_options_custom_file(file_path, config_basic.ELASTIC_JVM_OPTIONS_4GB_MEMORY_USAGE)
+
+
 def is_server_available(
         max_attempts: int = 5,
         wait_between_attempts_seconds: float = 10,
@@ -234,3 +240,25 @@ def is_server_available(
 
     print_api("Elasticsearch did not start within the expected time.", color='red', **print_kwargs)
     return False
+
+
+def is_4gb_memory_heap_options_applied_on_server() -> bool:
+    """
+    The function checks if the 4GB memory heap options are applied on the Elasticsearch server.
+    :return: bool.
+    """
+
+    # Send a GET request
+    response = requests.get(config_basic.DEFAULT_ELASTIC_URL_JVM_OPTIONS)
+    response.raise_for_status()  # Raise an exception for HTTP errors
+
+    # Load JSON data from the response
+    jvm_data = response.json()
+
+    # Check if memory heap options are applied in 'input_arguments' key.
+    for node in jvm_data['nodes'].values():
+        # Get the JVM input arguments values.
+        input_arguments = node['jvm']['input_arguments']
+
+        # Check that the 4GB memory heap options are applied.
+        return all(options in input_arguments for options in config_basic.ELASTIC_JVM_OPTIONS_4GB_MEMORY_USAGE)

atomicshop/wrappers/elasticsearchw/install_elastic.py

@@ -216,10 +216,7 @@ def install_elastic_kibana_ubuntu(install_elastic: bool = True, install_kibana:
         infrastructure.start_elastic_and_check_service_availability()
 
         print_api("Creating custom JVM options file with 4GB memory usage.")
-        infrastructure.create_jvm_options_custom_file(
-            file_path=config_basic.ELASTIC_JVM_OPTIONS_CUSTOM_FILE,
-            options=config_basic.ELASTIC_JVM_OPTIONS_4GB_MEMORY_USAGE
-        )
+        infrastructure.create_jvm_options_custom_4gb_memory_heap_file()
 
     if install_kibana:
         # Install Kibana.

atomicshop/wrappers/factw/install/pre_install_and_install_before_restart.py

@@ -68,7 +68,7 @@ def install_before_restart(
                 archive_path=fact_source_archive_path, extract_directory=installation_directory,
                 remove_first_directory=True, **(print_kwargs or {}))
 
-        # Set the executable permission on the pre-install file.
+        # Set the executable permission on the pre-installation file.
         permissions.set_executable_permission(fact_core_pre_install_file_path)
 
     # Run the shell script

atomicshop/wrappers/psutilw/memories.py

@@ -1,5 +1,7 @@
 import psutil
 
+from ...basics import numbers
+
 
 def get_memory_usage():
     """
@@ -7,3 +9,17 @@ def get_memory_usage():
     :return: float
     """
     return psutil.virtual_memory().percent
+
+
+def get_total_ram(convert_size_to_readable=False) -> tuple[int, str]:
+    """
+    Get total physical memory in bytes.
+    :return:
+    """
+
+    memory_size: int = psutil.virtual_memory().total
+
+    if convert_size_to_readable:
+        return numbers.convert_bytes_to_readable(memory_size)
+
+    return memory_size, 'B'

{atomicshop-2.10.3.dist-info → atomicshop-2.10.4.dist-info}/METADATA

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

{atomicshop-2.10.3.dist-info → atomicshop-2.10.4.dist-info}/RECORD

@@ -1,4 +1,4 @@
-atomicshop/__init__.py,sha256=CAdy7uaKf071UFjU2KsMKAsd6EzULOhS7j2IOVneT_A,123
+atomicshop/__init__.py,sha256=jiF6fRhuPCS2l3bXIdgVnGCUG5xcjtXdqlhFtq2zNTI,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
@@ -88,7 +88,7 @@ atomicshop/basics/isinstancing.py,sha256=fQ35xfqbguQz2BUn-3a4KVGskhTcIn8JjRtxV2r
 atomicshop/basics/list_of_dicts.py,sha256=EeUh5FwUSmjQ7_Df7yTBgwHsou5jx3tP2a0dzgs8-fk,5773
 atomicshop/basics/lists.py,sha256=pLpYPSu0BjJIAe_Ar55XhLsH2YBhftn7b-tTAdkK1sw,3928
 atomicshop/basics/multiprocesses.py,sha256=AczaI4TmYduNjE6_VEQhxvDQn4VLDdXYRxhPDpjH4T0,17974
-atomicshop/basics/numbers.py,sha256=j0f4glCtyIypEdCKv145F1gkzEEoZ2GdsGO-OM4BN7o,1439
+atomicshop/basics/numbers.py,sha256=EDmt4M72hVE3IUqximSsrxM7HW64QQFCaGP5_fZuLPo,1839
 atomicshop/basics/randoms.py,sha256=DmYLtnIhDK29tAQrGP1Nt-A-v8WC7WIEB8Edi-nk3N4,282
 atomicshop/basics/strings.py,sha256=aQ92AJPvb3U0O6n2FMqRUqEsPCiklwGX--jPmB9M0_s,15418
 atomicshop/basics/threads.py,sha256=xvgdDJdmgN0wmmARoZ-H7Kvl1GOcEbvgaeGL4M3Hcx8,2819
@@ -157,10 +157,10 @@ atomicshop/wrappers/dockerw/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMp
 atomicshop/wrappers/dockerw/dockerw.py,sha256=w8zSJr5C7cbvbuG09ORCpAe0BOcibqqL_Z2EKEBHYK4,6266
 atomicshop/wrappers/dockerw/install_docker.py,sha256=eF0raR1EO9Xk1MVH7CvtkFI2Fgu9zL12MIYV_1vPTQk,4799
 atomicshop/wrappers/elasticsearchw/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-atomicshop/wrappers/elasticsearchw/config_basic.py,sha256=q9Ybr8TTeNPy6FxtiYCln8WNuwOQjdPazTRoGl7Lk8w,1066
+atomicshop/wrappers/elasticsearchw/config_basic.py,sha256=fDujtrjEjbWiYh_WQ3OcYp_8mXhXPYeKLy4wSPL5qM0,1177
 atomicshop/wrappers/elasticsearchw/elasticsearchw.py,sha256=7TqFdEFznO8NlligJhEKk1vm641ALpCYdaRl1uoXdzM,9768
-atomicshop/wrappers/elasticsearchw/infrastructure.py,sha256=Sy15gLVe_LAk9WpAoFxu5YApecFlYeJzzJ8lk5NYQEw,9217
-atomicshop/wrappers/elasticsearchw/install_elastic.py,sha256=5CNgIoPIDnTCk5kU7Zcyb48TP4JScvUzeZmhcWt63sI,8754
+atomicshop/wrappers/elasticsearchw/infrastructure.py,sha256=aQZpPNN6mcBR5K5iOX-pLV3GJJhmkj5IqbTwkzKKSYE,10261
+atomicshop/wrappers/elasticsearchw/install_elastic.py,sha256=IhbapWeq5am-MtmnvKBNBPzvaL338rvfG0rbSpl8azE,8620
 atomicshop/wrappers/elasticsearchw/queries/__init__.py,sha256=KBjT-bAt75CJsx1Apko9mpuFU4pfZV8DcGWQvpX65RU,78
 atomicshop/wrappers/elasticsearchw/queries/aggregation.py,sha256=N9a5yMMnb10sMa_x1qJBFQpgyJ49UWo8_vxuqmUtZ1A,1742
 atomicshop/wrappers/elasticsearchw/queries/info.py,sha256=P_VhhBo8MvRI4Shi-bh4RsYtlYNRKRBzScXPC64Up_Q,2900
@@ -178,7 +178,7 @@ atomicshop/wrappers/factw/fact_extractor/docker_image.py,sha256=jJAoJNQ4aoATjn3x
 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/pre_install_and_install_before_restart.py,sha256=fAH53sJgWoXOOhjeAmME2SHYm-5YQAgEi1neaok82Lk,4246
+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
 atomicshop/wrappers/factw/postgresql/file_object.py,sha256=VRiCXnsd6yDbnsE-TEKYPC-gkAgFVkE6rygRrJLQShI,713
@@ -213,7 +213,7 @@ atomicshop/wrappers/playwrightw/scenarios.py,sha256=Wz7aVYfG7K4fuSe_TUAc1jhFXVq5
 atomicshop/wrappers/playwrightw/waits.py,sha256=308fdOu6YDqQ7K7xywj7R27sSmFanPBQqpZyBC-NFmo,7015
 atomicshop/wrappers/psutilw/cpus.py,sha256=w6LPBMINqS-T_X8vzdYkLS2Wzuve28Ydp_GafTCngrc,236
 atomicshop/wrappers/psutilw/disks.py,sha256=3ZSVoommKH1TWo37j_83frB-NqXF4Nf5q5mBCX8G4jE,9221
-atomicshop/wrappers/psutilw/memories.py,sha256=wpdKEkQ9Wty_r7ZJKkfli7wIHMXdQOMlmDlzmc_0FWo,161
+atomicshop/wrappers/psutilw/memories.py,sha256=_S0aL8iaoIHebd1vOFrY_T9aROM5Jx2D5CvDh_4j0Vc,528
 atomicshop/wrappers/psutilw/psutilw.py,sha256=G22ZQfGnqX15-feD8KUXfEZO4pFkIEnB8zgPzJ2jc7M,20868
 atomicshop/wrappers/psycopgw/psycopgw.py,sha256=XJvVf0oAUjCHkrYfKeFuGCpfn0Oxj3u4SbKMKA1508E,7118
 atomicshop/wrappers/pywin32w/wmi_win32process.py,sha256=qMzXtJ5hBZ5ydAyqpDbSx0nO2RJQL95HdmV5SzNKMhk,6826
@@ -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.3.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
-atomicshop-2.10.3.dist-info/METADATA,sha256=Y3tx3_gaPuodTn3bxopQR6X7_AYeMMMcv6Fjtv4dLJA,10423
-atomicshop-2.10.3.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-atomicshop-2.10.3.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
-atomicshop-2.10.3.dist-info/RECORD,,
+atomicshop-2.10.4.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
+atomicshop-2.10.4.dist-info/METADATA,sha256=0kskgiSsXWr6BHlxBF9mViz3QkT0EoWqwm0LKmPJdBQ,10423
+atomicshop-2.10.4.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+atomicshop-2.10.4.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
+atomicshop-2.10.4.dist-info/RECORD,,