在上下文管理器处理路径上键入提示

问题描述 投票:1回答:1

代码(在@ juanpa.arrivillaga的帮助下修复:

"""Helpers that can be used for context management."""

import logging
import os
from contextlib import contextmanager
from pathlib import Path
from typing import Union, Iterator, Optional

_LOGGER = logging.getLogger(__name__)


@contextmanager
def working_directory(temporary_path: Union[Path, str], initial_path: Optional[Union[Path, str]] = None) -> Iterator[None]:
    """Changes working directory, and returns to `initial_path` on exit. It's needed for PRAW for example,
    because it looks for praw.ini in Path.cwd(), but that file could be kept in a different directory.

    `initial_path` can be used for example to change working directory relative to the script path, or
    to end up in a different directory than Path.cwd() of the calling script.

    Inspiration: https://stackoverflow.com/questions/41742317/how-can-i-change-directory-with-python-pathlib
    """
    _LOGGER.debug('Working directory of the calling script: %s', Path.cwd())
    _LOGGER.debug('temporary_path = %s', temporary_path)
    _LOGGER.debug('initial_path = %s', initial_path)

    if not isinstance(temporary_path, (Path, str)):
        raise TypeError('"temporary_path" is not of type `Path` or `str`')

    if initial_path is None:
        initial_path = Path.cwd()
    else:
        initial_path = Path(initial_path).absolute()
        if not initial_path.is_dir():
            initial_path = initial_path.parent

    try:
        os.chdir(initial_path / temporary_path)
        _LOGGER.debug('Temporarily changed working directory to: %s', Path.cwd())
        yield
    finally:
        os.chdir(initial_path)

我输入的打字注释是否正确?

还有,有更多的pythonic方式来编写这个函数吗?你会改变什么?我也会在CodeReview中发布它。

python python-3.x mypy
1个回答
2
投票

打字很好,你只需要在你的代码中通过mypy显示错误。如果initial_pathtemporary_path都是str那么这将失败。这就是为什么它在抱怨。

你只在一个分支中转换为Path你没有else(不好的做法,IMO),所以当你到达这条线:

initial_path / temporary_path可能是这两个都是str

请注意,mypy不知道这一点,但if initial_path is not Path.cwd()不正确。此声明将始终为False。除非你的意思是对象身份,否则不要将它与is进行比较,在这种情况下,你不要。

考虑:

>>> from pathlib import Path
>>> Path().cwd() is  Path().cwd()
False

做就是了:

def working_directory(
    temporary_path: Union[Path, str],
    initial_path: Union[Path, str] = Path.cwd()
) -> Iterator[None]:
    temporary_path = Path(temporary_path)
    initial_path = Path(initial_path)

在你的功能的开始。

© www.soinside.com 2019 - 2024. All rights reserved.