Requests Library

Functions for making HTTP requests. Matches Python’s requests library API.

Available Functions

Setup

import "github.com/paularlott/scriptling/extlibs"

// Register the Requests library
p.RegisterLibrary("requests", extlibs.RequestsLibrary)

Functions

requests.get(url, **kwargs)

Makes a GET request to the specified URL.

Parameters:

• url: URL to request
• **kwargs: Optional arguments
  • timeout (int): Request timeout in seconds (default: 5)
  • headers (dict): HTTP headers to send
  • auth (tuple/list): Basic authentication as (username, password)

Returns: Response object

requests.post(url, data=None, **kwargs)

Makes a POST request to the specified URL.

Parameters:

• url: URL to request
• data (string, optional): Request body
• **kwargs: Optional arguments
  • timeout (int): Request timeout in seconds (default: 5)
  • headers (dict): HTTP headers to send
  • auth (tuple/list): Basic authentication as (username, password)

Returns: Response object

requests.put(url, data=None, **kwargs)

Makes a PUT request to the specified URL.

Parameters:

• url: URL to request
• data (string, optional): Request body
• **kwargs: Optional arguments
  • timeout (int): Request timeout in seconds (default: 5)
  • headers (dict): HTTP headers to send
  • auth (tuple/list): Basic authentication as (username, password)

Returns: Response object

requests.delete(url, **kwargs)

Makes a DELETE request to the specified URL.

Parameters:

• url: URL to request
• **kwargs: Optional arguments
  • timeout (int): Request timeout in seconds (default: 5)
  • headers (dict): HTTP headers to send
  • auth (tuple/list): Basic authentication as (username, password)

Returns: Response object

requests.patch(url, data=None, **kwargs)

Makes a PATCH request to the specified URL.

Parameters:

• url: URL to request
• data (string, optional): Request body
• **kwargs: Optional arguments
  • timeout (int): Request timeout in seconds (default: 5)
  • headers (dict): HTTP headers to send
  • auth (tuple/list): Basic authentication as (username, password)

Returns: Response object

Response Object

All HTTP functions return a response object with these attributes:

• status_code or ["status_code"]: HTTP status code (integer)
• text or ["text"]: Response body (string)
• headers or ["headers"]: Response headers (dictionary)
• url or ["url"]: The URL of the response

Response Methods

• json(): Parse response body as JSON
• raise_for_status(): Raise exception if status code >= 400

Examples

Basic GET Request

import requests

response = requests.get("https://api.example.com/users/1")
if response.status_code == 200:
    print("User data:", response.text)

GET with Options

import requests

# Using kwargs
response = requests.get("https://api.example.com/users/1", timeout=10, headers={"Authorization": "Bearer token123"})

# Using legacy options dict
options = {
    "timeout": 10,
    "headers": {"Authorization": "Bearer token123"}
}
response = requests.get("https://api.example.com/users/1", options)

POST Request

import requests
import json

new_user = {"name": "Alice", "email": "alice@example.com"}
body = json.dumps(new_user)

# Using kwargs
response = requests.post("https://api.example.com/users", data=body, headers={"Content-Type": "application/json"})

if response.status_code == 201:
    created = response.json()
    print("Created user:", created["id"])

Error Handling

import requests

try:
    response = requests.get("https://api.example.com/data")
    response.raise_for_status()  # Raises error if 4xx or 5xx
    data = response.json()
    print("Success:", data)
except Exception as e:
    print("Request failed:", e)

Using Response Attributes

import requests

response = requests.get("https://api.example.com/data")

# Both syntaxes work
status = response.status_code
# or
status = response["status_code"]

content = response.text
headers = response.headers

Complete Example

import requests
import json

# GET request with error handling
try:
    response = requests.get("https://jsonplaceholder.typicode.com/posts/1")
    response.raise_for_status()

    post = response.json()
    print("Post title:", post["title"])
    print("Status code:", response.status_code)

except Exception as e:
    print("Error:", e)

# POST request
try:
    new_post = {
        "title": "My Post",
        "body": "This is my post content",
        "userId": 1
    }

    body = json.dumps(new_post)

    response = requests.post(
        url="https://jsonplaceholder.typicode.com/posts",
        data=body,
        timeout=15,
        headers={"Content-Type": "application/json"}
    )
    response.raise_for_status()

    created = response.json()
    print("Created post ID:", created["id"])

except Exception as e:
    print("Error:", e)

Notes

• HTTP/2 support with automatic fallback to HTTP/1.1
• Connection pooling (100 connections per host)
• Accepts self-signed certificates
• Default timeout: 5 seconds
• Python requests-compatible API