bpo-21056: Document return type of next method of csv reader #146

aktech · 2017-02-18T06:40:58Z

csv.reader

>>> import csv
>>> fp = open('foo.csv')
>>> csv_reader = csv.reader(fp)
>>> next(csv_reader)
['a', 'b', 'c', 'd']

csv.DictReader

>>> fp = open('foo.csv')
>>> csv_dict_reader = csv.DictReader(fp)
>>> next(csv_dict_reader)
OrderedDict([('a', 'e'), ('b', 'f'), ('c', 'g'), ('d', 'h')])

Contents of foo.csv

a,b,c,d
e,f,g,h
i,j,k,l

Documentation: https://docs.python.org/3.7/library/csv.html#reader-objects

the-knights-who-say-ni · 2017-02-18T06:40:58Z

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA).

Unfortunately our records indicate you have not signed the CLA. For legal reasons we need you to sign this before we can look at your contribution. Please follow these steps to rectify the issue:

Sign the PSF contributor agreement
Wait at least one US business day and then check "Your Details" on bugs.python.org to see if your account has been marked as having signed the CLA (the delay is due to a person having to manually check your signed CLA)
Reply here saying you have completed the above steps

Thanks again to your contribution and we look forward to looking at it!

DimitrisJim · 2017-02-18T17:21:28Z

Doc/library/csv.rst

-   to the current dialect.  Usually you should call this as ``next(reader)``.
+   Return the next row of the reader's iterable object as a list (if reader) or
+   dict (if DictReader), parsed according to the current dialect. Usually you
+   should call this as ``next(reader)``.


I think it would be better to change these to:

Return the next row of the reader's iterable object as a list (if the object was returned from reader()) or a dict (if it is a DictReader) [...]

Sounds good! Fixed.

JDLH · 2017-02-20T06:44:15Z

Could you please check the bpo number? bpo-29521 has to do with Sphinx and building documentation, and has nothing to do with CSV support. As far as I know.

aktech · 2017-02-20T06:55:58Z

Could you please check the bpo number? bpo-29521 has to do with Sphinx and building documentation, and has nothing to do with CSV support. As far as I know.

Yeah, Thanks! I have fixed it now.

berkerpeksag · 2017-02-21T06:49:42Z

Doc/library/csv.rst

-   Return the next row of the reader's iterable object as a list, parsed according
-   to the current dialect.  Usually you should call this as ``next(reader)``.
+   Return the next row of the reader's iterable object as a list (if the object
+   was returned from ``reader()``) or a dict (if it is a ``DictReader``), parsed


reader() is not very clear here. "[...] from :func:`reader`" would be much clearer.

berkerpeksag · 2017-02-21T06:50:35Z

Doc/library/csv.rst

-   Return the next row of the reader's iterable object as a list, parsed according
-   to the current dialect.  Usually you should call this as ``next(reader)``.
+   Return the next row of the reader's iterable object as a list (if the object
+   was returned from ``reader()``) or a dict (if it is a ``DictReader``), parsed


if it is a :class:`DictReader` instance

berkerpeksag · 2017-02-21T06:51:28Z

Doc/library/csv.rst

-   to the current dialect.  Usually you should call this as ``next(reader)``.
+   Return the next row of the reader's iterable object as a list (if the object
+   was returned from ``reader()``) or a dict (if it is a ``DictReader``), parsed
+   according to the current dialect. Usually you should call this as


Add two spaces after a full-stop:

[...] dialect. Usually [...]

aktech · 2017-02-21T14:17:07Z

@berkerpeksag Thanks for the Review, I have made the changes now. Please have a look.

berkerpeksag

Looking at this again, I agree with Josh Rosenberg's comment at https://bugs.python.org/issue21056#msg214856 It would be better to the documentation for __next__ and document the return types of them in their documentation. Plus, we can adapt the examples you gave in #146 (comment) to the existing ones.

rhettinger · 2017-04-05T05:47:39Z

This looks fine. I'm not sure it is necessary though (I don't recall it ever having been a source of confusion).

Mariatta · 2017-05-23T05:09:59Z

Thanks @aktech

…ythonGH-146) (cherry picked from commit d618c8c)

…H-146) (#1749) (cherry picked from commit d618c8c)

…H-146) (#1750) (cherry picked from commit d618c8c)

ncoghlan · 2017-05-28T05:07:02Z

Added the sprint label, as this PR was submitted at the PyCon Pune 2017 core development sprint.

This fix prevent a NULL-pointer access (SEGFAULT), if a thread terminates with a MemoryError exception.

This fix prevent a NULL-pointer access (SEGFAULT), if a thread terminates with a MemoryError exception. (cherry picked from commit bcd724c)

Merge the PR if: - PR has "awaiting merge" and "automerge" labels, and - all CI status checks have passed. It will: - replace `#` with `GH-` - get the commit message from PR title and description Closes python/bedevere#14 Closes python/core-workflow#29

bpo-29521 document return type of next method of csv reader

c03618a

the-knights-who-say-ni added the CLA not signed label Feb 18, 2017

ncoghlan added cherry-pick for 3.5 and removed cherry-pick for 3.5 labels Feb 18, 2017

serhiy-storchaka added the docs Documentation in the Doc dir label Feb 18, 2017

DimitrisJim reviewed Feb 18, 2017

View reviewed changes

Explicitly mention the object type reader()/DictReader

b2638a0

aktech changed the title ~~bpo-29521 document return type of next method of csv reader~~ bpo-21056 document return type of next method of csv reader Feb 20, 2017

berkerpeksag requested changes Feb 21, 2017

View reviewed changes

berkerpeksag changed the title ~~bpo-21056 document return type of next method of csv reader~~ bpo-21056: Document return type of next method of csv reader Feb 21, 2017

Mariatta removed the CLA not signed label Feb 21, 2017

the-knights-who-say-ni added the CLA signed label Feb 21, 2017

Address comments: use :func: and :class:

b3699ad

berkerpeksag requested changes Feb 27, 2017

View reviewed changes

Mariatta approved these changes May 23, 2017

View reviewed changes

Mariatta merged commit d618c8c into python:master May 23, 2017

Mariatta pushed a commit to Mariatta/cpython that referenced this pull request May 23, 2017

[3.6] bpo-21056: Document return type of next method of csv reader (p…

35e4dce

…ythonGH-146) (cherry picked from commit d618c8c)

Mariatta pushed a commit to Mariatta/cpython that referenced this pull request May 23, 2017

[3.5] bpo-21056: Document return type of next method of csv reader (p…

f6f8862

…ythonGH-146) (cherry picked from commit d618c8c)

This was referenced May 23, 2017

[3.6] bpo-21056: Document return type of next method of csv reader #1749

Merged

[3.5] bpo-21056: Document return type of next method of csv reader #1750

Merged

Mariatta removed needs backport to 3.5 labels May 23, 2017

ambv pushed a commit that referenced this pull request May 23, 2017

[3.6] bpo-21056: Document return type of next method of csv reader (G…

6ef0882

…H-146) (#1749) (cherry picked from commit d618c8c)

ambv pushed a commit that referenced this pull request May 23, 2017

[3.5] bpo-21056: Document return type of next method of csv reader (G…

32dcf42

…H-146) (#1750) (cherry picked from commit d618c8c)

ncoghlan added the sprint label May 28, 2017

akruis pushed a commit to akruis/cpython that referenced this pull request Dec 20, 2017

Stackless issue python#146: always initialize the bomb type

bcd724c

This fix prevent a NULL-pointer access (SEGFAULT), if a thread terminates with a MemoryError exception.

Uh oh!

bpo-21056: Document return type of next method of csv reader #146

bpo-21056: Document return type of next method of csv reader #146

Uh oh!

Conversation

aktech commented Feb 18, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

csv.reader

csv.DictReader

Uh oh!

the-knights-who-say-ni commented Feb 18, 2017

Uh oh!

DimitrisJim Feb 18, 2017

Choose a reason for hiding this comment

Uh oh!

aktech Feb 18, 2017

Choose a reason for hiding this comment

Uh oh!

JDLH commented Feb 20, 2017

Uh oh!

aktech commented Feb 20, 2017

Uh oh!

berkerpeksag Feb 21, 2017

Choose a reason for hiding this comment

Uh oh!

berkerpeksag Feb 21, 2017

Choose a reason for hiding this comment

Uh oh!

berkerpeksag Feb 21, 2017

Choose a reason for hiding this comment

Uh oh!

aktech commented Feb 21, 2017

Uh oh!

berkerpeksag left a comment

Choose a reason for hiding this comment

Uh oh!

rhettinger commented Apr 5, 2017

Uh oh!

Mariatta commented May 23, 2017

Uh oh!

ncoghlan commented May 28, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

aktech commented Feb 18, 2017 •

edited

Loading