progress-table 1.3.1__tar.gz → 1.3.2__tar.gz

{progress-table-1.3.1 → progress-table-1.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: progress-table
-Version: 1.3.1
+Version: 1.3.2
 Summary: Display progress as a pretty table in the command line.
 Home-page: https://github.com/gahaalt/progress-table.git
 Author: Szymon Mikler

{progress-table-1.3.1 → progress-table-1.3.2}/progress_table/__init__.py

@@ -1,6 +1,6 @@
 #  Copyright (c) 2022-2024 Szymon Mikler
 
-__version__ = "1.3.1"
+__version__ = "1.3.2"
 
 from progress_table.v0.progress_table import ProgressTableV0
 from progress_table.v1.progress_table import ProgressTableV1

{progress-table-1.3.1 → progress-table-1.3.2}/progress_table.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: progress-table
-Version: 1.3.1
+Version: 1.3.2
 Summary: Display progress as a pretty table in the command line.
 Home-page: https://github.com/gahaalt/progress-table.git
 Author: Szymon Mikler

{progress-table-1.3.1 → progress-table-1.3.2}/progress_table.egg-info/SOURCES.txt

@@ -15,4 +15,6 @@ progress_table/v0/progress_table.py
 progress_table/v0/symbols.py
 progress_table/v1/__init__.py
 progress_table/v1/progress_table.py
-progress_table/v1/styles.py
+progress_table/v1/styles.py
+tests/test_docs_automated.py
+tests/test_examples_automated.py

progress-table-1.3.2/tests/test_docs_automated.py

@@ -0,0 +1,61 @@
+#  Copyright (c) 2022-2024 Szymon Mikler
+
+import logging
+import os
+import pathlib
+import re
+
+
+def get_header(msg):
+    msg_len = len(msg)
+    header = [
+        "#" * (msg_len + 6),
+        "## " + msg + " ##",
+        "#" * (msg_len + 6),
+    ]
+    return "\n".join(header) + "\n"
+
+
+def scan_for_code_blobs(text):
+    # Capture code blocks starting with py or python
+    blobs = re.findall(r"```(py|python)\n([\s\S]+?)\n```", text)
+
+    new_blobs = []
+    for mode, blob in blobs:
+        if "..." in blob:
+            continue
+        header = get_header(f"Generated ({mode})")
+        blob = header + blob
+
+        # For `py` code blocks, we append them to previous existing block
+        # But `python` block starts a new scope and finishes the previous block
+        # They usually need to include imports
+        if mode == "py" and new_blobs:
+            new_blobs[-1] = new_blobs[-1] + "\n" + blob
+        else:
+            new_blobs.append(blob)
+    return new_blobs
+
+
+def test_all_code_blobs():
+    # Testing whether code blobs from the documentation run without errors
+    all_code_blobs = []
+
+    for root, dirs, files in os.walk(""):
+        for file in files:
+            path = pathlib.Path(os.path.join(root, file))
+            if path.suffix == ".md":
+                code_blobs = scan_for_code_blobs(path.open("r").read())
+                for blob in code_blobs:
+                    all_code_blobs.append(blob)
+
+    logging.warning(f"Detected {len(all_code_blobs)} code examples!")
+
+    for idx, blob in enumerate(all_code_blobs):
+        try:
+            globals_temp = {}
+            exec(blob, globals_temp)
+        except Exception as e:
+            print(f"Exception during automated documentation testing {idx}/{len(all_code_blobs)}:")
+            print(blob)
+            raise e

progress-table-1.3.2/tests/test_examples_automated.py

@@ -0,0 +1,63 @@
+#  Copyright (c) 2022-2024 Szymon Mikler
+
+import hashlib
+import importlib
+import random
+import sys
+from glob import glob
+from io import StringIO
+
+EXPECTED_OUTPUTS = {
+    "examples.nn_training": "7e50cfd539e3e1799ecd5a7e7b7a7e18",
+    "examples.cumulating": "b5b7bc9b8232545ebfd5ca777bddacb4",
+    "examples.fibonacci": "bae5411af4bf8a4326f1bce59ca9aad9",
+    "examples.features": "474d4aff94a3070d2300d78d4159e0a6",
+}
+
+
+def set_seed():
+    random.seed(42)
+
+
+def capture_example_stdout(main_fn):
+    # To eliminate run to run variation of the example outputs we need to be independent from the execution speed
+    # This includes removing the influence of:
+    # * refresh rate
+    # * throughput display
+    override_kwds = dict(
+        refresh_rate=1000000000,
+        pbar_show_throughput=False,
+    )
+
+    # We will replace stdout with custom StringIO and check whether example stdout is as expected
+    out_buffer = StringIO()
+    sys.stdout = out_buffer
+    set_seed()
+    main_fn(**override_kwds)
+    sys.stdout = sys.__stdout__
+    return out_buffer.getvalue()
+
+
+def test_all_examples():
+    # Testing whether examples run exactly as intended
+
+    outputs = {}
+    for module in glob("examples/*"):
+        module = module.replace(".py", "").replace("/", ".")
+        print(f"Running example: {module}")
+        main_fn = importlib.import_module(module).main
+        out_str = capture_example_stdout(main_fn)
+
+        md5hash = hashlib.md5(out_str.encode()).hexdigest()
+        outputs[module] = md5hash
+
+    err_msg = []
+    for key in EXPECTED_OUTPUTS:
+        output = outputs.get(key, None)
+        expected = EXPECTED_OUTPUTS[key]
+        if output != expected:
+            err_msg.append(f" {output} instead of {expected} in {key}")
+    err_msg = "\n".join(err_msg)
+
+    if err_msg:
+        assert False, f"Errors in example outputs\n{err_msg}"