redditwarp - Reddit API Wrapper

Common errors

• ModuleNotFoundError: No module named 'redditwarp'

  cause The `redditwarp` package is not installed in your current Python environment.
  fix Run `pip install redditwarp` to install the library.

• redditwarp.errors.InvalidCredentials: Invalid credentials. Check your username, password, client ID, and client secret.

  cause One or more of the authentication parameters provided to `Auth.password_login` (or other Auth methods) are incorrect.
  fix Verify all your Reddit API credentials. Ensure the client ID and secret belong to a 'script' type application on Reddit and that the username/password are correct.

• redditwarp.errors.APIError: 429 - Too Many Requests

  cause Your application has exceeded Reddit's API rate limits. The server has temporarily blocked further requests.
  fix Implement a delay mechanism (e.g., `time.sleep()`) after catching `RateLimitError` or `APIError` with status code 429. Consider using a library like `tenacity` for robust retry logic.

• AttributeError: 'Post' object has no attribute 'some_non_existent_field'

  cause You are trying to access a property or field on a Reddit model object that does not exist or is not returned by the specific API endpoint called.
  fix Consult the `redditwarp` documentation for the specific model type (e.g., `Post`, `Comment`) to see its available attributes. Use `dir(object)` in a Python console to explore available fields. Ensure the API call you made fetches the data you expect.

Warnings

• breaking Major API changes occurred between `redditwarp` 0.x.x and 1.x.x. If you are migrating from an older 0.x.x version, expect significant changes in import paths, class names (e.g., `AsyncClient` vs `Client`), and method signatures.
  Fix: Refer to the official `redditwarp` documentation for the 1.x.x series to understand the new API structure. Re-evaluate your import statements and method calls.
• gotcha Incorrect or missing authentication credentials will lead to `redditwarp.errors.InvalidCredentials` or `redditwarp.errors.APIError` (e.g., HTTP 401 Unauthorized).
  Fix: Double-check your `REDDIT_USERNAME`, `REDDIT_PASSWORD`, `REDDIT_CLIENT_ID`, and `REDDIT_CLIENT_SECRET`. Ensure the client ID and secret are for the correct Reddit application type (script, web app, etc.) and that the user account exists and has the correct permissions.
• gotcha Reddit has strict rate limits. Making too many requests in a short period will result in `redditwarp.errors.RateLimitError` (HTTP 429 Too Many Requests).
  Fix: Implement proper rate limiting and exponential backoff in your application. The `redditwarp` library doesn't automatically handle backoff, so you must implement it yourself or use `time.sleep()` when catching `RateLimitError`.
• gotcha Attempting to access attributes or methods on a Reddit object (e.g., a `Post` or `Comment`) that do not exist or have not been loaded yet can result in an `AttributeError`.
  Fix: Consult the `redditwarp` documentation or use `dir(obj)` to inspect available attributes. Some attributes might only be present after specific API calls (e.g., `client.p.comment.get_comment(comment_id)` might fetch more details than a comment obtained from `get_top()`).
• gotcha `redditwarp` supports both synchronous and asynchronous operations. Mixing them without proper `asyncio` context can lead to runtime errors or deadlocks.
  Fix: If using `Client` (synchronous), stick to synchronous methods. If using `AsyncClient` (asynchronous), ensure your code is running within an `asyncio` event loop and `await` all asynchronous calls.

Install

• pip install redditwarp Install stable version

Imports

• Client
  wrong:

  import redditwarp.Client

  correct:

  from redditwarp import Client

  While 'import redditwarp.Client' works, 'from redditwarp import Client' is the idiomatic way to import core classes and reduces verbosity.
• Auth

  from redditwarp import Auth

  Auth contains various authentication methods (password_login, implicit_login, etc.).
• errors

  from redditwarp import errors

  Used for catching specific redditwarp exceptions like InvalidCredentials or RateLimitExceeded.

Quickstart

This quickstart demonstrates how to authenticate with Reddit using the password login flow and fetch the top posts from a subreddit. It emphasizes using environment variables for credentials and includes basic error handling for common API issues like rate limits. Remember to replace placeholder values or set environment variables.

import os
from redditwarp import Client, Auth
from redditwarp.errors import APIError, RateLimitError

# It's highly recommended to use environment variables for sensitive credentials.
# Set these in your environment: REDDIT_USERNAME, REDDIT_PASSWORD, 
# REDDIT_CLIENT_ID, REDDIT_CLIENT_SECRET
username = os.environ.get('REDDIT_USERNAME', 'your_username')
password = os.environ.get('REDDIT_PASSWORD', 'your_password')
client_id = os.environ.get('REDDIT_CLIENT_ID', 'your_client_id')
client_secret = os.environ.get('REDDIT_CLIENT_SECRET', 'your_client_secret')

# For password login flow, a user agent string is also good practice
user_agent = 'my_script_name_v1.0 (by /u/your_reddit_username)'

try:
    # Authenticate and create a client instance
    auth = Auth.password_login(
        username=username,
        password=password,
        client_id=client_id,
        client_secret=client_secret,
        user_agent=user_agent
    )
    client = Client(auth)

    # Fetch the top 5 posts from r/python
    print('Fetching top 5 posts from r/python...')
    subreddit_posts = client.p.subreddit.get_top(subreddit='python', limit=5)

    for post in subreddit_posts:
        print(f"- {post.title} (Score: {post.score})")

except APIError as e:
    print(f"Reddit API Error: {e.code} - {e.message}")
except RateLimitError:
    print("Rate limit exceeded. Please wait and try again.")
except Exception as e:
    print(f"An unexpected error occurred: {e}")