diff --git a/onionr/utils/readstatic.py b/onionr/utils/readstatic.py index 4abd67c8..55cf1340 100644 --- a/onionr/utils/readstatic.py +++ b/onionr/utils/readstatic.py @@ -1,7 +1,29 @@ +""" + Onionr - Private P2P Communication + + module to get static directory and read static data files +""" +""" + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . +""" + +from typing import Union import os -def get_static_dir(): +def get_static_dir()->str: return os.path.dirname(os.path.realpath(__file__)) + '/../static-data/' -def read_static(file:str, ret_bin:bool=False)->str: + +def read_static(file:str, ret_bin:bool=False)->Union[str, bytes]: static_file = get_static_dir() + file if ret_bin: @@ -10,4 +32,4 @@ def read_static(file:str, ret_bin:bool=False)->str: mode = 'r' with open(static_file, mode) as f: data = f.read() - return data \ No newline at end of file + return data