cherrypy.lib package

Submodules

• cherrypy.lib.auth_basic module
  • _try_decode()
  • basic_auth()
  • checkpassword_dict()
• cherrypy.lib.auth_digest module
  • H()
  • HttpDigestAuthorization
    • HttpDigestAuthorization.HA2()
    • HttpDigestAuthorization.errmsg()
    • HttpDigestAuthorization.is_nonce_stale()
    • HttpDigestAuthorization.matches()
    • HttpDigestAuthorization.request_digest()
    • HttpDigestAuthorization.scheme
    • HttpDigestAuthorization.validate_nonce()
  • TRACE()
  • _get_charset_declaration()
  • _respond_401()
  • _try_decode_header()
  • digest_auth()
  • get_ha1_dict()
  • get_ha1_dict_plain()
  • get_ha1_file_htdigest()
  • md5_hex()
  • synthesize_nonce()
  • www_authenticate()
• cherrypy.lib.caching module
  • Usage
  • AntiStampedeCache
    • AntiStampedeCache.wait()
  • Cache
    • Cache.clear()
    • Cache.delete()
    • Cache.get()
    • Cache.put()
  • MemoryCache
    • MemoryCache.antistampede_timeout
    • MemoryCache.clear()
    • MemoryCache.debug
    • MemoryCache.delay
    • MemoryCache.delete()
    • MemoryCache.expire_cache()
    • MemoryCache.expire_freq
    • MemoryCache.get()
    • MemoryCache.maxobj_size
    • MemoryCache.maxobjects
    • MemoryCache.maxsize
    • MemoryCache.put()
  • expires()
  • get()
  • tee_output()
• cherrypy.lib.covercp module
  • CoverStats
    • CoverStats.annotated_file()
    • CoverStats.index()
    • CoverStats.menu()
    • CoverStats.report()
  • _graft()
  • _percent()
  • _show_branch()
  • _skip_file()
  • get_tree()
  • serve()
  • start()
• cherrypy.lib.cpstats module
  • Overview
    • Data Gathering
    • Extrapolation
    • Reporting
    • Monitoring
    • Turning Collection Off
  • Usage
  • ByteCountWrapper
    • ByteCountWrapper.close()
    • ByteCountWrapper.next()
    • ByteCountWrapper.read()
    • ByteCountWrapper.readline()
    • ByteCountWrapper.readlines()
  • StatsPage
    • StatsPage.data()
    • StatsPage.formatting
    • StatsPage.get_dict_collection()
    • StatsPage.get_list_collection()
    • StatsPage.get_namespaces()
    • StatsPage.index()
    • StatsPage.pause()
    • StatsPage.resume()
  • StatsTool
    • StatsTool._setup()
    • StatsTool.record_start()
    • StatsTool.record_stop()
  • _get_threading_ident()
  • average_uriset_time()
  • extrapolate_statistics()
  • iso_format()
  • locale_date()
  • pause_resume()
  • proc_time()
• cherrypy.lib.cptools module
  • MonitoredHeaderMap
    • MonitoredHeaderMap.transform_key()
  • SessionAuth
    • SessionAuth._debug_message()
    • SessionAuth.anonymous()
    • SessionAuth.check_username_and_password()
    • SessionAuth.debug
    • SessionAuth.do_check()
    • SessionAuth.do_login()
    • SessionAuth.do_logout()
    • SessionAuth.login_screen()
    • SessionAuth.on_check()
    • SessionAuth.on_login()
    • SessionAuth.on_logout()
    • SessionAuth.run()
    • SessionAuth.session_key
  • accept()
  • allow()
  • autovary()
  • convert_params()
  • flatten()
  • ignore_headers()
  • log_hooks()
  • log_request_headers()
  • log_traceback()
  • proxy()
  • redirect()
  • referer()
  • response_headers()
  • session_auth()
  • trailing_slash()
  • validate_etags()
  • validate_since()
• cherrypy.lib.encoding module
  • ResponseEncoder
    • ResponseEncoder.add_charset
    • ResponseEncoder.debug
    • ResponseEncoder.default_encoding
    • ResponseEncoder.encode_stream()
    • ResponseEncoder.encode_string()
    • ResponseEncoder.encoding
    • ResponseEncoder.errors
    • ResponseEncoder.failmsg
    • ResponseEncoder.find_acceptable_charset()
    • ResponseEncoder.text_only
  • UTF8StreamEncoder
    • UTF8StreamEncoder.close()
    • UTF8StreamEncoder.next()
  • compress()
  • decode()
  • decompress()
  • gzip()
  • prepare_iter()
• cherrypy.lib.gctools module
  • GCRoot
    • GCRoot.classes
    • GCRoot.index()
    • GCRoot.stats()
  • ReferrerTree
    • ReferrerTree._format()
    • ReferrerTree.ascend()
    • ReferrerTree.format()
    • ReferrerTree.peek()
    • ReferrerTree.peek_length
  • RequestCounter
    • RequestCounter.after_request()
    • RequestCounter.before_request()
    • RequestCounter.start()
  • get_context()
  • get_instances()
• cherrypy.lib.httputil module
  • AcceptElement
    • AcceptElement.from_str()
    • AcceptElement.qvalue
  • CaseInsensitiveDict
    • CaseInsensitiveDict.transform_key()
  • HeaderElement
    • HeaderElement.from_str()
    • HeaderElement.parse()
  • HeaderMap
    • HeaderMap.elements()
    • HeaderMap.encode()
    • HeaderMap.encode_header_item()
    • HeaderMap.encode_header_items()
    • HeaderMap.encodings
    • HeaderMap.output()
    • HeaderMap.protocol
    • HeaderMap.use_rfc_2047
    • HeaderMap.values()
  • Host
    • Host.ip
    • Host.name
    • Host.port
  • SanitizedHost
    • SanitizedHost._sanitize()
    • SanitizedHost.dangerous
  • _parse_qs()
  • decode_TEXT()
  • decode_TEXT_maybe()
  • get_ranges()
  • header_elements()
  • parse_query_string()
  • protocol_from_http()
  • urljoin()
  • urljoin_bytes()
  • valid_status()
• cherrypy.lib.jsontools module
  • json_handler()
  • json_in()
  • json_out()
  • json_processor()
• cherrypy.lib.locking module
  • LockChecker
    • LockChecker.expired()
  • LockTimeout
  • NeverExpires
    • NeverExpires.expired()
  • Timer
    • Timer.after()
    • Timer.expired()
• cherrypy.lib.profiler module
  • CherryPy users
  • CherryPy developers
  • ProfileAggregator
    • ProfileAggregator.run()
  • Profiler
    • Profiler.index()
    • Profiler.menu()
    • Profiler.report()
    • Profiler.run()
    • Profiler.statfiles()
    • Profiler.stats()
  • make_app
  • new_func_strip_path()
  • serve()
• cherrypy.lib.reprconf module
  • Namespaces
  • Config
    • Config._apply()
    • Config.defaults
    • Config.environments
    • Config.namespaces
    • Config.reset()
    • Config.update()
  • NamespaceSet
    • NamespaceSet.copy()
  • Parser
    • Parser._abc_cache
    • Parser._abc_negative_cache
    • Parser._abc_negative_cache_version
    • Parser._abc_registry
    • Parser.as_dict()
    • Parser.dict_from_file()
    • Parser.load()
    • Parser.optionxform()
    • Parser.read()
  • _Builder
    • _Builder._build_call35()
    • _Builder.astnode()
    • _Builder.build()
    • _Builder.build_Add()
    • _Builder.build_Attribute()
    • _Builder.build_BinOp()
    • _Builder.build_Call()
    • _Builder.build_Constant()
    • _Builder.build_Dict()
    • _Builder.build_Index()
    • _Builder.build_List()
    • _Builder.build_Mult()
    • _Builder.build_Name()
    • _Builder.build_NameConstant()
    • _Builder.build_NoneType()
    • _Builder.build_Num()
    • _Builder.build_Str()
    • _Builder.build_Subscript()
    • _Builder.build_Tuple()
    • _Builder.build_USub()
    • _Builder.build_UnaryOp()
  • attributes()
  • modules()
  • unrepr()
• cherrypy.lib.sessions module
  • Locking sessions
  • Expiring Sessions
  • Session Fixation Protection
  • Sharing Sessions
  • Expiration Dates
  • FileSession
    • FileSession.LOCK_SUFFIX
    • FileSession.SESSION_PREFIX
    • FileSession._delete()
    • FileSession._exists()
    • FileSession._get_file_path()
    • FileSession._load()
    • FileSession._save()
    • FileSession.acquire_lock()
    • FileSession.clean_up()
    • FileSession.pickle_protocol
    • FileSession.release_lock()
    • FileSession.setup()
  • MemcachedSession
    • MemcachedSession._delete()
    • MemcachedSession._exists()
    • MemcachedSession._load()
    • MemcachedSession._save()
    • MemcachedSession.acquire_lock()
    • MemcachedSession.locks
    • MemcachedSession.mc_lock
    • MemcachedSession.release_lock()
    • MemcachedSession.servers
    • MemcachedSession.setup()
  • RamSession
    • RamSession._delete()
    • RamSession._exists()
    • RamSession._load()
    • RamSession._save()
    • RamSession.acquire_lock()
    • RamSession.cache
    • RamSession.clean_up()
    • RamSession.locks
    • RamSession.release_lock()
  • Session
    • Session._id
    • Session._regenerate()
    • Session.clean_freq
    • Session.clean_thread
    • Session.clean_up()
    • Session.clear()
    • Session.debug
    • Session.delete()
    • Session.generate_id()
    • Session.get()
    • Session.id
    • Session.id_observers
    • Session.items()
    • Session.keys()
    • Session.load()
    • Session.loaded
    • Session.locked
    • Session.missing
    • Session.now()
    • Session.originalid
    • Session.pop()
    • Session.regenerate()
    • Session.regenerated
    • Session.save()
    • Session.setdefault()
    • Session.timeout
    • Session.update()
    • Session.values()
  • _add_MSIE_max_age_workaround()
  • close()
  • expire()
  • init()
  • save()
  • set_response_cookie()
• cherrypy.lib.static module
  • _attempt()
  • _make_content_disposition()
  • _serve_fileobj()
  • _setup_mimetypes()
  • serve_download()
  • serve_file()
  • serve_fileobj()
  • staticdir()
  • staticfile()
• cherrypy.lib.xmlrpcutil module
  • _set_response()
  • on_error()
  • patched_path()
  • process_body()
  • respond()

Module contents

CherryPy Library.

class cherrypy.lib.file_generator(input, chunkSize=65536)

Bases: object

Yield the given input (a file object) in chunks (default 64k).

(Core)

next()

Return next chunk of file.

cherrypy.lib.file_generator_limited(fileobj, count, chunk_size=65536)

Yield the given file object in chunks.

Stopps after count bytes has been emitted. Default chunk size is 64kB. (Core)

cherrypy.lib.is_closable_iterator(obj)

Detect if the given object is both closable and iterator.

cherrypy.lib.is_iterator(obj)

Detect if the object provided implements the iterator protocol.

(i.e. like a generator).

This will return False for objects which are iterable, but not iterators themselves.

cherrypy.lib.set_vary_header(response, header_name)

Add a Vary header to a response.