circuits.web package

Subpackages

• circuits.web.dispatchers package
  • Submodules
    • circuits.web.dispatchers.dispatcher module
      • resolve_path()
      • resolve_methods()
      • find_handlers()
      • Dispatcher
        • Dispatcher.channel
    • circuits.web.dispatchers.jsonrpc module
      • rpc
      • JSONRPC
        • JSONRPC.channel
    • circuits.web.dispatchers.static module
      • Static
        • Static.channel
    • circuits.web.dispatchers.virtualhosts module
      • VirtualHosts
        • VirtualHosts.channel
    • circuits.web.dispatchers.xmlrpc module
      • rpc
      • XMLRPC
        • XMLRPC.channel
  • Module contents
• circuits.web.parsers package
  • Submodules
    • circuits.web.parsers.http module
      • InvalidRequestLine
      • InvalidHeader
      • InvalidChunkSize
      • HttpParser
        • HttpParser.get_version()
        • HttpParser.get_method()
        • HttpParser.get_status_code()
        • HttpParser.get_url()
        • HttpParser.get_scheme()
        • HttpParser.get_path()
        • HttpParser.get_query_string()
        • HttpParser.get_headers()
        • HttpParser.recv_body()
        • HttpParser.recv_body_into()
        • HttpParser.is_upgrade()
        • HttpParser.is_headers_complete()
        • HttpParser.is_partial_body()
        • HttpParser.is_message_begin()
        • HttpParser.is_message_complete()
        • HttpParser.is_chunked()
        • HttpParser.should_keep_alive()
        • HttpParser.execute()
    • circuits.web.parsers.multipart module
      • Parser for multipart/form-data
        • Licence (MIT)
      • MultiDict
        • MultiDict.keys()
        • MultiDict.append()
        • MultiDict.replace()
        • MultiDict.getall()
        • MultiDict.get()
        • MultiDict.iterallitems()
      • tob()
      • copy_file()
      • header_quote()
      • header_unquote()
      • parse_options_header()
      • MultipartError
      • MultipartParser
        • MultipartParser.parts()
        • MultipartParser.get()
        • MultipartParser.get_all()
      • MultipartPart
        • MultipartPart.feed()
        • MultipartPart.write_header()
        • MultipartPart.write_body()
        • MultipartPart.finish_header()
        • MultipartPart.is_buffered()
        • MultipartPart.value
        • MultipartPart.save_as()
      • parse_form_data()
    • circuits.web.parsers.querystring module
      • QueryStringToken
        • QueryStringToken.ARRAY
        • QueryStringToken.OBJECT
        • QueryStringToken.KEY
      • QueryStringParser
        • QueryStringParser.process()
        • QueryStringParser.parse()
        • QueryStringParser.tokens()
  • Module contents
• circuits.web.websockets package
  • Submodules
    • circuits.web.websockets.client module
      • WebSocketClient
        • WebSocketClient.channel
        • WebSocketClient.close()
        • WebSocketClient.connected
    • circuits.web.websockets.dispatcher module
      • WebSocketsDispatcher
        • WebSocketsDispatcher.channel
        • WebSocketsDispatcher.select_subprotocol()
  • Module contents

Submodules

• circuits.web.client module
  • parse_url()
  • HTTPException
  • NotConnected
  • request
  • Client
    • Client.channel
    • Client.write()
    • Client.close()
    • Client.connect()
    • Client.request()
    • Client.connected
    • Client.response
• circuits.web.constants module
• circuits.web.controllers module
  • expose()
  • ExposeMetaClass
  • BaseController
    • BaseController.channel
    • BaseController.uri
    • BaseController.forbidden()
    • BaseController.notfound()
    • BaseController.redirect()
    • BaseController.serve_file()
    • BaseController.serve_download()
    • BaseController.expires()
  • Controller
  • exposeJSON()
  • ExposeJSONMetaClass
  • JSONController
• circuits.web.errors module
  • httperror
    • httperror.code
    • httperror.description
    • httperror.sanitize()
  • forbidden
    • forbidden.code
  • unauthorized
    • unauthorized.code
  • notfound
    • notfound.code
  • redirect
• circuits.web.events module
  • request
    • request.success
    • request.failure
    • request.complete
  • response
    • response.success
    • response.failure
    • response.complete
  • stream
    • stream.success
    • stream.failure
    • stream.complete
  • terminate
• circuits.web.exceptions module
  • BadGateway
    • BadGateway.code
    • BadGateway.description
  • BadRequest
    • BadRequest.code
    • BadRequest.description
  • Forbidden
    • Forbidden.code
    • Forbidden.description
  • Gone
    • Gone.code
    • Gone.description
  • HTTPException
    • HTTPException.code
    • HTTPException.description
    • HTTPException.traceback
    • HTTPException.name
  • InternalServerError
    • InternalServerError.code
    • InternalServerError.description
  • LengthRequired
    • LengthRequired.code
    • LengthRequired.description
  • MethodNotAllowed
    • MethodNotAllowed.code
  • NotAcceptable
    • NotAcceptable.code
    • NotAcceptable.description
  • NotFound
    • NotFound.code
    • NotFound.description
  • NotImplemented
    • NotImplemented.code
    • NotImplemented.description
  • PreconditionFailed
    • PreconditionFailed.code
    • PreconditionFailed.description
  • RangeUnsatisfiable
    • RangeUnsatisfiable.code
    • RangeUnsatisfiable.description
  • Redirect
    • Redirect.code
  • RequestEntityTooLarge
    • RequestEntityTooLarge.code
    • RequestEntityTooLarge.description
  • RequestTimeout
    • RequestTimeout.code
    • RequestTimeout.description
  • RequestURITooLarge
    • RequestURITooLarge.code
    • RequestURITooLarge.description
  • ServiceUnavailable
    • ServiceUnavailable.code
    • ServiceUnavailable.description
  • Unauthorized
    • Unauthorized.code
    • Unauthorized.description
  • UnicodeError
  • UnsupportedMediaType
    • UnsupportedMediaType.code
    • UnsupportedMediaType.description
• circuits.web.headers module
  • header_elements()
  • HeaderElement
    • HeaderElement.parse()
    • HeaderElement.from_str()
  • AcceptElement
    • AcceptElement.from_str()
    • AcceptElement.qvalue
  • CaseInsensitiveDict
    • CaseInsensitiveDict.get()
    • CaseInsensitiveDict.update()
    • CaseInsensitiveDict.fromkeys()
    • CaseInsensitiveDict.setdefault()
    • CaseInsensitiveDict.pop()
  • Headers
    • Headers.elements()
    • Headers.get_all()
    • Headers.items()
    • Headers.append()
    • Headers.add_header()
• circuits.web.http module
  • HTTP
    • HTTP.channel
    • HTTP.version
    • HTTP.protocol
    • HTTP.scheme
    • HTTP.base
    • HTTP.uri
• circuits.web.loggers module
  • formattime()
  • Logger
    • Logger.channel
    • Logger.format
    • Logger.log_response()
    • Logger.log()
• circuits.web.main module
  • parse_options()
  • Authentication
    • Authentication.channel
    • Authentication.realm
    • Authentication.users
    • Authentication.request()
  • HelloWorld
    • HelloWorld.channel
    • HelloWorld.request()
  • Root
    • Root.hello()
  • select_poller()
  • parse_bind()
  • main()
• circuits.web.processors module
  • process_multipart()
  • process_urlencoded()
  • process()
• circuits.web.servers module
  • BaseServer
    • BaseServer.channel
    • BaseServer.host
    • BaseServer.port
    • BaseServer.display_banner
    • BaseServer.secure
  • Server
  • FakeSock
    • FakeSock.getpeername()
  • StdinServer
    • StdinServer.channel
    • StdinServer.host
    • StdinServer.port
    • StdinServer.secure
    • StdinServer.read()
    • StdinServer.write()
• circuits.web.sessions module
  • who()
  • create_session()
  • verify_session()
  • Session
    • Session.sid
    • Session.store
    • Session.expire()
  • Store
    • Store.delete()
    • Store.load()
    • Store.save()
  • MemoryStore
    • MemoryStore.data
    • MemoryStore.delete()
    • MemoryStore.load()
    • MemoryStore.save()
  • Sessions
    • Sessions.channel
    • Sessions.name
    • Sessions.store
    • Sessions.request()
• circuits.web.tools module
  • expires()
  • serve_file()
  • serve_download()
  • validate_etags()
  • validate_since()
  • check_auth()
  • basic_auth()
  • digest_auth()
  • gzip()
  • ReverseProxy
    • ReverseProxy.headers
    • ReverseProxy.init()
• circuits.web.url module
  • parse_url()
  • URL
    • URL.parse()
    • URL.equiv()
    • URL.canonical()
    • URL.defrag()
    • URL.deparam()
    • URL.abspath()
    • URL.lower()
    • URL.sanitize()
    • URL.escape()
    • URL.unescape()
    • URL.encode()
    • URL.relative()
    • URL.punycode()
    • URL.unpunycode()
    • URL.absolute()
    • URL.unicode()
    • URL.utf8()
• circuits.web.utils module
  • is_unix_socket()
  • average()
  • variance()
  • stddev()
  • parse_qs()
  • compress()
  • get_ranges()
• circuits.web.wrappers module
  • file_generator()
  • Host
    • Host.ip
    • Host.port
    • Host.name
  • HTTPStatus
    • HTTPStatus.status
    • HTTPStatus.reason
  • Request
    • Request.index
    • Request.script_name
    • Request.login
    • Request.handled
    • Request.scheme
    • Request.protocol
    • Request.server
    • Request.remote
    • Request.local
    • Request.host
  • Body
    • Body.encode_errors
  • Status
  • Response
    • Response.body
    • Response.status
    • Response.done
    • Response.close
    • Response.stream
    • Response.chunked
    • Response.prepare()
• circuits.web.wsgi module
  • create_environ()
  • Application
    • Application.channel
    • Application.headerNames
    • Application.init()
    • Application.translateHeaders()
    • Application.getRequestResponse()
    • Application.on_response()
    • Application.host
    • Application.port
    • Application.secure
  • Gateway
    • Gateway.channel
    • Gateway.init()

Module contents

Circuits Library - Web

circuits.web contains the circuits full stack web server that is HTTP and WSGI compliant.