ghnova.utils

utils

Utility functions for the ghnova package.

Functions

ghnova.utils.get_version_information

get_version_information() -> str

Get the version information.

Returns:

Name	Type	Description
str	str	Version information.

Source code in src/ghnova/utils/log.py

def get_version_information() -> str:
    """Get the version information.

    Returns:
        str: Version information.

    """
    return __version__

ghnova.utils.setup_logger

setup_logger(outdir: str = '.', label: str | None = None, log_level: str | int = 'INFO', print_version: bool = False) -> None

Set up logging output: call at the start of the script to use.

Parameters:

Name	Type	Description	Default
outdir	str	Output directory for log file.	'.'
label	str | None	Label for log file name. If None, no log file is created.	None
log_level	str | int	Logging level as string or integer.	'INFO'
print_version	bool	Whether to print version information to the log.	False

Source code in src/ghnova/utils/log.py

def setup_logger(
    outdir: str = ".", label: str | None = None, log_level: str | int = "INFO", print_version: bool = False
) -> None:
    """Set up logging output: call at the start of the script to use.

    Args:
        outdir: Output directory for log file.
        label: Label for log file name. If None, no log file is created.
        log_level: Logging level as string or integer.
        print_version: Whether to print version information to the log.

    """
    if isinstance(log_level, str):
        try:
            level = getattr(logging, log_level.upper())
        except AttributeError as e:
            raise ValueError(f"log_level {log_level} not understood") from e
    else:
        level = int(log_level)

    logger = logging.getLogger("ghnova")
    logger.propagate = False
    logger.setLevel(level)

    if not any(
        isinstance(h, logging.StreamHandler) and not isinstance(h, logging.FileHandler) for h in logger.handlers
    ):
        stream_handler = logging.StreamHandler()
        stream_handler.setFormatter(
            logging.Formatter("%(asctime)s %(name)s %(levelname)-8s: %(message)s", datefmt="%H:%M")
        )
        stream_handler.setLevel(level)
        logger.addHandler(stream_handler)

    if not any(isinstance(h, logging.FileHandler) for h in logger.handlers) and label:
        outdir_path = Path(outdir)
        outdir_path.mkdir(parents=True, exist_ok=True)
        log_file = outdir_path / f"{label}.log"
        file_handler = logging.FileHandler(log_file)
        file_handler.setFormatter(logging.Formatter("%(asctime)s %(levelname)-8s: %(message)s", datefmt="%H:%M"))

        file_handler.setLevel(level)
        logger.addHandler(file_handler)

    for handler in logger.handlers:
        handler.setLevel(level)

    if print_version:
        version = get_version_information()
        logger.info("Running ghnova version: %s", version)

ghnova.utils.process_async_response_with_last_modified async

process_async_response_with_last_modified(response: ClientResponse) -> tuple[dict[str, Any] | list[dict[str, Any]], int, str | None, str | None]

Process an asynchronous HTTP response and extract data, status, ETag, and Last-Modified.

Parameters:

Name	Type	Description	Default
response	ClientResponse	The asynchronous HTTP response object.	required

Returns:

Type	Description
tuple[dict[str, Any] | list[dict[str, Any]], int, str | None, str | None]	A tuple containing the response data, status code, ETag, and Last-Modified.

Source code in src/ghnova/utils/response.py

async def process_async_response_with_last_modified(
    response: ClientResponse,
) -> tuple[dict[str, Any] | list[dict[str, Any]], int, str | None, str | None]:
    """Process an asynchronous HTTP response and extract data, status, ETag, and Last-Modified.

    Args:
        response: The asynchronous HTTP response object.

    Returns:
        A tuple containing the response data, status code, ETag, and Last-Modified.

    """
    status_code = response.status
    etag = response.headers.get("ETag", None)
    last_modified = response.headers.get("Last-Modified", None)
    if status_code == 204:  # noqa: PLR2004
        data = {}
    elif 200 <= status_code < 300:  # noqa: PLR2004
        try:
            data = await response.json()
        except (ValueError, ContentTypeError) as e:
            logger.error("Failed to parse JSON response: %s", e)
            data = {}
    else:
        data = {}
    return data, status_code, etag, last_modified

ghnova.utils.process_response_with_last_modified

process_response_with_last_modified(response: Response) -> tuple[dict[str, Any] | list[dict[str, Any]], int, str | None, str | None]

Process an HTTP response and extract data, status, ETag, and Last-Modified.

Parameters:

Name	Type	Description	Default
response	Response	The HTTP response object.	required

Returns:

Type	Description
tuple[dict[str, Any] | list[dict[str, Any]], int, str | None, str | None]	A tuple containing the response data, status code, ETag, and Last-Modified.

Source code in src/ghnova/utils/response.py

def process_response_with_last_modified(
    response: Response,
) -> tuple[dict[str, Any] | list[dict[str, Any]], int, str | None, str | None]:
    """Process an HTTP response and extract data, status, ETag, and Last-Modified.

    Args:
        response: The HTTP response object.

    Returns:
        A tuple containing the response data, status code, ETag, and Last-Modified.

    """
    status_code = response.status_code
    etag = response.headers.get("ETag", None)
    last_modified = response.headers.get("Last-Modified", None)
    if status_code == 204:  # noqa: PLR2004
        data = {}
    elif 200 <= status_code < 300:  # noqa: PLR2004
        try:
            data = response.json()
        except ValueError as e:
            logger.error("Failed to parse JSON response: %s", e)
            data = {}
    else:
        data = {}
    return data, status_code, etag, last_modified