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

atomicshop/archiver/sevenz.py

@@ -25,6 +25,10 @@ def is_7z(file_object: Union[str, bytes]) -> bool:
                 return True
     except py7zr.Bad7zFile:
         return False
+    # For some reason there are files that return this exception instead of Bad7zFile.
+    except OSError as e:
+        if e.args[0] == 22:
+            return False
 
 
 def _is_7z_magic_number(data):

atomicshop/basics/dicts.py

@@ -242,3 +242,45 @@ def convert_object_with_attributes_to_dict(
         obj_dict[attr_name] = attr_value
 
     return obj_dict
+
+
+def convert_tuples_to_lists(obj):
+    """
+    Convert all tuples in object to lists. The first  input 'obj' can be a dictionary, list or tuple.
+    :param obj: dict, list, tuple, the object to convert.
+    :return:
+    """
+    if isinstance(obj, dict):
+        return {k: convert_tuples_to_lists(v) for k, v in obj.items()}
+    elif isinstance(obj, list):
+        return [convert_tuples_to_lists(element) for element in obj]
+    elif isinstance(obj, tuple):
+        return list(obj)
+    return obj
+
+
+def convert_int_to_str_in_mixed_lists(item):
+    """
+    Recursively traverse an item (which can be a dictionary, list, tuple, or a basic data type).
+    If a list or a tuple contains both integers and strings, convert all integers to strings.
+    This is useful when converting indexing a dictionary with mixed lists into Elasticsearch.
+    Since Elasticsearch doesn't support mixed lists, we need to convert integers to strings.
+    """
+
+    if isinstance(item, dict):
+        # If the item is a dictionary, apply the function to each value.
+        return {key: convert_int_to_str_in_mixed_lists(value) for key, value in item.items()}
+    elif isinstance(item, (list, tuple)):
+        # If the item is a list or a tuple, check if it contains both integers and strings.
+        contains_int = any(isinstance(elem, int) for elem in item)
+        contains_str = any(isinstance(elem, str) for elem in item)
+
+        if contains_int and contains_str:
+            # If both integers and strings are present, convert integers to strings.
+            return type(item)(str(elem) if isinstance(elem, int) else elem for elem in item)
+        else:
+            # Otherwise, apply the function to each element.
+            return type(item)(convert_int_to_str_in_mixed_lists(elem) for elem in item)
+    else:
+        # If the item is neither a dictionary, list, nor tuple, return it as is.
+        return item

atomicshop/basics/lists.py

@@ -99,3 +99,13 @@ def sort_list_by_another_list(list_of_strings_to_sort, list_of_strings_to_sort_b
         return len(list_of_strings_to_sort_by)
 
     return sorted(list_of_strings_to_sort, key=sort_key)
+
+
+def get_the_most_frequent_element_from_list(list_instance: list[str]) -> str:
+    """
+    This function will return the most frequent element from the list.
+    :param list_instance: list.
+    :return: string.
+    """
+
+    return max(set(list_instance), key=list_instance.count)

atomicshop/console_output.py

@@ -1,5 +1,7 @@
+import sys
 import contextlib
 import io
+import logging
 
 
 class TempDisableOutput:
@@ -37,3 +39,118 @@ class TempDisableOutput:
 
     def __exit__(self, *args):
         return self.redirect_stdout_object.__exit__(*args)
+
+
+def capture_console_output_without_outputting(func, *args, **kwargs):
+    """
+    Executes a function and captures its console output.
+
+    Args:
+        func: The function to execute.
+        *args: Arguments to pass to the function.
+        **kwargs: Keyword arguments to pass to the function.
+
+    Returns:
+        A string containing the captured console output.
+
+    Usage:
+        def example_function(name):
+            print(f"Hello, {name}!")
+
+        captured_output = capture_console_output(example_function, "World")
+        print("Captured output:", captured_output)
+
+    """
+
+    output_capture = io.StringIO()
+    with contextlib.redirect_stdout(output_capture):
+        func(*args, **kwargs)
+    return output_capture.getvalue()
+
+
+def capture_console_output_of_logging_without_outputting(func, *args, **kwargs):
+    """
+    Executes a function and captures its logger output.
+
+    Args:
+        func: The function to execute.
+        *args: Arguments to pass to the function.
+        **kwargs: Keyword arguments to pass to the function.
+
+    Returns:
+        A string containing the captured console output.
+
+    Usage:
+        def example_function():
+            logger = logging.getLogger()
+            logger.warning("This is a warning!")
+
+        captured_output = capture_logger_output(example_function)
+        print("Captured output:", captured_output)
+
+    """
+
+    log_capture_string = io.StringIO()
+    ch = logging.StreamHandler(log_capture_string)
+    ch.setLevel(logging.DEBUG)
+
+    logger = logging.getLogger()
+    old_handlers = logger.handlers
+    logger.handlers = [ch]
+
+    try:
+        func(*args, **kwargs)
+    finally:
+        logger.handlers = old_handlers
+        ch.close()
+
+    return log_capture_string.getvalue()
+
+
+def capture_all_output(func, *args, **kwargs):
+    """
+    Executes a function and captures its console and logger output.
+
+    Args:
+        func: The function to execute.
+        *args: Arguments to pass to the function.
+        **kwargs: Keyword arguments to pass to the function.
+
+    Returns:
+        A string containing the captured console and logger output.
+
+    Usage:
+        def example_function():
+            print("This is a print statement.")
+            logging.warning("This is a warning from logging.")
+            sys.stderr.write("This is a direct stderr write.\n")
+
+        captured_output = capture_all_output(example_function)
+        print("Captured output:", captured_output)
+    """
+
+    log_capture_string = io.StringIO()
+    ch = logging.StreamHandler(log_capture_string)
+    ch.setLevel(logging.DEBUG)
+
+    logger = logging.getLogger()
+    old_handlers = logger.handlers
+    logger.handlers = [ch]
+
+    stdout_capture = io.StringIO()
+    stderr_capture = io.StringIO()
+
+    old_stdout = sys.stdout
+    old_stderr = sys.stderr
+    sys.stdout = stdout_capture
+    sys.stderr = stderr_capture
+
+    try:
+        func(*args, **kwargs)
+    finally:
+        sys.stdout = old_stdout
+        sys.stderr = old_stderr
+        logger.handlers = old_handlers
+        ch.close()
+
+    return stdout_capture.getvalue() + stderr_capture.getvalue() + log_capture_string.getvalue()

atomicshop/file_io/jsons.py

@@ -107,3 +107,27 @@ def convert_json_string_to_dict(json_string: str) -> dict:
     """
 
     return json.loads(json_string)
+
+
+def is_dict_json_serializable(
+        dict_to_check: dict,
+        raise_exception: bool = False
+) -> tuple[bool, Union[str, None]]:
+    """
+    Check if dictionary is json serializable.
+
+    :param dict_to_check: dictionary to check.
+    :param raise_exception: boolean, if True, raise exception if dictionary is not json serializable.
+    :return:
+        boolean, True if dictionary is json serializable, False otherwise.
+        string, error message if dictionary is not json serializable, None otherwise.
+    """
+
+    try:
+        json.dumps(dict_to_check)
+        return True, None
+    except TypeError as e:
+        if raise_exception:
+            raise e
+        else:
+            return False, str(e)

atomicshop/wrappers/elasticsearchw/config_basic.py

@@ -0,0 +1,3 @@
+DEFAULT_PORT: str = '9200'
+DEFAULT_HOST: str = 'localhost'
+DEFAULT_URL: str = f"http://{DEFAULT_HOST}:{DEFAULT_PORT}"

atomicshop/wrappers/elasticsearchw/elasticsearchw.py

@@ -0,0 +1,101 @@
+from elasticsearch import Elasticsearch
+from datetime import datetime
+
+from . import config_basic
+from ...basics import dicts
+
+
+ELASTIC_WRAPPER = None
+
+
+def get_elastic_wrapper(url: str = None, overwrite: bool = False):
+    """
+    The function initializes the Elasticsearch wrapper.
+
+    :param url: str, the url of the Elasticsearch server. If None, the default url is used: http://localhost:9200
+    :param overwrite: bool, if True, the wrapper is reinitialized even if it is already initialized.
+    :return: Elasticsearch, the Elasticsearch wrapper.
+
+    Usage:
+        elastic_wrapper = get_elastic_wrapper()
+    or after you initialize it once, you can use it like:
+        atomicshop.wrappers.elasticsearchw.elasticsearchw.ELASTIC_WRAPPER
+    """
+
+    # If no url is provided, use the default url.
+    if url is None:
+        url = config_basic.DEFAULT_URL
+
+    # Get the global variable.
+    global ELASTIC_WRAPPER
+    # If the wrapper is not initialized, initialize it.
+    if ELASTIC_WRAPPER is None:
+        ELASTIC_WRAPPER = Elasticsearch([url])
+    # If the wrapper is already initialized, check if it should be overwritten.
+    else:
+        if overwrite:
+            ELASTIC_WRAPPER = Elasticsearch([url])
+
+    return ELASTIC_WRAPPER
+
+
+def test_connection(elastic_wrapper: Elasticsearch = None):
+    """
+    The function tests the connection to the Elasticsearch server.
+
+    :param elastic_wrapper: Elasticsearch, the Elasticsearch wrapper.
+    :return: bool, True if the connection is successful, False otherwise.
+
+    Usage:
+        res = test_connection()
+    """
+
+    if elastic_wrapper is None:
+        elastic_wrapper = get_elastic_wrapper()
+
+    if elastic_wrapper.ping():
+        return True
+    else:
+        return False
+
+
+def index(
+        index_name: str,
+        doc: dict,
+        doc_id: str = None,
+        use_current_timestamp: bool = False,
+        convert_mixed_lists_to_strings: bool = False,
+        elastic_wrapper: Elasticsearch = None):
+    """
+    The function indexes a document in the Elasticsearch server.
+
+    :param index_name: str, the name of the index.
+    :param doc: dict, the document to be indexed.
+    :param doc_id: str, the id of the document. If None, a random id is generated.
+        This means that if you index the document with the same id again, the document inside DB will be overwritten.
+    :param use_current_timestamp: bool, if True, the current datetime is used as the timestamp of the document.
+    :param convert_mixed_lists_to_strings: bool, if True, mixed lists or tuples when entries are strings and integers,
+        the integers will be converted to strings.
+    :param elastic_wrapper: Elasticsearch, the Elasticsearch wrapper.
+    :return: dict, the result of the indexing operation.
+
+    Usage:
+        doc = {
+            'author': 'test_author',
+            'text': 'Some test text',
+        }
+        res = index(index_name="test_index", doc=doc)
+    """
+
+    if elastic_wrapper is None:
+        elastic_wrapper = get_elastic_wrapper()
+
+    if use_current_timestamp:
+        doc['timestamp'] = datetime.now()
+
+    if convert_mixed_lists_to_strings:
+        doc = dicts.convert_int_to_str_in_mixed_lists(doc)
+
+    res = elastic_wrapper.index(index=index_name, body=doc, id=doc_id)
+
+    return res

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: atomicshop
-Version: 2.6.13
+Version: 2.7.0
 Summary: Atomic functions and classes to make developer life easier
 Author: Denis Kras
 License: MIT License
@@ -37,6 +37,7 @@ Requires-Dist: cryptography
 Requires-Dist: dnslib
 Requires-Dist: dnspython
 Requires-Dist: docker
+Requires-Dist: elasticsearch
 Requires-Dist: numpy
 Requires-Dist: openpyxl
 Requires-Dist: pandas

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

@@ -1,11 +1,11 @@
-atomicshop/__init__.py,sha256=9aDtSeyVZ9KVMcTOD8O_rsV0R5nLiG5uLKyqmUg3EUQ,123
+atomicshop/__init__.py,sha256=pI9HaUaffycFBm-uxjzPkctXsfbBrHNGXNLrGiv1Pv8,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
 atomicshop/certificates.py,sha256=J-cmd6Rpq3zZyzsOH-GcdqIXdg2UwM8_E9mg7XtUph8,3787
 atomicshop/command_line_processing.py,sha256=u5yT9Ger_cu7ni5ID0VFlRbVD46ARHeNC9tRM-_YXrQ,1038
 atomicshop/config_init.py,sha256=z2RXD_mw9nQlAOpuGry1h9QT-2LhNscXgGAktN3dCVQ,2497
-atomicshop/console_output.py,sha256=G-6jxnWooT1nJSaPxcCqIuw8S22R_0lOJcfrdovRhwE,1372
+atomicshop/console_output.py,sha256=AOSJjrRryE97PAGtgDL03IBtWSi02aNol8noDnW3k6M,4667
 atomicshop/console_user_response.py,sha256=31HIy9QGXa7f-GVR8MzJauQ79E_ZqAeagF3Ks4GGdDU,3234
 atomicshop/datetimes.py,sha256=ICr0_gQqWnIw4BuNtabrHzjSlwnZkBfhyCrOILs5xpU,14623
 atomicshop/diff_check.py,sha256=RON9cSTgy3jAnwUmAUkOyfF6bgrBKOq9Sbgyl3RYodw,12350
@@ -64,7 +64,7 @@ atomicshop/addons/process_list/compiled/Win10x64/process_list.lib,sha256=n9c2MVP
 atomicshop/archiver/_search_in_zip.py,sha256=dd8qFSvIhcKmtnPj_uYNJFPmMwZp4tZys0kKgTw_ACw,8385
 atomicshop/archiver/archiver.py,sha256=BomnK7zT-nQXA1z0i2R2aTv8eu88wPx7tf2HtOdbmEc,1280
 atomicshop/archiver/search_in_archive.py,sha256=mEngDfULXBd3Oio8a2SUtynfJASVLsH74XIYJOWVkH0,10467
-atomicshop/archiver/sevenz.py,sha256=8C90rTS1-JMsuvvuOuKGoNhFeVj3_1mfEKv9UCUf9QE,1201
+atomicshop/archiver/sevenz.py,sha256=5i_C50-deC1Cz_GQdMGofV2jeMPbbGWAvih-QnA72cg,1370
 atomicshop/archiver/zip.py,sha256=k742K1bEDtc_4N44j_Waebi-uOkxxavqltvV6q-BLW4,14402
 atomicshop/basics/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/basics/ansi_escape_codes.py,sha256=WtIkm-BjSZS5J5irDUdAMBNvdX-qXFZcTX98jcBMpJE,3140
@@ -72,7 +72,7 @@ atomicshop/basics/argparse_template.py,sha256=S-BIdKd45bmNdqO3Dj3yOxBgb0O90spZxG
 atomicshop/basics/booleans.py,sha256=-4JnSQ1pSb6CNY_62wtHBW8NltjPJEKM-gYOxFujunA,1772
 atomicshop/basics/bytes_arrays.py,sha256=WvSRDhIGt1ywF95t-yNgpxLm1nlZUbM1Dz6QckcyE8Y,5915
 atomicshop/basics/classes.py,sha256=n5uhPOWIKBAv0xa3--n-oQYIS64s6hb6JGs_1HgW2cs,8558
-atomicshop/basics/dicts.py,sha256=sAoHvY-Rtt7QkwHzIKk1j2ZFmteIm9yFCxBGkTrpbdk,9030
+atomicshop/basics/dicts.py,sha256=w9_ZolDNSf2ZyoZ53zIOrFq7VZWGWYAvAvwc4qHORAo,10973
 atomicshop/basics/dicts_nested.py,sha256=StYxYnYPa0SEJr1lmEwAv5zfERWWqoULeyG8e0zRAwE,4107
 atomicshop/basics/enumerations.py,sha256=41VVQYh_vnVapggxKg2IRU5e_EiMpZzX1n1mtxvoSzM,1364
 atomicshop/basics/enums.py,sha256=CeV8MfqWHihK7vvV6Mbzq7rD9JykeQfrJeFdLVzfHI4,3547
@@ -81,7 +81,7 @@ atomicshop/basics/guids.py,sha256=iRx5n18ATZWhpo748BwEjuLWLsu9y3OwF5-Adp-Dtik,40
 atomicshop/basics/hexs.py,sha256=i8CTG-J0TGGa25yFSbWEvpVyHFnof_qSWUrmXY-ylKM,1054
 atomicshop/basics/isinstancing.py,sha256=fQ35xfqbguQz2BUn-3a4KVGskhTcIn8JjRtxV2rFcRQ,876
 atomicshop/basics/list_of_dicts.py,sha256=fu0H6dUD9uUo2kl7FYIrWzOQMwCmg7qRxGnFM5S319E,5716
-atomicshop/basics/lists.py,sha256=9H-avAZ0LchdyZyTxmPZQWpvVR0-L4xM3QclI9fED2M,3637
+atomicshop/basics/lists.py,sha256=pLpYPSu0BjJIAe_Ar55XhLsH2YBhftn7b-tTAdkK1sw,3928
 atomicshop/basics/multiprocesses.py,sha256=AczaI4TmYduNjE6_VEQhxvDQn4VLDdXYRxhPDpjH4T0,17974
 atomicshop/basics/numbers.py,sha256=II-jP8MG0IYvmjT9_BLEai65xzDJ0LTHK2eFVSrgVqo,527
 atomicshop/basics/randoms.py,sha256=DmYLtnIhDK29tAQrGP1Nt-A-v8WC7WIEB8Edi-nk3N4,282
@@ -96,7 +96,7 @@ atomicshop/file_io/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuF
 atomicshop/file_io/csvs.py,sha256=4R4Kij8FmxNwXFjDtlF_A0flAk0Hj5nZKlEnqC5VxgQ,3125
 atomicshop/file_io/docxs.py,sha256=3IFtaurVhvntcuCL59bpFlzGyKxvDmVUjUQTHWluOMY,4369
 atomicshop/file_io/file_io.py,sha256=FR84ihjGlr7Eqejo-_js4nBICVst31axD0bwX19S2eM,6385
-atomicshop/file_io/jsons.py,sha256=uj-YiK-GxI6qCHgMbvx8t2vzWKvRarrvvqoUq8HvD3A,4416
+atomicshop/file_io/jsons.py,sha256=j-cU1w0iYhiqL5EelMhL3mDMLtaaP73Y97CXqwHcpZU,5154
 atomicshop/file_io/tomls.py,sha256=oa0Wm8yMkPRXKN9jgBuTnKbioSOee4mABW5IMUFCYyU,3041
 atomicshop/file_io/xlsxs.py,sha256=v_dyg9GD4LqgWi6wA1QuWRZ8zG4ZwB6Dz52ytdcmmmI,2184
 atomicshop/file_io/xmls.py,sha256=zh3SuK-dNaFq2NDNhx6ivcf4GYCfGM8M10PcEwDSpxk,2104
@@ -151,6 +151,9 @@ atomicshop/wrappers/ctyping/process_winapi.py,sha256=QcXL-ETtlSSkoT8F7pYle97ubGW
 atomicshop/wrappers/dockerw/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/wrappers/dockerw/dockerw.py,sha256=8MZCMek6L-QpawO5hn_gxXczI6ustPGcYBFWNiuQ1cw,949
 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
+atomicshop/wrappers/elasticsearchw/elasticsearchw.py,sha256=utWGAc9vFPhK6typiNat8X1YPHfvwQQyDqjgnvVcInc,3382
 atomicshop/wrappers/factw/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/wrappers/factw/config_fact.py,sha256=J-K9Zn50WcDC7ubb-boraSZExfBk7a6M52NhRJVlsjk,895
 atomicshop/wrappers/factw/config_install.py,sha256=QRygFnZ5r1ybJQl7ftFci3kNRmU-a-w3lMG1joElvcY,417
@@ -209,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.6.13.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
-atomicshop-2.6.13.dist-info/METADATA,sha256=CkX8ZlZTlnlCQ3q1KMw72rl6cyIgBHjaOj5r75e58MU,10340
-atomicshop-2.6.13.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-atomicshop-2.6.13.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
-atomicshop-2.6.13.dist-info/RECORD,,
+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,,