aiorequestful

📜 Guides & Getting Started

  • Installation
  • Sending requests
    • Sending simple requests
    • Handling the response payload
    • Authorising with the service
    • Caching responses
    • Handling error responses
    • Managing retries and backoff time
      • Retries and unsuccessful backoff time
      • Wait backoff time
      • Assignment on instantiation
  • Handling payload data
    • Basic usage
    • StringPayloadHandler
    • JSONPayloadHandler
    • Writing a PayloadHandler
  • Handling error responses
    • Basic usage
    • Supported status handlers
      • ClientErrorStatusHandler
      • UnauthorisedStatusHandler
      • RateLimitStatusHandler
    • Writing a StatusHandler
  • Authorising requests
    • Basic usage
    • Basic Authorisation
    • OAuth2Authoriser
      • ClientCredentialsFlow
      • AuthorisationCodeFlow
      • AuthorisationCodePKCEFlow
    • Utilities
      • AuthRequest
      • AuthResponse
      • AuthTester
      • SocketHandler
    • Writing an Authoriser
  • Caching responses
    • Core concepts and usage
      • ResponseRepositorySettings
      • ResponseRepository
      • ResponseCache
    • Cached sessions and responses
      • CachedResponse
      • CachedSession
    • SQLite
      • SQLiteTable
      • SQLiteCache
    • Writing a ResponseRepository
    • Writing a ResponseCache
  • Timers
    • Basic usage
    • CountTimer
      • StepCountTimer
      • GeometricCountTimer
      • PowerCountTimer
    • CeilingTimer
      • StepCeilingTimer
      • GeometricCeilingTimer
      • PowerCeilingTimer
    • Writing a Timer

🛠️ Project Info

  • Release History
    • 1.0.20
      • Fixed
    • 1.0.19
      • Fixed
    • 1.0.18
      • Fixed
    • 1.0.17
      • Changed
    • 1.0.16
      • Fixed
    • 1.0.15
      • Fixed
    • 1.0.14
      • Fixed
    • 1.0.13
      • Fixed
    • 1.0.12
      • Changed
    • 1.0.11
      • Added
    • 1.0.10
      • Added
      • Removed
    • 1.0.9
      • Changed
    • 1.0.8
      • Fixed
    • 1.0.7
      • Changed
    • 1.0.6
      • Fixed
    • 1.0.5
      • Fixed
    • 1.0.4
      • Fixed
    • 1.0.3
      • Fixed
    • 1.0.2
      • Changed
    • 1.0.1
      • Fixed
    • 1.0.0
      • Changed
      • Documentation
    • 0.6.1
      • Added
      • Documentation
    • 0.6.0
      • Changed
      • Fixed
    • 0.5.2
      • Fixed
    • 0.5.1
      • Changed
      • Fixed
    • 0.5.0
      • Changed
      • Removed
      • Documentation
    • 0.4.0
      • Changed
      • Documentation
    • 0.3.1
      • Added
      • Changed
    • 0.3.0
      • Changed
      • Removed
    • 0.2.1
      • Fixed
    • 0.2.0
      • Added
      • Changed
    • 0.1.1
      • Changed
    • 0.1.0
  • Contributing
    • Setup your development environment
    • Making changes and testing
    • Submitting your changes for review
  • Licence

📖 Reference

  • Auth
    • Base
      • Authoriser
        • Authoriser.logger
        • Authoriser.service_name
        • Authoriser.authorise()
    • Basic
      • BasicAuthoriser
        • BasicAuthoriser.login
        • BasicAuthoriser.password
        • BasicAuthoriser.encoding
        • BasicAuthoriser.authorise()
    • Exceptions
      • AuthoriserError
    • Oauth2
      • OAuth2Authoriser
        • OAuth2Authoriser.is_token_valid
        • OAuth2Authoriser.token_request
        • OAuth2Authoriser.response
        • OAuth2Authoriser.tester
      • ClientCredentialsFlow
        • ClientCredentialsFlow.create()
        • ClientCredentialsFlow.create_with_encoded_credentials()
        • ClientCredentialsFlow.authorise()
      • AuthorisationCodeFlow
        • AuthorisationCodeFlow.create()
        • AuthorisationCodeFlow.create_with_encoded_credentials()
        • AuthorisationCodeFlow.user_request
        • AuthorisationCodeFlow.refresh_request
        • AuthorisationCodeFlow.redirect_uri
        • AuthorisationCodeFlow.socket_handler
        • AuthorisationCodeFlow.authorise()
      • AuthorisationCodePKCEFlow
        • AuthorisationCodePKCEFlow.create()
        • AuthorisationCodePKCEFlow.code_verifier
    • Utils
      • AuthRequest
        • AuthRequest.payload
        • AuthRequest.method
        • AuthRequest.url
        • AuthRequest.set_payload_type()
        • AuthRequest.enrich_payload()
        • AuthRequest.enrich_headers()
        • AuthRequest.request()
        • AuthRequest.params
        • AuthRequest.data
        • AuthRequest.json
        • AuthRequest.cookies
        • AuthRequest.headers
        • AuthRequest.skip_auto_headers
        • AuthRequest.auth
        • AuthRequest.allow_redirects
        • AuthRequest.max_redirects
        • AuthRequest.compress
        • AuthRequest.chunked
        • AuthRequest.expect100
        • AuthRequest.raise_for_status
        • AuthRequest.read_until_eof
        • AuthRequest.proxy
        • AuthRequest.proxy_auth
        • AuthRequest.timeout
        • AuthRequest.verify_ssl
        • AuthRequest.fingerprint
        • AuthRequest.ssl_context
        • AuthRequest.ssl
        • AuthRequest.server_hostname
        • AuthRequest.proxy_headers
        • AuthRequest.trace_request_ctx
        • AuthRequest.read_bufsize
        • AuthRequest.auto_decompress
        • AuthRequest.max_line_size
        • AuthRequest.max_field_size
      • AuthResponse
        • AuthResponse.token
        • AuthResponse.headers
        • AuthResponse.sanitised
        • AuthResponse.logger
        • AuthResponse.file_path
        • AuthResponse.token_key
        • AuthResponse.token_prefix_default
        • AuthResponse.additional_headers
        • AuthResponse.replace()
        • AuthResponse.enrich()
        • AuthResponse.load_response_from_file()
        • AuthResponse.save_response_to_file()
      • AuthTester
        • AuthTester.logger
        • AuthTester.request
        • AuthTester.response_test
        • AuthTester.max_expiry
        • AuthTester.test()
      • SocketHandler
        • SocketHandler.port
        • SocketHandler.timeout
  • Cache
    • Backend
      • Base
        • ResponseRepositorySettings
          • ResponseRepositorySettings.name
          • ResponseRepositorySettings.payload_handler
          • ResponseRepositorySettings.fields
          • ResponseRepositorySettings.get_key()
          • ResponseRepositorySettings.get_name()
        • ResponseRepository
          • ResponseRepository.expire
          • ResponseRepository.create()
          • ResponseRepository.logger
          • ResponseRepository.settings
          • ResponseRepository.connection
          • ResponseRepository.commit()
          • ResponseRepository.close()
          • ResponseRepository.count()
          • ResponseRepository.contains()
          • ResponseRepository.clear()
          • ResponseRepository.serialize()
          • ResponseRepository.deserialize()
          • ResponseRepository.get_key_from_request()
          • ResponseRepository.get_response()
          • ResponseRepository.get_responses()
          • ResponseRepository.save_response()
          • ResponseRepository.save_responses()
          • ResponseRepository.delete_response()
          • ResponseRepository.delete_responses()
        • ResponseCache
          • ResponseCache.type
          • ResponseCache.connect()
          • ResponseCache.cache_name
          • ResponseCache.repository_getter
          • ResponseCache.expire
          • ResponseCache.commit()
          • ResponseCache.close()
          • ResponseCache.create_repository()
          • ResponseCache.get_repository_from_url()
          • ResponseCache.get_repository_from_requests()
          • ResponseCache.get_response()
          • ResponseCache.get_responses()
          • ResponseCache.save_response()
          • ResponseCache.save_responses()
          • ResponseCache.delete_response()
          • ResponseCache.delete_responses()
    • Exceptions
      • CacheError
    • Response
      • CachedResponse
    • Session
      • CachedSession
        • CachedSession.logger
        • CachedSession.cache
        • CachedSession.request()
  • Request
    • RequestHandler
      • RequestHandler.closed
      • RequestHandler.session
      • RequestHandler.retry_timer
      • RequestHandler.create()
      • RequestHandler.logger
      • RequestHandler.authoriser
      • RequestHandler.payload_handler
      • RequestHandler.response_handlers
      • RequestHandler.wait_timer
      • RequestHandler.authorise()
      • RequestHandler.close()
      • RequestHandler.log()
      • RequestHandler.request()
      • RequestHandler.get()
      • RequestHandler.post()
      • RequestHandler.put()
      • RequestHandler.delete()
      • RequestHandler.options()
      • RequestHandler.head()
      • RequestHandler.patch()
  • Response
    • Exceptions
      • ResponseError
      • PayloadHandlerError
      • StatusHandlerError
    • Payload
      • PayloadHandler
        • PayloadHandler.serialize()
        • PayloadHandler.deserialize()
      • StringPayloadHandler
        • StringPayloadHandler.serialize()
        • StringPayloadHandler.deserialize()
      • BytesPayloadHandler
        • BytesPayloadHandler.encoding
        • BytesPayloadHandler.serialize()
        • BytesPayloadHandler.deserialize()
      • JSONPayloadHandler
        • JSONPayloadHandler.indent
        • JSONPayloadHandler.serialize()
        • JSONPayloadHandler.deserialize()
    • Status
      • StatusHandler
        • StatusHandler.status_codes
        • StatusHandler.logger
        • StatusHandler.match()
        • StatusHandler.handle()
      • ClientErrorStatusHandler
        • ClientErrorStatusHandler.status_codes
        • ClientErrorStatusHandler.handle()
      • UnauthorisedStatusHandler
        • UnauthorisedStatusHandler.status_codes
        • UnauthorisedStatusHandler.handle()
      • RateLimitStatusHandler
        • RateLimitStatusHandler.status_codes
        • RateLimitStatusHandler.handle()
  • Exceptions
    • AIORequestfulError
    • InputError
    • AIORequestfulImportError
    • HTTPError
    • RequestError
  • Timer
    • Timer
      • Timer.initial
      • Timer.final
      • Timer.total
      • Timer.total_remaining
      • Timer.count
      • Timer.counter
      • Timer.count_remaining
      • Timer.can_increase
      • Timer.increase()
      • Timer.reset()
      • Timer.wait()
    • CountTimer
      • CountTimer.count
      • CountTimer.can_increase
    • StepCountTimer
      • StepCountTimer.final
      • StepCountTimer.total
      • StepCountTimer.total_remaining
      • StepCountTimer.step
      • StepCountTimer.increase()
    • GeometricCountTimer
      • GeometricCountTimer.final
      • GeometricCountTimer.total
      • GeometricCountTimer.total_remaining
      • GeometricCountTimer.factor
      • GeometricCountTimer.increase()
    • PowerCountTimer
      • PowerCountTimer.final
      • PowerCountTimer.total
      • PowerCountTimer.total_remaining
      • PowerCountTimer.exponent
      • PowerCountTimer.increase()
    • CeilingTimer
      • CeilingTimer.final
      • CeilingTimer.total
      • CeilingTimer.total_remaining
      • CeilingTimer.count
      • CeilingTimer.can_increase
    • StepCeilingTimer
      • StepCeilingTimer.step
      • StepCeilingTimer.increase()
    • GeometricCeilingTimer
      • GeometricCeilingTimer.factor
      • GeometricCeilingTimer.increase()
    • PowerCeilingTimer
      • PowerCeilingTimer.exponent
      • PowerCeilingTimer.increase()
  • Types
    • RequestKwargs
      • RequestKwargs.method
      • RequestKwargs.url
      • RequestKwargs.params
      • RequestKwargs.data
      • RequestKwargs.json
      • RequestKwargs.cookies
      • RequestKwargs.headers
      • RequestKwargs.skip_auto_headers
      • RequestKwargs.auth
      • RequestKwargs.allow_redirects
      • RequestKwargs.max_redirects
      • RequestKwargs.compress
      • RequestKwargs.chunked
      • RequestKwargs.expect100
      • RequestKwargs.raise_for_status
      • RequestKwargs.read_until_eof
      • RequestKwargs.proxy
      • RequestKwargs.proxy_auth
      • RequestKwargs.timeout
      • RequestKwargs.verify_ssl
      • RequestKwargs.fingerprint
      • RequestKwargs.ssl_context
      • RequestKwargs.ssl
      • RequestKwargs.server_hostname
      • RequestKwargs.proxy_headers
      • RequestKwargs.trace_request_ctx
      • RequestKwargs.read_bufsize
      • RequestKwargs.auto_decompress
      • RequestKwargs.max_line_size
      • RequestKwargs.max_field_size
  • Index
aiorequestful
  • Search

© Copyright 2025, George Martin Marino.

Built with Sphinx using a theme provided by Read the Docs.