Module: enum_item_decl

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 List
from cl.runtime.records.dataclasses_extensions import field
from cl.runtime.records.dataclasses_extensions import missing


@dataclass(slots=True, kw_only=True)
class EnumItemDecl:
    """Enum item declaration."""

    name: str = missing()
    """Item name."""

    label: str | None = missing()
    """Item label (if not specified, titleized name is used instead)."""

    comment: str | None = missing()
    """Item additional information."""

Classes

class EnumItemDecl (*, name: str = None, label: str | None = None, comment: str | None = None)

Enum item declaration.

Expand source code

@dataclass(slots=True, kw_only=True)
class EnumItemDecl:
    """Enum item declaration."""

    name: str = missing()
    """Item name."""

    label: str | None = missing()
    """Item label (if not specified, titleized name is used instead)."""

    comment: str | None = missing()
    """Item additional information."""

Fields

var comment -> str | None: Item additional information.
var label -> str | None: Item label (if not specified, titleized name is used instead).
var name -> str: Item name.