libervia-backend: sat/tools/common/files

annotate sat/tools/common/files_utils.py @ 3091:2e1c3d33099b

tools (common/files_utils): get_unique_name now uses and returns Path instances.

author	Goffi <goffi@goffi.org>
date	Fri, 20 Dec 2019 12:28:04 +0100
parents	ab2696e34d29
children	d6da17f6e4ce

rev	line source
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2771 diff changeset	1 #!/usr/bin/env python3
2593 d78eff6b4487 tools (common): new files_utils module: Goffi <goffi@goffi.org> parents: diff changeset	2 # -- coding: utf-8 --
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
2771 003b8b4b56a7 date update Goffi <goffi@goffi.org> parents: 2624 diff changeset	5 # Copyright (C) 2009-2019 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 """
3091 2e1c3d33099b tools (common/files_utils): get_unique_name now uses and returns Path instances. Goffi <goffi@goffi.org> parents: 3028 diff changeset	30 ori_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

Mercurial > libervia-backend

annotate sat/tools/common/files_utils.py @ 3091:2e1c3d33099b