Enable to switch off the removal of comments in csv2rec. #1699
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
| @@ -2109,7 +2109,7 @@ def csv2rec(fname, comments='#', skiprows=0, checkrows=0, delimiter=',', | |||
| files is automatic, if the filename ends in '.gz' | |||
|
|
|||
| - *comments*: the character used to indicate the start of a comment | |||
| in the file | |||
| in the file, or None to switch off the removal of comments | |||
There was a problem hiding this comment.
Could you do *None* (asterisks around the word None), please? We are in the process of updating our docs to a consistent standard notation.
|
There is also the load function which has a comments option with the same behavior but I guess it does not make sense to change it as load() is deprecated (?). |
|
travis failures are likely duds. The code change is simple enough, and I guess it is reasonable. There is always the question of whether one should be able to ignore the comment symbol in the first line only, but that is starting to get complicated, and we are just a graphing library. I see no reason not to merge this as-is. I'll leave this up for the day in case anybody has any objections. |
WeatherGod
added a commit
that referenced
this pull request
Jan 29, 2013
Enable to switch off the removal of comments in csv2rec.
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.
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: