Module: freq_key
Expand source code
# Copyright (C) 2023-present The Project Contributors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from dataclasses import dataclass
from typing import Type
from cl.runtime.records.dataclasses_extensions import missing
from cl.runtime.records.key_mixin import KeyMixin
@dataclass(slots=True, kw_only=True)
class FreqKey(KeyMixin):
"""Frequency specification."""
freq_id: str = missing()
"""Unique frequency identifier."""
@classmethod
def get_key_type(cls) -> Type:
return FreqKey
Classes
class FreqKey (*, freq_id: str = None)
-
Frequency specification.
Expand source code
@dataclass(slots=True, kw_only=True) class FreqKey(KeyMixin): """Frequency specification.""" freq_id: str = missing() """Unique frequency identifier.""" @classmethod def get_key_type(cls) -> Type: return FreqKey
Ancestors
- KeyMixin
- abc.ABC
Subclasses
Static methods
def get_key_type() -> Type
-
Inherited from:
KeyMixin
.get_key_type
Return key type even when called from a record.
Fields
var freq_id -> str
-
Unique frequency identifier.