85 support output to binary files

[Simon-van-Diepen]

Adds:

• sarxarray._io.to_binary, allowing the writing of one data variable contained in an xarray.Dataset or xarray.DataArray to a binary file, preserving the input dtype and shape.
• to_binary and crop are now top-level functions, accessible through sarxarray.to_binary and sarxarray.crop

[Simon-van-Diepen]

@rogerkuou I don't know what I did wrong with this PR and why it doesn't run the checks and I can just merge it directly already. Could you have a look?

[rogerkuou]

Hi @Simon-van-Diepen , I tried close and reopened this PR and GitHub actions were triggered. It fails on linting and test coverage. Can you fix? Thanks!

[Simon-van-Diepen]

Great, thanks @rogerkuou ! I'll fix the failed checks and then re-request the review

[Simon-van-Diepen]

Hi @rogerkuou I have added unit tests for all the ways the new function to_binary should fail. The remaining uncovered code will result in a file being written to the disk, which I do not know how to properly deal with in a unit test. Are there standard practices for this, or is it best to leave it uncovered?

[rogerkuou]

Hi @Simon-van-Diepen, pytest has a fixture tmp_path which is perfect for testing this sort. See PR #98.

[rogerkuou]

Hi @Simon-van-Diepen , thanks for this nice implementation!

I would propose one small thing on controlling the behavior of overwriting. Since these raw files can be big, this can avoid users accidentally overwriting some results.

Implementing this means you will need to add 1-2 more unit tests. Thanks in advance for this!

[rogerkuou]

Here we are always overwriting the existing file. I propose we either add an input arg in the function to control the behavior (default to non-overwriting is safer.) Or at least document this behavior in the function.

I would prefer the first actually.

[Simon-van-Diepen]

I have added an input argument allow_overwrite in 0cdc6ed, and added three unit tests, including one to ensure that the default will remain False.

There unfortunately is no way to address this in np.memmap directly, as w+ is the only mode allowing the creation of new files. The new input argument therefore is the best way to resolve this

[rogerkuou]

Thanks @Simon-van-Diepen! Please go ahead and merge.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud