Allow different encodings for reading JCAMP files #101
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
jjhelmus
reviewed
Jul 10, 2019
nmrglue/fileio/bruker.py
Outdated
| @@ -2091,7 +2092,7 @@ def rm_dig_filter( | |||
|
|
|||
| # JCAMP-DX functions | |||
|
|
|||
| def read_jcamp(filename): | |||
| def read_jcamp(filename, encodings=[locale.getpreferredencoding()]): | |||
There was a problem hiding this comment.
I think it would be preferable to use a single encoding here. If users want to try multiple encoding they can create a loop over read_jcamp with a check for a UnicodeDecodeError.
jjhelmus
reviewed
Jul 10, 2019
nmrglue/fileio/bruker.py
Outdated
| warn("Unable to correctly parse line:" + line) | ||
| for N, encoding in enumerate(encodings): | ||
| try: | ||
| with open(filename, 'r', encoding = encoding) as f: |
There was a problem hiding this comment.
In Python 2 encoding is not an argument in the buildin open command. io.open does support this argument.
|
@andreasdoll I made two suggestions on how I think this should be implemented. Let me know if you need any help with this. |
Allow to specify an encoding for reading JCAMP files. Keep the current behaviour by choosing the default encoding if no encoding is specified. Use io.open() to read a JCAMP file to guarantee backwards compatibility with Python 2.
|
Thanks @jjhelmus, I wasn't aware that encodings in open() is not backwards compatible. I've modified that commit according to your wishes and added the previously forgotten parameter docstring. |
|
LGTM, thanks @andreasdoll |
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.
Allow to provide a list of possible encodings for reading JCAMP files,
and use the first encoding which doesn't raise an UnicodeDecodeError.
Suppress such errors, except when all provided encodings fail.
Keep the current behaviour by choosing the default encoding if no
encoding is specified.
I'm not sure if you want to pull this, but for my purposes this is easier and more futureproof than converting the JCAMP files on operating system level.