Merge pull request #10539 from pradyunsg/vendoring-upgrade

Author: uranusjr

news/appdirs.vendor.rst

@@ -0,0 +1 @@
+Remove appdirs as a vendored dependency.

news/c8285e11-5b65-498c-9eaa-85ca096243f9.vendor.rst

@@ -0,0 +1 @@
+Upgrade distro to 1.6.0

news/d8390fd1-8c20-4ef8-bea3-ad6b2eb5b3a5.vendor.rst renamed to news/distlib.vendor.rst

@@ -1 +1 @@
-Patch platformdirs import its submodules from ``pip._vendor.platformdirs``.
+Add platformdirs as a vendored dependency.

news/distro.vendor.rst

@@ -0,0 +1 @@
+Upgrade progress to 1.6

news/ecb79d5a-46b6-4e7b-8ee8-561c9aac697b.vendor.rst

@@ -0,0 +1 @@
+Upgrade urllib3 to 1.26.7

news/platformdirs.vendor.rst

@@ -144,6 +144,29 @@ def user_log_dir(
     return PlatformDirs(appname=appname, appauthor=appauthor, version=version, opinion=opinion).user_log_dir
 
 
+def user_documents_dir() -> str:
+    """
+    :returns: documents directory tied to the user
+    """
+    return PlatformDirs().user_documents_dir
+
+
+def user_runtime_dir(
+    appname: Optional[str] = None,
+    appauthor: Union[str, None, "Literal[False]"] = None,
+    version: Optional[str] = None,
+    opinion: bool = True,
+) -> str:
+    """
+    :param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
+    :param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
+    :param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
+    :param opinion: See `opinion <platformdirs.api.PlatformDirsABC.opinion>`.
+    :returns: runtime directory tied to the user
+    """
+    return PlatformDirs(appname=appname, appauthor=appauthor, version=version, opinion=opinion).user_runtime_dir
+
+
 def user_data_path(
     appname: Optional[str] = None,
     appauthor: Union[str, None, "Literal[False]"] = None,
@@ -256,6 +279,29 @@ def user_log_path(
     return PlatformDirs(appname=appname, appauthor=appauthor, version=version, opinion=opinion).user_log_path
 
 
+def user_documents_path() -> Path:
+    """
+    :returns: documents path tied to the user
+    """
+    return PlatformDirs().user_documents_path
+
+
+def user_runtime_path(
+    appname: Optional[str] = None,
+    appauthor: Union[str, None, "Literal[False]"] = None,
+    version: Optional[str] = None,
+    opinion: bool = True,
+) -> Path:
+    """
+    :param appname: See `appname <platformdirs.api.PlatformDirsABC.appname>`.
+    :param appauthor: See `appauthor <platformdirs.api.PlatformDirsABC.appauthor>`.
+    :param version: See `version <platformdirs.api.PlatformDirsABC.version>`.
+    :param opinion: See `opinion <platformdirs.api.PlatformDirsABC.opinion>`.
+    :returns: runtime path tied to the user
+    """
+    return PlatformDirs(appname=appname, appauthor=appauthor, version=version, opinion=opinion).user_runtime_path
+
+
 __all__ = [
     "__version__",
     "__version_info__",
@@ -267,13 +313,17 @@ def user_log_path(
     "user_cache_dir",
     "user_state_dir",
     "user_log_dir",
+    "user_documents_dir",
+    "user_runtime_dir",
     "site_data_dir",
     "site_config_dir",
     "user_data_path",
     "user_config_path",
     "user_cache_path",
     "user_state_path",
     "user_log_path",
+    "user_documents_path",
+    "user_runtime_path",
     "site_data_path",
     "site_config_path",
 ]

news/progress.vendor.rst

@@ -6,6 +6,8 @@
     "user_cache_dir",
     "user_state_dir",
     "user_log_dir",
+    "user_documents_dir",
+    "user_runtime_dir",
     "site_data_dir",
     "site_config_dir",
 )