Allow -OO mode for docstring_decorator#29689
Merged
amyeroberts merged 1 commit intohuggingface:mainfrom Mar 21, 2024
Merged
Conversation
Fixes
```
File "/nix/store/rv8xdwghdad9jv2w86b8g08kan9l6ksm-python3.11-transformers-4.38.2/lib/python3.11/site-packages/transformers/models/auto/configuration_auto.py", line 987, in <module>
class AutoConfig:
File "/nix/store/rv8xdwghdad9jv2w86b8g08kan9l6ksm-python3.11-transformers-4.38.2/lib/python3.11/site-packages/transformers/models/auto/configuration_auto.py", line 1011, in AutoConfig
@replace_list_option_in_docstrings()
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/nix/store/rv8xdwghdad9jv2w86b8g08kan9l6ksm-python3.11-transformers-4.38.2/lib/python3.11/site-packages/transformers/models/auto/configuration_auto.py", line 966, in docstring_decorator
lines = docstrings.split("\n")
^^^^^^^^^^^^^^^^
AttributeError: 'NoneType' object has no attribute 'split'
```
Contributor
|
Hi @matthid, thannks for opening a PR,
Could you provide some more context here? Specifically where this change is being made and ideally a minimal code snippet which reproduces the issue? |
Contributor
Author
|
Sure just use the following script: and run the script with I hope this helps. |
Contributor
Author
|
Even more minimal (you can see in the stacktrace): |
Contributor
|
@matthid Could you share |
Contributor
Author
|
The script is literally the line I showed:
Run the following in a shell where I'm not sure what else I can say. |
Contributor
|
@matthid Sorry, my bad, I was skimming over this quickly and didn't notice the import line (and was misreading -OO as -00) |
amyeroberts
approved these changes
Mar 20, 2024
Contributor
There was a problem hiding this comment.
@matthid OK, as there's other parts of the library which handle the case when __doc__ is None, I think it's OK to add this.
However, I don't think we can guarantee the whole library is going to be compatible running with the -OO flag, so use at your own risk!
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
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.
What does this PR do?
Fixes
Note; I found this, but I'm now using
-Oinstead of-OOso this fix might not be exhaustive in the sense that now-OOmight run into the next issue. But since I run into that one, I figured sending a fix would be worthwhile, feel free to close if you think otherwise.Before submitting
Pull Request section?
to it if that's the case.
documentation guidelines, and
here are tips on formatting docstrings.