Python 3.14.0

https://docs.python.org/3.14
Admin
Python 3.14.0 is a stable release of the Python programming language, with official documentation...
Tokens:4,344,440
Snippets:34,204
Trust Score:10
Update:4 days ago
Show doc for...
Tokens:
Raw
### Display command example setup

Source: https://docs.python.org/3.14/library/pdb.html

Initial code setup to demonstrate the display command behavior with mutable objects.

```python
lst = []
breakpoint()
pass
lst.append(1)
print(lst)
```

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

### Create and run an HTTPServer

Source: https://docs.python.org/3.14/library/http.server.html

This example demonstrates the basic setup to create and start an HTTP server using the HTTPServer class.

```python
def run(server_class=HTTPServer, handler_class=BaseHTTPRequestHandler):
    server_address = ('', 8000)
    httpd = server_class(server_address, handler_class)
    httpd.serve_forever()
```

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

### Install Python on OpenBSD (i386 example)

Source: https://docs.python.org/3.14/using/unix.html

Example command for installing a specific version of Python on OpenBSD i386 architecture.

```bash
pkg_add ftp://ftp.openbsd.org/pub/OpenBSD/4.2/packages/i386/python-2.5.1p2.tgz
```

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

### Setup virtual environment and install package

Source: https://docs.python.org/3.14/library/importlib.metadata.html

Create a virtual environment and install the 'wheel' package using pip.

```bash
$ python -m venv example
$ source example/bin/activate
(example) $ python -m pip install wheel
```

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

### Basic argparse setup

Source: https://docs.python.org/3.14/howto/argparse.html

A minimal example showing the initialization of an ArgumentParser and the automatic help message generation.

```python
import argparse
parser = argparse.ArgumentParser()
parser.parse_args()
```

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

### py list --online example

Source: https://docs.python.org/3.14/using/windows.html

Example of listing online runtimes matching tag 3.14. The result matches what py install <TAG> would install.

```bash
$> py list --online 3.14

```

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

### Logging start command in start.py

Source: https://docs.python.org/3.14/howto/logging-cookbook.html

Example of using the logging module to record debug and info level events during a start command.

```python
# start.py
import logging

logger = logging.getLogger(__name__)

def command(options):
    logger.debug('About to start %s', options.name)
    # actually do the command processing here ...
    logger.info('Started the \'%s\' service.', options.name)
```

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

### Example: GET request

Source: https://docs.python.org/3.14/library/http.client.html

Example session using the GET method with http.client.HTTPSConnection.

```APIDOC
## Example: GET request

### Description
Example session using the GET method with http.client.HTTPSConnection.

### Code
```python
import http.client
conn = http.client.HTTPSConnection("www.python.org")
conn.request("GET", "/")
r1 = conn.getresponse()
print(r1.status, r1.reason)
# 200 OK
data1 = r1.read()  # This will return entire content.
# The following example demonstrates reading data in chunks.
conn.request("GET", "/")
r1 = conn.getresponse()
while chunk := r1.read(200):
    print(repr(chunk))
# b'<!doctype html>\n<!--[if"...
# Example of an invalid request
conn = http.client.HTTPSConnection("docs.python.org")
conn.request("GET", "/parrot.spam")
r2 = conn.getresponse()
print(r2.status, r2.reason)
# 404 Not Found
data2 = r2.read()
conn.close()
```
```

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

### Start a manager server with get_server()

Source: https://docs.python.org/3.14/library/multiprocessing.html

Demonstrates how to initialize a BaseManager and start a server that listens for connections.

```python
>>> from multiprocessing.managers import BaseManager
>>> manager = BaseManager(address=('', 50000), authkey=b'abc')
>>> server = manager.get_server()
>>> server.serve_forever()
```

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

### Get distribution version with version('wheel')

Source: https://docs.python.org/3.14/library/importlib.metadata.html

Use importlib.metadata.version() to get the installed distribution package version as a string. Raises PackageNotFoundError if the package is not installed.

```python
>>> version('wheel')
'0.32.3'
```

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

### Start a server with serve_forever

Source: https://docs.python.org/3.14/library/asyncio-eventloop.html

Demonstrates how to start a server using asyncio.start_server and maintain it with serve_forever.

```python
async def client_connected(reader, writer):
    # Communicate with the client with
    # reader/writer streams.  For example:
    await reader.readline()

async def main(host, port):
    srv = await asyncio.start_server(
        client_connected, host, port)
    await srv.serve_forever()

asyncio.run(main('127.0.0.1', 0))
```

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

### Unattended installation configuration file

Source: https://docs.python.org/3.14/using/windows.html

An example unattend.xml file that configures installation options for the Python installer.

```xml
<Options>
    <Option Name="InstallAllUsers" Value="no" />
    <Option Name="Include_launcher" Value="0" />
    <Option Name="Include_test" Value="no" />
    <Option Name="SimpleInstall" Value="yes" />
    <Option Name="SimpleInstallDescription">Just for me, no test suite</Option>
</Options>
```

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

### setup.py for building the extension

Source: https://docs.python.org/3.14/extending/newtypes_tutorial.html

Uses setuptools Extension and setup to compile the custom.c file into the 'custom' extension module.

```Python
from setuptools import Extension, setup
setup(ext_modules=[Extension("custom", ["custom.c"])])
```

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

### IsolatedAsyncioTestCase execution order example

Source: https://docs.python.org/3.14/library/unittest.html

An example illustrating the execution order of setup, teardown, and cleanup methods within an IsolatedAsyncioTestCase.

```python
from unittest import IsolatedAsyncioTestCase

events = []


class Test(IsolatedAsyncioTestCase):


    def setUp(self):
        events.append("setUp")

    async def asyncSetUp(self):
        self._async_connection = await AsyncConnection()
        events.append("asyncSetUp")

    async def test_response(self):
        events.append("test_response")
        response = await self._async_connection.get("https://example.com")
        self.assertEqual(response.status_code, 200)
        self.addAsyncCleanup(self.on_cleanup)

    def tearDown(self):
        events.append("tearDown")

    async def asyncTearDown(self):
        await self._async_connection.close()
        events.append("asyncTearDown")

    async def on_cleanup(self):
        events.append("cleanup")

if __name__ == "__main__":
    unittest.main()
```

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

### turtle.setup(width=CFG['width'], height=CFG['height'], startx=CFG['leftright'], starty=CFG['topbottom'])

Source: https://docs.python.org/3.14/library/turtle.html

Sets the size and position of the main window. Default values are stored in the configuration dictionary and can be changed via a turtle.cfg file.

```APIDOC
## turtle.setup(width=CFG['width'], height=CFG['height'], startx=CFG['leftright'], starty=CFG['topbottom'])

### Description
Set the size and position of the main window. Default values of arguments are stored in the configuration dictionary and can be changed via a `turtle.cfg` file.

### Method
Function call

### Endpoint
turtle.setup(width=CFG['width'], height=CFG['height'], startx=CFG['leftright'], starty=CFG['topbottom'])

### Parameters
#### Path Parameters
- **width** (int or float) - Optional - If an integer, a size in pixels; if a float, a fraction of the screen; default is 50% of screen
- **height** (int or float) - Optional - If an integer, the height in pixels; if a float, a fraction of the screen; default is 75% of screen
- **startx** (int or None) - Optional - If positive, starting position in pixels from the left edge of the screen; if negative from the right edge; if None, center window horizontally
- **starty** (int or None) - Optional - If positive, starting position in pixels from the top edge of the screen; if negative from the bottom edge; if None, center window vertically

### Request Example
```
>>> screen.setup (width=200, height=200, startx=0, starty=0)
>>>              # sets window to 200x200 pixels, in upper left of screen
>>> screen.setup(width=.75, height=0.5, startx=None, starty=None)
>>>              # sets window to 75% of screen by 50% of screen and centers
```

### Response
No return value.
```

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

### Creating a Custom instance

Source: https://docs.python.org/3.14/extending/newtypes_tutorial.html

Shows how to import the custom module and create a Custom instance after installation.

```Python
>>> import custom
>>> mycustom = custom.Custom()
```

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

### setup_scripts(_context_)

Source: https://docs.python.org/3.14/library/venv.html

Installs activation scripts appropriate to the platform into the virtual environment. This method is part of the EnvBuilder class.

```APIDOC
## setup_scripts(_context_)

### Description
Installs activation scripts appropriate to the platform into the virtual environment.

### Method
setup_scripts

### Parameters
- **_context_** (object) - Required - The context object for the virtual environment creation.

```

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

### Perform a GET request with HTTPSConnection

Source: https://docs.python.org/3.14/library/http.client.html

Example of performing a GET request to a host using HTTPSConnection and printing the response status and reason.

```python
>>> import http.client
>>> host = "docs.python.org"
>>> conn = http.client.HTTPSConnection(host)
>>> conn.request("GET", "/3/", headers={"Host": host})
>>> response = conn.getresponse()
>>> print(response.status, response.reason)
200 OK
```

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

### Get package version

Source: https://docs.python.org/3.14/library/importlib.metadata.html

Retrieve the version string for an installed package.

```python
(example) $ python
>>> from importlib.metadata import version
>>> version('wheel')
'0.32.3'
```

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

### post_setup(_context_)

Source: https://docs.python.org/3.14/library/venv.html

A placeholder method which can be overridden in third party implementations to pre-install packages in the virtual environment or perform other post-creation steps.

```APIDOC
## post_setup(_context_)

### Description
A placeholder method which can be overridden in third party implementations to pre-install packages in the virtual environment or perform other post-creation steps.

### Method
post_setup

### Parameters
- **_context_** (object) - Required - The context object for the virtual environment creation.

```

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

### Example foo.pth configuration file

Source: https://docs.python.org/3.14/library/site.html

A path configuration file containing package names to be added to sys.path.

```text
# foo package configuration

foo
bar
bletch
```

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

### Setting the first weekday

Source: https://docs.python.org/3.14/library/calendar.html

Example of using setfirstweekday to configure the calendar to start on Sunday.

```python
import calendar
calendar.setfirstweekday(calendar.SUNDAY)
```

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

### Implement setUp for repetitive test initialization

Source: https://docs.python.org/3.14/library/unittest.html

Use the setUp method to factor out common initialization code that runs before every test method.

```python
import unittest

class WidgetTestCase(unittest.TestCase):
    def setUp(self):
        self.widget = Widget('The widget')

    def test_default_widget_size(self):
        self.assertEqual(self.widget.size(), (50,50),
                         'incorrect default size')

    def test_widget_resize(self):
        self.widget.resize(100,150)
        self.assertEqual(self.widget.size(), (100,150),
                         'wrong size after resize')
```

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

### PyUnicodeDecodeError_GetStart / PyUnicodeEncodeError_GetStart / PyUnicodeTranslateError_GetStart

Source: https://docs.python.org/3.14/c-api/exceptions.html

Get the start attribute of the given Unicode exception object.

```APIDOC
## PyUnicodeDecodeError_GetStart / PyUnicodeEncodeError_GetStart / PyUnicodeTranslateError_GetStart

### Description
Gets the start attribute of the given exception object and places it into *start. If the UnicodeError.object is an empty sequence, the resulting start is 0. Otherwise, it is clipped to [0, len(object) - 1].

### Signatures
int PyUnicodeDecodeError_GetStart(PyObject *exc, Py_ssize_t *start)
int PyUnicodeEncodeError_GetStart(PyObject *exc, Py_ssize_t *start)
int PyUnicodeTranslateError_GetStart(PyObject *exc, Py_ssize_t *start)

### Parameters
- **exc** (PyObject *) - Required - The exception object.
- **start** (Py_ssize_t *) - Required - Pointer to a variable where the start value will be stored. Must not be NULL.

### Return Value
Returns 0 on success, -1 on failure.

### Notes
Part of the Stable ABI.
```

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

### Configure static module with libraries in Modules/Setup.local

Source: https://docs.python.org/3.14/extending/extending.html

Include additional libraries by appending them to the module definition line in the configuration file.

```text
spam spammodule.o -lX11
```

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

### ThreadPoolExecutor URL fetching setup

Source: https://docs.python.org/3.14/library/concurrent.futures.html

Initializes a list of URLs for use with a ThreadPoolExecutor example.

```python
import concurrent.futures
import urllib.request

URLS = ['http://www.foxnews.com/',
        'http://www.cnn.com/',
        'http://europe.wsj.com/',
        'http://www.bbc.co.uk/',
        'http://nonexistent-subdomain.python.org/']
```

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

### Execute file as top-level

Source: https://docs.python.org/3.14/library/__main__.html

Example of running a Python file as the top-level entry point.

```bash
$ python helloworld.py
Hello, world!
```

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

### Timer object usage

Source: https://docs.python.org/3.14/library/threading.html

Example of creating and starting a Timer that executes a function after a 30-second interval.

```python
def hello():
    print("hello, world")

t = Timer(30.0, hello)
t.start()  # after 30 seconds, "hello, world" will be printed
```

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

### Indentation Independence in Doctest

Source: https://docs.python.org/3.14/library/doctest.html

Demonstrates that doctest ignores leading whitespace in the starting column of the example.

```python
>>> assert "Easy!"
      >>> import math
          >>> math.floor(1.9)
          1
```

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

### Example start.py script

Source: https://docs.python.org/3.14/library/__main__.html

A sample script demonstrating the use of the __main__ block to prevent execution during imports.

```python
import sys

from namely import print_user_name

# my_name = "Dinsdale"

def main():
    try:
        print_user_name()
    except ValueError as ve:
        return str(ve)

if __name__ == "__main__":
    sys.exit(main())
```

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

### Get numeric value of a character

Source: https://docs.python.org/3.14/howto/unicode.html

Example of using unicodedata.numeric to retrieve the numeric value of a character.

```python
print(unicodedata.numeric(u[1]))
```

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

### Cmd.cmdloop(intro=None)

Source: https://docs.python.org/3.14/library/cmd.html

Repeatedly issue a prompt, accept input, parse an initial prefix, and dispatch to action methods. The optional intro argument overrides the intro class attribute.

```APIDOC
## Cmd.cmdloop(intro=None)

### Description
Repeatedly issue a prompt, accept input, parse an initial prefix off the received input, and dispatch to action methods, passing them the remainder of the line as argument. The optional argument is a banner or intro string to be issued before the first prompt (this overrides the intro class attribute).

### Method
cmdloop

### Parameters
- **intro** (string) - Optional - Banner or intro string to be issued before the first prompt.

### Behavior
- If the readline module is loaded, input will automatically inherit bash-like history-list editing.
- An end-of-file on input is passed back as the string 'EOF'.
- An interpreter instance will recognize a command name foo if and only if it has a method do_foo().
- A line beginning with '?' is dispatched to do_help().
- A line beginning with '!' is dispatched to do_shell() (if defined).
- This method will return when the postcmd() method returns a true value.
- If completion is enabled, completing commands is done automatically, and completing command args is done by calling complete_foo() with arguments text, line, begidx, and endidx.
```

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

### Create a SimpleXMLRPCServer

Source: https://docs.python.org/3.14/library/xmlrpc.server.html

Demonstrates setting up a server with a custom request handler, registering functions and instances, and starting the server loop.

```python
# Restrict to a particular path.
class RequestHandler(SimpleXMLRPCRequestHandler):
    rpc_paths = ('/RPC2',)

# Create server
with SimpleXMLRPCServer(('localhost', 8000),
                        requestHandler=RequestHandler) as server:
    server.register_introspection_functions()

    # Register pow() function; this will use the value of
    # pow.__name__ as the name, which is just 'pow'.
    server.register_function(pow)

    # Register a function under a different name
    def adder_function(x, y):
        return x + y
    server.register_function(adder_function, 'add')

    # Register an instance; all the methods of the instance are
    # published as XML-RPC methods (in this case, just 'mul').
    class MyFuncs:
        def mul(self, x, y):
            return x * y

    server.register_instance(MyFuncs())

    # Run the server's main loop
    server.serve_forever()
```

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

### Interactive Mode Welcome Message

Source: https://docs.python.org/3.14/tutorial/interpreter.html

Example of the output displayed when starting the Python interpreter in interactive mode.

```text
$ python3.14
Python 3.14 (default, April 4 2024, 09:25:04)
[GCC 10.2.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>>
```

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

### readline.set_completer_delims / readline.get_completer_delims

Source: https://docs.python.org/3.14/library/readline.html

Set or get the word delimiters for completion. These determine the start of the word to be considered for completion.

```APIDOC
## readline.set_completer_delims(string)

### Description
Set the word delimiters for completion.

### Parameters
- **string** (str) - The new word delimiters.

### Returns
None

## readline.get_completer_delims()

### Description
Get the word delimiters for completion.

### Returns
- **delims** (str) - The current word delimiters.
```

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

### Convert datetime to ctime string

Source: https://docs.python.org/3.14/library/datetime.html

Example of using ctime() to get a string representation of the datetime object.

```python
>>> import datetime as dt
>>> dt.datetime(2002, 12, 4, 20, 30, 40).ctime()
'Wed Dec  4 20:30:40 2002'
```

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

### Simple format string examples

Source: https://docs.python.org/3.14/library/string.html

Examples demonstrating positional arguments, implicit indexing, keyword arguments, attribute access, and index lookups.

```python
"First, thou shalt count to {0}"  # References first positional argument
"Bring me a {}"                   # Implicitly references the first positional argument
"From {} to {}"                   # Same as "From {0} to {1}"
"My quest is {name}"              # References keyword argument 'name'
"Weight in tons {0.weight}"       # 'weight' attribute of first positional arg
"Units destroyed: {players[0]}"   # First element of keyword argument 'players'.
```

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

### Access command help

Source: https://docs.python.org/3.14/using/windows.html

Examples of using the py help command and the /? option to display documentation for commands.

```text
$> py help
$> py help install
$> py install /?
```

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

### Get HTTP headers

Source: https://docs.python.org/3.14/library/asyncio-stream.html

Simple example querying HTTP headers of the URL passed on the command line.

```APIDOC
## Get HTTP headers

### Description
Simple example querying HTTP headers of the URL passed on the command line.

### Code
```python
import asyncio
import urllib.parse
import sys

async def print_http_headers(url):
    url = urllib.parse.urlsplit(url)
    if url.scheme == 'https':
        reader, writer = await asyncio.open_connection(
            url.hostname, 443, ssl=True)
    else:
        reader, writer = await asyncio.open_connection(
            url.hostname, 80)

    query = (
        f"HEAD {url.path or '/'} HTTP/1.0\r\n"
        f"Host: {url.hostname}\r\n"
        f"\r\n"
    )

    writer.write(query.encode('latin-1'))
    while True:
        line = await reader.readline()
        if not line:
            break

        line = line.decode('latin1').rstrip()
        if line:
            print(f'HTTP header> {line}')

    # Ignore the body, close the socket
    writer.close()
    await writer.wait_closed()

url = sys.argv[1]
asyncio.run(print_http_headers(url))
```

### Usage
```
python example.py http://example.com/path/page.html
```

or with HTTPS:
```
python example.py https://example.com/path/page.html
```
```

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

### Client for ExampleService with MultiCall

Source: https://docs.python.org/3.14/library/xmlrpc.server.html

Client code demonstrating how to interact with the ExampleService server and use MultiCall.

```python
server = ServerProxy("http://localhost:8000")

try:
    print(server.currentTime.getCurrentTime())
except Error as v:
    print("ERROR", v)

multi = MultiCall(server)
multi.getData()
multi.pow(2,9)
multi.add(1,2)
try:
    for response in multi():
        print(response)
except Error as v:
    print("ERROR", v)
```

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

### Py_Main equivalent configuration

Source: https://docs.python.org/3.14/c-api/interp-lifecycle.html

This code demonstrates the approximate equivalent configuration steps performed by Py_Main to initialize and run the interpreter.

```c
PyConfig config;
PyConfig_InitPythonConfig(&config);
PyConfig_SetArgv(&config, argc, argv);
Py_InitializeFromConfig(&config);
PyConfig_Clear(&config);

Py_RunMain();
```

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

### Raw socket network sniffer on Windows

Source: https://docs.python.org/3.14/library/socket.html

Starts a raw socket sniffer example for Windows. The code is incomplete in the source; it only imports the socket module. The full example requires administrator privileges to modify the network interface.

```python
import socket
```

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

### Initial C module file setup

Source: https://docs.python.org/3.14/extending/extending.html

The required initial lines for a C extension module, including the necessary Python header.

```c
#define PY_SSIZE_T_CLEAN
#include <Python.h>
```

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

### Generate sequences with range()

Source: https://docs.python.org/3.14/tutorial/controlflow.html

Examples of using range() with start, stop, and step arguments to generate specific arithmetic progressions.

```python
>>> list(range(5, 10))
[5, 6, 7, 8, 9]

>>> list(range(0, 10, 3))
[0, 3, 6, 9]

>>> list(range(-10, -100, -30))
[-10, -40, -70]
```

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

### test.support.import_helper.modules_setup

Source: https://docs.python.org/3.14/library/test.html

Returns a copy of sys.modules.

```APIDOC
## test.support.import_helper.modules_setup()

### Description
Return a copy of sys.modules.

### Returns
A copy of sys.modules.
```

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

### Setup testing defaults for WSGI

Source: https://docs.python.org/3.14/library/wsgiref.html

Example usage of setup_testing_defaults to populate a WSGI environment with dummy values for testing purposes.

```python
from wsgiref.util import setup_testing_defaults
from wsgiref.simple_server import make_server
```

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

### Managing patches with start and stop

Source: https://docs.python.org/3.14/library/unittest.mock-examples.html

Uses patcher.start() and patcher.stop() within setUp and tearDown methods to manage patches manually.

```python
>>> class MyTest(unittest.TestCase):
...     def setUp(self):
...         self.patcher = patch('mymodule.foo')
...         self.mock_foo = self.patcher.start()
...
...     def test_foo(self):
...         self.assertIs(mymodule.foo, self.mock_foo)
...
...     def tearDown(self):
...         self.patcher.stop()
...
>>> MyTest('test_foo').run()
```

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

### Build Python from source

Source: https://docs.python.org/3.14/using/unix.html

Standard commands to configure, build, and install Python from source code.

```bash
./configure
make
make install
```

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

### Server.start_serving()

Source: https://docs.python.org/3.14/library/asyncio-eventloop.html

Starts accepting connections. This method is idempotent and can be called when the server is already serving.

```APIDOC
## Server.start_serving()

### Description
Starts accepting connections. This method is idempotent, so it can be called when the server is already serving.

### Returns
Coroutine (async)

### Availability
Added in version 3.7.
```

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

### Basic urlsplit() example with attributes

Source: https://docs.python.org/3.14/library/urllib.parse.html

Shows how to parse a URL into a SplitResult and access its components. The example uses a URL with a port and query string, and demonstrates accessing scheme, netloc, hostname, port, and using _replace() to get a new URL.

```python
>>> from urllib.parse import urlsplit
>>> urlsplit("scheme://netloc/path?query#fragment")
SplitResult(scheme='scheme', netloc='netloc', path='/path',
            query='query', fragment='fragment')
>>> o = urlsplit("http://docs.python.org:80/3/library/urllib.parse.html?"
...              "highlight=params#url-parsing")
>>> o
SplitResult(scheme='http', netloc='docs.python.org:80',
            path='/3/library/urllib.parse.html',
            query='highlight=params', fragment='url-parsing')
>>> o.scheme
'http'
>>> o.netloc
'docs.python.org:80'
>>> o.hostname
'docs.python.org'
>>> o.port
80
>>> o._replace(fragment="").geturl()
'http://docs.python.org:80/3/library/urllib.parse.html?highlight=params'
```
Tokens:
Raw