Enable to switch off the removal of comments in csv2rec. #1699
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.
This patch adds a possibility to pass comments=None to csv2rec in order to switch off comments removal.
A real world example are CSV files where the header on the first line is introduced by a hash #. As a hash is the default value for the comments option, the header is ignored. To read such files including the header one has to call csv2rec with something like comments='AStringThatNeverHappensToBeAtTheBeginingOfTheLine' which is not clear from the documentation and which seems more like a hack than a solution.
Currently, the docstring gives no hint about this behaviour and is misleading in the sense that it speaks about a character not a string: