Improve csv functions by mentioning that enclosure character will be ignore #4190
Conversation
| @@ -77,6 +77,7 @@ | |||
| <para> | |||
| The <parameter>enclosure</parameter> parameter sets the field enclosure character. | |||
| It must be a single byte character. | |||
| If the CSV does not use an enclosure character, the parameter will be ignored. | |||
There was a problem hiding this comment.
I don't think this sentence is useful information. I mean, if the CSV does not use a separator (i.e. only one column), the separator will also be "ignored".
There was a problem hiding this comment.
I added this sentence, because while upgrading a package from php 8.3 to 8.4, I was getting this error:
ValueError: str_getcsv(): Argument #3 ($enclosure) must be a single character
The code that triggers the error is:
$columns = str_getcsv($line, $this->separator, $this->enclosure, $this->escape);So I started scratching my head and went back to reading the php doc which says:
So the current doc says you must set an enclosure character. Maybe for you it's obvious, that you can set it to any character, and, if the character is not present, it will be ignored. However it was not for me and I had to disturb the dev team by opening an issue on GitHub.
There was a problem hiding this comment.
Yeah, I'm aware of the background. :)
But like I've said, in the general case you cannot know whether enclosure characters are used (they are needed whenever the separator character or a line break are contained in a field value). And I've just checked latest LibreOffice Calc, and when importing a CSV, you need to choose between double- or single-quotes as enclosure character, even if the file is tab separated (and so rarely uses enclosure characters).
There was a problem hiding this comment.
Do you think adding the extra string will do harm?
See #4175