view roundup/backends/sessions_common.py @ 8408:e882a5d52ae5

refactor: move RateLimitExceeded to roundup.cgi.exceptions RateLimitExceeded is an HTTP exception that raises code 429. Move it to roundup.cgi.exceptions where all the other exceptions that result in http status codes are located. Also make it inherit from HTTPException since it is one. Also add docstrings for all HTTP exceptions and order HTTPExceptions by status code. BREAKING CHANGE: if somebody is importing RateLimitExceeded they will need to change their import. I consider it unlikely anybody is using RateLimitExceeded. Detectors and extensions are unlikely to raise RateLimitExceeded. So I am leaving it out of the upgrading doc. Just doc in change log.
author John Rouillard <rouilj@ieee.org>
date Sun, 10 Aug 2025 21:27:06 -0400
parents b04e44db7d8d
children
line wrap: on
line source

import base64, logging

import roundup.anypy.random_ as random_
from roundup.anypy.strings import b2s

logger = logging.getLogger('roundup.hyperdb.backend.sessions')
if not random_.is_weak:
    logger.debug("Importing good random generator")
else:
    logger.warning("**SystemRandom not available. Using poor random generator")


class SessionCommon:

    def log_debug(self, msg, *args, **kwargs):
        """Log a message with level DEBUG."""

        logger = self.get_logger()
        logger.debug(msg, *args, **kwargs)

    def log_info(self, msg, *args, **kwargs):
        """Log a message with level INFO."""

        logger = self.get_logger()
        logger.info(msg, *args, **kwargs)

    def log_warning(self, msg, *args, **kwargs):
        """Log a message with level INFO."""
        logger = self.get_logger()
        logger.warning(msg, *args, **kwargs)

    def get_logger(self):
        """Return the logger for this database."""

        # Because getting a logger requires acquiring a lock, we want
        # to do it only once.
        if not hasattr(self, '__logger'):
            self.__logger = logging.getLogger('roundup.hyperdb.backends.%s' %
                                              self.name or "basicdb" )

        return self.__logger

    def getUniqueKey(self, length=40):
        otk = b2s(base64.urlsafe_b64encode(
            random_.token_bytes(length))).rstrip('=')
        while self.exists(otk):
            otk = b2s(base64.urlsafe_b64encode(
                random_.token_bytes(length))).rstrip('=')

        return otk

Roundup Issue Tracker: http://roundup-tracker.org/