GoldyBot.files

  1from __future__ import annotations
  2import io
  3import os
  4import re
  5import threading
  6import time
  7from typing import IO, Any, Callable
  8
  9import GoldyBot
 10import requests
 11
 12MODULE_NAME = "FILES"
 13
 14class File(object):
 15    """Goldy Bot's File Handler."""
 16    def __init__(self, path):
 17        self.file_path = path
 18
 19        if self.exists() == False:
 20            GoldyBot.logging.print_and_log(f"[{MODULE_NAME}] Umm, that file doesn't exist, so I'm going to create it myself.")
 21            self.create()
 22
 23    def read(self) -> Any|None:
 24        """Commands Goldy to return the value of a file."""
 25        try:
 26            with self.get_file() as file:
 27                file_context = file.read()
 28                GoldyBot.logging.print_and_log(None, f"[{MODULE_NAME}] I've read the file '{self.file_path}'.")
 29                return file_context
 30
 31        except Exception as e:
 32            GoldyBot.logging.print_and_log("error", f"[{MODULE_NAME}] Oops, I Couldn't read the file '{self.file_path}', so I'm returning 'None'. \nError --> {e}")
 33            return None
 34
 35    def write(self, value) -> None:
 36        """Commands Goldy to write to the file with the following value."""
 37        try:
 38            # Try to edit value of file.
 39            with self.get_file() as file:
 40                file.seek(0)
 41                file.write(str(value))
 42                file.truncate()
 43
 44            GoldyBot.logging.print_and_log(None, f"[{MODULE_NAME}] I've written to '{self.file_path}'.")
 45        
 46        except Exception:
 47            GoldyBot.logging.print_and_log("error", f"[{MODULE_NAME}] I Couldn't edit '{self.file_path}' with the value '{value}'!")
 48
 49    def create(self) -> None:
 50        """Commands Goldy to create a file or directory."""
 51        if self.file_path[-1] == "/": # Create directory.
 52            os.mkdir(self.file_path)
 53            GoldyBot.logging.print_and_log(f"[{MODULE_NAME}] I've created a directory at '{self.file_path}'.")
 54        else: # Create file.
 55            open(self.file_path, "a+")
 56            GoldyBot.logging.print_and_log(f"[{MODULE_NAME}] I've created a file at '{self.file_path}'.")
 57
 58    def delete(self) -> None:
 59        """Commands Goldy to delete this file."""
 60        if self.file_path[-1] == "/": # Delete as directly.
 61            os.rmdir(self.file_path)
 62            GoldyBot.logging.print_and_log("info_5", f"[{MODULE_NAME}] I've removed the directory at '{self.file_path}'.")
 63        else: # Delete as file.
 64            os.remove(self.file_path)
 65            GoldyBot.logging.print_and_log("info_5", f"[{MODULE_NAME}] I've removed the file at '{self.file_path}'.")
 66        
 67
 68    def exists(self) -> bool:
 69        """Checks if the file exists."""
 70        if os.path.exists(self.file_path):
 71            return True
 72        else:
 73            return False
 74
 75    def get_file(self, mode="r+") -> IO:
 76        """Commands Goldy to open the file."""
 77        if mode == "wb": return open(self.file_path, mode) # For writing binary.
 78
 79        return open(self.file_path, mode, encoding='utf-8')
 80
 81class WebFile():
 82    """A web file is a class that partially inherits the GoldyBot.File() class but instead of taking in file path it takes in a URL of a file on the web."""
 83    def __init__(self, url:str, download_to_disk:bool=False, time_until_deletion:int|float=10):
 84        self._url = url
 85        self._download_to_disk = download_to_disk
 86        self._time_until_deletion = time_until_deletion
 87        self._request = requests.get(self._url, stream=True)
 88        self._request.raw.decode_content = True # Content-Encoding
 89
 90        self.file_path = self._url
 91
 92        self._file_object = io.BytesIO(self._request.content)
 93
 94        # Getting file name.
 95        try:
 96            self._file_object.name = re.findall("filename=(.+)", self._request.headers['Content-Disposition'])[0]
 97
 98        except KeyError: # If fail to get file name then fallback to default.
 99            GoldyBot.logging.log("warn", f"[{MODULE_NAME}] Failed to find the web file's file name so I'm giving it a default name.")
100
101            content_type = self._request.headers['Content-Type']
102            self._file_object.name = f"uwu_file.{content_type[content_type.index('/')+1:]}"
103
104        # Download to disk temporary if 'download_to_disk' is True.
105        if download_to_disk:
106            self.download_to_disk(self._time_until_deletion)
107
108    @property
109    def url(self) -> str:
110        """Returns url of file."""
111        return self._url
112
113    @property
114    def downloaded_to_disk(self) -> bool:
115        """Has this file been downloaded to disk."""
116        return self._download_to_disk
117
118    @property
119    def file_name(self) -> str:
120        """Returns name of file."""
121        return self._file_object.name
122
123    @property
124    def raw_bytes(self) -> bytes:
125        """Returns 🥩raw bytes of file. Sometimes this is more preferred by other libraries."""
126        return self._request.content
127
128    def download_to_disk(self, time_until_deletion:int|float=10) -> None:
129        """Downloads file to disk temporary. The file deletes itself by default in 5 seconds."""
130        File("./temp/") # Create temp folder.
131        
132        self.temp_file = File(f"./temp/{self._file_object.name}")
133
134        with self.temp_file.get_file(mode="wb") as file:
135            file.seek(0)
136            file.write(self._file_object.getvalue())
137            file.truncate()
138            file.close()
139
140        def delete_file_later(): time.sleep(time_until_deletion); self.temp_file.delete()
141
142        threading.Thread(target=delete_file_later).start()
143
144    def get_file(self) -> io.BytesIO|str:
145        """Returns file IO object but if 'download_to_disk' is True this will return the temporary path to the file."""
146        if self.downloaded_to_disk:
147            return f"./temp/{self._file_object.name}"
148        else:
149            return self._file_object
150    
151    # Inheriting read method from GoldyBot.File class.
152    read:Callable[[], Any|None] = File.__dict__["read"]
153    """Commands Goldy to return the value of a file."""