Merge pull request #164 from kddubey/kddubey/fix-python-314

Prepare for Python 3.14

Author: martinjm97

README.md

@@ -65,10 +65,7 @@ pip install -e .
 python -m pip install -e ".[dev]"
 ```
 
-Style:
-- Please use [`black`](https://github.com/psf/black) formatting
-- Set your vertical line ruler to 121
-- Use [`flake8`](https://github.com/PyCQA/flake8) linting.
+Use [`flake8`](https://github.com/PyCQA/flake8) linting.
 
 To run tests, run:
 
@@ -202,7 +199,7 @@ Running `python main.py -h` results in the following:
 
 ```
 >>> python main.py -h
-usage: demo.py --x X [--pi PI] [-h]
+usage: main.py --x X [--pi PI] [-h]
 
 optional arguments:
   --x X       (float, required) What am I?
@@ -919,5 +916,5 @@ class MyCustomTap(to_tap_class(my_class_or_function)):
     # Special argument behavior, e.g., override configure and/or process_args
 ```
 
-Please see `demo_data_model.py` for an example of overriding [`configure`](#configuring-arguments) and
-[`process_args`](#argument-processing).
+Please see [`demos/demo_data_model.py`](./demos/demo_data_model.py) for an example of overriding
+[`configure`](#configuring-arguments) and [`process_args`](#argument-processing).

demo.py renamed to demos/demo.py

@@ -1,6 +1,4 @@
 """
-Works for Pydantic v1 and v2.
-
 Example commands:
 
 python demo_data_model.py -h
@@ -16,6 +14,7 @@
     --arg_bool \
     -arg 3.14
 """
+
 from typing import List, Literal, Optional, Union
 
 from pydantic import BaseModel, Field

demo_data_model.py renamed to demos/demo_data_model.py

@@ -18,7 +18,6 @@ readme = "README.md"
 license = { file = "LICENSE.txt" }
 dependencies = [
     "docstring-parser >= 0.15",
-    "packaging",
     "typing-inspect >= 0.7.1",
 ]
 requires-python = ">=3.9"
@@ -41,6 +40,7 @@ keywords = [
 
 [project.optional-dependencies]
 dev-no-pydantic = [
+    "black",
     "pytest",
     "pytest-cov",
     "flake8",
@@ -62,6 +62,9 @@ version = {attr = "tap.__version__"}
 [tool.setuptools.package-data]
 tap = ["py.typed"]
 
+[tool.black]
+line-length = 121
+
 [project.urls]
 Homepage = "https://github.com/swansonk14/typed-argument-parser"
 Issues = "https://github.com/swansonk14/typed-argument-parser/issues"

pyproject.toml

@@ -10,7 +10,6 @@
 from typing import Any, Callable, Optional, Sequence, TypeVar, Union
 
 from docstring_parser import Docstring, parse
-from packaging.version import Version
 
 try:
     import pydantic
@@ -21,7 +20,7 @@
     _PydanticField = type("_PydanticField", (object,), {})
     _PYDANTIC_FIELD_TYPES = ()
 else:
-    _IS_PYDANTIC_V1 = Version(pydantic.__version__) < Version("2.0.0")
+    _IS_PYDANTIC_V1 = pydantic.VERSION.startswith("1.")
     from pydantic import BaseModel
     from pydantic.fields import FieldInfo as PydanticFieldBaseModel
     from pydantic.dataclasses import FieldInfo as PydanticFieldDataclass
@@ -191,7 +190,21 @@ def _tap_data_from_class_or_function(
 
     sig = inspect.signature(class_or_function)
 
-    for param_name, param in sig.parameters.items():
+    is_pydantic_v1_dataclass_class = (
+        _IS_PYDANTIC_V1 and _is_pydantic_dataclass(class_or_function) and inspect.isclass(class_or_function)
+    )
+
+    for idx, (param_name, param) in enumerate(sig.parameters.items()):
+        if (
+            idx == 0
+            and param.annotation == inspect.Parameter.empty
+            and param_name == "self"
+            and is_pydantic_v1_dataclass_class
+        ):
+            # This check gets around a quirk of Pydantic v1 dataclasses. Sometime after Python 3.13.0, the signature
+            # started including self as the first parameter out of inspect.signature
+            continue
+
         # Skip **kwargs
         if param.kind == inspect.Parameter.VAR_KEYWORD:
             has_kwargs = True

src/tap/tapify.py

@@ -110,8 +110,11 @@ def configure(self):
                 self.add_subparser("a", SubparserB)
                 self.add_subparser("a", SubparserA)
 
-        if sys.version_info >= (3, 11):
-            with self.assertRaises(ArgumentError):
+        if sys.version_info >= (3, 14):
+            with self.assertRaises(ValueError, msg="conflicting subparser: a"):
+                Args().parse_args([])
+        elif sys.version_info >= (3, 11):
+            with self.assertRaises(ArgumentError, msg="argument {a}: conflicting subparser: a"):
                 Args().parse_args([])
         else:
             args = Args().parse_args("a --bar 2".split())
@@ -134,8 +137,11 @@ def configure(self):
                 self.add_subparsers(help="sub-command1 help")
                 self.add_subparsers(help="sub-command2 help")
 
-        if sys.version_info >= (3, 12, 5):
-            with self.assertRaises(ArgumentError):
+        if sys.version_info >= (3, 14):
+            with self.assertRaises(ValueError, msg="cannot have multiple subparser arguments"):
+                Args().parse_args([])
+        elif sys.version_info >= (3, 12, 5):
+            with self.assertRaises(ArgumentError, msg="cannot have multiple subparser arguments"):
                 Args().parse_args([])
         else:
             with self.assertRaises(SystemExit):

tests/test_subparser.py

@@ -10,8 +10,6 @@
 import unittest
 from unittest import TestCase
 
-from packaging.version import Version
-
 from tap import tapify
 
 
@@ -20,7 +18,7 @@
 except ModuleNotFoundError:
     _IS_PYDANTIC_V1 = None
 else:
-    _IS_PYDANTIC_V1 = Version(pydantic.__version__) < Version("2.0.0")
+    _IS_PYDANTIC_V1 = pydantic.VERSION.startswith("1.")
 
 
 # Suppress prints from SystemExit

tests/test_tapify.py

@@ -9,7 +9,6 @@
 import sys
 from typing import Any, Callable, List, Literal, Optional, Type, Union
 
-from packaging.version import Version
 import pytest
 
 from tap import to_tap_class, Tap
@@ -21,7 +20,7 @@
 except ModuleNotFoundError:
     _IS_PYDANTIC_V1 = None
 else:
-    _IS_PYDANTIC_V1 = Version(pydantic.__version__) < Version("2.0.0")
+    _IS_PYDANTIC_V1 = pydantic.VERSION.startswith("1.")
 
 
 # To properly test the help message, we need to know how argparse formats it. It changed from 3.9 -> 3.10 -> 3.13
@@ -422,8 +421,8 @@ def test_subclasser_complex_help_message(class_or_function_: Any):
 
     {_OPTIONS_TITLE}:
     {_ARG_WITH_ALIAS}
-                            (Union[float, int], default=3) This argument has a long name and will be aliased with a short
-                            one
+                            ({type_to_str(Union[float, int])}, default=3) This argument has a long name and will be
+                            aliased with a short one
     --arg_int ARG_INT     (int, required) some integer
     --arg_bool            (bool, default=True)
     --arg_list [ARG_LIST {_ARG_LIST_DOTS}]
@@ -470,9 +469,7 @@ def test_subclasser_complex_help_message(class_or_function_: Any):
         ),
         (
             "--arg_int 1 --baz X --foo b",
-            SystemExit(
-                r"error: argument \{a,b}: invalid choice: 'X' \(choose from '?a'?, '?b'?\)"
-            ),
+            SystemExit(r"error: argument \{a,b}: invalid choice: 'X' \(choose from '?a'?, '?b'?\)"),
         ),
         (
             "--arg_int 1 b --baz X --foo",
@@ -544,7 +541,7 @@ def test_subclasser_subparser(
     ],
 )
 def test_subclasser_subparser_help_message(
-    class_or_function_: Any, args_string_and_description_and_expected_message: tuple[str, str]
+    class_or_function_: Any, args_string_and_description_and_expected_message: tuple[str, str, str]
 ):
     args_string, description, expected_message = args_string_and_description_and_expected_message
     _test_subclasser_message(

tests/test_to_tap_class.py

@@ -3,6 +3,7 @@
 import json
 import os
 import subprocess
+import sys
 from tempfile import TemporaryDirectory
 from typing import Any, Callable, List, Literal, Dict, Set, Tuple, Union
 import unittest
@@ -145,7 +146,11 @@ def test_type_to_str(self) -> None:
         self.assertEqual(type_to_str(List[bool]), "List[bool]")
         self.assertEqual(type_to_str(Set[int]), "Set[int]")
         self.assertEqual(type_to_str(Dict[str, int]), "Dict[str, int]")
-        self.assertEqual(type_to_str(Union[List[int], Dict[float, bool]]), "Union[List[int], Dict[float, bool]]")
+
+        if sys.version_info >= (3, 14):
+            self.assertEqual(type_to_str(Union[List[int], Dict[float, bool]]), "List[int] | Dict[float, bool]")
+        else:
+            self.assertEqual(type_to_str(Union[List[int], Dict[float, bool]]), "Union[List[int], Dict[float, bool]]")
 
 
 def class_decorator(cls):