[3.13] gh-80678: Document the preferred delimiters of csv.Sniffer (GH-154336) (#154591)

https://github.com/python/cpython/commit/98d9c4d4953887bbbc62cd1217a64404453b1dab
commit: 98d9c4d4953887bbbc62cd1217a64404453b1dab
branch: 3.13
author: Hugo van Kemenade <[email protected]>
committer: hugovk <[email protected]>
date: 2026-07-31T12:34:19+03:00
summary:

[3.13] gh-80678: Document the preferred delimiters of csv.Sniffer (GH-154336) (#154591)

Co-authored-by: Serhiy Storchaka <[email protected]>
Co-authored-by: Claude Opus 4.8 (1M context) <[email protected]>

files:
M Doc/library/csv.rst
M Lib/csv.py

diff --git a/Doc/library/csv.rst b/Doc/library/csv.rst
index 8f105eeac77bbc..ee1ea87d68655f 100644
--- a/Doc/library/csv.rst
+++ b/Doc/library/csv.rst
@@ -314,6 +314,11 @@ The :mod:`csv` module defines the following classes:
       is given, it is interpreted as a string containing possible valid
       delimiter characters.
 
+      If several delimiters fit the sample equally well ---
+      for example if both ``','`` and ``';'`` split every row consistently ---
+      the delimiters ``','``, ``'\t'``, ``';'``, ``' '`` and ``':'``
+      are preferred, in this order,
+      no matter how many times each of them occurs.
 
    .. method:: has_header(sample)
 
diff --git a/Lib/csv.py b/Lib/csv.py
index b73ad049d98166..905e5b6ac077d3 100644
--- a/Lib/csv.py
+++ b/Lib/csv.py
@@ -244,6 +244,10 @@ def __init__(self):
     def sniff(self, sample, delimiters=None):
         """
         Returns a dialect (or None) corresponding to the sample
+
+        If several delimiters fit the sample equally well, the
+        delimiters listed in the preferred attribute are preferred, in
+        that order, no matter how many times each of them occurs.
         """
 
         quotechar, doublequote, delimiter, skipinitialspace = \

_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: [email protected]