add pydantic_extra_types.S3Path to typing

eonu · Dec 28, 2024 · ecba884 · ecba884
1 parent 0eccade
commit ecba884
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 0 deletions.
diff --git a/docs/source/sections/typing/pydantic_extra_types.rst b/docs/source/sections/typing/pydantic_extra_types.rst
@@ -83,6 +83,11 @@ Phone number type
 
 - :py:obj:`pydantic_extra_types.phone_numbers.PhoneNumber` (``>= 2.1.0``)
 
+Path types
+----------
+
+- :py:obj:`pydantic_extra_types.s3.S3Path` (``>= 2.10.0``)
+
 Payment types
 -------------
 

diff --git a/feud/_internal/_types/click.py b/feud/_internal/_types/click.py
@@ -131,6 +131,12 @@
 
         EXTRA_TYPES[SemanticVersion] = click.STRING
 
+    if version >= packaging.version.parse("2.10.0"):
+        from pydantic_extra_types.s3 import S3Path
+
+        # NOTE: pathlib.Path isn't ideal for S3 paths
+        EXTRA_TYPES[S3Path] = click.STRING
+
 except ImportError:
     EXTRA_TYPES = {}
 

diff --git a/feud/typing/pydantic_extra_types.py b/feud/typing/pydantic_extra_types.py
@@ -85,5 +85,10 @@ def split(string: str) -> str:
 
         __all__.append("SemanticVersion")
 
+    if version >= packaging.version.parse("2.10.0"):
+        from pydantic_extra_types.s3 import S3Path
+
+        __all__.append("S3Path")
+
 except ImportError:
     pass
diff --git a/...unit/test_internal/test_types/test_click/test_get_click_type/test_pydantic_extra_types.py b/...unit/test_internal/test_types/test_click/test_get_click_type/test_pydantic_extra_types.py
@@ -39,6 +39,7 @@
         (t.LanguageAlpha2, click.STRING),
         (t.LanguageName, click.STRING),
         (t.SemanticVersion, click.STRING),
+        (t.S3Path, click.STRING),
     ],
 )
 def test_pydantic_extra(