Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

make FieldInfo a protocol #949

Merged
merged 4 commits into from
Feb 19, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions xsdata/formats/dataclass/compat.py
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
import abc
from dataclasses import MISSING, fields, is_dataclass
from typing import Any, Dict, Iterator, List, NamedTuple, Optional, Set, Type, cast
from types import MappingProxyType
from typing import Any, Dict, Iterator, Optional, Protocol, Set, Type

from xsdata.exceptions import XmlContextError
from xsdata.formats.dataclass.models.generics import AnyElement, DerivedElement
from xsdata.utils.hooks import load_entry_points


class FieldInfo(NamedTuple):
class FieldInfo(Protocol):
"""A class field info wrapper."""

name: str
init: bool
metadata: Dict[str, Any]
metadata: "MappingProxyType[Any, Any]"
default: Any
default_factory: Any

Expand Down Expand Up @@ -173,7 +174,7 @@ def verify_model(self, obj: Any):

def get_fields(self, obj: Any) -> Iterator[FieldInfo]:
"""Return a dataclass fields iterator."""
yield from cast(List[FieldInfo], fields(obj))
yield from fields(obj)

def default_value(self, field: FieldInfo, default: Optional[Any] = None) -> Any:
"""Return the default value or factory of the given model field."""
Expand Down
Loading