""" A few utility bobs and bits. """ import logging from pathlib import Path, PurePath from typing import Optional, Tuple import requests from colorama import Fore, Style def move(path: PurePath, from_folders: Tuple[str], to_folders: Tuple[str]) -> Optional[PurePath]: """ If the input path is located anywhere within from_folders, replace the from_folders with to_folders. Returns None otherwise. """ length = len(from_folders) if path.parts[:length] == from_folders: return PurePath(*to_folders, *path.parts[length:]) return None def rename(path: PurePath, to_name: str) -> PurePath: """ Set the file name of the input path to to_name. """ return PurePath(*path.parts[:-1], to_name) def stream_to_path(response: requests.Response, to_path: Path, chunk_size: int = 1024 ** 2) -> None: """ Download a requests response content to a file by streaming it. This function avoids excessive memory usage when downloading large files. The chunk_size is in bytes. """ with open(to_path, 'wb') as file_descriptor: for chunk in response.iter_content(chunk_size=chunk_size): file_descriptor.write(chunk) def prompt_yes_no(question: str, default: Optional[bool] = None) -> bool: """ Prompts the user a yes/no question and returns their choice. """ if default is True: prompt = "[Y/n]" elif default is False: prompt = "[y/N]" else: prompt = "[y/n]" text = f"{question} {prompt} " wrong_reply = "Please reply with 'yes'/'y' or 'no'/'n'." while True: response = input(text).strip().lower() if response in {"yes", "ye", "y"}: return True if response in {"no", "n"}: return False if response == "" and default is not None: return default print(wrong_reply) class ResolveException(Exception): """An exception while resolving a file.""" def resolve_path(directory: Path, target_file: Path) -> Path: """Resolve a file relative to the path of this organizer. Raises a [ResolveException] if the file is outside the given directory. """ absolute_path = directory.joinpath(target_file).resolve() if directory not in absolute_path.parents: raise ResolveException( f"Path resolved to file outside folder ({absolute_path})" ) return absolute_path class PrettyLogger: """ A logger that prints some specially formatted log messages in color. """ def __init__(self, logger: logging.Logger) -> None: self.logger = logger def modified_file(self, file_name: Path) -> None: """ An existing file has changed. """ self.logger.info( f"{Fore.MAGENTA}{Style.BRIGHT}Modified {file_name}.{Style.RESET_ALL}") def new_file(self, file_name: Path) -> None: """ A new file has been downloaded. """ self.logger.info( f"{Fore.GREEN}{Style.BRIGHT}Created {file_name}.{Style.RESET_ALL}") def ignored_file(self, file_name: Path) -> None: """ Nothing in particular happened to this file. """ self.logger.info(f"{Style.DIM}Ignored {file_name}.{Style.RESET_ALL}") def starting_synchronizer( self, target_directory: Path, synchronizer_name: str, subject: Optional[str] = None, ) -> None: """ A special message marking that a synchronizer has been started. """ subject_str = f"{subject} " if subject else "" self.logger.info("") self.logger.info(( f"{Fore.CYAN}{Style.BRIGHT}Synchronizing {subject_str}to {target_directory}" f" using the {synchronizer_name} synchronizer.{Style.RESET_ALL}" ))