cherrypy: 18.8.0 -> 6387a2b

lib/cherrypy/lib/__init__.py

@@ -6,8 +6,8 @@ def is_iterator(obj):
 
     (i.e. like a generator).
 
-    This will return False for objects which are iterable,
-    but not iterators themselves.
+    This will return False for objects which are iterable, but not
+    iterators themselves.
     """
     from types import GeneratorType
     if isinstance(obj, GeneratorType):

lib/cherrypy/lib/auth_basic.py

@@ -18,7 +18,6 @@ as the credentials store::
                   'tools.auth_basic.accept_charset': 'UTF-8',
     }
     app_config = { '/' : basic_auth }
-
 """
 
 import binascii

lib/cherrypy/lib/auth_digest.py

@@ -55,7 +55,7 @@ def TRACE(msg):
 
 
 def get_ha1_dict_plain(user_password_dict):
-    """Returns a get_ha1 function which obtains a plaintext password from a
+    """Return a get_ha1 function which obtains a plaintext password from a
     dictionary of the form: {username : password}.
 
     If you want a simple dictionary-based authentication scheme, with plaintext
@@ -72,7 +72,7 @@ def get_ha1_dict_plain(user_password_dict):
 
 
 def get_ha1_dict(user_ha1_dict):
-    """Returns a get_ha1 function which obtains a HA1 password hash from a
+    """Return a get_ha1 function which obtains a HA1 password hash from a
     dictionary of the form: {username : HA1}.
 
     If you want a dictionary-based authentication scheme, but with
@@ -87,7 +87,7 @@ def get_ha1_dict(user_ha1_dict):
 
 
 def get_ha1_file_htdigest(filename):
-    """Returns a get_ha1 function which obtains a HA1 password hash from a
+    """Return a get_ha1 function which obtains a HA1 password hash from a
     flat file with lines of the same format as that produced by the Apache
     htdigest utility. For example, for realm 'wonderland', username 'alice',
     and password '4x5istwelve', the htdigest line would be::
@@ -135,7 +135,7 @@ def synthesize_nonce(s, key, timestamp=None):
 
 
 def H(s):
-    """The hash function H"""
+    """The hash function H."""
     return md5_hex(s)
 
 
@@ -259,10 +259,11 @@ class HttpDigestAuthorization(object):
         return False
 
     def is_nonce_stale(self, max_age_seconds=600):
-        """Returns True if a validated nonce is stale. The nonce contains a
-        timestamp in plaintext and also a secure hash of the timestamp.
-        You should first validate the nonce to ensure the plaintext
-        timestamp is not spoofed.
+        """Return True if a validated nonce is stale.
+
+        The nonce contains a timestamp in plaintext and also a secure
+        hash of the timestamp. You should first validate the nonce to
+        ensure the plaintext timestamp is not spoofed.
         """
         try:
             timestamp, hashpart = self.nonce.split(':', 1)
@@ -275,7 +276,10 @@ class HttpDigestAuthorization(object):
         return True
 
     def HA2(self, entity_body=''):
-        """Returns the H(A2) string. See :rfc:`2617` section 3.2.2.3."""
+        """Return the H(A2) string.
+
+        See :rfc:`2617` section 3.2.2.3.
+        """
         # RFC 2617 3.2.2.3
         # If the "qop" directive's value is "auth" or is unspecified,
         # then A2 is:
@@ -306,7 +310,6 @@ class HttpDigestAuthorization(object):
             4.3.  This refers to the entity the user agent sent in the
             request which has the Authorization header. Typically GET
             requests don't have an entity, and POST requests do.
-
         """
         ha2 = self.HA2(entity_body)
         # Request-Digest -- RFC 2617 3.2.2.1
@@ -395,7 +398,6 @@ def digest_auth(realm, get_ha1, key, debug=False, accept_charset='utf-8'):
     key
         A secret string known only to the server, used in the synthesis
         of nonces.
-
     """
     request = cherrypy.serving.request
 
@@ -447,9 +449,7 @@ def digest_auth(realm, get_ha1, key, debug=False, accept_charset='utf-8'):
 
 
 def _respond_401(realm, key, accept_charset, debug, **kwargs):
-    """
-    Respond with 401 status and a WWW-Authenticate header
-    """
+    """Respond with 401 status and a WWW-Authenticate header."""
     header = www_authenticate(
         realm, key,
         accept_charset=accept_charset,

lib/cherrypy/lib/caching.py

@@ -42,7 +42,6 @@ from cherrypy.lib import cptools, httputil
 
 
 class Cache(object):
-
     """Base class for Cache implementations."""
 
     def get(self):
@@ -64,17 +63,16 @@ class Cache(object):
 
 # ------------------------------ Memory Cache ------------------------------- #
 class AntiStampedeCache(dict):
-
     """A storage system for cached items which reduces stampede collisions."""
 
     def wait(self, key, timeout=5, debug=False):
         """Return the cached value for the given key, or None.
 
-        If timeout is not None, and the value is already
-        being calculated by another thread, wait until the given timeout has
-        elapsed. If the value is available before the timeout expires, it is
-        returned. If not, None is returned, and a sentinel placed in the cache
-        to signal other threads to wait.
+        If timeout is not None, and the value is already being
+        calculated by another thread, wait until the given timeout has
+        elapsed. If the value is available before the timeout expires,
+        it is returned. If not, None is returned, and a sentinel placed
+        in the cache to signal other threads to wait.
 
         If timeout is None, no waiting is performed nor sentinels used.
         """
@@ -127,7 +125,6 @@ class AntiStampedeCache(dict):
 
 
 class MemoryCache(Cache):
-
     """An in-memory cache for varying response content.
 
     Each key in self.store is a URI, and each value is an AntiStampedeCache.
@@ -381,7 +378,10 @@ def get(invalid_methods=('POST', 'PUT', 'DELETE'), debug=False, **kwargs):
 
 
 def tee_output():
-    """Tee response output to cache storage. Internal."""
+    """Tee response output to cache storage.
+
+    Internal.
+    """
     # Used by CachingTool by attaching to request.hooks
 
     request = cherrypy.serving.request
@@ -441,7 +441,6 @@ def expires(secs=0, force=False, debug=False):
             * Expires
 
         If any are already present, none of the above response headers are set.
-
     """
 
     response = cherrypy.serving.response

lib/cherrypy/lib/cpstats.py

@@ -184,7 +184,6 @@ To report statistics::
 To format statistics reports::
 
     See 'Reporting', above.
-
 """
 
 import logging
@@ -254,7 +253,6 @@ def proc_time(s):
 
 
 class ByteCountWrapper(object):
-
     """Wraps a file-like object, counting the number of bytes read."""
 
     def __init__(self, rfile):
@@ -307,7 +305,6 @@ def _get_threading_ident():
 
 
 class StatsTool(cherrypy.Tool):
-
     """Record various information about the current request."""
 
     def __init__(self):
@@ -316,8 +313,8 @@ class StatsTool(cherrypy.Tool):
     def _setup(self):
         """Hook this tool into cherrypy.request.
 
-        The standard CherryPy request object will automatically call this
-        method when the tool is "turned on" in config.
+        The standard CherryPy request object will automatically call
+        this method when the tool is "turned on" in config.
         """
         if appstats.get('Enabled', False):
             cherrypy.Tool._setup(self)

lib/cherrypy/lib/cptools.py

@@ -94,8 +94,8 @@ def validate_etags(autotags=False, debug=False):
 def validate_since():
     """Validate the current Last-Modified against If-Modified-Since headers.
 
-    If no code has set the Last-Modified response header, then no validation
-    will be performed.
+    If no code has set the Last-Modified response header, then no
+    validation will be performed.
     """
     response = cherrypy.serving.response
     lastmod = response.headers.get('Last-Modified')
@@ -123,9 +123,9 @@ def validate_since():
 def allow(methods=None, debug=False):
     """Raise 405 if request.method not in methods (default ['GET', 'HEAD']).
 
-    The given methods are case-insensitive, and may be in any order.
-    If only one method is allowed, you may supply a single string;
-    if more than one, supply a list of strings.
+    The given methods are case-insensitive, and may be in any order. If
+    only one method is allowed, you may supply a single string; if more
+    than one, supply a list of strings.
 
     Regardless of whether the current method is allowed or not, this
     also emits an 'Allow' response header, containing the given methods.
@@ -154,22 +154,23 @@ def proxy(base=None, local='X-Forwarded-Host', remote='X-Forwarded-For',
           scheme='X-Forwarded-Proto', debug=False):
     """Change the base URL (scheme://host[:port][/path]).
 
-    For running a CP server behind Apache, lighttpd, or other HTTP server.
+    For running a CP server behind Apache, lighttpd, or other HTTP
+    server.
 
-    For Apache and lighttpd, you should leave the 'local' argument at the
-    default value of 'X-Forwarded-Host'. For Squid, you probably want to set
-    tools.proxy.local = 'Origin'.
+    For Apache and lighttpd, you should leave the 'local' argument at
+    the default value of 'X-Forwarded-Host'. For Squid, you probably
+    want to set tools.proxy.local = 'Origin'.
 
-    If you want the new request.base to include path info (not just the host),
-    you must explicitly set base to the full base path, and ALSO set 'local'
-    to '', so that the X-Forwarded-Host request header (which never includes
-    path info) does not override it. Regardless, the value for 'base' MUST
-    NOT end in a slash.
+    If you want the new request.base to include path info (not just the
+    host), you must explicitly set base to the full base path, and ALSO
+    set 'local' to '', so that the X-Forwarded-Host request header
+    (which never includes path info) does not override it. Regardless,
+    the value for 'base' MUST NOT end in a slash.
 
     cherrypy.request.remote.ip (the IP address of the client) will be
-    rewritten if the header specified by the 'remote' arg is valid.
-    By default, 'remote' is set to 'X-Forwarded-For'. If you do not
-    want to rewrite remote.ip, set the 'remote' arg to an empty string.
+    rewritten if the header specified by the 'remote' arg is valid. By
+    default, 'remote' is set to 'X-Forwarded-For'. If you do not want to
+    rewrite remote.ip, set the 'remote' arg to an empty string.
     """
 
     request = cherrypy.serving.request
@@ -217,8 +218,8 @@ def proxy(base=None, local='X-Forwarded-Host', remote='X-Forwarded-For',
 def ignore_headers(headers=('Range',), debug=False):
     """Delete request headers whose field names are included in 'headers'.
 
-    This is a useful tool for working behind certain HTTP servers;
-    for example, Apache duplicates the work that CP does for 'Range'
+    This is a useful tool for working behind certain HTTP servers; for
+    example, Apache duplicates the work that CP does for 'Range'
     headers, and will doubly-truncate the response.
     """
     request = cherrypy.serving.request
@@ -281,7 +282,6 @@ def referer(pattern, accept=True, accept_missing=False, error=403,
 
 
 class SessionAuth(object):
-
     """Assert that the user is logged in."""
 
     session_key = 'username'
@@ -319,7 +319,10 @@ Message: %(error_msg)s
 </body></html>""") % vars()).encode('utf-8')
 
     def do_login(self, username, password, from_page='..', **kwargs):
-        """Login. May raise redirect, or return True if request handled."""
+        """Login.
+
+        May raise redirect, or return True if request handled.
+        """
         response = cherrypy.serving.response
         error_msg = self.check_username_and_password(username, password)
         if error_msg:
@@ -336,7 +339,10 @@ Message: %(error_msg)s
             raise cherrypy.HTTPRedirect(from_page or '/')
 
     def do_logout(self, from_page='..', **kwargs):
-        """Logout. May raise redirect, or return True if request handled."""
+        """Logout.
+
+        May raise redirect, or return True if request handled.
+        """
         sess = cherrypy.session
         username = sess.get(self.session_key)
         sess[self.session_key] = None
@@ -346,7 +352,9 @@ Message: %(error_msg)s
         raise cherrypy.HTTPRedirect(from_page)
 
     def do_check(self):
-        """Assert username. Raise redirect, or return True if request handled.
+        """Assert username.
+
+        Raise redirect, or return True if request handled.
         """
         sess = cherrypy.session
         request = cherrypy.serving.request
@@ -408,8 +416,7 @@ def session_auth(**kwargs):
 
     Any attribute of the SessionAuth class may be overridden
     via a keyword arg to this function:
-
-    """ + '\n    '.join(
+    """ + '\n' + '\n    '.join(
         '{!s}: {!s}'.format(k, type(getattr(SessionAuth, k)).__name__)
         for k in dir(SessionAuth)
         if not k.startswith('__')
@@ -490,8 +497,8 @@ def trailing_slash(missing=True, extra=False, status=None, debug=False):
 def flatten(debug=False):
     """Wrap response.body in a generator that recursively iterates over body.
 
-    This allows cherrypy.response.body to consist of 'nested generators';
-    that is, a set of generators that yield generators.
+    This allows cherrypy.response.body to consist of 'nested
+    generators'; that is, a set of generators that yield generators.
     """
     def flattener(input):
         numchunks = 0
@@ -622,13 +629,15 @@ def autovary(ignore=None, debug=False):
 
 
 def convert_params(exception=ValueError, error=400):
-    """Convert request params based on function annotations, with error handling.
+    """Convert request params based on function annotations.
 
-    exception
-        Exception class to catch.
+    This function also processes errors that are subclasses of ``exception``.
 
-    status
-        The HTTP error code to return to the client on failure.
+    :param BaseException exception: Exception class to catch.
+    :type exception: BaseException
+
+    :param error: The HTTP status code to return to the client on failure.
+    :type error: int
     """
     request = cherrypy.serving.request
     types = request.handler.callable.__annotations__

lib/cherrypy/lib/encoding.py

@@ -261,9 +261,7 @@ class ResponseEncoder:
 
 
 def prepare_iter(value):
-    """
-    Ensure response body is iterable and resolves to False when empty.
-    """
+    """Ensure response body is iterable and resolves to False when empty."""
     if isinstance(value, text_or_bytes):
         # strings get wrapped in a list because iterating over a single
         # item list is much faster than iterating over every character
@@ -360,7 +358,6 @@ def gzip(compress_level=5, mime_types=['text/html', 'text/plain'],
         * No 'gzip' or 'x-gzip' is present in the Accept-Encoding header
         * No 'gzip' or 'x-gzip' with a qvalue > 0 is present
         * The 'identity' value is given with a qvalue > 0.
-
     """
     request = cherrypy.serving.request
     response = cherrypy.serving.response

lib/cherrypy/lib/gctools.py

@@ -14,7 +14,6 @@ from cherrypy.process.plugins import SimplePlugin
 
 
 class ReferrerTree(object):
-
     """An object which gathers all referrers of an object to a given depth."""
 
     peek_length = 40
@@ -132,7 +131,6 @@ def get_context(obj):
 
 
 class GCRoot(object):
-
     """A CherryPy page handler for testing reference leaks."""
 
     classes = [

lib/cherrypy/lib/httputil.py

@@ -71,10 +71,10 @@ def protocol_from_http(protocol_str):
 def get_ranges(headervalue, content_length):
     """Return a list of (start, stop) indices from a Range header, or None.
 
-    Each (start, stop) tuple will be composed of two ints, which are suitable
-    for use in a slicing operation. That is, the header "Range: bytes=3-6",
-    if applied against a Python string, is requesting resource[3:7]. This
-    function will return the list [(3, 7)].
+    Each (start, stop) tuple will be composed of two ints, which are
+    suitable for use in a slicing operation. That is, the header "Range:
+    bytes=3-6", if applied against a Python string, is requesting
+    resource[3:7]. This function will return the list [(3, 7)].
 
     If this function returns an empty list, you should return HTTP 416.
     """
@@ -127,7 +127,6 @@ def get_ranges(headervalue, content_length):
 
 
 class HeaderElement(object):
-
     """An element (with parameters) from an HTTP header's element list."""
 
     def __init__(self, value, params=None):
@@ -169,14 +168,14 @@ q_separator = re.compile(r'; *q *=')
 
 
 class AcceptElement(HeaderElement):
-
     """An element (with parameters) from an Accept* header's element list.
 
-    AcceptElement objects are comparable; the more-preferred object will be
-    "less than" the less-preferred object. They are also therefore sortable;
-    if you sort a list of AcceptElement objects, they will be listed in
-    priority order; the most preferred value will be first. Yes, it should
-    have been the other way around, but it's too late to fix now.
+    AcceptElement objects are comparable; the more-preferred object will
+    be "less than" the less-preferred object. They are also therefore
+    sortable; if you sort a list of AcceptElement objects, they will be
+    listed in priority order; the most preferred value will be first.
+    Yes, it should have been the other way around, but it's too late to
+    fix now.
     """
 
     @classmethod
@@ -249,8 +248,7 @@ def header_elements(fieldname, fieldvalue):
 
 
 def decode_TEXT(value):
-    r"""
-    Decode :rfc:`2047` TEXT
+    r"""Decode :rfc:`2047` TEXT.
 
     >>> decode_TEXT("=?utf-8?q?f=C3=BCr?=") == b'f\xfcr'.decode('latin-1')
     True
@@ -265,9 +263,7 @@ def decode_TEXT(value):
 
 
 def decode_TEXT_maybe(value):
-    """
-    Decode the text but only if '=?' appears in it.
-    """
+    """Decode the text but only if '=?' appears in it."""
     return decode_TEXT(value) if '=?' in value else value
 
 
@@ -388,7 +384,6 @@ def parse_query_string(query_string, keep_blank_values=True, encoding='utf-8'):
 
 
 class CaseInsensitiveDict(jaraco.collections.KeyTransformingDict):
-
     """A case-insensitive dict subclass.
 
     Each key is changed on entry to title case.
@@ -417,7 +412,6 @@ else:
 
 
 class HeaderMap(CaseInsensitiveDict):
-
     """A dict subclass for HTTP request and response headers.
 
     Each key is changed on entry to str(key).title(). This allows headers
@@ -494,7 +488,6 @@ class HeaderMap(CaseInsensitiveDict):
 
 
 class Host(object):
-
     """An internet address.
 
     name

lib/cherrypy/lib/locking.py

@@ -7,22 +7,22 @@ class NeverExpires(object):
 
 
 class Timer(object):
-    """
-    A simple timer that will indicate when an expiration time has passed.
-    """
+    """A simple timer that will indicate when an expiration time has passed."""
     def __init__(self, expiration):
         'Create a timer that expires at `expiration` (UTC datetime)'
         self.expiration = expiration
 
     @classmethod
     def after(cls, elapsed):
-        """
-        Return a timer that will expire after `elapsed` passes.
-        """
-        return cls(datetime.datetime.utcnow() + elapsed)
+        """Return a timer that will expire after `elapsed` passes."""
+        return cls(
+            datetime.datetime.now(datetime.timezone.utc) + elapsed,
+        )
 
     def expired(self):
-        return datetime.datetime.utcnow() >= self.expiration
+        return datetime.datetime.now(
+            datetime.timezone.utc,
+        ) >= self.expiration
 
 
 class LockTimeout(Exception):
@@ -30,9 +30,7 @@ class LockTimeout(Exception):
 
 
 class LockChecker(object):
-    """
-    Keep track of the time and detect if a timeout has expired
-    """
+    """Keep track of the time and detect if a timeout has expired."""
     def __init__(self, session_id, timeout):
         self.session_id = session_id
         if timeout:

lib/cherrypy/lib/profiler.py

@@ -30,7 +30,6 @@ to get a quick sanity-check on overall CP performance. Use the
 ``--profile`` flag when running the test suite. Then, use the ``serve()``
 function to browse the results in a web browser. If you run this
 module from the command line, it will call ``serve()`` for you.
-
 """
 
 import io
@@ -47,7 +46,9 @@ try:
     import pstats
 
     def new_func_strip_path(func_name):
-        """Make profiler output more readable by adding `__init__` modules' parents
+        """Add ``__init__`` modules' parents.
+
+        This makes the profiler output more readable.
         """
         filename, line, name = func_name
         if filename.endswith('__init__.py'):

lib/cherrypy/lib/reprconf.py

@@ -27,18 +27,17 @@ from cherrypy._cpcompat import text_or_bytes
 
 
 class NamespaceSet(dict):
-
     """A dict of config namespace names and handlers.
 
-    Each config entry should begin with a namespace name; the corresponding
-    namespace handler will be called once for each config entry in that
-    namespace, and will be passed two arguments: the config key (with the
-    namespace removed) and the config value.
+    Each config entry should begin with a namespace name; the
+    corresponding namespace handler will be called once for each config
+    entry in that namespace, and will be passed two arguments: the
+    config key (with the namespace removed) and the config value.
 
     Namespace handlers may be any Python callable; they may also be
-    context managers, in which case their __enter__
-    method should return a callable to be used as the handler.
-    See cherrypy.tools (the Toolbox class) for an example.
+    context managers, in which case their __enter__ method should return
+    a callable to be used as the handler. See cherrypy.tools (the
+    Toolbox class) for an example.
     """
 
     def __call__(self, config):
@@ -48,9 +47,10 @@ class NamespaceSet(dict):
             A flat dict, where keys use dots to separate
             namespaces, and values are arbitrary.
 
-        The first name in each config key is used to look up the corresponding
-        namespace handler. For example, a config entry of {'tools.gzip.on': v}
-        will call the 'tools' namespace handler with the args: ('gzip.on', v)
+        The first name in each config key is used to look up the
+        corresponding namespace handler. For example, a config entry of
+        {'tools.gzip.on': v} will call the 'tools' namespace handler
+        with the args: ('gzip.on', v)
         """
         # Separate the given config into namespaces
         ns_confs = {}
@@ -103,7 +103,6 @@ class NamespaceSet(dict):
 
 
 class Config(dict):
-
     """A dict-like set of configuration data, with defaults and namespaces.
 
     May take a file, filename, or dict.
@@ -167,7 +166,7 @@ class Parser(configparser.ConfigParser):
                 self._read(fp, filename)
 
     def as_dict(self, raw=False, vars=None):
-        """Convert an INI file to a dictionary"""
+        """Convert an INI file to a dictionary."""
         # Load INI file into a dict
         result = {}
         for section in self.sections():
@@ -188,7 +187,7 @@ class Parser(configparser.ConfigParser):
 
     def dict_from_file(self, file):
         if hasattr(file, 'read'):
-            self.readfp(file)
+            self.read_file(file)
         else:
             self.read(file)
         return self.as_dict()

lib/cherrypy/lib/sessions.py

@@ -120,7 +120,6 @@ missing = object()
 
 
 class Session(object):
-
     """A CherryPy dict-like Session object (one per request)."""
 
     _id = None
@@ -148,9 +147,11 @@ class Session(object):
     to session data."""
 
     loaded = False
+    """If True, data has been retrieved from storage.
+
+    This should happen automatically on the first attempt to access
+    session data.
     """
-    If True, data has been retrieved from storage. This should happen
-    automatically on the first attempt to access session data."""
 
     clean_thread = None
     'Class-level Monitor which calls self.clean_up.'
@@ -165,9 +166,10 @@ class Session(object):
     'True if the session requested by the client did not exist.'
 
     regenerated = False
+    """True if the application called session.regenerate().
+
+    This is not set by internal calls to regenerate the session id.
     """
-    True if the application called session.regenerate(). This is not set by
-    internal calls to regenerate the session id."""
 
     debug = False
     'If True, log debug information.'
@@ -335,8 +337,9 @@ class Session(object):
 
     def pop(self, key, default=missing):
         """Remove the specified key and return the corresponding value.
-        If key is not found, default is returned if given,
-        otherwise KeyError is raised.
+
+        If key is not found, default is returned if given, otherwise
+        KeyError is raised.
         """
         if not self.loaded:
             self.load()
@@ -351,13 +354,19 @@ class Session(object):
         return key in self._data
 
     def get(self, key, default=None):
-        """D.get(k[,d]) -> D[k] if k in D, else d.  d defaults to None."""
+        """D.get(k[,d]) -> D[k] if k in D, else d.
+
+        d defaults to None.
+        """
         if not self.loaded:
             self.load()
         return self._data.get(key, default)
 
     def update(self, d):
-        """D.update(E) -> None.  Update D from E: for k in E: D[k] = E[k]."""
+        """D.update(E) -> None.
+
+        Update D from E: for k in E: D[k] = E[k].
+        """
         if not self.loaded:
             self.load()
         self._data.update(d)
@@ -369,7 +378,10 @@ class Session(object):
         return self._data.setdefault(key, default)
 
     def clear(self):
-        """D.clear() -> None.  Remove all items from D."""
+        """D.clear() -> None.
+
+        Remove all items from D.
+        """
         if not self.loaded:
             self.load()
         self._data.clear()
@@ -492,7 +504,8 @@ class FileSession(Session):
         """Set up the storage system for file-based sessions.
 
         This should only be called once per process; this will be done
-        automatically when using sessions.init (as the built-in Tool does).
+        automatically when using sessions.init (as the built-in Tool
+        does).
         """
         # The 'storage_path' arg is required for file-based sessions.
         kwargs['storage_path'] = os.path.abspath(kwargs['storage_path'])
@@ -616,7 +629,8 @@ class MemcachedSession(Session):
         """Set up the storage system for memcached-based sessions.
 
         This should only be called once per process; this will be done
-        automatically when using sessions.init (as the built-in Tool does).
+        automatically when using sessions.init (as the built-in Tool
+        does).
         """
         for k, v in kwargs.items():
             setattr(cls, k, v)

lib/cherrypy/lib/static.py

@@ -1,19 +1,18 @@
 """Module with helpers for serving static files."""
 
+import mimetypes
 import os
 import platform
 import re
 import stat
-import mimetypes
-import urllib.parse
 import unicodedata
-
+import urllib.parse
 from email.generator import _make_boundary as make_boundary
 from io import UnsupportedOperation
 
 import cherrypy
 from cherrypy._cpcompat import ntob
-from cherrypy.lib import cptools, httputil, file_generator_limited
+from cherrypy.lib import cptools, file_generator_limited, httputil
 
 
 def _setup_mimetypes():
@@ -57,15 +56,15 @@ def serve_file(path, content_type=None, disposition=None, name=None,
                debug=False):
     """Set status, headers, and body in order to serve the given path.
 
-    The Content-Type header will be set to the content_type arg, if provided.
-    If not provided, the Content-Type will be guessed by the file extension
-    of the 'path' argument.
+    The Content-Type header will be set to the content_type arg, if
+    provided. If not provided, the Content-Type will be guessed by the
+    file extension of the 'path' argument.
 
-    If disposition is not None, the Content-Disposition header will be set
-    to "<disposition>; filename=<name>; filename*=utf-8''<name>"
-    as described in :rfc:`6266#appendix-D`.
-    If name is None, it will be set to the basename of path.
-    If disposition is None, no Content-Disposition header will be written.
+    If disposition is not None, the Content-Disposition header will be
+    set to "<disposition>; filename=<name>; filename*=utf-8''<name>" as
+    described in :rfc:`6266#appendix-D`. If name is None, it will be set
+    to the basename of path. If disposition is None, no Content-
+    Disposition header will be written.
     """
     response = cherrypy.serving.response
 
@@ -185,7 +184,10 @@ def serve_fileobj(fileobj, content_type=None, disposition=None, name=None,
 
 
 def _serve_fileobj(fileobj, content_type, content_length, debug=False):
-    """Internal. Set response.body to the given file object, perhaps ranged."""
+    """Set ``response.body`` to the given file object, perhaps ranged.
+
+    Internal helper.
+    """
     response = cherrypy.serving.response
 
     # HTTP/1.0 didn't have Range/Accept-Ranges headers, or the 206 code