view sat/tools/common/ @ 3091:2e1c3d33099b

tools (common/files_utils): get_unique_name now uses and returns Path instances.
author Goffi <>
date Fri, 20 Dec 2019 12:28:04 +0100
parents ab2696e34d29
children d6da17f6e4ce
line wrap: on
line source

#!/usr/bin/env python3
# -*- coding: utf-8 -*-

# SAT: a jabber client
# Copyright (C) 2009-2019 Jérôme Poisson (

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero 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
# GNU Affero General Public License for more details.

# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <>.

"""tools to help manipulating files"""
from pathlib import Path

def get_unique_name(path):
    """Generate a path with a name not conflicting with existing file

    @param path(str, Path): path to the file to create
    @return (Path): unique path (can be the same as path if there is no conflict)
    ori_path = Path(path)
    idx = 1
    while path.exists():
        path = ori_path.with_name(  + f"_{idx}")
        idx += 1
    return path