Module: script

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
from cl.runtime.views.script_language_enum import ScriptLanguageEnum


@dataclass(slots=True, kw_only=True)
class Script:
    """Script body element."""

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

    language: ScriptLanguageEnum | None = missing()
    """Script Language."""

    body: List[str] = missing()
    """Body"""

    word_wrap: bool | None = missing()
    """Automatically wrap text to the next line when it reaches the end of a line or a specified margin."""

Classes

class Script (*, name: str = None, language: ScriptLanguageEnum | None = None, body: List[str] = None, word_wrap: bool | None = None)

Script body element.

Expand source code

@dataclass(slots=True, kw_only=True)
class Script:
    """Script body element."""

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

    language: ScriptLanguageEnum | None = missing()
    """Script Language."""

    body: List[str] = missing()
    """Body"""

    word_wrap: bool | None = missing()
    """Automatically wrap text to the next line when it reaches the end of a line or a specified margin."""

Fields

var body -> List[str]: Body
var language -> ScriptLanguageEnum | None: Script Language.
var name -> str: Script name.
var word_wrap -> bool | None: Automatically wrap text to the next line when it reaches the end of a line or a specified margin.