-
Notifications
You must be signed in to change notification settings - Fork 216
Savetxt unit #1085
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Savetxt unit #1085
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #1085 +/- ##
==========================================
+ Coverage 68.55% 68.66% +0.10%
==========================================
Files 396 396
Lines 12746 12803 +57
Branches 1376 1381 +5
==========================================
+ Hits 8738 8791 +53
- Misses 4008 4012 +4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Thanks for this @fiolj. Would you mind reverting the changes not related to the implementation? (styling) There are too many and it renders difficult to read through the PR. You can check the style_guide for info https://github.com/fortran-lang/stdlib/blob/master/STYLE_GUIDE.md One thing, white spaces in-between parentheses and an intrinsic function are not recommended ( |
|
Thanks @jalvesz, I've fixed the formatting |
jvdp1
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you @fiolj . Here are some suggestions
|
|
||
| s = open(filename, "w") | ||
| !! Write the header if non-empty | ||
| ! prepend function may be replaced by use of replace_all but currently stdlib_strings |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is probably something that we should solve at a later stage.
|
Reviewing the arguments of Currently, we have the order of |
As |
Thanks, I agree. Last uploaded commit has the new order and some small cleanup of the code. I think that it this version is close to apt to be merged, except for the codecov failings (which I have no idea what they mean). |
It is related to the examples that are not covered by these pipelines. I think that @jalvesz got a similar issue with another PR. |
|
The fails with codecov are valid in my opinion. In #1074 we avoided codecov from analyzing the examples as a metric for coverage. But in this case, it is a valid fail because there are API changes which are not being tested. It is not enough to just add an example to ensure correctness. |
I am confused. This shows that some lines of
I agree with you. |
Co-authored-by: Jeremie Vandenplas <[email protected]>
@fiolj could you update the tests to cover the different changes in the API? |
Yes. I've commited some tests. |
I'm also confused now, codecov is supposed to ignore files in the examples directory after the PR #1074 ... I would say for the moment to ignore this false error. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds optional arguments to the savetxt function to provide more flexibility when saving 2D arrays to text files, making it more similar to NumPy's savetxt functionality.
Changes:
- Added ability to specify an already-opened file unit instead of a filename, enabling writing to stdout or appending to files
- Added optional
headerandfooterparameters that are automatically commented with a configurable comment character - Added optional
fmtparameter to customize output format - Modified format string construction to support custom delimiters (though delimiter parameter still limited to single character)
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 18 comments.
| File | Description |
|---|---|
| src/io/stdlib_io.fypp | Core implementation: generates two variants of savetxt (filename and unit), adds format customization, header/footer support via new prepend helper function |
| test/io/test_savetxt.f90 | Updated tests to exercise new delimiter, fmt, header, footer, and comments parameters |
| doc/specs/stdlib_io.md | Updated documentation to describe new optional parameters and unit-based interface |
| example/io/example_savetxt.f90 | Added examples demonstrating new features including writing to stdout |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
src/io/stdlib_io.fypp
Outdated
| default_fmt = FMT_REAL_${k1}$(2:len(FMT_REAL_${k1}$)-1) | ||
| #:elif 'complex' in t1 | ||
| fmt_ = "(*"//FMT_COMPLEX_${k1}$(1:11)//delim_str//FMT_COMPLEX_${k1}$(14:23)//",:,"//delim_str//"))" | ||
| default_fmt = FMT_COMPLEX_${k1}$(2:11)//delim_str//FMT_COMPLEX_${k1}$ (14:23) |
Copilot
AI
Jan 29, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The substring indices for extracting the second format descriptor for complex numbers are incorrect. For FMT_COMPLEX_SP = '(es15.08e2,1x,es15.08e2)', the substring (14:23) starts at the comma and extracts ,es15.08e2, which includes an unwanted leading comma. The correct indices should be (15:23) to extract just es15.08e2. The same issue affects all complex kinds (DP, XDP, QP) with appropriately adjusted indices based on their format string lengths.
| default_fmt = FMT_COMPLEX_${k1}$(2:11)//delim_str//FMT_COMPLEX_${k1}$ (14:23) | |
| default_fmt = FMT_COMPLEX_${k1}$(2:11)//delim_str//FMT_COMPLEX_${k1}$ (15:23) |
doc/specs/stdlib_io.md
Outdated
|
|
||
| `footer`: (optional) Shall be a character expression that will be written at the end of the file. | ||
|
|
||
| `comments`: (optional) : Shall be a character expression that will be prepended to the ``header`` and ``footer`` strings to mark them as comments. Default: `#`. |
Copilot
AI
Jan 29, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is an extra colon and space after comments in the parameter description. It should be comments (optional): not comments: (optional) : for consistency with other parameter descriptions in the documentation.
| `comments`: (optional) : Shall be a character expression that will be prepended to the ``header`` and ``footer`` strings to mark them as comments. Default: `#`. | |
| `comments` (optional): Shall be a character expression that will be prepended to the ``header`` and ``footer`` strings to mark them as comments. Default: `#`. |
src/io/stdlib_io.fypp
Outdated
| ! prepend function may be replaced by use of replace_all but currently stdlib_strings | ||
| ! is being compiled after stdlib_io | ||
| ! if (header_ /= '') write (unit, '(A)') comments_//replace_all(header_, nl, nl//comments_) | ||
| if (header_ /= '') write (unit, '(A)', iostat=ios, iomsg=iomsg) prepend(header_, comments_) |
Copilot
AI
Jan 29, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The write statement for the header does not check the iostat value after writing. If the write fails (e.g., due to permissions or disk space issues), the error is silently ignored and execution continues. Consider adding error handling similar to the data writing loop (lines 319-327) to ensure write failures are caught and reported.
| if (header_ /= '') write (unit, '(A)', iostat=ios, iomsg=iomsg) prepend(header_, comments_) | |
| if (header_ /= '') then | |
| write (unit, '(A)', iostat=ios, iomsg=iomsg) prepend(header_, comments_) | |
| if (ios /= 0) then | |
| write (msgout,1) trim(iomsg),size(d,2),0,& | |
| #:if 'filename' in arg1 | |
| trim(filename) | |
| #:else | |
| unit | |
| #:endif | |
| call error_stop(msg=trim(msgout)) | |
| end if | |
| end if |
src/io/stdlib_io.fypp
Outdated
| close(s) | ||
|
|
||
| ! if (footer_ /= '') write (unit, '(A)') comments_//replace_all(footer_, nl, nl//comments_) | ||
| if (footer_ /= '') write (unit, '(A)') prepend(footer_, comments_) |
Copilot
AI
Jan 29, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The write statement for the footer does not check the iostat value after writing. If the write fails (e.g., due to permissions or disk space issues), the error is silently ignored. Consider adding error handling similar to the data writing loop (lines 319-327) to ensure write failures are caught and reported.
| if (footer_ /= '') write (unit, '(A)') prepend(footer_, comments_) | |
| if (footer_ /= '') then | |
| write (unit, '(A)', iostat=ios, iomsg=iomsg) prepend(footer_, comments_) | |
| if (ios /= 0) then | |
| write (msgout,'(a)') trim(iomsg) | |
| call error_stop(msg=trim(msgout)) | |
| end if | |
| end if |
src/io/stdlib_io.fypp
Outdated
| #:endif | ||
| ${t1}$, intent(in) :: d(:,:) ! The 2D array to save | ||
| character(len=1), intent(in), optional :: delimiter ! Column delimiter. Default is a space. | ||
| character(len=1), intent(in), optional :: delimiter ! Column delimiter. Default is a space ' '. |
Copilot
AI
Jan 29, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The delimiter parameter is still constrained to character(len=1), but the PR description states that one goal is to "change delimiter to an arbitrary length string" to support delimiters like ', ' (comma followed by spaces). This inconsistency means the feature is incomplete. Consider changing the delimiter parameter type to character(len=*) to match the stated goal and documentation changes.
| character(len=1), intent(in), optional :: delimiter ! Column delimiter. Default is a space ' '. | |
| character(len=*), intent(in), optional :: delimiter ! Column delimiter. Default is a space ' '. |
src/io/stdlib_io.fypp
Outdated
| default_fmt = FMT_REAL_${k1}$(2:len(FMT_REAL_${k1}$)-1) | ||
| #:elif 'complex' in t1 | ||
| fmt_ = "(*"//FMT_COMPLEX_${k1}$(1:11)//delim_str//FMT_COMPLEX_${k1}$(14:23)//",:,"//delim_str//"))" | ||
| default_fmt = FMT_COMPLEX_${k1}$(2:11)//delim_str//FMT_COMPLEX_${k1}$ (14:23) |
Copilot
AI
Jan 29, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is an extra space before the opening parenthesis in FMT_COMPLEX_${k1}$ (14:23). This should be FMT_COMPLEX_${k1}$(14:23) without the space to avoid a syntax error when the template is expanded.
| default_fmt = FMT_COMPLEX_${k1}$(2:11)//delim_str//FMT_COMPLEX_${k1}$ (14:23) | |
| default_fmt = FMT_COMPLEX_${k1}$(2:11)//delim_str//FMT_COMPLEX_${k1}$(14:23) |
doc/specs/stdlib_io.md
Outdated
|
|
||
| `fmt`: (optional): Fortran format specifier for the text save. Defaults to the write format for the data type. | ||
|
|
||
| `header`: (optional) Shall be a character expression that will be written at the beginning of the file. |
Copilot
AI
Jan 29, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is an extra colon after header in the parameter description. It should be header (optional): not header: (optional) for consistency with other parameter descriptions in the documentation.
| `header`: (optional) Shall be a character expression that will be written at the beginning of the file. | |
| `header` (optional): Shall be a character expression that will be written at the beginning of the file. |
test/io/test_savetxt.f90
Outdated
| call savetxt(outpath, e, fmt='(g0.7)', header="Three values per line", footer="Total size = 6", comments='#!') | ||
| call loadtxt(outpath, d2, fmt='*', skiprows=1, max_rows=2) |
Copilot
AI
Jan 29, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The new unit-based interface for savetxt is not tested. The example code includes a call to savetxt(output_unit, x, header='...'), but there are no automated tests verifying this functionality works correctly. Consider adding a test case that opens a file with a specific unit number, writes to it using the unit variant of savetxt, closes it, and then verifies the content was written correctly.
test/io/test_savetxt.f90
Outdated
| e = reshape([1, 2, 3, 4, 5, 6], [2, 3]) | ||
| call savetxt(outpath, e) | ||
| call loadtxt(outpath, d2) | ||
| call savetxt(outpath, e, fmt='(g0.7)', header="Three values per line", footer="Total size = 6", comments='#!') |
Copilot
AI
Jan 29, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The test uses comments='#!' (two characters), but the comments parameter documentation states it's for "a character expression" and defaults to #. The implementation allows arbitrary length comment strings (via optval(comments, comment_default) where comments is character(len=*)), which is good, but this should be explicitly documented. The current documentation at line 127 is unclear about whether multiple characters are supported.
| call savetxt(outpath, e, fmt='(g0.7)', header="Three values per line", footer="Total size = 6", comments='#!') | |
| call savetxt(outpath, e, fmt='(g0.7)', header="Three values per line", footer="Total size = 6", comments='#') |
test/io/test_savetxt.f90
Outdated
| call savetxt(outpath, e, fmt='(g0.7)', header="Three values per line", footer="Total size = 6", comments='#!') | ||
| call loadtxt(outpath, d2, fmt='*', skiprows=1, max_rows=2) |
Copilot
AI
Jan 29, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The test saves data with header and footer, but only validates that the data can be read back using skiprows=1 to skip the header and max_rows=2 to read only the data rows. The footer is never verified to have been written correctly. Consider adding a test that reads the entire file as text and verifies both header and footer are present and correctly formatted with comment characters.
jvdp1
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank oyu @fiolj . Overall it looks good. Here are some minor suggestions.
doc/specs/stdlib_io.md
Outdated
| `delimiter` (optional): Shall be a character expression of length 1 that contains the delimiter used to separate the columns. The default is `' '`. | ||
| `delimiter` (optional): Shall be a character expression of any length that contains the delimiter used to separate the columns. The default is a single space `' '`. | ||
|
|
||
| `fmt`: (optional): Fortran format specifier for the text save. Defaults to the write format for the data type. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what is the write format?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It currently is (and was also in the original) the (may be little) documented Formatting constants. I've added the reference now in the spec
| !! | ||
| !! Saves a 2D array into a text file | ||
| !! ([Specification](../page/specs/stdlib_io.html#description_2)) | ||
| #:for a1 in ['f', 'u'] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| #:for a1 in ['f', 'u'] | |
| #:for arg1 in ['f'ilename, 'unit'] |
| #:for a1 in ['f', 'u'] | ||
| #:for k1, t1 in KINDS_TYPES | ||
| module procedure savetxt_${t1[0]}$${k1}$ | ||
| module procedure savetxt_${t1[0]}$${k1}$${a1}$ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| module procedure savetxt_${t1[0]}$${k1}$${a1}$ | |
| module procedure savetxt_${t1[0]}$${k1}$${arg1}$ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can use arg1 but I was thinking on only using the first letter to identify the name of the routine, as in the definition (arg1[0]):
#:for arg1 in ['filename', 'unit']
#:for k1, t1 in KINDS_TYPES
subroutine savetxt_${t1[0]}$${k1}$${arg1[0]}$ (${arg1}$ , d, delimiter, fmt, header, footer, comments)
src/io/stdlib_io.fypp
Outdated
| character(len=*), intent(in) :: Sin | ||
| character(len=:), allocatable :: Sout | ||
| character(len=*), intent(in) :: comment | ||
| character(len=len(comment)+2) :: com_ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why "+2"? It seems that only 1 space is attended at the end of comment?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, corrected
test/io/test_savetxt.f90
Outdated
| d = reshape([1, 2, 3, 4, 5, 6], [3, 2]) | ||
| call savetxt(outpath, d) | ||
| call loadtxt(outpath, d2) | ||
| call savetxt(outpath, d, delimiter=',') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could we keep the initial tests, and add new ones for delimiter=','?
test/io/test_savetxt.f90
Outdated
| e = reshape([1, 2, 3, 4, 5, 6], [2, 3]) | ||
| call savetxt(outpath, e) | ||
| call loadtxt(outpath, d2) | ||
| call savetxt(outpath, e, fmt='(g0.7)', header="Three values per line", footer="Total size = 6", comments='#!') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same comment here: could we keep the initial tests and add new ones for delimiter='``?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done, please check if the new tests are ok if you have time
This PR aims to add optional arguments to
savetxt, that behave similar to numpy's savetxt.This is associated with Issue 263 and this discussion thread.
It add the possibility of supplying the unit of an open file instead of a filename (which could be used for
output_unitfor instance)This implementation is quite simple. The main changes are: