Merge current dev while retaining numeric timestamp minimum and validation

Author: Sanjays2402

.github/workflows/build-release.yml

@@ -25,7 +25,7 @@ jobs:
       - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
         with:
           persist-credentials: false
-      - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
         with: # zizmor: ignore[cache-poisoning] cache key is lockfile-derived
           enable-cache: true
       - run: uv run tox -e${{ matrix.tox }}
@@ -36,7 +36,7 @@ jobs:
       - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
         with:
           persist-credentials: false
-      - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
         with: # zizmor: ignore[cache-poisoning] cache key is lockfile-derived
           enable-cache: true
       - run: uv build
@@ -55,7 +55,7 @@ jobs:
       - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
         with:
           persist-credentials: false
-      - uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+      - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
         with: # zizmor: ignore[cache-poisoning] cache key is lockfile-derived
           enable-cache: true
       - run: uv run tox -e lint

.pre-commit-config.yaml

@@ -2,17 +2,17 @@ ci:
   autoupdate_schedule: monthly
 repos:
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.15.20
+  rev: v0.16.6
   hooks:
     - id: ruff
     - id: ruff-format
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.37.4
+  rev: 0.38.0
   hooks:
     - id: check-github-workflows
     - id: check-readthedocs
 - repo: https://github.com/zizmorcore/zizmor-pre-commit
-  rev: v1.26.1
+  rev: v1.30.0
   hooks:
     - id: zizmor
 - repo: https://github.com/asottile/blacken-docs
@@ -21,11 +21,11 @@ repos:
   - id: blacken-docs
     additional_dependencies: [black==24.10.0]
 - repo: https://github.com/pre-commit/mirrors-mypy
-  rev: v2.1.0
+  rev: v2.3.1
   hooks:
   - id: mypy
     additional_dependencies: ["marshmallow>=3.24.1,<5", "types-PyYAML"]
 - repo: https://github.com/astral-sh/uv-pre-commit
-  rev: 0.11.26
+  rev: 0.12.10
   hooks:
     - id: uv-lock

AUTHORS.rst

@@ -91,3 +91,5 @@ Contributors (chronological)
 - Felix Claessen `@Flix6x <https://github.com/Flix6x>`_
 - Karthik Ramadugu `@karthiksai109 <https://github.com/karthiksai109>`_
 - Amir Kahriman `@kingdomOfIT <https://github.com/kingdomOfIT>`_
+- Alex Chen `@alexchen-sys <https://github.com/alexchen-sys>`_
+- Bing Gao `@binggao1230 <binggao1230>`_

CHANGELOG.rst

@@ -9,6 +9,11 @@ Bug fixes:
 - ``MarshmallowPlugin``: Emit ``minimum: 0`` rather than the non-standard
   ``min: "0"`` for ``DateTime`` fields with the ``"timestamp"`` and
   ``"timestamp_ms"`` formats (:issue:`1064`).
+- Recognize ``trace`` operations defined in view docstrings, instead of
+  silently dropping them (:pr:`1059`).
+  Thanks :user:`binggao1230` for the PR.
+- Fix intersect ``OneOf`` and ``Equal`` choices in ``field2choices`` (:issue:`198`).
+  Thanks :user:`alexchen-sys` for the PR.
 
 Other changes:
 
@@ -124,7 +129,7 @@ Other changes:
 
 Bug fixes:
 
-- ``MarshmallowPlugin``: Fix handling of ``Nested`` fields with 
+- ``MarshmallowPlugin``: Fix handling of ``Nested`` fields with
   ``allow_none=True`` (:issue:`833`). Thanks :user:`jc-harrison`
   for reporting and :user:`kolditz-senec` for the PR.
 

pyproject.toml

@@ -60,7 +60,7 @@ default-groups = ["dev"]
 exclude-newer = "1 week"
 
 [build-system]
-requires = ["flit_core<4"]
+requires = ["flit_core<5"]
 build-backend = "flit_core.buildapi"
 
 [tool.flit.sdist]

src/apispec/ext/marshmallow/field_converter.py

@@ -242,21 +242,14 @@ def field2choices(
         """
         attributes = {}
 
-        comparable = [
-            validator.comparable
-            for validator in field.validators
-            if hasattr(validator, "comparable")
-        ]
-        if comparable:
-            attributes["enum"] = comparable
-        else:
-            choices = [
-                OrderedSet(validator.choices)
-                for validator in field.validators
-                if hasattr(validator, "choices")
-            ]
-            if choices:
-                attributes["enum"] = list(functools.reduce(operator.and_, choices))
+        choices = []
+        for validator in field.validators:
+            if hasattr(validator, "choices"):
+                choices.append(OrderedSet(validator.choices))
+            elif hasattr(validator, "comparable"):
+                choices.append(OrderedSet([validator.comparable]))
+        if choices:
+            attributes["enum"] = list(functools.reduce(operator.and_, choices))
 
         if field.allow_none:
             enum = attributes.get("enum")

src/apispec/yaml_utils.py

@@ -36,7 +36,7 @@ def load_yaml_from_docstring(docstring: str) -> dict:
     return yaml.safe_load(yaml_string) or {}
 
 
-PATH_KEYS = {"get", "put", "post", "delete", "options", "head", "patch"}
+PATH_KEYS = {"get", "put", "post", "delete", "options", "head", "patch", "trace"}
 
 
 def load_operations_from_docstring(docstring: str) -> dict:

tests/test_ext_marshmallow_field.py

@@ -190,15 +190,79 @@ def test_only_allows_valid_properties_in_metadata(spec_fixture):
     assert "not_valid" not in res
 
 
-def test_field_with_choices_multiple(spec_fixture):
-    field = fields.Str(
-        validate=[
-            validate.OneOf(["freddie", "brian", "john"]),
-            validate.OneOf(["brian", "john", "roger"]),
-        ]
-    )
+@pytest.mark.parametrize(
+    ("validators", "expected_enum"),
+    [
+        (
+            [
+                validate.OneOf(["freddie", "brian", "john"]),
+                validate.OneOf(["brian", "john", "roger"]),
+            ],
+            {"brian", "john"},
+        ),
+        (
+            [
+                validate.OneOf(["freddie", "brian"]),
+                validate.OneOf(["john", "roger"]),
+            ],
+            set(),
+        ),
+    ],
+)
+def test_field_with_multiple_oneof(spec_fixture, validators, expected_enum):
+    field = fields.Str(validate=validators)
+    res = spec_fixture.openapi.field2property(field)
+    assert set(res["enum"]) == expected_enum
+
+
+@pytest.mark.parametrize(
+    ("validators", "expected_enum"),
+    [
+        (
+            [
+                validate.Equal("brian"),
+                validate.Equal("brian"),
+            ],
+            {"brian"},
+        ),
+        (
+            [
+                validate.Equal("freddie"),
+                validate.Equal("brian"),
+            ],
+            set(),
+        ),
+    ],
+)
+def test_field_with_multiple_equal(spec_fixture, validators, expected_enum):
+    field = fields.Str(validate=validators)
+    res = spec_fixture.openapi.field2property(field)
+    assert set(res["enum"]) == expected_enum
+
+
+@pytest.mark.parametrize(
+    ("validators", "expected_enum"),
+    [
+        (
+            [
+                validate.OneOf(["freddie", "brian", "john"]),
+                validate.Equal("brian"),
+            ],
+            {"brian"},
+        ),
+        (
+            [
+                validate.OneOf(["freddie", "brian"]),
+                validate.Equal("john"),
+            ],
+            set(),
+        ),
+    ],
+)
+def test_field_with_oneof_and_equal(spec_fixture, validators, expected_enum):
+    field = fields.Str(validate=validators)
     res = spec_fixture.openapi.field2property(field)
-    assert set(res["enum"]) == {"brian", "john"}
+    assert set(res["enum"]) == expected_enum
 
 
 def test_field_with_additional_metadata(spec_fixture):

tests/test_yaml_utils.py

@@ -29,6 +29,22 @@ def test_load_operations_from_docstring_empty_docstring(docstring):
     assert yaml_utils.load_operations_from_docstring(docstring) == {}
 
 
+@pytest.mark.parametrize(
+    "method", ("get", "put", "post", "delete", "options", "head", "patch", "trace")
+)
+def test_load_operations_from_docstring_path_methods(method):
+    docstring = f"""Foo.
+    ---
+    {method}:
+        responses:
+            200:
+                description: ok
+    """
+
+    operations = yaml_utils.load_operations_from_docstring(docstring)
+    assert operations == {method: {"responses": {200: {"description": "ok"}}}}
+
+
 def test_dict_to_yaml_unicode():
     assert yaml_utils.dict_to_yaml({"가": "나"}) == '"\\uAC00": "\\uB098"\n'
     assert yaml_utils.dict_to_yaml({"가": "나"}, {"allow_unicode": True}) == "가: 나\n"