Mercurial > libervia-backend

annotate sat/tools/common/files_utils.py @ 3185:554b3b632378

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
memory (cache): purge + pathlib: - cache is now purged on backend startup (every file which has passed EOL will be deleted) - use of pathlib, getPath now returns a Path
author Goffi <goffi@goffi.org>
date Wed, 26 Feb 2020 15:54:43 +0100
parents 559a625a236b
children 5ba0b1cdd45b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
1 #!/usr/bin/env python3
3137
559a625a236b fixed shebangs
Goffi <goffi@goffi.org>
parents: 3136
diff changeset
2
2593
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
3
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
4 # SAT: a jabber client
3136
9d0df638c8b4 dates update
Goffi <goffi@goffi.org>
parents: 3131
diff changeset
5 # Copyright (C) 2009-2020 Jérôme Poisson (goffi@goffi.org)
2593
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
6
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
7 # This program is free software: you can redistribute it and/or modify
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
8 # it under the terms of the GNU Affero General Public License as published by
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
9 # the Free Software Foundation, either version 3 of the License, or
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
10 # (at your option) any later version.
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
11
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
12 # This program is distributed in the hope that it will be useful,
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
15 # GNU Affero General Public License for more details.
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
16
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
17 # You should have received a copy of the GNU Affero General Public License
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
19
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
20 """tools to help manipulating files"""
3091
2e1c3d33099b tools (common/files_utils): get_unique_name now uses and returns Path instances.
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
21 from pathlib import Path
2593
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
22
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
23
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
24 def get_unique_name(path):
3091
2e1c3d33099b tools (common/files_utils): get_unique_name now uses and returns Path instances.
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
25 """Generate a path with a name not conflicting with existing file
2593
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
26
3091
2e1c3d33099b tools (common/files_utils): get_unique_name now uses and returns Path instances.
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
27 @param path(str, Path): path to the file to create
2e1c3d33099b tools (common/files_utils): get_unique_name now uses and returns Path instances.
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
28 @return (Path): unique path (can be the same as path if there is no conflict)
2593
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
29 """
3131
d6da17f6e4ce tools (common/files_utils): fixed get_unique_name when `path` is a str and not a Path
Goffi <goffi@goffi.org>
parents: 3091
diff changeset
30 ori_path = path = Path(path)
2593
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
31 idx = 1
3091
2e1c3d33099b tools (common/files_utils): get_unique_name now uses and returns Path instances.
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
32 while path.exists():
2e1c3d33099b tools (common/files_utils): get_unique_name now uses and returns Path instances.
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
33 path = ori_path.with_name(ori_path.name + f"_{idx}")
2593
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
34 idx += 1
d78eff6b4487 tools (common): new files_utils module:
Goffi <goffi@goffi.org>
parents:
diff changeset
35 return path