xlwings-utils 0.0.7.post2__tar.gz → 0.0.7.post4__tar.gz

{xlwings_utils-0.0.7.post2 → xlwings_utils-0.0.7.post4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xlwings_utils
-Version: 0.0.7.post2
+Version: 0.0.7.post4
 Summary: xlwings_utils
 Author-email: Ruud van der Ham <rt.van.der.ham@gmail.com>
 Project-URL: Homepage, https://github.com/salabim/xlwings_utils
@@ -123,26 +123,33 @@ In this case, only the really processed rows are copied to the sheet.
 
 The module has support for capturing stdout and -later- using showing the captured output on a sheet.
 
-To do that:
+This is rather important as printing in xlwings lite to the UI pane is rather slow.
 
-```makes it possible to capture stdout writes, which
-with xwu.capture_stdout():
-    ...
-```
-and then the captured output can be copied to the screen, like
+In order to capture stdout output, use
 
-```can then be copied to a worksheet in a later stage.
-sheet.range(4,5).value = xwu.captured_stdout_as_value()
-```
 
-Clearing the captured stdout buffer can be done with `xwu.clear_captured_std_out`.
+```
+with xwu.capture:
+    """
+    code with print statements
+    """
+```
 
-Normally, stdout will also be sent to the xlwings lite UI panel. This can be suppressed with
+and then the captured output can be copied to a sheet, like
 
 ```
-with xwu.capture_stdout(include_print=False):
-    ...
+sheet.range(4,5).value = xwu.capture.value
 ```
+Upon reading the value, the capture buffer will be emptied.
+
+If you don't want the buffer to be emptied after accessing the value, use `xwu.capture.value_keep`.
+
+The capture buffer can also be retrieved as a string with `xwu.capture.str` and `xwu.capture.str_keep`.
+
+Clearing the captured stdout buffer can be done at any time with `xwu.capture.clear()`.
+
+Normally, stdout will not be sent to the xlwings lite UI panel when captured with the `xwu.capture` context manager. However, if you specify `xwu.capture.include_print = True`, the output will be sent to the UI panel as well. Note that this setting remains active until a `xwu.capture.include_print = False` is issued.
+
 
 ## Contact info
 

{xlwings_utils-0.0.7.post2 → xlwings_utils-0.0.7.post4}/README.md

@@ -109,26 +109,33 @@ In this case, only the really processed rows are copied to the sheet.
 
 The module has support for capturing stdout and -later- using showing the captured output on a sheet.
 
-To do that:
+This is rather important as printing in xlwings lite to the UI pane is rather slow.
 
-```makes it possible to capture stdout writes, which
-with xwu.capture_stdout():
-    ...
-```
-and then the captured output can be copied to the screen, like
+In order to capture stdout output, use
 
-```can then be copied to a worksheet in a later stage.
-sheet.range(4,5).value = xwu.captured_stdout_as_value()
-```
 
-Clearing the captured stdout buffer can be done with `xwu.clear_captured_std_out`.
+```
+with xwu.capture:
+    """
+    code with print statements
+    """
+```
 
-Normally, stdout will also be sent to the xlwings lite UI panel. This can be suppressed with
+and then the captured output can be copied to a sheet, like
 
 ```
-with xwu.capture_stdout(include_print=False):
-    ...
+sheet.range(4,5).value = xwu.capture.value
 ```
+Upon reading the value, the capture buffer will be emptied.
+
+If you don't want the buffer to be emptied after accessing the value, use `xwu.capture.value_keep`.
+
+The capture buffer can also be retrieved as a string with `xwu.capture.str` and `xwu.capture.str_keep`.
+
+Clearing the captured stdout buffer can be done at any time with `xwu.capture.clear()`.
+
+Normally, stdout will not be sent to the xlwings lite UI panel when captured with the `xwu.capture` context manager. However, if you specify `xwu.capture.include_print = True`, the output will be sent to the UI panel as well. Note that this setting remains active until a `xwu.capture.include_print = False` is issued.
+
 
 ## Contact info
 

{xlwings_utils-0.0.7.post2 → xlwings_utils-0.0.7.post4}/pyproject.toml

@@ -10,7 +10,7 @@ authors = [
     { name = "Ruud van der Ham", email = "rt.van.der.ham@gmail.com" },
 ]
 description = "xlwings_utils"
-version = "0.0.7.post2"
+version = "0.0.7.post4"
 readme = "README.md"
 requires-python = ">=3.9"
 dependencies = [

{xlwings_utils-0.0.7.post2 → xlwings_utils-0.0.7.post4}/tests/test_xlwings_utils.py

@@ -1,6 +1,7 @@
 import os
 import sys
 from pathlib import Path
+import io
 
 if __name__ == "__main__":  # to make the tests run without the pytest cli
     file_folder = os.path.dirname(__file__)
@@ -102,37 +103,46 @@ def test_raise():
         this_block[1, 7] = 1
 
 
-def test_capture_stdout(capsys):
+def test_capture(capsys):
     print("abc")
     print("def")
     out, err = capsys.readouterr()
     assert out == "abc\ndef\n"
-    assert xwu.captured_stdout_as_str() == ""
-    assert xwu.captured_stdout_as_value() == []
+    assert xwu.capture.str_keep == ""
+    assert xwu.capture.value_keep == []
 
-    xwu.capture_stdout(do_capture=True)
-    print("abc")
-    print("def")
+    with xwu.capture:
+        print("abc")
+        print("def")
     out, err = capsys.readouterr()
-    assert out == "abc\ndef\n"
-
-    assert xwu.captured_stdout_as_str(clear=False) == "abc\ndef\n"
-    assert xwu.captured_stdout_as_value(clear=False) == [["abc"], ["def"]]
-
-    # out, err = capsys.readouterr()
-    # assert out == "abc\ndef\n"
-
-    # xwu.clear_captured_stdout()
-    # assert xwu.captured_stdout_as_str() == ""
-    # with xwu.capture_stdout(include_print=False):
-    #     print("ghi")
-    #     print("jkl")
-    # assert xwu.captured_stdout_as_str() == "ghi\njkl\n"
-    # assert xwu.captured_stdout_as_value() == [["ghi"], ["jkl"]]
-    # out, err = capsys.readouterr()
-    # assert out == ""
-
-
+    assert out == ""
+    assert xwu.capture.str_keep == "abc\ndef\n"
+    assert xwu.capture.value_keep == [['abc'], ['def']]
+    assert xwu.capture.str == "abc\ndef\n"
+    assert xwu.capture.value == []
+        
+    with xwu.capture:
+        print("abc")
+        print("def")
+    out, err = capsys.readouterr()
+    xwu.capture.clear()
+    assert xwu.capture.str_keep == ""
+
+    with xwu.capture:
+        print("abc")
+        print("def")
+    with xwu.capture:
+        print("ghi")
+        print("jkl")        
+    out, err = capsys.readouterr()
+    assert out == ""
+    assert xwu.capture.str_keep == "abc\ndef\nghi\njkl\n"        
+    assert xwu.capture.value_keep == [['abc'], ['def'], ['ghi'], ['jkl']]
+    assert xwu.capture.value == [['abc'], ['def'], ['ghi'], ['jkl']]    
+    assert xwu.capture.value == []
+ 
+    # include_print is not testable with pytest
+    
 if __name__ == "__main__":
     pytest.main(["-vv", "-s", "-x", __file__])
 

{xlwings_utils-0.0.7.post2 → xlwings_utils-0.0.7.post4}/xlwings_utils/xlwings_utils.py

@@ -13,8 +13,6 @@ from pathlib import Path
 import os
 import sys
 
-_org_stdout = sys.stdout
-
 dbx = None
 Pythonista = sys.platform == "ios"
 
@@ -375,105 +373,91 @@ class block:
         return f"block({self.value})"
 
 
-def clear_captured_stdout(clear=True):
+
+class _capture:
     """
-    empties the captured stdout
+    specifies how to capture stdout
 
     Parameters
     ----------
-    clear : bool
-        if True (default), the capture buffer is emptied
-
-        if False: no action
-    """
-    if clear:
-        _buffer.clear()
-
-
-def captured_stdout_as_str(clear=True):
-    """
-    returns the captured stdout as a string
-
-    Returns
-    -------
-    captured stdout : list
-        each line is an element of the list
-    """
-    result = "".join(_buffer)
-    clear_captured_stdout(clear)
-    return result
-
+    include_print : bool
+        if True (default), the output is also printed out as normal
 
-def captured_stdout_as_value(clear=True):
-    """
-    returns the captured stdout as a list of lists
-
-    Returns
-    -------
-    captured stdout : list of lists
-        each line is an element of the list
+        if False, no output is printed
 
     Note
     ----
-    This can be used directly to fill a xlwings range
-    """
-    return [[line] for line in captured_stdout_as_str(clear).splitlines()]
+    Use this function as a context manager, like ::
 
+        with capture_stdout():
+            ...
+    """
 
-class handle_capture_stdout:
     def __init__(self):
-        pass
+        self.stdout = sys.stdout
+        self._include_print = False
+        self._buffer=[]
+
+    def __enter__(self):
+        sys.stdout = self
 
-    def isatty(self):
-        return False
+    def __exit__(self, exc_type, exc_value, tb):
+        sys.stdout = self.stdout
 
     def write(self, data):
-        _buffer.append(data)
-        if _do_print:
-            _org_stdout.write(data)
+        self._buffer.append(data)
+        if self._include_print:
+            self.stdout.write(data)
 
     def flush(self):
-        if _do_print:
-            _org_stdout.flush()
-        _buffer.append("\n")
-
-
-def reset():
-    global _buffer
-    sys.stdout=_org_stdout
-    _buffer=[]
-
-reset()
-
-def capture_stdout(do_print=True, do_capture=True, clear=True):
-    global _do_print
-    """
-    start capture stdout
-
-    Parameters
-    ----------
-    do_print : bool
-        if True (default), the output is (also) printed out as normal
+        if self._include_print:
+            self.stdout.flush()
+        self._buffer.append("\n")
+        
 
-        if False, no output is printed
+    @property
+    def value(self):
+        result=self.value_keep
+        self.clear()
+        return result
+        
+        
+    @property
+    def value_keep(self):
+        result= [[line] for line in self.str_keep.splitlines()]
+        return result
+        
+    @property
+    def str(self):
+        result = self.str_keep
+        self._buffer.clear()
+        return result        
+        
+    @property
+    def str_keep(self):
+        result = "".join(self._buffer)
+        return result        
+        
+    def clear(self):
+        self._buffer.clear()
+        
+        
+    @property
+    def include_print(self):
+        return self._include_print
+        
+    @include_print.setter
+    def include_print(self, value):
+        self._include_print=value
+        
 
-    do_capture : bool
-        if True (default), the output is (also) captured to a buffer
 
-        if False, no output is captured
+def reset():
+    capture.include_print=False
+    capture.clear()
+    
+capture=_capture()
 
-    clear : bool
-        if True (default), the capture buffer is emptied
-    """
-    if not (do_print or do_capture):
-        raise ValueError("at least one of do_print and do_capture should be True")
-
-    if do_capture:
-        if sys.stdout is _org_stdout:
-            sys.stdout = handle_capture_stdout()
-        _do_print=do_print
-    else:
-        sys.stdout=_org_stdout
 
 if __name__ == "__main__":
     ...

{xlwings_utils-0.0.7.post2 → xlwings_utils-0.0.7.post4}/xlwings_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xlwings_utils
-Version: 0.0.7.post2
+Version: 0.0.7.post4
 Summary: xlwings_utils
 Author-email: Ruud van der Ham <rt.van.der.ham@gmail.com>
 Project-URL: Homepage, https://github.com/salabim/xlwings_utils
@@ -123,26 +123,33 @@ In this case, only the really processed rows are copied to the sheet.
 
 The module has support for capturing stdout and -later- using showing the captured output on a sheet.
 
-To do that:
+This is rather important as printing in xlwings lite to the UI pane is rather slow.
 
-```makes it possible to capture stdout writes, which
-with xwu.capture_stdout():
-    ...
-```
-and then the captured output can be copied to the screen, like
+In order to capture stdout output, use
 
-```can then be copied to a worksheet in a later stage.
-sheet.range(4,5).value = xwu.captured_stdout_as_value()
-```
 
-Clearing the captured stdout buffer can be done with `xwu.clear_captured_std_out`.
+```
+with xwu.capture:
+    """
+    code with print statements
+    """
+```
 
-Normally, stdout will also be sent to the xlwings lite UI panel. This can be suppressed with
+and then the captured output can be copied to a sheet, like
 
 ```
-with xwu.capture_stdout(include_print=False):
-    ...
+sheet.range(4,5).value = xwu.capture.value
 ```
+Upon reading the value, the capture buffer will be emptied.
+
+If you don't want the buffer to be emptied after accessing the value, use `xwu.capture.value_keep`.
+
+The capture buffer can also be retrieved as a string with `xwu.capture.str` and `xwu.capture.str_keep`.
+
+Clearing the captured stdout buffer can be done at any time with `xwu.capture.clear()`.
+
+Normally, stdout will not be sent to the xlwings lite UI panel when captured with the `xwu.capture` context manager. However, if you specify `xwu.capture.include_print = True`, the output will be sent to the UI panel as well. Note that this setting remains active until a `xwu.capture.include_print = False` is issued.
+
 
 ## Contact info