Passed
Push — main ( 4cd557...ac26d8 )
by torrua
01:36
created

loglan_db.model_db.base_syllable   A

Complexity

Total Complexity 0

Size/Duplication

Total Lines 38
Duplicated Lines 0 %

Test Coverage

Coverage 100%

Importance

Changes 0
Metric Value
eloc 10
dl 0
loc 38
ccs 11
cts 11
cp 1
rs 10
c 0
b 0
f 0
wmc 0
1
# -*- coding: utf-8 -*-
2
# pylint: disable=C0303
3 1
"""
4
This module contains a basic Syllable Model
5
"""
6 1
from loglan_db.model_db import t_name_syllables
7 1
from loglan_db.model_db.base_word import db
8 1
from loglan_db.model_init import InitBase, DBBase
9
10
11 1
class BaseSyllable(db.Model, InitBase, DBBase):
12
    """Base Syllable's DB Model
13
14
    Describes a table structure for storing information about loglan syllables.
15
16
    <details><summary>Show Examples</summary><p>
17
    ```python
18
    {'id': 37, 'name': 'zv', 'type': 'InitialCC', 'allowed': True}
19
20
    {'id': 38, 'name': 'cdz', 'type': 'UnintelligibleCCC', 'allowed': False}
21
    ```
22
    </p></details>
23
    """
24
25 1
    __tablename__ = t_name_syllables
26
27 1
    id = db.Column(db.Integer, primary_key=True)
28
    """*Syllable's internal ID number*  
29
        **int** : primary_key=True"""
30 1
    name = db.Column(db.String(8), nullable=False, unique=False)
31
    """*Syllable itself*  
32
            **str** : max_length=8, nullable=False, unique=False"""
33 1
    type = db.Column(db.String(32), nullable=False, unique=False)
34
    """*Syllable's type*  
35
            **str** : max_length=8, nullable=False, unique=False"""
36 1
    allowed = db.Column(db.Boolean, nullable=True, unique=False)
37 1
    """*Is this syllable acceptable in grammar*  
38
            **bool** : nullable=True, unique=False"""
39