-
Notifications
You must be signed in to change notification settings - Fork 16
/
config.py
76 lines (66 loc) · 2.68 KB
/
config.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
from dataclasses import dataclass, field
from fretboardgtr.base import ConfigIniter
from fretboardgtr.elements.background import BackgroundConfig
from fretboardgtr.elements.cross import CrossConfig
from fretboardgtr.elements.fret_number import FretNumberConfig
from fretboardgtr.elements.frets import FretConfig
from fretboardgtr.elements.neck_dots import NeckDotConfig
from fretboardgtr.elements.notes import FrettedNoteConfig, OpenNoteConfig
from fretboardgtr.elements.nut import NutConfig
from fretboardgtr.elements.strings import StringConfig
from fretboardgtr.elements.tuning import TuningConfig
from fretboardgtr.note_colors import NoteColors
@dataclass
class FretBoardGeneralConfig(ConfigIniter):
"""General configuration for a Fretboard."""
x_start: float = 30.0
y_start: float = 30.0
x_end_offset: float = 0.0
y_end_offset: float = 0.0
fret_height: int = 50
fret_width: int = 70
first_fret: int = 1
last_fret: int = 12
show_tuning: bool = True
show_frets: bool = True
show_nut: bool = True
show_degree_name: bool = False
show_note_name: bool = True
open_color_scale: bool = False
fretted_color_scale: bool = True
open_colors: NoteColors = field(default_factory=NoteColors)
fretted_colors: NoteColors = field(default_factory=NoteColors)
enharmonic: bool = True
@dataclass
class FretBoardConfig(ConfigIniter):
"""Configuration for the fretboard but also for all its elements.
Inside configurations are :
FretBoardGeneralConfig
BackgroundConfig
FretNumberConfig
NeckDotConfig
FretConfig
NutConfig
TuningConfig
StringConfig
OpenNoteConfig
FrettedNoteConfig
CrossConfig
"""
general: FretBoardGeneralConfig = field(default_factory=FretBoardGeneralConfig)
background: BackgroundConfig = field(default_factory=BackgroundConfig)
fret_numbers: FretNumberConfig = field(default_factory=FretNumberConfig)
neck_dots: NeckDotConfig = field(default_factory=NeckDotConfig)
frets: FretConfig = field(default_factory=FretConfig)
nut: NutConfig = field(default_factory=NutConfig)
tuning: TuningConfig = field(default_factory=TuningConfig)
strings: StringConfig = field(default_factory=StringConfig)
open_notes: OpenNoteConfig = field(default_factory=OpenNoteConfig)
fretted_notes: FrettedNoteConfig = field(default_factory=FrettedNoteConfig)
cross: CrossConfig = field(default_factory=CrossConfig)
def validate(self) -> "FretBoardConfig":
if self.general.first_fret <= 0:
self.general.first_fret = 1
if self.general.last_fret < self.general.first_fret:
self.general.last_fret = self.general.first_fret
return self