3.0以降引数キーワードのみを作成するサポートがあります:
class S3Obj:
def __init__(self, bucket, key, *, storage_class='Standard'):
self.bucket = bucket
self.key = key
self.storage_class = storage_class
そのような署名を取得する方法データクラス? 次のような内容ですが、できればSyntaxError:は不要です。
@dataclass
class S3Obj:
bucket: str
key: str
*
storage_class: str = 'Standard'
理想的には宣言的ですが、__post_init__コードが再利用できる限り、フックや置換クラス デコレータを使用することもできます。
編集：省略記号リテラルを使った次のような構文になるかもしれません
@mydataclass
class S3Obj:
bucket: str
key: str
...
storage_class: str = 'Standard'
ベストアンサー1
Python 3.10以降では、dataclasses.KW_ONLY次のように動作するセンチネル:
@dataclasses.dataclass
class Example:
a: int
b: int
_: dataclasses.KW_ONLY
c: int
d: int
疑似フィールドの後のフィールドはKW_ONLYキーワードのみです。
kw_onlyデコレータにはdataclasses.dataclass、すべてのフィールドをキーワードのみにするパラメータもあります。
@dataclasses.dataclass(kw_only=True)
class Example:
a: int
b: int
個々のフィールドをキーワードのみとしてマークするためにkw_only=Trueを渡すこともできます。dataclasses.field
キーワードのみのフィールドが非キーワードのみのフィールドの後に来る場合（継承によって可能、または個別にキーワードのみのフィールドをマークすることによって可能）、キーワードのみのフィールドは並べ替え他のフィールドの後、特に の目的のために__init__。他のデータクラス機能は宣言された順序を維持します。この順序変更は混乱を招くため、おそらく避けるべきです。
Python 3.10 以前の回答:
これを実行するときに、 はあまり役に立ちませんdataclasses。フィールドをキーワードのみの引数で初期化する必要があることを指定する方法はありません__post_init__。また、フックは元のコンストラクタ引数がキーワードで渡されたかどうかを知りません。また、 をイントロスペクトする良い方法はなくInitVar、InitVarをキーワードのみとしてマークすることはできません。
少なくとも、生成された を置き換える必要があります__init__。おそらく最も簡単な方法は、__init__手動で定義することです。それをしたくない場合は、おそらく最も堅牢な方法は、フィールド オブジェクトを作成し、 で kwonly としてマークしてmetadataから、独自のデコレータでメタデータを検査することです。これは、思ったよりもさらに複雑です。
import dataclasses
import functools
import inspect
# Helper to make calling field() less verbose
def kwonly(default=dataclasses.MISSING, **kwargs):
kwargs.setdefault('metadata', {})
kwargs['metadata']['kwonly'] = True
return dataclasses.field(default=default, **kwargs)
def mydataclass(_cls, *, init=True, **kwargs):
if _cls is None:
return functools.partial(mydataclass, **kwargs)
no_generated_init = (not init or '__init__' in _cls.__dict__)
_cls = dataclasses.dataclass(_cls, **kwargs)
if no_generated_init:
# No generated __init__. The user will have to provide __init__,
# and they probably already have. We assume their __init__ does
# what they want.
return _cls
fields = dataclasses.fields(_cls)
if any(field.metadata.get('kwonly') and not field.init for field in fields):
raise TypeError('Non-init field marked kwonly')
# From this point on, ignore non-init fields - but we don't know
# about InitVars yet.
init_fields = [field for field in fields if field.init]
for i, field in enumerate(init_fields):
if field.metadata.get('kwonly'):
first_kwonly = field.name
num_kwonly = len(init_fields) - i
break
else:
# No kwonly fields. Why were we called? Assume there was a reason.
return _cls
if not all(field.metadata.get('kwonly') for field in init_fields[-num_kwonly:]):
raise TypeError('non-kwonly init fields following kwonly fields')
required_kwonly = [field.name for field in init_fields[-num_kwonly:]
if field.default is field.default_factory is dataclasses.MISSING]
original_init = _cls.__init__
# Time to handle InitVars. This is going to get ugly.
# InitVars don't show up in fields(). They show up in __annotations__,
# but the current dataclasses implementation doesn't understand string
# annotations, and we want an implementation that's robust against
# changes in string annotation handling.
# We could inspect __post_init__, except there doesn't have to be a
# __post_init__. (It'd be weird to use InitVars with no __post_init__,
# but it's allowed.)
# As far as I can tell, that leaves inspecting __init__ parameters as
# the only option.
init_params = tuple(inspect.signature(original_init).parameters)
if init_params[-num_kwonly] != first_kwonly:
# InitVars following kwonly fields. We could adopt a convention like
# "InitVars after kwonly are kwonly" - in fact, we could have adopted
# "all fields after kwonly are kwonly" too - but it seems too likely
# to cause confusion with inheritance.
raise TypeError('InitVars after kwonly fields.')
# -1 to exclude self from this count.
max_positional = len(init_params) - num_kwonly - 1
@functools.wraps(original_init)
def __init__(self, *args, **kwargs):
if len(args) > max_positional:
raise TypeError('Too many positional arguments')
check_required_kwargs(kwargs, required_kwonly)
return original_init(self, *args, **kwargs)
_cls.__init__ = __init__
return _cls
def check_required_kwargs(kwargs, required):
# Not strictly necessary, but if we don't do this, error messages for
# required kwonly args will list them as positional instead of
# keyword-only.
missing = [name for name in required if name not in kwargs]
if not missing:
return
# We don't bother to exactly match the built-in logic's exception
raise TypeError(f"__init__ missing required keyword-only argument(s): {missing}")
使用例:
@mydataclass
class S3Obj:
bucket: str
key: str
storage_class: str = kwonly('Standard')
これはある程度テストされていますが、私が望むほど徹底的ではありません。
では、メタクラスやデコレータが確認できるようなことは何もしない...ので、提案する構文は では得られません。 のように、実際に名前の検索や割り当てをトリガーするものを使えば、かなり近いものが得られるので、メタクラスはそれが起こっていることを確認できます。ただし、専用の処理が必要なものが多いので、これを堅牢に実装するのは複雑です。継承、、、注釈内の前方参照などは、慎重に処理しないとすべて問題を引き起こします。継承はおそらく最も多くの問題を引き起こします。...kwonly_start = Truetyping.ClassVardataclasses.InitVar
面倒な部分をすべて処理しない概念実証は次のようになります。
# Does not handle inheritance, InitVar, ClassVar, or anything else
# I'm forgetting.
class POCMetaDict(dict):
def __setitem__(self, key, item):
# __setitem__ instead of __getitem__ because __getitem__ is
# easier to trigger by accident.
if key == 'kwonly_start':
self['__non_kwonly'] = len(self['__annotations__'])
super().__setitem__(key, item)
class POCMeta(type):
@classmethod
def __prepare__(cls, name, bases, **kwargs):
return POCMetaDict()
def __new__(cls, name, bases, classdict, **kwargs):
classdict.pop('kwonly_start')
non_kwonly = classdict.pop('__non_kwonly')
newcls = super().__new__(cls, name, bases, classdict, **kwargs)
newcls = dataclass(newcls)
if non_kwonly is None:
return newcls
original_init = newcls.__init__
@functools.wraps(original_init)
def __init__(self, *args, **kwargs):
if len(args) > non_kwonly:
raise TypeError('Too many positional arguments')
return original_init(self, *args, **kwargs)
newcls.__init__ = __init__
return newcls
次のように使います
class S3Obj(metaclass=POCMeta):
bucket: str
key: str
kwonly_start = True
storage_class: str = 'Standard'
これは未テストです。