3 """Utilities for working with files."""
10 from typing import Optional
12 from os.path import isfile, join, exists
17 logger = logging.getLogger(__name__)
20 def create_path_if_not_exist(path, on_error=None):
22 Attempts to create path if it does not exist. If on_error is
23 specified, it is called with an exception if one occurs, otherwise
24 exception is rethrown.
28 >>> path = os.path.join("/tmp", str(uuid.uuid4()), str(uuid.uuid4()))
29 >>> os.path.exists(path)
31 >>> create_path_if_not_exist(path)
32 >>> os.path.exists(path)
35 logger.debug(f"Creating path {path}")
36 previous_umask = os.umask(0)
41 if ex.errno != errno.EEXIST and not os.path.isdir(path):
42 if on_error is not None:
47 os.umask(previous_umask)
50 def does_file_exist(filename: str) -> bool:
51 return os.path.exists(filename)
54 def get_file_raw_timestamps(filename: str) -> Optional[os.stat_result]:
56 return os.stat(filename)
57 except Exception as e:
62 def get_file_raw_timestamp(filename: str, extractor) -> Optional[float]:
63 tss = get_file_raw_timestamps(filename)
69 def get_file_raw_atime(filename: str) -> Optional[float]:
70 return get_file_raw_timestamp(filename, lambda x: x.st_atime)
73 def get_file_raw_mtime(filename: str) -> Optional[float]:
74 return get_file_raw_timestamp(filename, lambda x: x.st_mtime)
77 def get_file_raw_ctime(filename: str) -> Optional[float]:
78 return get_file_raw_timestamp(filename, lambda x: x.st_ctime)
81 def convert_file_timestamp_to_datetime(
82 filename: str, producer
83 ) -> Optional[datetime.datetime]:
84 ts = producer(filename)
86 return datetime.datetime.fromtimestamp(ts)
90 def get_file_atime_as_datetime(filename: str) -> Optional[datetime.datetime]:
91 return convert_file_timestamp_to_datetime(filename, get_file_raw_atime)
94 def get_file_mtime_as_datetime(filename: str) -> Optional[datetime.datetime]:
95 return convert_file_timestamp_to_datetime(filename, get_file_raw_mtime)
98 def get_file_ctime_as_datetime(filename: str) -> Optional[datetime.datetime]:
99 return convert_file_timestamp_to_datetime(filename, get_file_raw_ctime)
102 def get_file_timestamp_age_seconds(filename: str, extractor) -> Optional[int]:
104 ts = get_file_raw_timestamps(filename)
107 result = extractor(ts)
111 def get_file_atime_age_seconds(filename: str) -> Optional[int]:
112 return get_file_timestamp_age_seconds(filename, lambda x: x.st_atime)
115 def get_file_ctime_age_seconds(filename: str) -> Optional[int]:
116 return get_file_timestamp_age_seconds(filename, lambda x: x.st_ctime)
119 def get_file_mtime_age_seconds(filename: str) -> Optional[int]:
120 return get_file_timestamp_age_seconds(filename, lambda x: x.st_mtime)
123 def get_file_timestamp_timedelta(
124 filename: str, extractor
125 ) -> Optional[datetime.timedelta]:
126 age = get_file_timestamp_age_seconds(filename, extractor)
128 return datetime.timedelta(seconds=float(age))
132 def get_file_atime_timedelta(filename: str) -> Optional[datetime.timedelta]:
133 return get_file_timestamp_timedelta(filename, lambda x: x.st_atime)
136 def get_file_ctime_timedelta(filename: str) -> Optional[datetime.timedelta]:
137 return get_file_timestamp_timedelta(filename, lambda x: x.st_ctime)
140 def get_file_mtime_timedelta(filename: str) -> Optional[datetime.timedelta]:
141 return get_file_timestamp_timedelta(filename, lambda x: x.st_mtime)
144 def describe_file_timestamp(
145 filename: str, extractor, *, brief=False
147 age = get_file_timestamp_age_seconds(filename, extractor)
151 return datetime_utils.describe_duration_briefly(age)
153 return datetime_utils.describe_duration(age)
156 def describe_file_atime(filename: str, *, brief=False) -> Optional[str]:
157 return describe_file_timestamp(filename, lambda x: x.st_atime, brief=brief)
160 def describe_file_ctime(filename: str, *, brief=False) -> Optional[str]:
161 return describe_file_timestamp(filename, lambda x: x.st_ctime, brief=brief)
164 def describe_file_mtime(filename: str, *, brief=False) -> Optional[str]:
165 return describe_file_timestamp(filename, lambda x: x.st_mtime, brief=brief)
168 def expand_globs(in_filename: str):
169 for filename in glob.glob(in_filename):
173 def get_files(directory: str):
174 for filename in os.listdir(directory):
175 full_path = join(directory, filename)
176 if isfile(full_path) and exists(full_path):
180 def get_directories(directory: str):
181 for d in os.listdir(directory):
182 full_path = join(directory, d)
183 if not isfile(full_path) and exists(full_path):
187 def get_files_recursive(directory: str):
188 for filename in get_files(directory):
190 for subdir in get_directories(directory):
191 for filename in get_files_recursive(subdir):