refactor(vcs literal): Rename to VCSLiteral and move to types

tony · tony · commit 1a9c0449d94e · 2022-06-18T18:21:49.000-05:00
diff --git a/libvcs/shortcuts.py b/libvcs/shortcuts.py
@@ -6,7 +6,7 @@
 from libvcs._internal.run import ProgressCallbackProtocol
 from libvcs.exc import InvalidPipURL, InvalidVCS
 
-VcsLiteral = t.Literal["git", "svn", "hg"]
+VCSLiteral = t.Literal["git", "svn", "hg"]
 
 
 @t.overload
@@ -44,7 +44,7 @@ def create_project(
 
 def create_project(
     url: str,
-    vcs: VcsLiteral,
+    vcs: VCSLiteral,
     progress_callback: t.Optional[ProgressCallbackProtocol] = None,
     *args,
     **kwargs
diff --git a/libvcs/types.py b/libvcs/types.py
@@ -8,7 +8,7 @@
 .. _typeshed's: https://github.com/python/typeshed/blob/5df8de7/stdlib/_typeshed/__init__.pyi#L115-L118
 """  # NOQA E501
 from os import PathLike
-from typing import Union
+from typing import Literal, Union
 
 from typing_extensions import TypeAlias
 
@@ -17,3 +17,7 @@
 
 StrOrBytesPath: TypeAlias = Union[str, bytes, PathLike[str], PathLike[bytes]]  # stable
 """:class:`os.PathLike`, :class:`str` or :term:`bytes-like object`"""
+
+
+VCSLiteral = Literal["git", "svn", "hg"]
+"""UNSTABLE: Literal of built-in VCS aliases"""
