Module `clu.phontools.alignment.parser.symbols`

Expand source code

from __future__ import annotations

# from dataclasses import dataclass
from enum import Enum
from typing import Literal, Text

__all__ = ["Symbol", "TranscriptTypes"]


class TranscriptTypes(Enum):
    """"""

    GOLD: Text = "GOLD"
    TRANSCRIPT: Text = "TRANSCRIPT"


class Symbol:
    """"""

    NULL: Literal["NULL"] = "NULL"

    def __init__(
        self, symbol: Text, original_index: int, index: int, source: TranscriptTypes
    ):
        self.symbol: Text = symbol
        self.original_index: int = original_index
        self.index: int = index
        self.source: TranscriptTypes = source

    def is_null(self) -> bool:
        """Checks whether the symbol is NULL"""
        return self.symbol == Symbol.NULL

    @staticmethod
    def create_null(index: int, source: TranscriptTypes) -> Symbol:
        """Easily create a Symbol for NULL"""
        return Symbol(original_index=-1, index=index, symbol=Symbol.NULL, source=source)

Classes

class Symbol (symbol: Text, original_index: int, index: int, source: TranscriptTypes)

Expand source code

class Symbol:
    """"""

    NULL: Literal["NULL"] = "NULL"

    def __init__(
        self, symbol: Text, original_index: int, index: int, source: TranscriptTypes
    ):
        self.symbol: Text = symbol
        self.original_index: int = original_index
        self.index: int = index
        self.source: TranscriptTypes = source

    def is_null(self) -> bool:
        """Checks whether the symbol is NULL"""
        return self.symbol == Symbol.NULL

    @staticmethod
    def create_null(index: int, source: TranscriptTypes) -> Symbol:
        """Easily create a Symbol for NULL"""
        return Symbol(original_index=-1, index=index, symbol=Symbol.NULL, source=source)

Class variables

var NULL : Literal['NULL']

Static methods

def create_null(index: int, source: TranscriptTypes) ‑> Symbol

Easily create a Symbol for NULL

Expand source code

@staticmethod
def create_null(index: int, source: TranscriptTypes) -> Symbol:
    """Easily create a Symbol for NULL"""
    return Symbol(original_index=-1, index=index, symbol=Symbol.NULL, source=source)

Methods

def is_null(self) ‑> bool

Checks whether the symbol is NULL

Expand source code

def is_null(self) -> bool:
    """Checks whether the symbol is NULL"""
    return self.symbol == Symbol.NULL

class TranscriptTypes (value, names=None, *, module=None, qualname=None, type=None, start=1)

Expand source code

class TranscriptTypes(Enum):
    """"""

    GOLD: Text = "GOLD"
    TRANSCRIPT: Text = "TRANSCRIPT"

Ancestors

enum.Enum

Class variables

var GOLD : str
var TRANSCRIPT : str