Use file object directly in temporary_config()
#1598
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The context manager uses `NamedTemporaryFile` to store the current configuration, to later restore them. Instead of passing the file object directly to the save function, it just passes the file name, i.e. the save (and the load function) will open the file again, which is in itself not a problem. However, on the Github Windows image this leads to a permission error (using the created file object is fine). This commit solves this by adding the `file` argument to `Config.save()` that allows to pass a file object directly to the function. The same change is applied to the load function of the config object.
philip-paul-mueller
added a commit
to philip-paul-mueller/jace
that referenced
this pull request
Jun 17, 2024
It is known that DaCe does not work out of the box on [MacOSX](https://spcldace.readthedocs.io/en/latest/setup/installation.html#common-issues-with-the-dace-python-module) and [Windows](spcl/dace#1598). Furthermore, since JaCe is a pure Python project we relay on the portability of DaCe and Jax and in the end Python. Thus every crossplatform problem should be handled by DaCe and Jax and not JaCe.
…he previous code repopened the file with `open()` that has `rt` the new file must also be opened that way.
tbennun
changed the title
temporary_config() context manager.temporary_config() context manager
tbennun
changed the title
temporary_config() context managertemporary_config()
tbennun
reviewed
Jun 20, 2024
| @@ -39,10 +40,11 @@ def temporary_config(): | |||
| Config.set("optimizer", "autooptimize", value=True) | |||
| foo() | |||
| """ | |||
| with tempfile.NamedTemporaryFile() as fp: | |||
| Config.save(fp.name) | |||
| with tempfile.NamedTemporaryFile(mode='w+t') as fp: | |||
There was a problem hiding this comment.
what does 't' mean in mode?
There was a problem hiding this comment.
It means text mode, on UNIX \n is the newline character, but on Windows it is \r\n (https://en.wikipedia.org/wiki/Newline#Representation). In that mode \r\n is transformed into \n it is essentially a compatibility layer, see help(open).
I used it because it preserves old behaviour, but it is probably not needed.
tbennun
approved these changes
Jun 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The context manager uses
NamedTemporaryFileto store the current configuration, to later restore them. Instead of passing the file object directly to the save function, it just passes the file name, i.e. the save (and the load function) will open the file again, which is in itself not a problem. However, on the Github Windows image this leads to a permission error (using the created file object is fine).This commit solves this by adding the
fileargument toConfig.save()that allows to pass a file object directly to the function. The same change is applied to the load function of the config object.