neulab/docprompting-conala huggingface dataset:
FTPHandler.ftp_open(req)  
Open the FTP file indicated by req. The login is always done with empty username and password.
urllib.request.getproxies()  
This helper function returns a dictionary of scheme to proxy server URL mappings. It scans the environment for variables named <scheme>_proxy, in a case insensitive approach, for all operating systems first, and when it cannot find it, looks for proxy information from Mac OSX System Configuration for Mac OS X and Windows Systems Registry for Windows. If both lowercase and uppercase environment variables exist (and disagree), lowercase is preferred.  Note If the environment variable REQUEST_METHOD is set, which usually indicates your script is running in a CGI environment, the environment variable HTTP_PROXY (uppercase _PROXY) will be ignored. This is because that variable can be injected by a client using the “Proxy:” HTTP header. If you need to use an HTTP proxy in a CGI environment, either use ProxyHandler explicitly, or make sure the variable name is in lowercase (or at least the _proxy suffix).
class urllib.request.HTTPBasicAuthHandler(password_mgr=None)  
Handle authentication with the remote host. password_mgr, if given, should be something that is compatible with HTTPPasswordMgr; refer to section HTTPPasswordMgr Objects for information on the interface that must be supported. HTTPBasicAuthHandler will raise a ValueError when presented with a wrong Authentication scheme.
HTTPBasicAuthHandler.http_error_401(req, fp, code, msg, hdrs)  
Retry the request with authentication information, if available.
class urllib.request.HTTPCookieProcessor(cookiejar=None)  
A class to handle HTTP Cookies.
HTTPCookieProcessor.cookiejar  
The http.cookiejar.CookieJar in which cookies are stored.
class urllib.request.HTTPDefaultErrorHandler  
A class which defines a default handler for HTTP error responses; all responses are turned into HTTPError exceptions.
class urllib.request.HTTPDigestAuthHandler(password_mgr=None)  
Handle authentication with the remote host. password_mgr, if given, should be something that is compatible with HTTPPasswordMgr; refer to section HTTPPasswordMgr Objects for information on the interface that must be supported. When both Digest Authentication Handler and Basic Authentication Handler are both added, Digest Authentication is always tried first. If the Digest Authentication returns a 40x response again, it is sent to Basic Authentication handler to Handle. This Handler method will raise a ValueError when presented with an authentication scheme other than Digest or Basic.  Changed in version 3.3: Raise ValueError on unsupported Authentication Scheme.
HTTPDigestAuthHandler.http_error_401(req, fp, code, msg, hdrs)  
Retry the request with authentication information, if available.
HTTPErrorProcessor.https_response(request, response)  
Process HTTPS error responses. The behavior is same as http_response().
HTTPErrorProcessor.http_response(request, response)  
Process HTTP error responses. For 200 error codes, the response object is returned immediately. For non-200 error codes, this simply passes the job on to the http_error_<type>() handler methods, via OpenerDirector.error(). Eventually, HTTPDefaultErrorHandler will raise an HTTPError if no other handler handles the error.
HTTPHandler.http_open(req)  
Send an HTTP request, which can be either GET or POST, depending on req.has_data().
class urllib.request.HTTPPasswordMgr  
Keep a database of (realm, uri) -> (user, password) mappings.
HTTPPasswordMgr.add_password(realm, uri, user, passwd)  
uri can be either a single URI, or a sequence of URIs. realm, user and passwd must be strings. This causes (user, passwd) to be used as authentication tokens when authentication for realm and a super-URI of any of the given URIs is given.
HTTPPasswordMgr.find_user_password(realm, authuri)  
Get user/password for given realm and URI, if any. This method will return (None, None) if there is no matching user/password. For HTTPPasswordMgrWithDefaultRealm objects, the realm None will be searched if the given realm has no matching user/password.
class urllib.request.HTTPPasswordMgrWithDefaultRealm  
Keep a database of (realm, uri) -> (user, password) mappings. A realm of None is considered a catch-all realm, which is searched if no other realm fits.
class urllib.request.HTTPPasswordMgrWithPriorAuth  
A variant of HTTPPasswordMgrWithDefaultRealm that also has a database of uri -> is_authenticated mappings. Can be used by a BasicAuth handler to determine when to send authentication credentials immediately instead of waiting for a 401 response first.  New in version 3.5.
HTTPPasswordMgrWithPriorAuth.add_password(realm, uri, user, passwd, is_authenticated=False)  
realm, uri, user, passwd are as for HTTPPasswordMgr.add_password(). is_authenticated sets the initial value of the is_authenticated flag for the given URI or list of URIs. If is_authenticated is specified as True, realm is ignored.
HTTPPasswordMgrWithPriorAuth.find_user_password(realm, authuri)  
Same as for HTTPPasswordMgrWithDefaultRealm objects
HTTPPasswordMgrWithPriorAuth.is_authenticated(self, authuri)  
Returns the current state of the is_authenticated flag for the given URI.
HTTPPasswordMgrWithPriorAuth.update_authenticated(self, uri, is_authenticated=False)  
Update the is_authenticated flag for the given uri or list of URIs.
HTTPRedirectHandler.http_error_301(req, fp, code, msg, hdrs)  
Redirect to the Location: or URI: URL. This method is called by the parent OpenerDirector when getting an HTTP ‘moved permanently’ response.
HTTPRedirectHandler.http_error_302(req, fp, code, msg, hdrs)  
The same as http_error_301(), but called for the ‘found’ response.
HTTPRedirectHandler.http_error_303(req, fp, code, msg, hdrs)  
The same as http_error_301(), but called for the ‘see other’ response.
HTTPRedirectHandler.http_error_307(req, fp, code, msg, hdrs)  
The same as http_error_301(), but called for the ‘temporary redirect’ response.
HTTPRedirectHandler.redirect_request(req, fp, code, msg, hdrs, newurl)  
Return a Request or None in response to a redirect. This is called by the default implementations of the http_error_30*() methods when a redirection is received from the server. If a redirection should take place, return a new Request to allow http_error_30*() to perform the redirect to newurl. Otherwise, raise HTTPError if no other handler should try to handle this URL, or return None if you can’t but another handler might.  Note The default implementation of this method does not strictly follow RFC 2616, which says that 301 and 302 responses to POST requests must not be automatically redirected without confirmation by the user. In reality, browsers do allow automatic redirection of these responses, changing the POST to a GET, and the default implementation reproduces this behavior.
class urllib.request.HTTPSHandler(debuglevel=0, context=None, check_hostname=None)  
A class to handle opening of HTTPS URLs. context and check_hostname have the same meaning as in http.client.HTTPSConnection.  Changed in version 3.2: context and check_hostname were added.
HTTPSHandler.https_open(req)  
Send an HTTPS request, which can be either GET or POST, depending on req.has_data().
urllib.request.install_opener(opener)  
Install an OpenerDirector instance as the default global opener. Installing an opener is only necessary if you want urlopen to use that opener; otherwise, simply call OpenerDirector.open() instead of urlopen(). The code does not check for a real OpenerDirector, and any class with the appropriate interface will work.
class urllib.request.OpenerDirector  
The OpenerDirector class opens URLs via BaseHandlers chained together. It manages the chaining of handlers, and recovery from errors.
OpenerDirector.add_handler(handler)  
handler should be an instance of BaseHandler. The following methods are searched, and added to the possible chains (note that HTTP errors are a special case). Note that, in the following, protocol should be replaced with the actual protocol to handle, for example http_response() would be the HTTP protocol response handler. Also type should be replaced with the actual HTTP code, for example http_error_404() would handle HTTP 404 errors.  
<protocol>_open() — signal that the handler knows how to open protocol URLs. See BaseHandler.<protocol>_open() for more information.  
http_error_<type>() — signal that the handler knows how to handle HTTP errors with HTTP error code type. See BaseHandler.http_error_<nnn>() for more information.  
<protocol>_error() — signal that the handler knows how to handle errors from (non-http) protocol. 
<protocol>_request() — signal that the handler knows how to pre-process protocol requests. See BaseHandler.<protocol>_request() for more information.  
<protocol>_response() — signal that the handler knows how to post-process protocol responses. See BaseHandler.<protocol>_response() for more information.
OpenerDirector.error(proto, *args)  
Handle an error of the given protocol. This will call the registered error handlers for the given protocol with the given arguments (which are protocol specific). The HTTP protocol is a special case which uses the HTTP response code to determine the specific error handler; refer to the http_error_<type>() methods of the handler classes. Return values and exceptions raised are the same as those of urlopen().
OpenerDirector.open(url, data=None[, timeout])  
Open the given url (which can be a request object or a string), optionally passing the given data. Arguments, return values and exceptions raised are the same as those of urlopen() (which simply calls the open() method on the currently installed global OpenerDirector). The optional timeout parameter specifies a timeout in seconds for blocking operations like the connection attempt (if not specified, the global default timeout setting will be used). The timeout feature actually works only for HTTP, HTTPS and FTP connections).
urllib.request.pathname2url(path)  
Convert the pathname path from the local syntax for a path to the form used in the path component of a URL. This does not produce a complete URL. The return value will already be quoted using the quote() function.
class urllib.request.ProxyBasicAuthHandler(password_mgr=None)  
Handle authentication with the proxy. password_mgr, if given, should be something that is compatible with HTTPPasswordMgr; refer to section HTTPPasswordMgr Objects for information on the interface that must be supported.
ProxyBasicAuthHandler.http_error_407(req, fp, code, msg, hdrs)  
Retry the request with authentication information, if available.
class urllib.request.ProxyDigestAuthHandler(password_mgr=None)  
Handle authentication with the proxy. password_mgr, if given, should be something that is compatible with HTTPPasswordMgr; refer to section HTTPPasswordMgr Objects for information on the interface that must be supported.
ProxyDigestAuthHandler.http_error_407(req, fp, code, msg, hdrs)  
Retry the request with authentication information, if available.
class urllib.request.ProxyHandler(proxies=None)  
Cause requests to go through a proxy. If proxies is given, it must be a dictionary mapping protocol names to URLs of proxies. The default is to read the list of proxies from the environment variables <protocol>_proxy. If no proxy environment variables are set, then in a Windows environment proxy settings are obtained from the registry’s Internet Settings section, and in a Mac OS X environment proxy information is retrieved from the OS X System Configuration Framework. To disable autodetected proxy pass an empty dictionary. The no_proxy environment variable can be used to specify hosts which shouldn’t be reached via proxy; if set, it should be a comma-separated list of hostname suffixes, optionally with :port appended, for example cern.ch,ncsa.uiuc.edu,some.host:8080.  Note HTTP_PROXY will be ignored if a variable REQUEST_METHOD is set; see the documentation on getproxies().
Request.add_header(key, val)  
Add another header to the request. Headers are currently ignored by all handlers except HTTP handlers, where they are added to the list of headers sent to the server. Note that there cannot be more than one header with the same name, and later calls will overwrite previous calls in case the key collides. Currently, this is no loss of HTTP functionality, since all headers which have meaning when used more than once have a (header-specific) way of gaining the same functionality using only one header.
Request.add_unredirected_header(key, header)  
Add a header that will not be added to a redirected request.
Request.data  
The entity body for the request, or None if not specified.  Changed in version 3.4: Changing value of Request.data now deletes “Content-Length” header if it was previously set or calculated.
Request.full_url  
The original URL passed to the constructor.  Changed in version 3.4.  Request.full_url is a property with setter, getter and a deleter. Getting full_url returns the original request URL with the fragment, if it was present.
Request.get_full_url()  
Return the URL given in the constructor.  Changed in version 3.4.  Returns Request.full_url
Request.get_header(header_name, default=None)  
Return the value of the given header. If the header is not present, return the default value.
Request.get_method()  
Return a string indicating the HTTP request method. If Request.method is not None, return its value, otherwise return 'GET' if Request.data is None, or 'POST' if it’s not. This is only meaningful for HTTP requests.  Changed in version 3.3: get_method now looks at the value of Request.method.
Request.has_header(header)  
Return whether the instance has the named header (checks both regular and unredirected).
Request.header_items()  
Return a list of tuples (header_name, header_value) of the Request headers.
Request.host  
The URI authority, typically a host, but may also contain a port separated by a colon.
Request.method  
The HTTP request method to use. By default its value is None, which means that get_method() will do its normal computation of the method to be used. Its value can be set (thus overriding the default computation in get_method()) either by providing a default value by setting it at the class level in a Request subclass, or by passing a value in to the Request constructor via the method argument.  New in version 3.3.   Changed in version 3.4: A default value can now be set in subclasses; previously it could only be set via the constructor argument.
Request.remove_header(header)  
Remove named header from the request instance (both from regular and unredirected headers).  New in version 3.4.
Request.selector  
The URI path. If the Request uses a proxy, then selector will be the full URL that is passed to the proxy.
Request.set_proxy(host, type)  
Prepare the request by connecting to a proxy server. The host and type will replace those of the instance, and the instance’s selector will be the original URL given in the constructor.
Request.unverifiable  
boolean, indicates whether the request is unverifiable as defined by RFC 2965.
class urllib.request.UnknownHandler  
A catch-all class to handle unknown URLs.
urllib.request.url2pathname(path)  
Convert the path component path from a percent-encoded URL to the local syntax for a path. This does not accept a complete URL. This function uses unquote() to decode path.
urllib.request.urlcleanup()  
Cleans up temporary files that may have been left behind by previous calls to urlretrieve().
class urllib.request.URLopener(proxies=None, **x509)  
 Deprecated since version 3.3.  Base class for opening and reading URLs. Unless you need to support opening objects using schemes other than http:, ftp:, or file:, you probably want to use FancyURLopener. By default, the URLopener class sends a User-Agent header of urllib/VVV, where VVV is the urllib version number. Applications can define their own User-Agent header by subclassing URLopener or FancyURLopener and setting the class attribute version to an appropriate string value in the subclass definition. The optional proxies parameter should be a dictionary mapping scheme names to proxy URLs, where an empty dictionary turns proxies off completely. Its default value is None, in which case environmental proxy settings will be used if present, as discussed in the definition of urlopen(), above. Additional keyword parameters, collected in x509, may be used for authentication of the client when using the https: scheme. The keywords key_file and cert_file are supported to provide an SSL key and certificate; both are needed to support client authentication. URLopener objects will raise an OSError exception if the server returns an error code.  
open(fullurl, data=None)  
Open fullurl using the appropriate protocol. This method sets up cache and proxy information, then calls the appropriate open method with its input arguments. If the scheme is not recognized, open_unknown() is called. The data argument has the same meaning as the data argument of urlopen(). This method always quotes fullurl using quote(). 
  
open_unknown(fullurl, data=None)  
Overridable interface to open unknown URL types. 
  
retrieve(url, filename=None, reporthook=None, data=None)  
Retrieves the contents of url and places it in filename. The return value is a tuple consisting of a local filename and either an email.message.Message object containing the response headers (for remote URLs) or None (for local URLs). The caller must then open and read the contents of filename. If filename is not given and the URL refers to a local file, the input filename is returned. If the URL is non-local and filename is not given, the filename is the output of tempfile.mktemp() with a suffix that matches the suffix of the last path component of the input URL. If reporthook is given, it must be a function accepting three numeric parameters: A chunk number, the maximum size chunks are read in and the total size of the download (-1 if unknown). It will be called once at the start and after each chunk of data is read from the network. reporthook is ignored for local URLs. If the url uses the http: scheme identifier, the optional data argument may be given to specify a POST request (normally the request type is GET). The data argument must in standard application/x-www-form-urlencoded format; see the urllib.parse.urlencode() function. 
  
version  
Variable that specifies the user agent of the opener object. To get urllib to tell servers that it is a particular user agent, set this in a subclass as a class variable or in the constructor before calling the base constructor.
open(fullurl, data=None)  
Open fullurl using the appropriate protocol. This method sets up cache and proxy information, then calls the appropriate open method with its input arguments. If the scheme is not recognized, open_unknown() is called. The data argument has the same meaning as the data argument of urlopen(). This method always quotes fullurl using quote().
open_unknown(fullurl, data=None)  
Overridable interface to open unknown URL types.
retrieve(url, filename=None, reporthook=None, data=None)  
Retrieves the contents of url and places it in filename. The return value is a tuple consisting of a local filename and either an email.message.Message object containing the response headers (for remote URLs) or None (for local URLs). The caller must then open and read the contents of filename. If filename is not given and the URL refers to a local file, the input filename is returned. If the URL is non-local and filename is not given, the filename is the output of tempfile.mktemp() with a suffix that matches the suffix of the last path component of the input URL. If reporthook is given, it must be a function accepting three numeric parameters: A chunk number, the maximum size chunks are read in and the total size of the download (-1 if unknown). It will be called once at the start and after each chunk of data is read from the network. reporthook is ignored for local URLs. If the url uses the http: scheme identifier, the optional data argument may be given to specify a POST request (normally the request type is GET). The data argument must in standard application/x-www-form-urlencoded format; see the urllib.parse.urlencode() function.
version  
Variable that specifies the user agent of the opener object. To get urllib to tell servers that it is a particular user agent, set this in a subclass as a class variable or in the constructor before calling the base constructor.
urllib.request.urlretrieve(url, filename=None, reporthook=None, data=None)  
Copy a network object denoted by a URL to a local file. If the URL points to a local file, the object will not be copied unless filename is supplied. Return a tuple (filename, headers) where filename is the local file name under which the object can be found, and headers is whatever the info() method of the object returned by urlopen() returned (for a remote object). Exceptions are the same as for urlopen(). The second argument, if present, specifies the file location to copy to (if absent, the location will be a tempfile with a generated name). The third argument, if present, is a callable that will be called once on establishment of the network connection and once after each block read thereafter. The callable will be passed three arguments; a count of blocks transferred so far, a block size in bytes, and the total size of the file. The third argument may be -1 on older FTP servers which do not return a file size in response to a retrieval request. The following example illustrates the most common usage scenario: >>> import urllib.request
>>> local_filename, headers = urllib.request.urlretrieve('http://python.org/')
>>> html = open(local_filename)
>>> html.close()
 If the url uses the http: scheme identifier, the optional data argument may be given to specify a POST request (normally the request type is GET). The data argument must be a bytes object in standard application/x-www-form-urlencoded format; see the urllib.parse.urlencode() function. urlretrieve() will raise ContentTooShortError when it detects that the amount of data available was less than the expected amount (which is the size reported by a Content-Length header). This can occur, for example, when the download is interrupted. The Content-Length is treated as a lower bound: if there’s more data to read, urlretrieve reads more data, but if less data is available, it raises the exception. You can still retrieve the downloaded data in this case, it is stored in the content attribute of the exception instance. If no Content-Length header was supplied, urlretrieve can not check the size of the data it has downloaded, and just returns it. In this case you just have to assume that the download was successful.
class urllib.response.addinfourl  
 
url  
URL of the resource retrieved, commonly used to determine if a redirect was followed. 
  
headers  
Returns the headers of the response in the form of an EmailMessage instance. 
  
status  
 New in version 3.9.  Status code returned by server. 
  
geturl()  
 Deprecated since version 3.9: Deprecated in favor of url.  
  
info()  
 Deprecated since version 3.9: Deprecated in favor of headers.  
  
code  
 Deprecated since version 3.9: Deprecated in favor of status.  
  
getstatus()  
 Deprecated since version 3.9: Deprecated in favor of status.
getstatus()  
 Deprecated since version 3.9: Deprecated in favor of status.
geturl()  
 Deprecated since version 3.9: Deprecated in favor of url.
info()  
 Deprecated since version 3.9: Deprecated in favor of headers.