コンテンツへスキップ

参考 ultralytics/utils/files.py

備考

このファイルはhttps://github.com/ultralytics/ultralytics/blob/main/ ultralytics/utils/files .py にあります。もし問題を発見したら、Pull Request🛠️ を投稿して修正にご協力ください。ありがとうございました!



ultralytics.utils.files.WorkingDirectory

ベース: ContextDecorator

使い方:WorkingDirectory(dir) デコレータまたは 'with WorkingDirectory(dir):' コンテキストマネージャ。

ソースコード ultralytics/utils/files.py
class WorkingDirectory(contextlib.ContextDecorator):
    """Usage: @WorkingDirectory(dir) decorator or 'with WorkingDirectory(dir):' context manager."""

    def __init__(self, new_dir):
        """Sets the working directory to 'new_dir' upon instantiation."""
        self.dir = new_dir  # new dir
        self.cwd = Path.cwd().resolve()  # current dir

    def __enter__(self):
        """Changes the current directory to the specified directory."""
        os.chdir(self.dir)

    def __exit__(self, exc_type, exc_val, exc_tb):  # noqa
        """Restore the current working directory on context exit."""
        os.chdir(self.cwd)

__enter__()

カレントディレクトリを指定されたディレクトリに変更する。

ソースコード ultralytics/utils/files.py
def __enter__(self):
    """Changes the current directory to the specified directory."""
    os.chdir(self.dir)

__exit__(exc_type, exc_val, exc_tb)

コンテキストの終了時に現在の作業ディレクトリを復元する。

ソースコード ultralytics/utils/files.py
def __exit__(self, exc_type, exc_val, exc_tb):  # noqa
    """Restore the current working directory on context exit."""
    os.chdir(self.cwd)

__init__(new_dir)

インスタンス化時に作業ディレクトリを 'new_dir' に設定する。

ソースコード ultralytics/utils/files.py
def __init__(self, new_dir):
    """Sets the working directory to 'new_dir' upon instantiation."""
    self.dir = new_dir  # new dir
    self.cwd = Path.cwd().resolve()  # current dir



ultralytics.utils.files.spaces_in_path(path)

名前にスペースが含まれるパスを扱うためのコンテキスト・マネージャー。パスにスペースが含まれている場合、それをアンダースコアに置き換える。 アンダースコアに置き換え、ファイル/ディレクトリを新しいパスにコピーし、 コンテキストコードブロックを実行した後、ファイル/ディレクトリを元の場所にコピーする。 を元の場所にコピーする。

パラメーター

名称 タイプ 説明 デフォルト
path str | Path

本来の道。

必須

収量:

タイプ 説明
Path

スペースがあればアンダースコアに、なければ元のパスに置き換えた一時的なパス。

例
with ultralytics.utils.files import spaces_in_path

with spaces_in_path('/path/with spaces') as new_path:
    # Your code here
ソースコード ultralytics/utils/files.py
@contextmanager
def spaces_in_path(path):
    """
    Context manager to handle paths with spaces in their names. If a path contains spaces, it replaces them with
    underscores, copies the file/directory to the new path, executes the context code block, then copies the
    file/directory back to its original location.

    Args:
        path (str | Path): The original path.

    Yields:
        (Path): Temporary path with spaces replaced by underscores if spaces were present, otherwise the original path.

    Example:
        ```python
        with ultralytics.utils.files import spaces_in_path

        with spaces_in_path('/path/with spaces') as new_path:
            # Your code here
        ```
    """

    # If path has spaces, replace them with underscores
    if " " in str(path):
        string = isinstance(path, str)  # input type
        path = Path(path)

        # Create a temporary directory and construct the new path
        with tempfile.TemporaryDirectory() as tmp_dir:
            tmp_path = Path(tmp_dir) / path.name.replace(" ", "_")

            # Copy file/directory
            if path.is_dir():
                # tmp_path.mkdir(parents=True, exist_ok=True)
                shutil.copytree(path, tmp_path)
            elif path.is_file():
                tmp_path.parent.mkdir(parents=True, exist_ok=True)
                shutil.copy2(path, tmp_path)

            try:
                # Yield the temporary path
                yield str(tmp_path) if string else tmp_path

            finally:
                # Copy file/directory back
                if tmp_path.is_dir():
                    shutil.copytree(tmp_path, path, dirs_exist_ok=True)
                elif tmp_path.is_file():
                    shutil.copy2(tmp_path, path)  # Copy back the file

    else:
        # If there are no spaces, just yield the original path
        yield path



ultralytics.utils.files.increment_path(path, exist_ok=False, sep='', mkdir=False)

すなわち、runs/exp --> runs/exp{sep}2, runs/exp{sep}3, ... など。

パスが存在し、exist_okがTrueに設定されていない場合、パスの末尾に数字とsepが追加され、パスがインクリメントされる。 をパスの末尾に付加することでインクリメントされる。パスがファイルの場合、ファイルの拡張子は保持される。パスがディレクトリの場合は がパスの末尾に直接付加される。mkdirがTrueに設定されている場合、パスはディレクトリとして作成されます。 ディレクトリとして作成されます。

パラメーター

名称 タイプ 説明 デフォルト
path (str, Path)

インクリメントへの道

必須
exist_ok bool

Trueの場合、パスはインクリメントされず、そのまま返される。デフォルトはFalseです。

False
sep str

パスとインクリメント番号の間に使用するセパレーター。デフォルトは''である。

''
mkdir bool

ディレクトリが存在しない場合に作成する。デフォルトは False。

False

リターンズ

タイプ 説明
Path

パスのインクリメント。

ソースコード ultralytics/utils/files.py
def increment_path(path, exist_ok=False, sep="", mkdir=False):
    """
    Increments a file or directory path, i.e. runs/exp --> runs/exp{sep}2, runs/exp{sep}3, ... etc.

    If the path exists and exist_ok is not set to True, the path will be incremented by appending a number and sep to
    the end of the path. If the path is a file, the file extension will be preserved. If the path is a directory, the
    number will be appended directly to the end of the path. If mkdir is set to True, the path will be created as a
    directory if it does not already exist.

    Args:
        path (str, pathlib.Path): Path to increment.
        exist_ok (bool, optional): If True, the path will not be incremented and returned as-is. Defaults to False.
        sep (str, optional): Separator to use between the path and the incrementation number. Defaults to ''.
        mkdir (bool, optional): Create a directory if it does not exist. Defaults to False.

    Returns:
        (pathlib.Path): Incremented path.
    """
    path = Path(path)  # os-agnostic
    if path.exists() and not exist_ok:
        path, suffix = (path.with_suffix(""), path.suffix) if path.is_file() else (path, "")

        # Method 1
        for n in range(2, 9999):
            p = f"{path}{sep}{n}{suffix}"  # increment path
            if not os.path.exists(p):
                break
        path = Path(p)

    if mkdir:
        path.mkdir(parents=True, exist_ok=True)  # make directory

    return path



ultralytics.utils.files.file_age(path=__file__)

ファイルの最終更新からの日数を返す。

ソースコード ultralytics/utils/files.py
def file_age(path=__file__):
    """Return days since last file update."""
    dt = datetime.now() - datetime.fromtimestamp(Path(path).stat().st_mtime)  # delta
    return dt.days  # + dt.seconds / 86400  # fractional days



ultralytics.utils.files.file_date(path=__file__)

人間が読めるファイルの更新日、すなわち'2021-3-26'を返す。

ソースコード ultralytics/utils/files.py
def file_date(path=__file__):
    """Return human-readable file modification date, i.e. '2021-3-26'."""
    t = datetime.fromtimestamp(Path(path).stat().st_mtime)
    return f"{t.year}-{t.month}-{t.day}"



ultralytics.utils.files.file_size(path)

ファイル/ディレクトリのサイズ(MB)を返します。

ソースコード ultralytics/utils/files.py
def file_size(path):
    """Return file/dir size (MB)."""
    if isinstance(path, (str, Path)):
        mb = 1 << 20  # bytes to MiB (1024 ** 2)
        path = Path(path)
        if path.is_file():
            return path.stat().st_size / mb
        elif path.is_dir():
            return sum(f.stat().st_size for f in path.glob("**/*") if f.is_file()) / mb
    return 0.0



ultralytics.utils.files.get_latest_run(search_dir='.')

runsにある最新の'last.pt'へのパスを返す(つまり--resume fromへ)。

ソースコード ultralytics/utils/files.py
def get_latest_run(search_dir="."):
    """Return path to most recent 'last.pt' in /runs (i.e. to --resume from)."""
    last_list = glob.glob(f"{search_dir}/**/last*.pt", recursive=True)
    return max(last_list, key=os.path.getctime) if last_list else ""





作成日:2023-11-12 更新日:2023-11-25
作成者:glenn-jocher(3),Laughing-q(1)