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: urllib2.getproxies not documented
Type: Stage:
Components: Documentation Versions: Python 2.6
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: orsenthil Nosy List: eric.araujo, georg.brandl, ned.deily, orsenthil, timmie
Priority: normal Keywords:

Created on 2009-03-11 10:14 by timmie, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (4)
msg83464 - (view) Author: Tim Michelsen (timmie) Date: 2009-03-11 10:14
There is no documentation for the function 


in
http://docs.python.org/search.html?q=getproxies&check_keywords=yes&area=default

But the docstring shows:
ul.getproxies?
Type:           function
Base Class:     <type 'function'>
String Form:    <function getproxies at 0x01096EF0>
Namespace:      Interactive
File:           c:\programme\pythonxy\python\lib\urllib.py
Definition:     ul.getproxies()
Docstring:
    Return a dictionary of scheme -> proxy server URL mappings.

Returns settings gathered from the environment, if specified,
or the registry.
msg94154 - (view) Author: Ned Deily (ned.deily) * (Python committer) Date: 2009-10-16 22:55
In Python 2, urllib2.getproxies is one of a number of helper functions 
imported from urllib.  It's not externally documented there, either, and 
likely not intended to be used externally.
msg94198 - (view) Author: Senthil Kumaran (orsenthil) * (Python committer) Date: 2009-10-18 02:21
getproxies is urllib one of the many helper functions that is not
documented in the Documentation files.

I am not sure of a good resolution for this (leave it as such/Document
it/ make it private). I shall look into the test coverage,usage of the
function and decide.
msg100131 - (view) Author: Senthil Kumaran (orsenthil) * (Python committer) Date: 2010-02-26 00:57
urllib.getproxies() might be helpful to be documented too. I have added documentaion to this helper function in the r78457 (trunk), r78458, r78459, r78460.
History
Date User Action Args
2022-04-11 14:56:46adminsetgithub: 49725
2010-02-26 00:57:16orsenthilsetstatus: open -> closed
resolution: fixed
messages: + msg100131
2010-02-16 05:27:26eric.araujosetnosy: + eric.araujo
2009-10-18 02:21:02orsenthilsetassignee: georg.brandl -> orsenthil

messages: + msg94198
nosy: + orsenthil
2009-10-16 22:55:42ned.deilysetnosy: + ned.deily
messages: + msg94154
2009-03-11 10:14:54timmiecreate