summaryrefslogtreecommitdiffstats
path: root/Modules
diff options
context:
space:
mode:
authorSkip Montanaro <skip.montanaro@gmail.com>2024-01-18 22:18:42 (GMT)
committerGitHub <noreply@github.com>2024-01-18 22:18:42 (GMT)
commit72abb8c5d487ead9eb115fec8132ccef5ba189e5 (patch)
treecb8111dc4a58e39d0d6a1deca86d858b823b40aa /Modules
parent68a7b78cd5185cbd9456f42c15ecf872a7c16f44 (diff)
downloadcpython-72abb8c5d487ead9eb115fec8132ccef5ba189e5.zip
cpython-72abb8c5d487ead9eb115fec8132ccef5ba189e5.tar.gz
cpython-72abb8c5d487ead9eb115fec8132ccef5ba189e5.tar.bz2
gh-114123: Migrate docstring from _csv to csv (#114124)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Éric <merwok@netwok.org>
Diffstat (limited to 'Modules')
-rw-r--r--Modules/_csv.c71
1 files changed, 1 insertions, 70 deletions
diff --git a/Modules/_csv.c b/Modules/_csv.c
index d45a15a..8d94156 100644
--- a/Modules/_csv.c
+++ b/Modules/_csv.c
@@ -8,8 +8,6 @@ module instead.
*/
-#define MODULE_VERSION "1.0"
-
// clinic/_csv.c.h uses internal pycore_modsupport.h API
#ifndef Py_BUILD_CORE_BUILTIN
# define Py_BUILD_CORE_MODULE 1
@@ -1607,68 +1605,7 @@ PyType_Spec error_spec = {
* MODULE
*/
-PyDoc_STRVAR(csv_module_doc,
-"CSV parsing and writing.\n"
-"\n"
-"This module provides classes that assist in the reading and writing\n"
-"of Comma Separated Value (CSV) files, and implements the interface\n"
-"described by PEP 305. Although many CSV files are simple to parse,\n"
-"the format is not formally defined by a stable specification and\n"
-"is subtle enough that parsing lines of a CSV file with something\n"
-"like line.split(\",\") is bound to fail. The module supports three\n"
-"basic APIs: reading, writing, and registration of dialects.\n"
-"\n"
-"\n"
-"DIALECT REGISTRATION:\n"
-"\n"
-"Readers and writers support a dialect argument, which is a convenient\n"
-"handle on a group of settings. When the dialect argument is a string,\n"
-"it identifies one of the dialects previously registered with the module.\n"
-"If it is a class or instance, the attributes of the argument are used as\n"
-"the settings for the reader or writer:\n"
-"\n"
-" class excel:\n"
-" delimiter = ','\n"
-" quotechar = '\"'\n"
-" escapechar = None\n"
-" doublequote = True\n"
-" skipinitialspace = False\n"
-" lineterminator = '\\r\\n'\n"
-" quoting = QUOTE_MINIMAL\n"
-"\n"
-"SETTINGS:\n"
-"\n"
-" * quotechar - specifies a one-character string to use as the\n"
-" quoting character. It defaults to '\"'.\n"
-" * delimiter - specifies a one-character string to use as the\n"
-" field separator. It defaults to ','.\n"
-" * skipinitialspace - specifies how to interpret spaces which\n"
-" immediately follow a delimiter. It defaults to False, which\n"
-" means that spaces immediately following a delimiter is part\n"
-" of the following field.\n"
-" * lineterminator - specifies the character sequence which should\n"
-" terminate rows.\n"
-" * quoting - controls when quotes should be generated by the writer.\n"
-" It can take on any of the following module constants:\n"
-"\n"
-" csv.QUOTE_MINIMAL means only when required, for example, when a\n"
-" field contains either the quotechar or the delimiter\n"
-" csv.QUOTE_ALL means that quotes are always placed around fields.\n"
-" csv.QUOTE_NONNUMERIC means that quotes are always placed around\n"
-" fields which do not parse as integers or floating point\n"
-" numbers.\n"
-" csv.QUOTE_STRINGS means that quotes are always placed around\n"
-" fields which are strings. Note that the Python value None\n"
-" is not a string.\n"
-" csv.QUOTE_NOTNULL means that quotes are only placed around fields\n"
-" that are not the Python value None.\n"
-" csv.QUOTE_NONE means that quotes are never placed around fields.\n"
-" * escapechar - specifies a one-character string used to escape\n"
-" the delimiter when quoting is set to QUOTE_NONE.\n"
-" * doublequote - controls the handling of quotes inside fields. When\n"
-" True, two consecutive quotes are interpreted as one during read,\n"
-" and when writing, each quote character embedded in the data is\n"
-" written as two quotes\n");
+PyDoc_STRVAR(csv_module_doc, "CSV parsing and writing.\n");
PyDoc_STRVAR(csv_reader_doc,
" csv_reader = reader(iterable [, dialect='excel']\n"
@@ -1741,12 +1678,6 @@ csv_exec(PyObject *module) {
return -1;
}
- /* Add version to the module. */
- if (PyModule_AddStringConstant(module, "__version__",
- MODULE_VERSION) == -1) {
- return -1;
- }
-
/* Set the field limit */
module_state->field_limit = 128 * 1024;