Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add mypy annotations for utils/appdirs #5925

Merged
merged 2 commits into from
Nov 6, 2018
Merged

Add mypy annotations for utils/appdirs #5925

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4973760
Add mypy annotations for utils/appdirs
mbaluna Oct 26, 2018
eed9489
Remove win_path_to_bytes annotation
mbaluna Oct 31, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions src/pip/_internal/utils/appdirs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,16 @@
from pip._vendor.six import PY2, text_type

from pip._internal.utils.compat import WINDOWS, expanduser
from pip._internal.utils.typing import MYPY_CHECK_RUNNING

if MYPY_CHECK_RUNNING:
from typing import ( # noqa: F401
List, Union
)


def user_cache_dir(appname):
# type: (str) -> str
r"""
Return full path to the user-specific cache dir for this application.

Expand Down Expand Up @@ -61,6 +68,7 @@ def user_cache_dir(appname):


def user_data_dir(appname, roaming=False):
# type: (str, bool) -> str
r"""
Return full path to the user-specific data dir for this application.

Expand Down Expand Up @@ -113,6 +121,7 @@ def user_data_dir(appname, roaming=False):


def user_config_dir(appname, roaming=True):
# type: (str, bool) -> str
"""Return full path to the user-specific config dir for this application.

"appname" is the name of application.
Expand Down Expand Up @@ -146,6 +155,7 @@ def user_config_dir(appname, roaming=True):
# for the discussion regarding site_config_dirs locations
# see <https://github.com/pypa/pip/issues/1733>
def site_config_dirs(appname):
# type: (str) -> List[str]
r"""Return a list of potential user-shared config dirs for this application.

"appname" is the name of application.
Expand Down Expand Up @@ -186,6 +196,7 @@ def site_config_dirs(appname):
# -- Windows support functions --

def _get_win_folder_from_registry(csidl_name):
# type: (str) -> str
"""
This is a fallback technique at best. I'm not sure if using the
registry for this guarantees us the correct answer for all CSIDL_*
Expand All @@ -208,6 +219,7 @@ def _get_win_folder_from_registry(csidl_name):


def _get_win_folder_with_ctypes(csidl_name):
# type: (str) -> str
csidl_const = {
"CSIDL_APPDATA": 26,
"CSIDL_COMMON_APPDATA": 35,
Expand Down