doc_content
stringlengths
1
386k
doc_id
stringlengths
5
188
winreg.KEY_READ Combines the STANDARD_RIGHTS_READ, KEY_QUERY_VALUE, KEY_ENUMERATE_SUB_KEYS, and KEY_NOTIFY values.
python.library.winreg#winreg.KEY_READ
winreg.KEY_SET_VALUE Required to create, delete, or set a registry value.
python.library.winreg#winreg.KEY_SET_VALUE
winreg.KEY_WOW64_32KEY Indicates that an application on 64-bit Windows should operate on the 32-bit registry view.
python.library.winreg#winreg.KEY_WOW64_32KEY
winreg.KEY_WOW64_64KEY Indicates that an application on 64-bit Windows should operate on the 64-bit registry view.
python.library.winreg#winreg.KEY_WOW64_64KEY
winreg.KEY_WRITE Combines the STANDARD_RIGHTS_WRITE, KEY_SET_VALUE, and KEY_CREATE_SUB_KEY access rights.
python.library.winreg#winreg.KEY_WRITE
winreg.LoadKey(key, sub_key, file_name) Creates a subkey under the specified key and stores registration information from a specified file into that subkey. key is a handle returned by ConnectRegistry() or one of the constants HKEY_USERS or HKEY_LOCAL_MACHINE. sub_key is a string that identifies the subkey to load. f...
python.library.winreg#winreg.LoadKey
winreg.OpenKey(key, sub_key, reserved=0, access=KEY_READ) winreg.OpenKeyEx(key, sub_key, reserved=0, access=KEY_READ) Opens the specified key, returning a handle object. key is an already open key, or one of the predefined HKEY_* constants. sub_key is a string that identifies the sub_key to open. reserved is a rese...
python.library.winreg#winreg.OpenKey
winreg.OpenKey(key, sub_key, reserved=0, access=KEY_READ) winreg.OpenKeyEx(key, sub_key, reserved=0, access=KEY_READ) Opens the specified key, returning a handle object. key is an already open key, or one of the predefined HKEY_* constants. sub_key is a string that identifies the sub_key to open. reserved is a rese...
python.library.winreg#winreg.OpenKeyEx
PyHKEY.Close() Closes the underlying Windows handle. If the handle is already closed, no error is raised.
python.library.winreg#winreg.PyHKEY.Close
PyHKEY.Detach() Detaches the Windows handle from the handle object. The result is an integer that holds the value of the handle before it is detached. If the handle is already detached or closed, this will return zero. After calling this function, the handle is effectively invalidated, but the handle is not closed. Y...
python.library.winreg#winreg.PyHKEY.Detach
PyHKEY.__enter__() PyHKEY.__exit__(*exc_info) The HKEY object implements __enter__() and __exit__() and thus supports the context protocol for the with statement: with OpenKey(HKEY_LOCAL_MACHINE, "foo") as key: ... # work with key will automatically close key when control leaves the with block.
python.library.winreg#winreg.PyHKEY.__enter__
PyHKEY.__enter__() PyHKEY.__exit__(*exc_info) The HKEY object implements __enter__() and __exit__() and thus supports the context protocol for the with statement: with OpenKey(HKEY_LOCAL_MACHINE, "foo") as key: ... # work with key will automatically close key when control leaves the with block.
python.library.winreg#winreg.PyHKEY.__exit__
winreg.QueryInfoKey(key) Returns information about a key, as a tuple. key is an already open key, or one of the predefined HKEY_* constants. The result is a tuple of 3 items: Index Meaning 0 An integer giving the number of sub keys this key has. 1 An integer giving the number of values this key has. 2 An in...
python.library.winreg#winreg.QueryInfoKey
winreg.QueryReflectionKey(key) Determines the reflection state for the specified key. key is an already open key, or one of the predefined HKEY_* constants. Returns True if reflection is disabled. Will generally raise NotImplementedError if executed on a 32-bit operating system. Raises an auditing event winreg.QueryR...
python.library.winreg#winreg.QueryReflectionKey
winreg.QueryValue(key, sub_key) Retrieves the unnamed value for a key, as a string. key is an already open key, or one of the predefined HKEY_* constants. sub_key is a string that holds the name of the subkey with which the value is associated. If this parameter is None or empty, the function retrieves the value set ...
python.library.winreg#winreg.QueryValue
winreg.QueryValueEx(key, value_name) Retrieves the type and data for a specified value name associated with an open registry key. key is an already open key, or one of the predefined HKEY_* constants. value_name is a string indicating the value to query. The result is a tuple of 2 items: Index Meaning 0 The val...
python.library.winreg#winreg.QueryValueEx
winreg.REG_BINARY Binary data in any form.
python.library.winreg#winreg.REG_BINARY
winreg.REG_DWORD 32-bit number.
python.library.winreg#winreg.REG_DWORD
winreg.REG_DWORD_BIG_ENDIAN A 32-bit number in big-endian format.
python.library.winreg#winreg.REG_DWORD_BIG_ENDIAN
winreg.REG_DWORD_LITTLE_ENDIAN A 32-bit number in little-endian format. Equivalent to REG_DWORD.
python.library.winreg#winreg.REG_DWORD_LITTLE_ENDIAN
winreg.REG_EXPAND_SZ Null-terminated string containing references to environment variables (%PATH%).
python.library.winreg#winreg.REG_EXPAND_SZ
winreg.REG_FULL_RESOURCE_DESCRIPTOR A hardware setting.
python.library.winreg#winreg.REG_FULL_RESOURCE_DESCRIPTOR
winreg.REG_LINK A Unicode symbolic link.
python.library.winreg#winreg.REG_LINK
winreg.REG_MULTI_SZ A sequence of null-terminated strings, terminated by two null characters. (Python handles this termination automatically.)
python.library.winreg#winreg.REG_MULTI_SZ
winreg.REG_NONE No defined value type.
python.library.winreg#winreg.REG_NONE
winreg.REG_QWORD A 64-bit number. New in version 3.6.
python.library.winreg#winreg.REG_QWORD
winreg.REG_QWORD_LITTLE_ENDIAN A 64-bit number in little-endian format. Equivalent to REG_QWORD. New in version 3.6.
python.library.winreg#winreg.REG_QWORD_LITTLE_ENDIAN
winreg.REG_RESOURCE_LIST A device-driver resource list.
python.library.winreg#winreg.REG_RESOURCE_LIST
winreg.REG_RESOURCE_REQUIREMENTS_LIST A hardware resource list.
python.library.winreg#winreg.REG_RESOURCE_REQUIREMENTS_LIST
winreg.REG_SZ A null-terminated string.
python.library.winreg#winreg.REG_SZ
winreg.SaveKey(key, file_name) Saves the specified key, and all its subkeys to the specified file. key is an already open key, or one of the predefined HKEY_* constants. file_name is the name of the file to save registry data to. This file cannot already exist. If this filename includes an extension, it cannot be use...
python.library.winreg#winreg.SaveKey
winreg.SetValue(key, sub_key, type, value) Associates a value with a specified key. key is an already open key, or one of the predefined HKEY_* constants. sub_key is a string that names the subkey with which the value is associated. type is an integer that specifies the type of the data. Currently this must be REG_SZ...
python.library.winreg#winreg.SetValue
winreg.SetValueEx(key, value_name, reserved, type, value) Stores data in the value field of an open registry key. key is an already open key, or one of the predefined HKEY_* constants. value_name is a string that names the subkey with which the value is associated. reserved can be anything – zero is always passed to ...
python.library.winreg#winreg.SetValueEx
winsound — Sound-playing interface for Windows The winsound module provides access to the basic sound-playing machinery provided by Windows platforms. It includes functions and several constants. winsound.Beep(frequency, duration) Beep the PC’s speaker. The frequency parameter specifies frequency, in hertz, of the ...
python.library.winsound
winsound.Beep(frequency, duration) Beep the PC’s speaker. The frequency parameter specifies frequency, in hertz, of the sound, and must be in the range 37 through 32,767. The duration parameter specifies the number of milliseconds the sound should last. If the system is not able to beep the speaker, RuntimeError is r...
python.library.winsound#winsound.Beep
winsound.MB_ICONASTERISK Play the SystemDefault sound.
python.library.winsound#winsound.MB_ICONASTERISK
winsound.MB_ICONEXCLAMATION Play the SystemExclamation sound.
python.library.winsound#winsound.MB_ICONEXCLAMATION
winsound.MB_ICONHAND Play the SystemHand sound.
python.library.winsound#winsound.MB_ICONHAND
winsound.MB_ICONQUESTION Play the SystemQuestion sound.
python.library.winsound#winsound.MB_ICONQUESTION
winsound.MB_OK Play the SystemDefault sound.
python.library.winsound#winsound.MB_OK
winsound.MessageBeep(type=MB_OK) Call the underlying MessageBeep() function from the Platform API. This plays a sound as specified in the registry. The type argument specifies which sound to play; possible values are -1, MB_ICONASTERISK, MB_ICONEXCLAMATION, MB_ICONHAND, MB_ICONQUESTION, and MB_OK, all described below...
python.library.winsound#winsound.MessageBeep
winsound.PlaySound(sound, flags) Call the underlying PlaySound() function from the Platform API. The sound parameter may be a filename, a system sound alias, audio data as a bytes-like object, or None. Its interpretation depends on the value of flags, which can be a bitwise ORed combination of the constants described...
python.library.winsound#winsound.PlaySound
winsound.SND_ALIAS The sound parameter is a sound association name from the registry. If the registry contains no such name, play the system default sound unless SND_NODEFAULT is also specified. If no default sound is registered, raise RuntimeError. Do not use with SND_FILENAME. All Win32 systems support at least the...
python.library.winsound#winsound.SND_ALIAS
winsound.SND_ASYNC Return immediately, allowing sounds to play asynchronously.
python.library.winsound#winsound.SND_ASYNC
winsound.SND_FILENAME The sound parameter is the name of a WAV file. Do not use with SND_ALIAS.
python.library.winsound#winsound.SND_FILENAME
winsound.SND_LOOP Play the sound repeatedly. The SND_ASYNC flag must also be used to avoid blocking. Cannot be used with SND_MEMORY.
python.library.winsound#winsound.SND_LOOP
winsound.SND_MEMORY The sound parameter to PlaySound() is a memory image of a WAV file, as a bytes-like object. Note This module does not support playing from a memory image asynchronously, so a combination of this flag and SND_ASYNC will raise RuntimeError.
python.library.winsound#winsound.SND_MEMORY
winsound.SND_NODEFAULT If the specified sound cannot be found, do not play the system default sound.
python.library.winsound#winsound.SND_NODEFAULT
winsound.SND_NOSTOP Do not interrupt sounds currently playing.
python.library.winsound#winsound.SND_NOSTOP
winsound.SND_NOWAIT Return immediately if the sound driver is busy. Note This flag is not supported on modern Windows platforms.
python.library.winsound#winsound.SND_NOWAIT
winsound.SND_PURGE Stop playing all instances of the specified sound. Note This flag is not supported on modern Windows platforms.
python.library.winsound#winsound.SND_PURGE
wsgiref — WSGI Utilities and Reference Implementation The Web Server Gateway Interface (WSGI) is a standard interface between web server software and web applications written in Python. Having a standard interface makes it easy to use an application that supports WSGI with a number of different web servers. Only author...
python.library.wsgiref
class wsgiref.handlers.BaseCGIHandler(stdin, stdout, stderr, environ, multithread=True, multiprocess=False) Similar to CGIHandler, but instead of using the sys and os modules, the CGI environment and I/O streams are specified explicitly. The multithread and multiprocess values are used to set the wsgi.multithread and...
python.library.wsgiref#wsgiref.handlers.BaseCGIHandler
class wsgiref.handlers.BaseHandler This is an abstract base class for running WSGI applications. Each instance will handle a single HTTP request, although in principle you could create a subclass that was reusable for multiple requests. BaseHandler instances have only one method intended for external use: run(app) ...
python.library.wsgiref#wsgiref.handlers.BaseHandler
add_cgi_vars() Insert CGI variables for the current request into the environ attribute.
python.library.wsgiref#wsgiref.handlers.BaseHandler.add_cgi_vars
error_body The error response body. This should be an HTTP response body bytestring. It defaults to the plain text, “A server error occurred. Please contact the administrator.”
python.library.wsgiref#wsgiref.handlers.BaseHandler.error_body
error_headers The HTTP headers used for error responses. This should be a list of WSGI response headers ((name, value) tuples), as described in PEP 3333. The default list just sets the content type to text/plain.
python.library.wsgiref#wsgiref.handlers.BaseHandler.error_headers
error_output(environ, start_response) This method is a WSGI application to generate an error page for the user. It is only invoked if an error occurs before headers are sent to the client. This method can access the current error information using sys.exc_info(), and should pass that information to start_response whe...
python.library.wsgiref#wsgiref.handlers.BaseHandler.error_output
error_status The HTTP status used for error responses. This should be a status string as defined in PEP 3333; it defaults to a 500 code and message.
python.library.wsgiref#wsgiref.handlers.BaseHandler.error_status
get_scheme() Return the URL scheme being used for the current request. The default implementation uses the guess_scheme() function from wsgiref.util to guess whether the scheme should be “http” or “https”, based on the current request’s environ variables.
python.library.wsgiref#wsgiref.handlers.BaseHandler.get_scheme
get_stderr() Return an output stream object suitable for use as the wsgi.errors of the request currently being processed.
python.library.wsgiref#wsgiref.handlers.BaseHandler.get_stderr
get_stdin() Return an input stream object suitable for use as the wsgi.input of the request currently being processed.
python.library.wsgiref#wsgiref.handlers.BaseHandler.get_stdin
http_version If origin_server is true, this string attribute is used to set the HTTP version of the response set to the client. It defaults to "1.0".
python.library.wsgiref#wsgiref.handlers.BaseHandler.http_version
log_exception(exc_info) Log the exc_info tuple in the server log. exc_info is a (type, value, traceback) tuple. The default implementation simply writes the traceback to the request’s wsgi.errors stream and flushes it. Subclasses can override this method to change the format or retarget the output, mail the traceback...
python.library.wsgiref#wsgiref.handlers.BaseHandler.log_exception
origin_server This attribute should be set to a true value if the handler’s _write() and _flush() are being used to communicate directly to the client, rather than via a CGI-like gateway protocol that wants the HTTP status in a special Status: header. This attribute’s default value is true in BaseHandler, but false i...
python.library.wsgiref#wsgiref.handlers.BaseHandler.origin_server
os_environ The default environment variables to be included in every request’s WSGI environment. By default, this is a copy of os.environ at the time that wsgiref.handlers was imported, but subclasses can either create their own at the class or instance level. Note that the dictionary should be considered read-only, ...
python.library.wsgiref#wsgiref.handlers.BaseHandler.os_environ
run(app) Run the specified WSGI application, app.
python.library.wsgiref#wsgiref.handlers.BaseHandler.run
sendfile() Override to implement platform-specific file transmission. This method is called only if the application’s return value is an instance of the class specified by the wsgi_file_wrapper attribute. It should return a true value if it was able to successfully transmit the file, so that the default transmission ...
python.library.wsgiref#wsgiref.handlers.BaseHandler.sendfile
server_software If the origin_server attribute is set, this attribute’s value is used to set the default SERVER_SOFTWARE WSGI environment variable, and also to set a default Server: header in HTTP responses. It is ignored for handlers (such as BaseCGIHandler and CGIHandler) that are not HTTP origin servers. Changed ...
python.library.wsgiref#wsgiref.handlers.BaseHandler.server_software
setup_environ() Set the environ attribute to a fully-populated WSGI environment. The default implementation uses all of the above methods and attributes, plus the get_stdin(), get_stderr(), and add_cgi_vars() methods and the wsgi_file_wrapper attribute. It also inserts a SERVER_SOFTWARE key if not present, as long as...
python.library.wsgiref#wsgiref.handlers.BaseHandler.setup_environ
traceback_limit The maximum number of frames to include in tracebacks output by the default log_exception() method. If None, all frames are included.
python.library.wsgiref#wsgiref.handlers.BaseHandler.traceback_limit
wsgi_file_wrapper A wsgi.file_wrapper factory, or None. The default value of this attribute is the wsgiref.util.FileWrapper class.
python.library.wsgiref#wsgiref.handlers.BaseHandler.wsgi_file_wrapper
wsgi_multiprocess The value to be used for the wsgi.multiprocess environment variable. It defaults to true in BaseHandler, but may have a different default (or be set by the constructor) in the other subclasses.
python.library.wsgiref#wsgiref.handlers.BaseHandler.wsgi_multiprocess
wsgi_multithread The value to be used for the wsgi.multithread environment variable. It defaults to true in BaseHandler, but may have a different default (or be set by the constructor) in the other subclasses.
python.library.wsgiref#wsgiref.handlers.BaseHandler.wsgi_multithread
wsgi_run_once The value to be used for the wsgi.run_once environment variable. It defaults to false in BaseHandler, but CGIHandler sets it to true by default.
python.library.wsgiref#wsgiref.handlers.BaseHandler.wsgi_run_once
_flush() Force buffered data to be transmitted to the client. It’s okay if this method is a no-op (i.e., if _write() actually sends the data).
python.library.wsgiref#wsgiref.handlers.BaseHandler._flush
_write(data) Buffer the bytes data for transmission to the client. It’s okay if this method actually transmits the data; BaseHandler just separates write and flush operations for greater efficiency when the underlying system actually has such a distinction.
python.library.wsgiref#wsgiref.handlers.BaseHandler._write
class wsgiref.handlers.CGIHandler CGI-based invocation via sys.stdin, sys.stdout, sys.stderr and os.environ. This is useful when you have a WSGI application and want to run it as a CGI script. Simply invoke CGIHandler().run(app), where app is the WSGI application object you wish to invoke. This class is a subclass of...
python.library.wsgiref#wsgiref.handlers.CGIHandler
class wsgiref.handlers.IISCGIHandler A specialized alternative to CGIHandler, for use when deploying on Microsoft’s IIS web server, without having set the config allowPathInfo option (IIS>=7) or metabase allowPathInfoForScriptMappings (IIS<7). By default, IIS gives a PATH_INFO that duplicates the SCRIPT_NAME at the f...
python.library.wsgiref#wsgiref.handlers.IISCGIHandler
wsgiref.handlers.read_environ() Transcode CGI variables from os.environ to PEP 3333 “bytes in unicode” strings, returning a new dictionary. This function is used by CGIHandler and IISCGIHandler in place of directly using os.environ, which is not necessarily WSGI-compliant on all platforms and web servers using Python...
python.library.wsgiref#wsgiref.handlers.read_environ
class wsgiref.handlers.SimpleHandler(stdin, stdout, stderr, environ, multithread=True, multiprocess=False) Similar to BaseCGIHandler, but designed for use with HTTP origin servers. If you are writing an HTTP server implementation, you will probably want to subclass this instead of BaseCGIHandler. This class is a subc...
python.library.wsgiref#wsgiref.handlers.SimpleHandler
class wsgiref.headers.Headers([headers]) Create a mapping-like object wrapping headers, which must be a list of header name/value tuples as described in PEP 3333. The default value of headers is an empty list. Headers objects support typical mapping operations including __getitem__(), get(), __setitem__(), setdefault...
python.library.wsgiref#wsgiref.headers.Headers
add_header(name, value, **_params) Add a (possibly multi-valued) header, with optional MIME parameters specified via keyword arguments. name is the header field to add. Keyword arguments can be used to set MIME parameters for the header field. Each parameter must be a string or None. Underscores in parameter names ar...
python.library.wsgiref#wsgiref.headers.Headers.add_header
get_all(name) Return a list of all the values for the named header. The returned list will be sorted in the order they appeared in the original header list or were added to this instance, and may contain duplicates. Any fields deleted and re-inserted are always appended to the header list. If no fields exist with the...
python.library.wsgiref#wsgiref.headers.Headers.get_all
wsgiref.simple_server.demo_app(environ, start_response) This function is a small but complete WSGI application that returns a text page containing the message “Hello world!” and a list of the key/value pairs provided in the environ parameter. It’s useful for verifying that a WSGI server (such as wsgiref.simple_server...
python.library.wsgiref#wsgiref.simple_server.demo_app
wsgiref.simple_server.make_server(host, port, app, server_class=WSGIServer, handler_class=WSGIRequestHandler) Create a new WSGI server listening on host and port, accepting connections for app. The return value is an instance of the supplied server_class, and will process requests using the specified handler_class. a...
python.library.wsgiref#wsgiref.simple_server.make_server
class wsgiref.simple_server.WSGIRequestHandler(request, client_address, server) Create an HTTP handler for the given request (i.e. a socket), client_address (a (host,port) tuple), and server (WSGIServer instance). You do not need to create instances of this class directly; they are automatically created as needed by ...
python.library.wsgiref#wsgiref.simple_server.WSGIRequestHandler
get_environ() Returns a dictionary containing the WSGI environment for a request. The default implementation copies the contents of the WSGIServer object’s base_environ dictionary attribute and then adds various headers derived from the HTTP request. Each call to this method should return a new dictionary containing ...
python.library.wsgiref#wsgiref.simple_server.WSGIRequestHandler.get_environ
get_stderr() Return the object that should be used as the wsgi.errors stream. The default implementation just returns sys.stderr.
python.library.wsgiref#wsgiref.simple_server.WSGIRequestHandler.get_stderr
handle() Process the HTTP request. The default implementation creates a handler instance using a wsgiref.handlers class to implement the actual WSGI application interface.
python.library.wsgiref#wsgiref.simple_server.WSGIRequestHandler.handle
class wsgiref.simple_server.WSGIServer(server_address, RequestHandlerClass) Create a WSGIServer instance. server_address should be a (host,port) tuple, and RequestHandlerClass should be the subclass of http.server.BaseHTTPRequestHandler that will be used to process requests. You do not normally need to call this cons...
python.library.wsgiref#wsgiref.simple_server.WSGIServer
get_app() Returns the currently-set application callable.
python.library.wsgiref#wsgiref.simple_server.WSGIServer.get_app
set_app(application) Sets the callable application as the WSGI application that will receive requests.
python.library.wsgiref#wsgiref.simple_server.WSGIServer.set_app
wsgiref.util.application_uri(environ) Similar to request_uri(), except that the PATH_INFO and QUERY_STRING variables are ignored. The result is the base URI of the application object addressed by the request.
python.library.wsgiref#wsgiref.util.application_uri
class wsgiref.util.FileWrapper(filelike, blksize=8192) A wrapper to convert a file-like object to an iterator. The resulting objects support both __getitem__() and __iter__() iteration styles, for compatibility with Python 2.1 and Jython. As the object is iterated over, the optional blksize parameter will be repeated...
python.library.wsgiref#wsgiref.util.FileWrapper
wsgiref.util.guess_scheme(environ) Return a guess for whether wsgi.url_scheme should be “http” or “https”, by checking for a HTTPS environment variable in the environ dictionary. The return value is a string. This function is useful when creating a gateway that wraps CGI or a CGI-like protocol such as FastCGI. Typica...
python.library.wsgiref#wsgiref.util.guess_scheme
wsgiref.util.is_hop_by_hop(header_name) Return True if ‘header_name’ is an HTTP/1.1 “Hop-by-Hop” header, as defined by RFC 2616.
python.library.wsgiref#wsgiref.util.is_hop_by_hop
wsgiref.util.request_uri(environ, include_query=True) Return the full request URI, optionally including the query string, using the algorithm found in the “URL Reconstruction” section of PEP 3333. If include_query is false, the query string is not included in the resulting URI.
python.library.wsgiref#wsgiref.util.request_uri
wsgiref.util.setup_testing_defaults(environ) Update environ with trivial defaults for testing purposes. This routine adds various parameters required for WSGI, including HTTP_HOST, SERVER_NAME, SERVER_PORT, REQUEST_METHOD, SCRIPT_NAME, PATH_INFO, and all of the PEP 3333-defined wsgi.* variables. It only supplies defa...
python.library.wsgiref#wsgiref.util.setup_testing_defaults
wsgiref.util.shift_path_info(environ) Shift a single name from PATH_INFO to SCRIPT_NAME and return the name. The environ dictionary is modified in-place; use a copy if you need to keep the original PATH_INFO or SCRIPT_NAME intact. If there are no remaining path segments in PATH_INFO, None is returned. Typically, this...
python.library.wsgiref#wsgiref.util.shift_path_info