Deprecate CifParser init support of filename as StringIO#4531
Merged
shyuep merged 4 commits intomaterialsproject:masterfrom Oct 31, 2025
Merged
Conversation
0886cdc to
57a62f1
Compare
|
Thanks, @DanielYang59, for taking this up. My initial confusion was whether using a file handler is supported in the cif = 'my_path.cif'
with open(cif) as file:
parser = CifParser(filename=file)
# output: "TypeError: Unsupported file format."I think this used to work at some point, even though it might not have been intended. It's more of my negligence to misinterpret the interface. I like that you make the error statement explicit now, as |
b29ac07 to
6ca7022
Compare
6ca7022 to
0b70f4a
Compare
This reverts commit 1911a75.
0b70f4a to
2cdb14d
Compare
CifParser init from str with filenameCifParser init support of filename as StringIO
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
__init__ofCifParsertofrom_strRevert accidentally removed filename asreverted, guess this was not intended, also doesn't agree with type/docstringTextIOWrappersupport (though this may not be intended) in Improve type annotations and comments forio.cif#3820, add a deprecation warningfilenameofCifParserconstructor could also be the string for the CIF file itself (StringIO), it's a bit confusing (cc @ka-sarthak) but I guess this was intended to supportfrom_str. After this refactoring this could be deprecated I guess