xlwings-utils 25.0.0.post3__tar.gz → 25.0.0.post4__tar.gz

{xlwings_utils-25.0.0.post3 → xlwings_utils-25.0.0.post4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xlwings_utils
-Version: 25.0.0.post3
+Version: 25.0.0.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
@@ -30,6 +30,16 @@ In the script, add
 >
 > The GitHub repository can be found on https://github.com/salabim/xlwings_utils .
 
+General
+
+It is recommended to put
+
+```
+import xlwings_utils as xwu
+```
+
+at the top of a xlwings lite script.
+
 ## Dropbox support
 
 The xlwings lite system does not provide access to the local file system. With this module, files can be copied between Dropbox and the local pyodide file system, making it possible to indirectly use the local file system.
@@ -50,15 +60,15 @@ The functions `list_local`, `read_local` and `write_local` offer similar functio
 So, a way to access a file on the system's drive (mapped to Dropbox) as a local file is:
 
 ```
-contents = xlwings_utils.read_dropbox('/downloads/file1.xls')
-xlwings_utils.write_local('file1.xlsx')
+contents = xwu.read_dropbox('/downloads/file1.xls')
+xwu.write_local('file1.xlsx')
 df = pandas.read_excel"file1.xlsx")
 ...
 ```
 And the other direction:
 ```
-contents = xlwings_utils.read_local('file1.gif')
-xlwings_utils.write_dropbox('/downloads/file1.gif')
+contents = xwu.read_local('file1.gif')
+xwu.write_dropbox('/downloads/file1.gif')
 ```
 
 ## Block support
@@ -89,7 +99,7 @@ It is not allowed t,o read or write outside the block dimensions.
 
 It is also possible to define an empty block, like
 ```
-block = xlwings_utils.block(number_of_rows, number_columns)
+block = xwu.block(number_of_rows, number_columns)
 ```
 The dimensions can be queried or redefined with `block.number_of_rows` and 
 `block.number_of_columns`.
@@ -191,12 +201,35 @@ The module has support for capturing stdout and -later- using showing the captur
 
 This is rather important as printing in xlwings lite to the UI pane is rather slow.
 
-In order to capture stdout output, use `xwu.capture.enabled = True`. And to stop capturing, use `xwu.capture.enabled = False`.
+In order to capture stdout output, it is required to first issue
+
+```caoture
+capture = xwu.Capture()
+```
+
+By this, capture is automatically enabled and print is disabled. Alternatively, it is possible to use
+
+```
+capture = xwu.Capture(enabled=False)
+```
+
+to disable the capture. And with
+
+```
+capture = xwu.Capture(include_print=True)
+```
+
+the stdout output is captured and printed.
+
+Capturing van be enabled and disabled at any time with `capture.enbaled = True` and `capture.enabled = False`.
+
+And including print likewise with `capture.include_print`.
+
 Alternatively, a context manager is provided:
 
 
 ```
-with xwu.capture:
+with capture:
     """
     code with print statements
     """
@@ -206,17 +239,15 @@ Note that stopping the capture, leaves the captured output in place, so it can b
 In either case, the captured output can be then copied to a sheet, like
 
 ```
-sheet.range(4,5).value = xwu.capture.value
+sheet.range(4,5).value = 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`.
+If you don't want the buffer to be emptied after accessing the value, use `capture.value_keep`.
 
-Clearing the captured stdout buffer can be done at any time with `xwu.capture.clear()`.
+The capture buffer can also be retrieved as a string with `capture.str` and `capture.str_keep`.
 
-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.
+Clearing the captured stdout buffer can be done at any time with `capture.clear()`.
 
 
 ## Contact info

{xlwings_utils-25.0.0.post3 → xlwings_utils-25.0.0.post4}/README.md

@@ -16,6 +16,16 @@ In the script, add
 >
 > The GitHub repository can be found on https://github.com/salabim/xlwings_utils .
 
+General
+
+It is recommended to put
+
+```
+import xlwings_utils as xwu
+```
+
+at the top of a xlwings lite script.
+
 ## Dropbox support
 
 The xlwings lite system does not provide access to the local file system. With this module, files can be copied between Dropbox and the local pyodide file system, making it possible to indirectly use the local file system.
@@ -36,15 +46,15 @@ The functions `list_local`, `read_local` and `write_local` offer similar functio
 So, a way to access a file on the system's drive (mapped to Dropbox) as a local file is:
 
 ```
-contents = xlwings_utils.read_dropbox('/downloads/file1.xls')
-xlwings_utils.write_local('file1.xlsx')
+contents = xwu.read_dropbox('/downloads/file1.xls')
+xwu.write_local('file1.xlsx')
 df = pandas.read_excel"file1.xlsx")
 ...
 ```
 And the other direction:
 ```
-contents = xlwings_utils.read_local('file1.gif')
-xlwings_utils.write_dropbox('/downloads/file1.gif')
+contents = xwu.read_local('file1.gif')
+xwu.write_dropbox('/downloads/file1.gif')
 ```
 
 ## Block support
@@ -75,7 +85,7 @@ It is not allowed t,o read or write outside the block dimensions.
 
 It is also possible to define an empty block, like
 ```
-block = xlwings_utils.block(number_of_rows, number_columns)
+block = xwu.block(number_of_rows, number_columns)
 ```
 The dimensions can be queried or redefined with `block.number_of_rows` and 
 `block.number_of_columns`.
@@ -177,12 +187,35 @@ The module has support for capturing stdout and -later- using showing the captur
 
 This is rather important as printing in xlwings lite to the UI pane is rather slow.
 
-In order to capture stdout output, use `xwu.capture.enabled = True`. And to stop capturing, use `xwu.capture.enabled = False`.
+In order to capture stdout output, it is required to first issue
+
+```caoture
+capture = xwu.Capture()
+```
+
+By this, capture is automatically enabled and print is disabled. Alternatively, it is possible to use
+
+```
+capture = xwu.Capture(enabled=False)
+```
+
+to disable the capture. And with
+
+```
+capture = xwu.Capture(include_print=True)
+```
+
+the stdout output is captured and printed.
+
+Capturing van be enabled and disabled at any time with `capture.enbaled = True` and `capture.enabled = False`.
+
+And including print likewise with `capture.include_print`.
+
 Alternatively, a context manager is provided:
 
 
 ```
-with xwu.capture:
+with capture:
     """
     code with print statements
     """
@@ -192,17 +225,15 @@ Note that stopping the capture, leaves the captured output in place, so it can b
 In either case, the captured output can be then copied to a sheet, like
 
 ```
-sheet.range(4,5).value = xwu.capture.value
+sheet.range(4,5).value = 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`.
+If you don't want the buffer to be emptied after accessing the value, use `capture.value_keep`.
 
-Clearing the captured stdout buffer can be done at any time with `xwu.capture.clear()`.
+The capture buffer can also be retrieved as a string with `capture.str` and `capture.str_keep`.
 
-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.
+Clearing the captured stdout buffer can be done at any time with `capture.clear()`.
 
 
 ## Contact info

{xlwings_utils-25.0.0.post3 → xlwings_utils-25.0.0.post4}/pyproject.toml

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

{xlwings_utils-25.0.0.post3 → xlwings_utils-25.0.0.post4}/xlwings_utils/xlwings_utils.py

@@ -636,7 +636,7 @@ class block:
         return self.vlookup(s, row_from=row_from, row_to=row_to, column1=column1, column2=column2)
 
 
-class _capture:
+class Capture:
     """
     specifies how to capture stdout
 
@@ -721,15 +721,6 @@ class _capture:
         self._include_print = value
 
 
-def reset():
-    capture.enabled = False
-    capture.include_print = False
-    capture.clear()
-    print('reset',sys.stdout)
-
-capture = _capture()
-
-
 if __name__ == "__main__":
     ...
 

{xlwings_utils-25.0.0.post3 → xlwings_utils-25.0.0.post4}/xlwings_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xlwings_utils
-Version: 25.0.0.post3
+Version: 25.0.0.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
@@ -30,6 +30,16 @@ In the script, add
 >
 > The GitHub repository can be found on https://github.com/salabim/xlwings_utils .
 
+General
+
+It is recommended to put
+
+```
+import xlwings_utils as xwu
+```
+
+at the top of a xlwings lite script.
+
 ## Dropbox support
 
 The xlwings lite system does not provide access to the local file system. With this module, files can be copied between Dropbox and the local pyodide file system, making it possible to indirectly use the local file system.
@@ -50,15 +60,15 @@ The functions `list_local`, `read_local` and `write_local` offer similar functio
 So, a way to access a file on the system's drive (mapped to Dropbox) as a local file is:
 
 ```
-contents = xlwings_utils.read_dropbox('/downloads/file1.xls')
-xlwings_utils.write_local('file1.xlsx')
+contents = xwu.read_dropbox('/downloads/file1.xls')
+xwu.write_local('file1.xlsx')
 df = pandas.read_excel"file1.xlsx")
 ...
 ```
 And the other direction:
 ```
-contents = xlwings_utils.read_local('file1.gif')
-xlwings_utils.write_dropbox('/downloads/file1.gif')
+contents = xwu.read_local('file1.gif')
+xwu.write_dropbox('/downloads/file1.gif')
 ```
 
 ## Block support
@@ -89,7 +99,7 @@ It is not allowed t,o read or write outside the block dimensions.
 
 It is also possible to define an empty block, like
 ```
-block = xlwings_utils.block(number_of_rows, number_columns)
+block = xwu.block(number_of_rows, number_columns)
 ```
 The dimensions can be queried or redefined with `block.number_of_rows` and 
 `block.number_of_columns`.
@@ -191,12 +201,35 @@ The module has support for capturing stdout and -later- using showing the captur
 
 This is rather important as printing in xlwings lite to the UI pane is rather slow.
 
-In order to capture stdout output, use `xwu.capture.enabled = True`. And to stop capturing, use `xwu.capture.enabled = False`.
+In order to capture stdout output, it is required to first issue
+
+```caoture
+capture = xwu.Capture()
+```
+
+By this, capture is automatically enabled and print is disabled. Alternatively, it is possible to use
+
+```
+capture = xwu.Capture(enabled=False)
+```
+
+to disable the capture. And with
+
+```
+capture = xwu.Capture(include_print=True)
+```
+
+the stdout output is captured and printed.
+
+Capturing van be enabled and disabled at any time with `capture.enbaled = True` and `capture.enabled = False`.
+
+And including print likewise with `capture.include_print`.
+
 Alternatively, a context manager is provided:
 
 
 ```
-with xwu.capture:
+with capture:
     """
     code with print statements
     """
@@ -206,17 +239,15 @@ Note that stopping the capture, leaves the captured output in place, so it can b
 In either case, the captured output can be then copied to a sheet, like
 
 ```
-sheet.range(4,5).value = xwu.capture.value
+sheet.range(4,5).value = 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`.
+If you don't want the buffer to be emptied after accessing the value, use `capture.value_keep`.
 
-Clearing the captured stdout buffer can be done at any time with `xwu.capture.clear()`.
+The capture buffer can also be retrieved as a string with `capture.str` and `capture.str_keep`.
 
-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.
+Clearing the captured stdout buffer can be done at any time with `capture.clear()`.
 
 
 ## Contact info