This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: New httplib lacks documentation
Type: Stage:
Components: Documentation Versions:
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: brett.cannon Nosy List: brett.cannon, fdrake, gvanrossum, rsalz, skip.montanaro
Priority: high Keywords:

Created on 2001-09-04 17:01 by rsalz, last changed 2022-04-10 16:04 by admin. This issue is now closed.

Messages (14)
msg6339 - (view) Author: Rich Salz (rsalz) Date: 2001-09-04 17:01
urllib should allow the user to set the content-type. 
This would allow applications to do more than just
"forms posting" -- e.g., use it to make SOAP requests.
The attached patch allows that.

msg6340 - (view) Author: Guido van Rossum (gvanrossum) * (Python committer) Date: 2001-09-04 18:20
Logged In: YES 
user_id=6380

Isn't SOAP an HTTP application? Then you shouldn't be using
urllib, but httplib.
msg6341 - (view) Author: Guido van Rossum (gvanrossum) * (Python committer) Date: 2001-09-04 18:20
Logged In: YES 
user_id=6380

There's no uploaded file!  You have to check the checkbox labeled
"Check to Upload & Attach File" when you upload a file.

Please try again.

(This is a SourceForge annoyance that we can do nothing about.
:-( )
msg6342 - (view) Author: Rich Salz (rsalz) Date: 2001-09-04 19:16
Logged In: YES 
user_id=36737

Okay,  I'll accept that.  Had HTTP documented that it
included HTTPS I wouldn't have made the initial mistake. :)
Let me know if you want the diff.
msg6343 - (view) Author: Guido van Rossum (gvanrossum) * (Python committer) Date: 2001-09-04 19:20
Logged In: YES 
user_id=6380

Please don't Delete requests. Please don't Close them unless
you are a project manager (I consider it a SF bug that the
submitter can decide to close a bug report if they happen to
have admin perms on another project). I've reopened this and
recategorized as Doc and assigned to Fred so he can see if
the httplib docs need to be updated.
msg6344 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2001-09-04 21:03
Logged In: YES 
user_id=3066

It's not at all clear what sort of documentation update is
needed.  What did you have in mind?
msg6345 - (view) Author: Rich Salz (rsalz) Date: 2001-09-05 02:02
Logged In: YES 
user_id=36737

I created this bug because urllib didn't let you set the content-type header. Guido pointed out that I should be using 
httplib.  I didn't use httplib because I didn't know until I read the source, that httplib had an https object that used 
SSL.  So I guess "document the https object" is what this has mutated into.
msg6346 - (view) Author: Skip Montanaro (skip.montanaro) * (Python triager) Date: 2001-09-05 03:45
Logged In: YES 
user_id=44345

I'm not sure why you'd want to program SOAP (or XMLRPC, for
that matter) directly.  You would (normally) only use those
protocols through special-purpose modules like SOAP.py or
xmlrpclib.py, both of which talk to httplib I believe.  I
don't see that allowing the Content-Type: header to be
overridden at the urllib level is all that necessary.  If
you're going to want to mess with Content-Type: you're
probably going to want to mess with other headers as well.
msg6347 - (view) Author: Guido van Rossum (gvanrossum) * (Python committer) Date: 2001-09-05 15:37
Logged In: YES 
user_id=6380

Fred: it turns out the httplib docs still document the old
version of the module. The new version is considerably more
powerful, and is essentially undocumented. Maybe you can
shame Greg Stein into providing some docs, or maybe you can
convert the copious docstrings to LaTeX.
msg6348 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2001-11-26 21:51
Logged In: YES 
user_id=3066

I have contributed docs for the new version waiting for
review in my inbox; these should be checked in this week. 
Bumping priority so this stays visible to me.
msg6349 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2001-11-30 06:07
Logged In: YES 
user_id=3066

Checked in as Doc/lib/libhttplib.tex revision 1.28.  Updates
contributed by Kalle Svensson.

Thanks, Kalle!
msg6350 - (view) Author: Rich Salz (rsalz) Date: 2001-12-18 17:34
Logged In: YES 
user_id=36737

The **x509 parameter of HTTPSConnection needs to be
documented. It's a dictionary with at most two keys. 
key_file specifies the PEM-fformat private key file and
cert_file specifies contains the PEM-format certificate and
optional list of CA's in the cert chain.
(I believe there's an open defect for SSL sockets not being
docuemented.)
msg6351 - (view) Author: Brett Cannon (brett.cannon) * (Python committer) Date: 2003-05-12 06:36
Logged In: YES 
user_id=357491

It looks like the parameters to HTTPSConnection have changed and are now 
``def __init__(self, host, port=None, key_file=None, 
cert_file=None, strict=None):``.  The docs on the key file and cert file can 
probably be copied from socket.ssl .
msg6352 - (view) Author: Brett Cannon (brett.cannon) * (Python committer) Date: 2003-05-20 02:57
Logged In: YES 
user_id=357491

OK, docs added and backported.
History
Date User Action Args
2022-04-10 16:04:24adminsetgithub: 35104
2001-09-04 17:01:03rsalzcreate