Prawcore

Warnings

• breaking Prawcore explicitly follows semantic versioning where only major versions introduce breaking changes to its public interface. Always pin your major version dependency to avoid unexpected breakages.
  Fix: Update your `install_requires` (e.g., `prawcore >=X.Y, <(X+1)` or `prawcore~=X.Y`) and consult the changelog before upgrading to a new major version.
• breaking Prawcore 3.0.0 dropped support for Python 3.8. Earlier versions also dropped support for Python 3.6 and 3.7. Ensure your Python environment meets the `~=3.9` requirement.
  Fix: Upgrade your Python interpreter to version 3.9 or higher.
• breaking In prawcore 3.0.0, the `RateLimiter` attribute `next_request_timestamp` was removed and replaced with `next_request_timestamp_ns`.
  Fix: Update code referencing `RateLimiter.next_request_timestamp` to use `RateLimiter.next_request_timestamp_ns` instead.
• gotcha Applications frequently encounter `prawcore.exceptions.OAuthException: invalid_grant`. This usually indicates an issue with your OAuth credentials (Client ID, Client Secret, Username, Password) or an active 2FA on the Reddit account preventing script access.
  Fix: Double-check your `client_id`, `client_secret`, `username`, and `password`. Ensure 2FA is disabled on the Reddit account if using password flow, or that refresh tokens are handled correctly for other flows. Also, verify your user agent is unique and descriptive.
• gotcha Encountering `prawcore.exceptions.Forbidden` (HTTP 403) means the authenticated user lacks permission for the requested action or resource, such as accessing private subreddits or replying to locked content.
  Fix: Verify the Reddit account associated with your credentials has the necessary permissions. Review the specific API endpoint documentation for required scopes and user roles.
• gotcha Older versions of prawcore had issues handling Reddit's rate limits, leading to frequent 429 (Too Many Requests) errors. While newer versions improved this, robust error handling for `prawcore.exceptions.ResponseException` and `prawcore.exceptions.RequestException` is crucial for stable bots.
  Fix: Ensure you are on the latest prawcore version. Implement `try-except` blocks for `prawcore.exceptions.ResponseException` (to check `response.status_code`) and `prawcore.exceptions.RequestException`, and incorporate retry logic with exponential backoff for network-related issues or rate limits.

Install

• pip install prawcore Install stable version

Imports

• prawcore

  import prawcore

• TrustedAuthenticator

  from prawcore import TrustedAuthenticator

• Requestor

  from prawcore import Requestor

• ReadOnlyAuthorizer

  from prawcore import ReadOnlyAuthorizer

• session

  from prawcore import session

Quickstart

This example demonstrates how to use prawcore to fetch a user's trophies. It assumes you have created a Reddit script application and set `PRAWCORE_CLIENT_ID` and `PRAWCORE_CLIENT_SECRET` environment variables. Replace 'YOUR_VALID_USER_AGENT' with a unique and descriptive user agent string.

import os
import pprint
import prawcore

# Ensure these environment variables are set before running:
# PRAWCORE_CLIENT_ID, PRAWCORE_CLIENT_SECRET

client_id = os.environ.get('PRAWCORE_CLIENT_ID', '')
client_secret = os.environ.get('PRAWCORE_CLIENT_SECRET', '')
user_agent = "YOUR_VALID_USER_AGENT"

if not client_id or not client_secret:
    print("Error: PRAWCORE_CLIENT_ID and PRAWCORE_CLIENT_SECRET environment variables must be set.")
    exit(1)

authenticator = prawcore.TrustedAuthenticator(
    prawcore.Requestor(user_agent),
    client_id,
    client_secret,
)
authorizer = prawcore.ReadOnlyAuthorizer(authenticator)
authorizer.refresh()

with prawcore.session(authorizer) as session:
    try:
        response = session.request("GET", "/api/v1/user/bboe/trophies")
        pprint.pprint(response)
    except prawcore.exceptions.ResponseException as e:
        print(f"API Error: {e.response.status_code} - {e.response.text}")
    except prawcore.exceptions.RequestException as e:
        print(f"Request Error: {e}")