[Patches] [ python-Patches-725899 ] Cause urllib.urlretrieve() to match docs for local files

[SourceForge.net]

Patches item #725899, was opened at 2003-04-22 18:27
Message generated for change (Comment added) made by gvanrossum
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=305470&aid=725899&group_id=5470

Category: Library (Lib)
Group: Python 2.3
Status: Closed
Resolution: None
Priority: 7
Submitted By: Brett Cannon (bcannon)
Assigned to: Brett Cannon (bcannon)
Summary: Cause urllib.urlretrieve() to match docs for local files

Initial Comment:
As of right now, urllib.urlretrieve() returns an actual 
mimetools.Message object for its 'headers' value.  Now both the 
module doc and doc string say that it should be returning None.  I 
have a patch here (all 3 lines of it) to cause urlretrive to match the 
documentation.

But perhaps we should change the docs instead?  I have no clue if 
there is any code out in the wild that relies on the current behavior.  I 
personally say keep the code as it is and fix the docs, but that is just 
me.

I am going to hold off on applying this patch until someone else 
either agrees with me or I get someone higher up the food chain to 
tell me I am wrong.  I am going to assign this to Guido initially but I 
can apply the patch myself; just need an answer on this before b1 
goes out since this patch changes semantics.

----------------------------------------------------------------------

>Comment By: Guido van Rossum (gvanrossum)
Date: 2003-04-24 07:57

Message:
Logged In: YES 
user_id=6380

Very thorough. Thanks!

----------------------------------------------------------------------

Comment By: Brett Cannon (bcannon)
Date: 2003-04-23 22:48

Message:
Logged In: YES 
user_id=357491

OK, docstring is fixed along with the lib docs.  Also fixed a couple typos.  
Also backported to release2.2-maint.

----------------------------------------------------------------------

Comment By: Brett Cannon (bcannon)
Date: 2003-04-23 22:47

Message:
Logged In: YES 
user_id=357491

OK, docstring is fixed along with the lib docs.  Also fixed a couple typos.  
Also backported to release2.2-maint.

----------------------------------------------------------------------

Comment By: Guido van Rossum (gvanrossum)
Date: 2003-04-22 20:58

Message:
Logged In: YES 
user_id=6380

Backport to 2.2: yes, but it's just a doc issue.

The best way to work with 2.2 if you have the disk space and
you already have a trunk checkout:

1) make a copy of your trunk checkout

2) in that copy, do "cvs update -r release22-maint"

>From now on, the copy works on the branch. Just remember
never to do "cvs update -A" there (this resets the sticky
tag to the trunk).

----------------------------------------------------------------------

Comment By: Guido van Rossum (gvanrossum)
Date: 2003-04-22 20:54

Message:
Logged In: YES 
user_id=6380

Somehow, tracker permissions have to be updated separately,
and some of the SF admin screens are not very clear. I've
upgraded your permissions in this tracker now!

----------------------------------------------------------------------

Comment By: Brett Cannon (bcannon)
Date: 2003-04-22 20:37

Message:
Logged In: YES 
user_id=357491

Should I also backport this to 2.2?  I assume yes, but thought I should 
double-check (maybe subconsciously I don't want to have to deal with 
learning how to get a commit correct on a tagged branch =).

----------------------------------------------------------------------

Comment By: Brett Cannon (bcannon)
Date: 2003-04-22 20:35

Message:
Logged In: YES 
user_id=357491

OK, I will fix the docs (both the library docs and the docstring).

And I don't know why the hell I am not listed.  I still can't delete items off of 
tracker items that I have created (this was a problem before I became a 
committer).  Guess I need to email SF tech support and see what they say.  I 
will get the docs changed and close this patch (assuming it lets me) as if it 
was assigned to me.

----------------------------------------------------------------------

Comment By: Guido van Rossum (gvanrossum)
Date: 2003-04-22 20:27

Message:
Logged In: YES 
user_id=6380

Hm, I don't see you in the list of committers?

----------------------------------------------------------------------

Comment By: Guido van Rossum (gvanrossum)
Date: 2003-04-22 20:25

Message:
Logged In: YES 
user_id=6380

In general fixing the docs is much safet than fixing the
code. ;-)

If you submit a doc patch here it'll be applied. (Note that
the docstring is also lying.)

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=305470&aid=725899&group_id=5470