Python Reference

https://speedsheet.io/s/python
Admin
This project provides a comprehensive collection of Python code examples and explanations, covering...
Tokens:126,233
Snippets:2,404
Trust Score:6
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install a Package

Source: https://speedsheet.io/s/python

Installs a package by its name. You can specify a version or a version range.

```bash
pip install package_name
```

```bash
pip install package_name==1.2.3
```

```bash
pip install package_name>=1.2.3
```

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

### Install Package from Wheel File

Source: https://speedsheet.io/s/python?q=pip-only

Installs a package from a local wheel (.whl) file.

```bash
pip install package_name.whl
```

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

### Create and Start a Basic Process

Source: https://speedsheet.io/s/python?q=process-only

Demonstrates how to create a basic process with a target function and arguments, start its execution, and wait for it to complete.

```python
from processing import Process

# Assuming worker_function and worker_argument_1 are defined elsewhere
process_1 = Process( target = worker_function, args = (worker_argument_1,)
process_1.start()
process_1.join()
```

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

### List All Installed Packages

Source: https://speedsheet.io/s/python?q=pip-only

Lists all packages currently installed in the environment along with their versions.

```bash
pip list
```

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

### Install a Specific Package

Source: https://speedsheet.io/s/python?q=pip-only

Installs a package by its name. You can also specify a version.

```bash
pip install package_name
```

```bash
pip install package_name==1.2.3
```

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

### Install Packages from Requirements File

Source: https://speedsheet.io/s/python?q=pip-only

Installs all packages listed in a requirements.txt file. This is useful for setting up project dependencies.

```bash
pip install -r requirements.txt
```

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

### Egg Distribution - Starting Module

Source: https://speedsheet.io/s/python?q=distribution

The __main__.py file serves as the entry point for an egg distribution. Python executes this module when the egg is started.

```python
__main__.py

```

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

### Example of Getting Function Name

Source: https://speedsheet.io/s/python?q=functions-only

Demonstrates how to access and store the name of a function.

```python
def function_1():
    return "This is a function."

function_name = function_1.__name__
```

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

### Install Package Using Proxy

Source: https://speedsheet.io/s/python?q=pip-only

Installs a package while using a proxy server. Supports basic and authenticated proxy configurations.

```bash
pip install package_name --proxy="proxyserver.com
```

```bash
pip install package_name --proxy="https://user:password@proxyserver.com
```

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

### Get Match Start Position

Source: https://speedsheet.io/s/python?q=regex-only

The `.start()` method on a match object returns the starting index of the matched substring within the original string.

```python
# Assuming 'match' is a valid re.Match object
start_index = match.start()
```

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

### Install Black Code Formatter

Source: https://speedsheet.io/s/python_tools

Use this command to install the Black code formatter.

```bash
pip install black
```

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

### Create and Start a Basic Thread

Source: https://speedsheet.io/s/python?q=thread-only

Use this to create and start a thread that executes a specified function. Ensure the target function and its arguments are correctly defined. Call `.join()` to wait for its completion.

```python
from threading import Thread

# Define the worker function and its arguments
def worker_function(worker_argument_1):
    pass # Your code here

# Create the thread
thread_1 = Thread(target=worker_function, args=(worker_argument_1,))

# Start the thread
thread_1.start()

# Wait for the thread to complete
thread_1.join()
```

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

### Basic Argparse Setup

Source: https://speedsheet.io/s/python?q=argparse-only

Initializes an ArgumentParser with a description. Use this for standard command-line argument parsing.

```python
from argparse import ArgumentParser

parser = ArgumentParser(description = 'description')
```

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

### Get Python Home Directory

Source: https://speedsheet.io/s/python?q=how-to

Obtain the path to the Python installation directory using `sys.prefix`.

```python
from sys import prefix
python_home_directory = prefix
```

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

### Call a Function with Named Arguments (Example)

Source: https://speedsheet.io/s/python?q=functions-only

Provides an example of calling a function using named arguments, emphasizing that order does not matter.

```python
def greet(greeting, name):
    print(greeting, name)

# Call:
greet(name = 'John', greeting = 'Hi')
```

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

### Get Starting Module Name

Source: https://speedsheet.io/s/python?q=how-to

Retrieve the name of the script that initiated the program's execution using `sys.argv[0]`.

```python
from sys import argv
module_name = argv[0]
```

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

### Start Main Coroutine with run()

Source: https://speedsheet.io/s/python?q=asyncio-only

A typical way to start your asyncio application by running the main coroutine on the event loop.

```python
from asyncio import run

async def main():
    ...

run(main())
```

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

### Create Requirements File

Source: https://speedsheet.io/s/python?q=pip-only

Generates a requirements.txt file listing all packages installed in the current environment.

```bash
pip freeze > requirements.txt
```

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

### Python f-string - Formatting Options Example

Source: https://speedsheet.io/s/python

Provides an example of left alignment and comma separation for integers using f-strings.

```python
string_1 = "On the left!"
Padded = f"{string_1:<20}"
int_1 = 12345
comma_separated = f"{int_1:,d}"
```

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

### Python Match - List Matching Example

Source: https://speedsheet.io/s/python?q=match-only

Demonstrates matching a list based on its contents and structure. This example shows matching a list with specific values.

```python
list_1 =[1, 3]
match list_1:
    case [1]:
        print ('Value [1]')
    case [1, 2]:
        print ('Value [1, 2]')
    case [1, 3]:
        print ('Value [1, 3]')
    case _:
        print ('Unmatched Value')
# Prints: Value [1, 3]'
```

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

### Argparse - Optional Argument Example

Source: https://speedsheet.io/s/python?q=argparse-only

Example of optional arguments. Parses a value for '--id' and shows that '--name' is None as it was not provided.

```python
from argparse import ArgumentParser

parser = ArgumentParser()
parser.add_argument('-n', '--name')
parser.add_argument('-i', '--id')
arguments = parser.parse_args(['-i', '42'])
print(arguments.name, arguments.id) # Prints: None 42
```

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

### Argparse - Flag Parameter Example

Source: https://speedsheet.io/s/python?q=argparse-only

Example demonstrating how to use boolean flags. Prints True for present flags and False for absent ones.

```python
from argparse import ArgumentParser

parser = ArgumentParser()
parser.add_argument('-d', '--debug', action = 'store_true')
parser.add_argument('-v', '--verbose', action = 'store_true')
arguments = parser.parse_args(['-d'])
print(arguments.debug, arguments.verbose) # Prints: True False
```

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

### For Loop with Range (Start and End)

Source: https://speedsheet.io/s/python

Iterate within a specified start and end point.

```python
for i in range(end_plus_1):
    ...
for i in range(start, end_plus_1):
    ...
```

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

### Python Identifier Examples

Source: https://speedsheet.io/s/python

Examples of valid Python identifiers that follow the naming conventions.

```python
a1
item_2
three_word_name
```

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

### View Package Details

Source: https://speedsheet.io/s/python?q=pip-only

Displays detailed information about an installed package, including version, author, and dependencies.

```bash
pip show package_name
```

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

### Get Variable Type in Python

Source: https://speedsheet.io/s/python?q=type%28%29

Returns the type of a given item. Example shows getting the type of a float.

```Python
item_1 = 1.0
item_1_type = type(item_1) # Returns `class 'float'`.
```

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

### Minimal setup.py

Source: https://speedsheet.io/s/python?q=how-to

A basic `setup.py` file for packaging a Python project, specifying the package name, version, description, and source directory.

```python
from setuptools import find_packages, setup

setup(
    name='app_name',
    version='1.0.0',
    description='App description.',
    packages=find_packages('src'),
    package_dir={'': 'src'}
)
```

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

### Example of Function with Default Arguments

Source: https://speedsheet.io/s/python?q=functions-only

Demonstrates calling a function with and without providing a value for an optional argument.

```python
def say_hello(name, greeting = "Hello"):
    print(greeting, name)

say_hello("John")
say_hello("John", "Hi")
```

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

### Python Indexing Example

Source: https://speedsheet.io/s/python?q=fundamentals-only

Shows how to access elements in a list using 0-based indexing in Python.

```python
first = some_list[0]
```

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

### Start Python REPL

Source: https://speedsheet.io/s/python?q=command-line-only

Launches the Python Read-Eval-Print Loop (REPL) for interactive Python sessions.

```bash
python3
```

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

### Python f-string - Alignment Examples

Source: https://speedsheet.io/s/python

Demonstrates right, center, and left alignment of strings within a specified width using f-strings.

```python
string_1 = "value-1"
align_right = f'{string_1:>10}'
align_center = f'{string_1:^10}'
align_left = f'{string_1:<10}'
```

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

### Python Match - Conditional Matching on Tuple Example

Source: https://speedsheet.io/s/python?q=match-only

Combines tuple pattern matching with a conditional check. This example matches a tuple where the second element is even.

```python
item_1 = (1, 2)
match item_1:
    case (1, x) if x % 2 == 0:
        print('Value (1,x) x is even.')
    case (1, x):
        print('Value (1,x) x is odd.')
    case _:
        print('Unmatched value')
# Prints: 'Value (1,x) x is even.'
```

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

### Python Sequence - Get Sublist From Position

Source: https://speedsheet.io/s/python?q=slicing-only

Extracts a sublist starting from a specified index to the end of the sequence.

```python
list_1 = [0, 1, 2, 3, 4]
value = list_1[2:] # Returns [2, 3, 4]
```

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

### Create and Start a Basic Process Class

Source: https://speedsheet.io/s/python?q=process-only

Shows how to define a custom process class by inheriting from `Process`, overriding the `run` method, and then creating and managing an instance of this class.

```python
from processing import Process

class ProcessClass(Process):
    def run(self):
        # Custom process logic here
        pass

process_1 = ProcessClass()
process_1.start()
process_1.join()
```

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

### Wheel Distribution - Setup

Source: https://speedsheet.io/s/python?q=distribution

Configure the setup.py file for a Python wheel distribution. This file specifies package metadata and dependencies.

```python
from setuptools import setup, find_packages

setup(
    name='package_name',
    version='2.0.1',
    description='package description here.',
    packages=find_packages(exclude=['contrib', 'docs', 'tests'])
)
```

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

### Extract a subset of a tuple using slicing

Source: https://speedsheet.io/s/python?q=tuple-only

Use slicing with `[start:end_plus_1]` to get a sub-tuple. The end index is exclusive.

```python
tuple_1[start:end_plus_1]
```

```python
tuple_1 = (1, 2, 3, 4, 5)
tuple_subset = tuple_1[1:3] # Returns (2, 3).
```

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

### Sample INI File Structure

Source: https://speedsheet.io/s/python?q=configparser-only

An example of a typical INI file structure with a section and various property types.

```ini
[section_name]
property_name = Property Value
int_property = 42
float_property = 1.23
boolean_property = True
```

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

### Check PIP Version

Source: https://speedsheet.io/s/python?q=pip-only

Displays the currently installed version of PIP.

```bash
pip -V
```

```bash
pip --version
```

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

### Python Identifier Naming Convention

Source: https://speedsheet.io/s/python?q=fundamentals-only

Provides the regex pattern and examples for valid Python identifiers, emphasizing that they are case-sensitive and cannot start with a digit.

```regex
[_a-zA-Z][_0-9a-zA-Z]*
```

```python
a1
item_2
three_word_name
```

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

### Get DateTime Day of Week

Source: https://speedsheet.io/s/python

Get the day of the week as an integer, where 0 is Monday and 6 is Sunday. Requires calling the method with parentheses.

```python
= datetime_1.weekday()
```

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

### Generate Random Integer

Source: https://speedsheet.io/s/python?q=random-only

Use `randrange(max_plus_1)` to get an integer from 0 up to (but not including) `max_plus_1`. You can also specify a start, stop, and step.

```Python
from random import randrange

next = randrange(100)
print(next) # Prints: 17
```

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

### Get Variable Type Name in Python

Source: https://speedsheet.io/s/python?q=type%28%29

Returns the string name of the item's type. Example prints the type name of a float.

```Python
float_1 = 1.0
print(type(float_1).__name__) # Prints `'float'`.
```

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

### Create a New Class Instance

Source: https://speedsheet.io/s/python?q=classes-only

Demonstrates the syntax for creating a new instance (object) of a class by calling the class name as a function, optionally passing arguments to its constructor.

```python
= Class1(arg_1, ...)
```

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

### Get seconds (non-day portion) from timedelta

Source: https://speedsheet.io/s/python?q=timedelta-only

Retrieves the number of seconds from the time portion (less than a day) of a timedelta object. For example, 1 hour and 15 seconds will return 3615.

```python
from datetime import timedelta
timedelta_1 = timedelta(days = 2, hours = 1, seconds = 15)
seconds = timedelta_1.seconds
```

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

### Create a Process with a Name

Source: https://speedsheet.io/s/python?q=process-only

Illustrates how to create a process and assign it a specific name for easier identification.

```python
from processing import Process

process_1 = Process( name = "process name", target = worker_function, args = (worker_argument_1,))
process_1.start()
process_1.join()
```

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

### Create a Process Class with Arguments

Source: https://speedsheet.io/s/python?q=process-only

Demonstrates how to create a custom process class that accepts arguments during initialization. It highlights the requirement to call the parent `Process` class's `__init__` method as the first step.

```python
from processing import Process

class WorkerClass(Process):
    def __init__(self, argument_1, ...):
        #1
        Process.__init__(self)
        # ... other initialization logic ...
        pass

#1 - Must call `Process.__init__()`
#1 - Must Be First Line In `__init__` Method

worker_1 = WorkerClass(argument_1, ...)
worker_1.start()
worker_1.join()
```

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

### Python Dictionary Initialization

Source: https://speedsheet.io/s/python?q=dict-only

Demonstrates different ways to initialize an empty or pre-populated dictionary in Python.

```python
dict_1 = {}
dict_2 = {'key_1': 'value_1', 'key_2': 'value_2'}
dict_3 = dict([('key_1', 'value_1'), ('key_2', 'value_2')])
```

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

### Wheel Distribution - Create

Source: https://speedsheet.io/s/python?q=distribution

Build wheel distribution files from the project root directory using the setup.py script. The output is placed in the /dist directory.

```shell
python3 setup.py sdist bdist_wheel
```

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

### Python .format() - Single Variable Example

Source: https://speedsheet.io/s/python

Shows how to format a string using a single variable with the .format() method.

```python
string_1 = "norminal"
formatted = "Everything is {}.".format(string_1)
```

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

### For Loop with Range (Start, End, Step)

Source: https://speedsheet.io/s/python

Iterate with a custom step size.

```python
for i in range(start, end_plus_one, step):
    ...
# Example:
for i in range(2, 9, 2): # Loops through 2, 4, 6, 8.
    print(i)
```

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

### Define and Use Instance Methods

Source: https://speedsheet.io/s/python?q=classes-only

Shows how to define instance methods within a class and how to call them both internally using `self` and externally using the instance name.

```python
class Class1:
    def method_1(self, arg_1, ...):
        ...
```

```python
class Class1:
    def ...(self):
        self.method_1(arg_1, ...)
```

```python
class_1.method_1(arg_1, ...)
```

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

### Define Package Directory with __init__.py

Source: https://speedsheet.io/s/python?q=modules-only

Create an __init__.py file in a subdirectory to define it as a package. This file can be empty and is executed when the package is imported.

```text
__init__.py
```

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

### Get Current Module File Path

Source: https://speedsheet.io/s/python?q=how-to

Access the `__file__` attribute to get the path of the current module.

```python
__file__
```

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

### Get DateTime Second

Source: https://speedsheet.io/s/python

Extract the second component from a datetime object.

```python
= datetime_1.second
```

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

### Thread Lock - Create

Source: https://speedsheet.io/s/python?q=lock-only

Code example for creating a basic threading Lock object.

```python
from threading import Lock

=Lock()
```

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

### Get DateTime Month

Source: https://speedsheet.io/s/python

Extract the month component from a datetime object.

```python
= datetime_1.month
```

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

### Python Comment Example

Source: https://speedsheet.io/s/python?q=fundamentals-only

Demonstrates how to use single-line comments in Python, which are ignored by the interpreter.

```python
# This is a comment.
Start the comment with a hash '#'. Comments are ignored by the compiler.
```

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

### Process Lock - Create

Source: https://speedsheet.io/s/python?q=lock-only

Code example for creating a basic multiprocessing Lock object.

```python
from multiprocessing import Lock

= Lock()
```

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

### Example of Function Returning a Single Value

Source: https://speedsheet.io/s/python?q=functions-only

Demonstrates a function that returns a specific value.

```python
def return_a_1():
    return 1

results = return_a_1()
```

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

### HTTP - Get

Source: https://speedsheet.io/s/python?q=http-only

Makes an HTTP GET call to the specified URL and returns the response content as bytes.

```APIDOC
## HTTP - Get

### Description
Makes an HTTP GET call to the specified URL. The response content is returned as bytes.

### Method
GET

### Endpoint
`urlopen(url)`

### Parameters
#### Path Parameters
- **url** (string) - Required - The URL to send the GET request to.

### Request Example
```python
from urllib.request import urlopen

url = "https://httpbin.org/get"
with urlopen(url) as response:
    content = response.read()
    text = content.decode("utf-8", "ignore")
    print("Response:", text)
```

### Response
#### Success Response (200)
- **content** (bytes) - The raw content of the HTTP response.

#### Response Example
```
{
  "example": "Response: {\"args\": {}, \"headers\": {\"Accept\": \"*/*\", \"Host\": \"httpbin.org\", \"User-Agent\": \"Python-urllib/3.x\"},\"origin\": \"<your_ip>\", \"url\": \"https://httpbin.org/get\"}"
}
```
```

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

### Get DateTime Day

Source: https://speedsheet.io/s/python

Extract the day component from a datetime object.

```python
= datetime_1.day
```

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

### Get DateTime Year

Source: https://speedsheet.io/s/python

Extract the year component from a datetime object.

```python
= datetime_1.year
```

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

### Get DateTime Minute

Source: https://speedsheet.io/s/python

Extract the minute component from a datetime object.

```python
= datetime_1.minute
```

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

### Show Help Documentation

Source: https://speedsheet.io/s/python?q=how-to

Display help documentation for any Python item (keyword, function, class, module) using the `help()` function.

```python
help(item)
```

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

### Create a Byte Array

Source: https://speedsheet.io/s/python?q=byte-only

Demonstrates how to create a byte array from a string literal or a list of integers.

```Python
bytes_1 = b"String to bytes."
bytes_2 = bytes([66, 121, 116, 101, 115])
```

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

### Getting Instance Attributes as Dictionary

Source: https://speedsheet.io/s/python?q=classes-only

Accesses the `__dict__` attribute of an instance to get a dictionary of its instance attributes and their values.

```python
= instance_1.__dict__
```

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

### Recommended Project Structure

Source: https://speedsheet.io/s/python?q=how-to

This snippet outlines a standard Python project directory layout, including source, tests, documentation, and configuration files.

```text
project_name/
├─ README.md
├─ pyproject.toml
├─ setup.cfg
├─ dist/
├─ docs/
│ └─ ...
├─ src/
│ ├─ __main__.py
│ └─ package/
│ ├─__init__.py
│ └─module.py
└─ tests/
 └─ ...
```

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

### Get DateTime Hour

Source: https://speedsheet.io/s/python

Extract the hour component from a datetime object.

```python
= datetime_1.hour
```

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

### Python Operator Precedence - Example

Source: https://speedsheet.io/s/python?q=operators-only

Illustrates the order in which operations are performed in Python expressions, from highest to lowest precedence.

```python
(...)
[...]
{key: value}
{...}
x[index], func_1(), x.attrib
await x
**
+x, -x, ~x
*, /, //, %, @
+, -
<<, >>
&
^
|
in, not in, is, is not, <, <=, >, >=, !=, ==
not
and
or
if else
lambda
:=
```

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

### Get Main Module File Path

Source: https://speedsheet.io/s/python?q=how-to

Access `__main__.__file__` to get the file path when the current module is the main program.

```python
__main__.__file__
```

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

### Python String Format() - Multiple Variables Example

Source: https://speedsheet.io/s/python?q=string-format%28%29-only

Shows how to insert multiple variables into a string using sequential placeholders. The order of variables in .format() matches the order of the placeholders.

```python
string_1 = "The cake"
string_2 = "a lie"
the_truth = "{} is {}.
```

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

### Hello World with Command-line Arguments

Source: https://speedsheet.io/s/python

This Python script accepts a name as a command-line argument and prints a greeting. It defaults to 'World' if no argument is provided. Run using 'python3 hello2.py your_name_here'.

```python
from sys import argv

def main():
    if len(argv) > 1:
        name = argv[1]
    else:
        name = "World"
    print("hello " + name + "!")

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

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

### Get Day of Week

Source: https://speedsheet.io/s/python?q=date-only

Use the `weekday()` method to get the day of the week as an integer, where Monday is 0 and Sunday is 6.

```python
= date_1.weekday()
```

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

### Python List Indexing and Slicing Examples

Source: https://speedsheet.io/s/python?q=slicing-only

Demonstrates various ways to access elements and sublists using positive and negative indices, slicing with start/end points, and steps. Note that the 'all' slice is not recommended for intuitive use.

```python
list_1 = [0, 1, 2, 3, 4]
first = list_1[0] # Returns 0
second = list_1[1]
second_last = list_1[-2] # Returns 3
last = list_1[-1] # Returns 4
all_slice = list_1[:] # Returns [0, 1, 2, 3, 4] (Not Recommended)
all_but_first = list_1[1:] # Returns [1, 2, 3, 4]
all_but_last = list_1[:-1] # Returns [0, 1, 2, 3]
reversed_list = list_1[::-1] # Returns [4, 3, 2, 1, 0]
from_1_to_3 = list_1[1:4] # Returns [1, 2, 3]
from_1_step_to_3 = list_1[1:4:2] # Returns [1, 3]
even = list_1[::2] # Returns [0, 2, 4]
odd_from_1 = list_1[1::2] # Returns [1, 3]
```

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

### Countdown Example with Carriage Return

Source: https://speedsheet.io/s/python?q=print-only

Demonstrates using `end='\r'` to create a dynamic countdown on a single line.

```python
from time import sleep

for i in range(5,0,-1):
    print(i, end='\r')
    sleep(1)
print('Done.')
```

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

### Semaphore - Using With Statement (General)

Source: https://speedsheet.io/s/python?q=semaphore-only

Demonstrates using a generic Semaphore with a 'with' statement for automatic acquisition and release. This is a concise way to manage semaphore lifecycles.

```python
with Semaphore() as semaphore_1: ...
```

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

### Get Current Date

Source: https://speedsheet.io/s/python?q=date-only

Import the `date` object from the `datetime` module and use the `today()` method to get the current local date.

```python
from datetime import date

=
 date.today()
```

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

### Basic Hello World Script

Source: https://speedsheet.io/s/python

A simple Python script to print 'Hello World!' to the console. Run this from the command line using 'python3 hello.py'.

```python
print("Hello World!")
```

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

### Start Event Loop Forever

Source: https://speedsheet.io/s/python?q=asyncio-only

Starts the event loop and keeps it running indefinitely until explicitly stopped. This is useful for long-running applications or servers.

```python
event_loop_1.run_forever()
```

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

### Python List Indexing Examples

Source: https://speedsheet.io/s/python?q=sequence-only

Demonstrates basic indexing to retrieve individual elements from a list, including positive and negative indices.

```python
list_1 = [0, 1, 2, 3, 4]
first = list_1[0] # Returns 0
second = list_1[1] # Returns 1
second_last = list_1[-2] # Returns 3
last = list_1[-1] # Returns 4
```

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

### Force Reinstall Package

Source: https://speedsheet.io/s/python?q=pip-only

Installs a package, forcing a reinstallation even if it's already present. Useful for troubleshooting.

```bash
pip install --force-reinstall package_name
```

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

### Python String Format() - Basic Usage

Source: https://speedsheet.io/s/python?q=string-format%28%29-only

Demonstrates basic string formatting with single variables, multiple variables, right padding, and number formatting with commas and decimal places.

```python
string_1 = "value 1"
string_2 = "value 2"
float_3 = 12345.67
formatted_string = "{}".format(string_1)
string_1_and_2 = "{} {}".format(string_1, string_2)
pad_right = "{:<20}".format(string_1)
formatted_number = "{:, .1f}".format(float_3)
```

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

### Check if String Starts With a Value

Source: https://speedsheet.io/s/python?q=strings-only

Use the `startswith` method to determine if a string begins with a specified prefix.

```python
string_1 = "HelloWorld"
starts_with_hello = string_1.startswith("Hello")
print(starts_with_hello) # Output: True

starts_with_world = string_1.startswith("World")
print(starts_with_world) # Output: False
```

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

### Example of Function Returning Multiple Values

Source: https://speedsheet.io/s/python?q=functions-only

Demonstrates a function returning multiple values, which are then assigned to variables.

```python
def return_three_values():
    return "one", "two", "three"

results = return_three_values()
```

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

### HTTP GET Request with urlopen

Source: https://speedsheet.io/s/python?q=http-only

Make an HTTP GET request to a specified URL and read the response content. Ensure the response is decoded to a string.

```python
from urllib.request import urlopen
url = "https://httpbin.org/get"
with urlopen(url) as response:
    content = response.read()
text = content.decode("utf-8", "ignore")
print("Response:", text)
```

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

### Define a Class with Constructor and Arguments

Source: https://speedsheet.io/s/python?q=classes-only

Shows how to define a class constructor (`__init__`) that accepts arguments and uses them to set instance variables.

```python
class Class1:
    def __init__(self, arg_1, ...):
        ...
```

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

### Get Dictionary Keys

Source: https://speedsheet.io/s/python?q=dict-only

Use the `keys()` method to get a view object of the dictionary's keys. Convert it to a list using `list()` if needed.

```python
dict_1.keys()
# As List:
# list(dict_1.keys())
```

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

### Python Pool Creation Options

Source: https://speedsheet.io/s/python?q=process-pool-only

Demonstrates different ways to create a multiprocessing Pool, including using the default number of CPUs and specifying initialization functions.

```python
from multiprocessing import Pool

# Create a pool using the default number of CPUs
pool_1 = Pool()

# Create a pool with a specified number of processes
pool_1 = Pool(process_count)

# Create a pool with all available options
pool_1 = Pool( processes = process_count, initializen = initializing_function, initargs = initial_arguments, maxtasksperchild = number_of_tasks)
```

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

### Write to File using File Pointer

Source: https://speedsheet.io/s/python?q=acronyms-only

Demonstrates how to open a file in write mode and write content using a file pointer (fp).

```python
with open(file_name, "w") as fp:
  fp.write()
```

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

### Check if Thread is Alive

Source: https://speedsheet.io/s/python?q=thread-only

The `is_alive()` method returns `True` if the thread is currently running (i.e., has been started but not yet terminated). It returns `False` if the thread has not been started or has already finished.

```python
is_running = thread_1.is_alive()
```

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

### Example of Function with Arbitrary Keyword Arguments

Source: https://speedsheet.io/s/python?q=functions-only

Demonstrates calling a function using named arguments that are collected into the `kwargs` dictionary.

```python
def say(**kwargs):
    print(kwargs['greeting'], kwargs['name'])

say(greeting = "Hi", name = "John")
```

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

### Get a Specific Time Zone Object

Source: https://speedsheet.io/s/python?q=timezone-only

Instantiate a ZoneInfo object for a specific time zone. Use this when you need to perform time zone conversions or get time zone-specific information.

```python
from zoneinfo import ZoneInfo
zone_1 = ZoneInfo('America/New_York')
```

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

### Get a Property Value from a ConfigParser Section

Source: https://speedsheet.io/s/python?q=configparser-only

Shows two methods for retrieving a property's value from a section. `get` returns `None` if not found, while dictionary access raises `KeyError`.

```python
section_1.get('property_name')
```

```python
section_1['property_name']
```

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

### Use __post_init__ for Initialization

Source: https://speedsheet.io/s/python?q=dataclass-only

The `__post_init__` method is automatically called after the dataclass instance is created. Use it for any additional setup or validation logic.

```python
@dataclass
class NewClass1:
    ...

    def __post_init__(self):
        ...
```

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

### Get a Dictionary Value by Key

Source: https://speedsheet.io/s/python?q=dict-only

Access a value using its key with square bracket notation (raises `KeyError` if not found) or use the `get()` method which returns `None` or a default value if the key is absent.

```python
dict_1["a"] # Preferred style. Raises `KeyError` if not found.
dict_1.get("a") # Returns `None` if not found.
dict_1.get("z", "default_value")

# Example:
dict_1 = {"a": "value a", "b": "value b", "c": "value c"}
value_a = dict_1["a"]
value_a = dict_1.get("a")
value_a = dict_1.get("z", "value a")
print(value_a) # Print: value a
```

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

### Get Date Part of DateTime

Source: https://speedsheet.io/s/python

Extract the date component from a datetime object, discarding the time.

```python
= datetime_1.date()
```

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

### Get Time Part of DateTime

Source: https://speedsheet.io/s/python

Extract the time component from a datetime object, discarding the date.

```python
= datetime_1.time()
```

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

### Get All Property Names for a ConfigParser Section

Source: https://speedsheet.io/s/python?q=configparser-only

Shows two ways to get a list of all property names within a specific section of a ConfigParser object: using `options` or converting section keys to a list.

```python
config_parser.options(section_name)
```

```python
list(section_1.keys())
```

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

### Getting Decimal Precision

Source: https://speedsheet.io/s/python

Retrieve the current precision setting for decimal operations using `getcontext().prec`.

```python
from decimal import getcontext
getcontext().prec
```

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

### Hello World with User Input

Source: https://speedsheet.io/s/python

This script prompts the user for a name and prints a greeting. If no name is entered, it defaults to 'World'. Run using 'python3 hello2.py'.

```python
def main():
    name = input("Enter Name: ")
    if not name:
        name = "World"
    print("hello " + name + "!")

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

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

### Uninstall a Package

Source: https://speedsheet.io/s/python?q=pip-only

Removes an installed package from the environment.

```bash
pip uninstall package_name
```

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

### Task - Get Name

Source: https://speedsheet.io/s/python?q=asyncio-only

Retrieves the name of the Task.

```APIDOC
## Task - Get Name

### Description
Retrieves the name of the Task.

### Method
`task.get_name()`

### Parameters
None

### Response
- **return value** (`str`) - The name of the task.
```

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

### Create a List with Initial Value and Size

Source: https://speedsheet.io/s/python?q=list-only

A list can be created with a specified size, where all elements are initialized to a given value.

```python
five_ones = [1] * 5 # Returns [1, 1, 1, 1, 1]
```

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

### Get the Name of an Asyncio Task

Source: https://speedsheet.io/s/python?q=asyncio-only

Retrieves the name of the task.

```python
task_1.get_name()
```

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

### Check if String Starts With Value

Source: https://speedsheet.io/s/python

Returns True if the string begins with or is equal to the specified test value, False otherwise.

```python
string_1.startswith(test_value)
```

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

### Get Current DateTime

Source: https://speedsheet.io/s/python?q=datetime-only

Retrieves the current date and time.

```python
from datetime import datetime
= datetime.today()
```

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

### Python String Format() - With Formatting Example

Source: https://speedsheet.io/s/python?q=string-format%28%29-only

Applies formatting specifiers to control the output, such as left alignment within a specified width and formatting integers with commas.

```python
string_1 = "On the left!"
Padded = "{:<20}".format(string_1)
int_1 = 12345
comma_separated = "{:,d}".format(int_1)
```

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

### Format Date - Basic Usage

Source: https://speedsheet.io/s/python?q=formatting-only

Demonstrates basic date formatting using f-strings and the format() method with a placeholder for the date format.

```Python
f'{datetime_1:date_format}'
```

```Python
'{:date_format}'.format(datetime_1)
```

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

### Thread Lock - Basics Using With

Source: https://speedsheet.io/s/python?q=lock-only

Shows how to use a threading Lock with a 'with' statement for automatic acquisition and release.

```python
from threading import Lock

# Create and Use:
with Lock() as lock_1: ...
```

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

### Get String Length

Source: https://speedsheet.io/s/python?q=strings-only

Returns the total number of characters in a string.

```Python
= len(string_1)
```

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

### Import Package using __init__.py

Source: https://speedsheet.io/s/python?q=modules-only

The __init__.py file is executed when a package is imported as a module, allowing initialization code to run.

```python
import package_1
```

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

### Get Character at Position

Source: https://speedsheet.io/s/python?q=strings-only

Retrieves the character at a specific index in a string.

```Python
= string_1[position]
```

```Python
character_2 = "012345"[2] # Returns "2"
```

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

### Python Match - Match List Example

Source: https://speedsheet.io/s/python

Matches a list against specific internal values. This snippet demonstrates matching a list with a known sequence of elements.

```python
list_1 =[1, 3]
match list_1:
    case [1]:
        print('Value [1]')
    case [1, 2]:
        print('Value [1, 2]')
    case [1, 3]:
        print('Value [1, 3]')
    case _:
        print('Unmatched Value')
# Prints: Value (1, 3)'
```

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

### Python Match - Match Tuple Example

Source: https://speedsheet.io/s/python

Matches a tuple against specific internal values. This snippet demonstrates matching a tuple with a known sequence of elements.

```python
tuple_1 =(1, 3)
match tuple_1:
    case (1):
        print('Value (1)')
    case (1, 2):
        print('Value (1, 2)')
    case (1, 3):
        print('Value (1, 3)')
    case _:
        print('Unmatched Value')
# Prints: Value (1, 3)'
```

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

### Get Deque Size

Source: https://speedsheet.io/s/python?q=deque-only

Returns the current number of items in the deque.

```python
size = len(queue_1)
```

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

### Call a Function with a Dictionary of Arguments

Source: https://speedsheet.io/s/python?q=functions-only

Demonstrates how to unpack a dictionary into keyword arguments when calling a function.

```python
def say(greeting, name):
    print(greeting, name)

dict_1 = {'greeting' : 'Hi', 'name' : 'John'}
say(**dict_1)
```

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

### Datetime - Get Time Zone Name

Source: https://speedsheet.io/s/python

Retrieves the name of the time zone associated with a datetime object.

```APIDOC
## Datetime - Get Time Zone Name

### Description
Returns the name of the time zone.

### Method
`tzname()`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```python
from datetime import datetime
from zoneinfo import ZoneInfo

datetime_1 = datetime(2001, 1, 1, 0, 0, 0, tzinfo=ZoneInfo('America/New_York'))
print(datetime_1.tzname())
```

### Response
#### Success Response
- **tzname** (str) - The name of the time zone (e.g., 'EST', 'EDT').

#### Response Example
```
EST
```
```

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

### Initialize a Standard Queue

Source: https://speedsheet.io/s/python?q=standard-queue-only

Instantiate a standard FIFO queue. Optionally, specify a maximum size to limit the number of elements.

```python
from queue import Queue

queue_1 = Queue()
queue_2 = Queue(max_size=10) # Example with max_size
```

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

### Type Casting

Source: https://speedsheet.io/s/python

Converts a variable from one data type to another. For example, converting a float to an integer.

```python
new_type(item_1)
```

```python
float_1 = 10.5
int_1 = int(float_1) # Converts float 10.5 into integer 10.
```

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

### Iterate Over All Sections and Properties in ConfigParser

Source: https://speedsheet.io/s/python?q=configparser-only

Provides a Python code example for iterating through all sections and their properties within a ConfigParser object, printing each property name and its value.

```python
for section_name in config_1.sections():
    section = config_1[section_name]
    for property_name, value in section.items():
        print(section_name, property_name, ":", value)
```

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

### Using a Class Property

Source: https://speedsheet.io/s/python?q=classes-only

Demonstrates how to use a class property, treating it like an instance variable for assignment and retrieval.

```python
class_1 = Class1()
class_1.variable_1 = value_1 # Assign value
value_2 = class_1.variable_1 # Retrieve value
```

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

### Define and Create a Process Class

Source: https://speedsheet.io/s/python?q=process-only

Explains how to define a custom process class by inheriting from `Process` and overriding the `run` method.

```python
from processing import Process

class ProcessClass(Process):
    #1
    def run(self):
        #2
        pass

#1 - Inherit from `Process`
#2 - Override `run()`

process_1 = ProcessClass()
process_1.start()
process_1.join()
```

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

### Upgrade a Specific Package

Source: https://speedsheet.io/s/python?q=pip-only

Upgrades an already installed package to its latest version.

```bash
pip install --upgrade package_name
```

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

### Thread Lock - Basics

Source: https://speedsheet.io/s/python?q=lock-only

Demonstrates the basic creation and usage of a threading Lock. Acquire and release the lock manually.

```python
from threading import Lock

# Create:
lock_1 = Lock()

# Use:
lock_1.acquire() ... lock_1.release()
```

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

### Split String from End by Delimiter

Source: https://speedsheet.io/s/python

Splits a string into a list of substrings based on a specified delimiter, starting from the end of the string. The delimiter itself is not included in the results.

```python
string_1.rsplit(split_string)
```

```python
string_1.rsplit(split_string, split_count)
```

```python
string_1 = "ab/cd/ef"
split_1 = string_1.rsplit("/", 1)
```

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

### Get days from timedelta

Source: https://speedsheet.io/s/python?q=timedelta-only

Retrieves the number of whole days from a timedelta object.

```python
from datetime import timedelta
timedelta_1 = timedelta(days = 2, hours = 1, seconds = 15)
days = timedelta_1.days
```

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

### Show Python Version

Source: https://speedsheet.io/s/python?q=command-line-only

Displays the currently installed Python version. Use `python` or `python3` depending on your system's configuration.

```bash
python --version
python3 --version
```

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

### Get the first element of a list

Source: https://speedsheet.io/s/python?q=list-only

Retrieves the element at index 0 from a list.

```python
# list_1[0]
```

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

### Process Lock - Basics

Source: https://speedsheet.io/s/python?q=lock-only

Demonstrates the basic creation and usage of a multiprocessing Lock. Acquire and release the lock manually.

```python
from multiprocessing import Lock

# Create:
lock_1 = Lock()

# Use:
lock_1.acquire() ... lock_1.release()
```

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

### Get File Extension

Source: https://speedsheet.io/s/python?q=path-only

Returns the file extension, including the leading dot.

```python
from os.path import splitext

extension = splitext('/root/parent/file.txt')[1] # Returns: '.txt'

```

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

### Set Process as Daemon

Source: https://speedsheet.io/s/python?q=process-only

Explains how to set a process as a daemon, causing it to terminate automatically when the parent process exits. This must be done before starting the process.

```python
process_1.daemon = True
# Must be called before calling .start()
```

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

### Print to Standard Output

Source: https://speedsheet.io/s/python?q=how-to

The preferred method for standard output is `print(...)`. `print(..., file=sys.stdout)` is an explicit alternative.

```python
print('text...')
```

```python
print('text...', file = sys.stdout)
```

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

### Get Function Name

Source: https://speedsheet.io/s/python?q=functions-only

Retrieves the name of a function using the `__name__` attribute.

```python
= function_1.__name__
```

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

### Task - Get Exception

Source: https://speedsheet.io/s/python?q=asyncio-only

Retrieves the exception raised by the Task, if any. This method does not block.

```APIDOC
## Task - Get Exception

### Description
Retrieves the exception raised by the Task, if any. This method never blocks.

### Method
`task.exception()`

### Parameters
None

### Response
- **return value** - The exception raised by the task, or `None` if no exception was raised.
```

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

### Yield Keyword - Factorial Series Example

Source: https://speedsheet.io/s/python?q=generators

Demonstrates using `yield` to create a generator that produces a series of factorial values. The function `factorial_series` yields each calculated factorial.

```Python
from math import factorial
def factorial_series(n):
    for i in range (n + 1):
        yield factorial(i)

for value in factorial_series(4):
    print(value)
```

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

### Python Identifier Regex

Source: https://speedsheet.io/s/python

Defines the regular expression pattern for valid Python identifiers. Identifiers must start with a letter or underscore and can be followed by letters, digits, or underscores.

```regex
[_a-zA-Z][_0-9a-zA-Z]*
```

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

### Future - Get Exception

Source: https://speedsheet.io/s/python?q=asyncio-only

Retrieves the exception raised by the Future, if any. This method does not block.

```APIDOC
## Future - Get Exception

### Description
Retrieves the exception raised by the Future, if any. This method never blocks.

### Method
`future.exception()`

### Parameters
None

### Response
- **return value** - The exception raised by the future, or `None` if no exception was raised.
```

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

### Create and Start a Basic Thread Class

Source: https://speedsheet.io/s/python?q=thread-only

Define a custom thread by inheriting from `threading.Thread` and overriding the `run` method. Instantiate the class and call `.start()` to begin execution. Use `.join()` to wait for the thread to finish.

```python
from threading import Thread

class ThreadClass(Thread):
    def run(self):
        pass # Your code here

# Create an instance of the thread class
thread_1 = ThreadClass()

# Start the thread
thread_1.start()

# Wait for the thread to complete
thread_1.join()
```

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

### For Loop with Range

Source: https://speedsheet.io/s/python?q=control-structure-only

Iterate through a sequence of numbers. Can specify start and end values.

```python
for i in range(end_plus_1): ...
```

```python
for i in range(start, end_plus_1): ...
```

```python
for i in range(5): # Loops through 0, 1, 2, 3, 4. ...
```

```python
for i in range(1,5): # Loops through 1, 2, 3, 4. ...
```

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

### Create a Dataclass Instance

Source: https://speedsheet.io/s/python?q=dataclass-only

Instantiate a dataclass by passing arguments in order or by field name.

```python
item_1 = NewClass1(value_1, value_2 ...)
```

```python
item_1 = NewClass1(field_1 = value_1, field_2 = value_2 ...)
```

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

### Time Zone - Get

Source: https://speedsheet.io/s/python?q=timezone-only

Retrieves the zone info object for a specified time zone.

```APIDOC
## Time Zone - Get

### Description
Returns the zone info object for the given time zone.

### Usage
```python
from zoneinfo import ZoneInfo
zone_1 = ZoneInfo('America/New_York')
```

### Parameters
#### Path Parameters
- **time_zone** (string) - Required - The identifier for the time zone (e.g., 'America/EST').

### Response
#### Success Response (200)
- **zone_info** (object) - An object containing details for the specified time zone.
```

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

### Define and Use Instance Variables

Source: https://speedsheet.io/s/python?q=classes-only

Explains how to define, set, and get instance variables within a class. Instance variables are unique to each object and are typically managed using `self`.

```python
class Class1:
    def some_method(self):
        self.variable_1 = value  # Create / Set
        = self.variable_1  # Get
```

```python
= class_1.variable_1
```

```python
class_1.variable_1 = new_value
```

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

### Get absolute value of timedelta

Source: https://speedsheet.io/s/python?q=timedelta-only

Returns the absolute (non-negative) duration of a timedelta object.

```python
absolute_timedelta = abs(timedelta_1)
```

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

### Egg Distribution - Create

Source: https://speedsheet.io/s/python?q=distribution

Zip all Python files, including __main__.py, into a single zip file to create a distributable egg. Ensure __main__.py is at the root of the zip.

```shell
zip -r egg_file.egg *

```

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

### Define and Instantiate a Class with Equality

Source: https://speedsheet.io/s/python?q=classes-only

Defines a simple class with an initializer and an equality comparison method. Demonstrates instantiation and comparison.

```python
class SampleClass:
    def __init__(self, value_1 = None, value_2 = None):
        self.value_1 = value_1
        self.value_2 = value_2

    def __eq__ (self, other):
        if not isinstance(other, SampleClass):
            return False
        return (self.value_1 == other.value_1 and self.value_2 == other.value_2)

# Instantiate:
item1 = SampleClass(1, "one")
item2 = SampleClass(2, "two")

# Compare:
if item1 == item2:
    print("The same.")
else:
    print("Different.")
```

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

### Get the first element of a tuple

Source: https://speedsheet.io/s/python?q=tuple-only

The first element of a tuple is always at index 0.

```python
tuple_1[0]
```

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

### Get the Size of a Set

Source: https://speedsheet.io/s/python?q=set-only

Use the len() function to return the number of elements in a set.

```python
len(set_1)
```
Tokens:
Raw