Skip to content

Common

Profile

Abstract base class for read and write profile

Source code in src\omoospace\common.py 
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
class Profile:
    """Abstract base class for read and write profile"""

    def _read_profile(self):
        """Read profile data from Omoospace.yml file."""
        if self.profile_file is None:
            raise ValueError("profile file is None.")

        if not self.profile_file.exists():
            return {}
        with self.profile_file.open("r", encoding="utf-8") as file:
            return yaml.load(file) or {}

    def _write_profile(self, data):
        """Write profile data to Omoospace.yml file."""
        if self.profile_file is None:
            raise ValueError("profile file is None.")

        self.profile_file.parent.mkdir(parents=True, exist_ok=True)
        with self.profile_file.open("w", encoding="utf-8") as file:
            yaml.dump(data, file)

    @property
    def language(self) -> str:
        """str: Omoospace language."""
        parts = self.profile_file.stem.split(".")
        return parts[-1] if len(parts) > 1 else "en"

    def _key(self, key) -> str:
        return key_dict[key][self.language]

    def get(self, key: str) -> Any:
        """Get the latest data for this item from the profile file."""
        profile = self._read_profile()
        return profile.get(self._key(key))

    def set(self, key: str, value: Any):
        """Set the value for the given key in the profile file."""
        profile = self._read_profile()
        profile[self._key(key)] = value
        self._write_profile(profile)

language: str property

str: Omoospace language.

get(key)

Get the latest data for this item from the profile file.

Source code in src\omoospace\common.py 
46
47
48
49
def get(self, key: str) -> Any:
    """Get the latest data for this item from the profile file."""
    profile = self._read_profile()
    return profile.get(self._key(key))

set(key, value)

Set the value for the given key in the profile file.

Source code in src\omoospace\common.py 
51
52
53
54
55
def set(self, key: str, value: Any):
    """Set the value for the given key in the profile file."""
    profile = self._read_profile()
    profile[self._key(key)] = value
    self._write_profile(profile)

ProfileItem

Abstract class for profile items like Maker, Tool, and Work.

This base class provides a unified way to access and update profile data, ensuring that attribute access always returns the latest data from the configuration file.

Source code in src\omoospace\common.py 
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
class ProfileItem:
    """Abstract class for profile items like Maker, Tool, and Work.

    This base class provides a unified way to access and update profile data, ensuring
    that attribute access always returns the latest data from the configuration file.
    """

    """The name used in the profile dictionary (e.g., "makers", "tools", "works")."""
    _dict_name: str
    _item_name: str

    def __init__(self, omoospace: "Omoospace", name: str) -> None:
        self._item_name = name
        self._omoospace = omoospace

        # init item with name if not find in profile
        item_dict = self._omoospace.get(self._dict_name) or {}
        if self._item_name not in item_dict:
            item_dict[self._item_name] = {}

        self._omoospace.set(self._dict_name, item_dict)

    def __repr__(self):
        return self.name

    def _key(self, key) -> str:
        return key_dict[key][self._omoospace.language]

    @property
    def data(self):
        # e.g. makers
        item_dict = self._omoospace.get(self._dict_name)
        if item_dict is None:
            raise AttributeError(f"{self._dict_name} not found in profile.")

        # e.g. maker
        data = item_dict.get(self._item_name)
        if data is None:
            raise AttributeError(f"{self._item_name} not found in {self._dict_name}.")
        return data

    @data.setter
    def data(self, value: Any):
        """Update the profile with current data."""
        items = self._omoospace.get(self._dict_name) or {}

        items[self._item_name] = value

        self._omoospace.set(self._dict_name, items)

    def get(self, key: str) -> Any:
        """Get the latest data for this item from the profile file."""
        return self.data.get(self._key(key)) if isinstance(self.data, dict) else None

    def set(self, key: str, value: Any):
        """Update the profile with current data."""
        data = self.data if isinstance(self.data, dict) else {}

        data[self._key(key)] = value

        self.data = data

    def remove(self):
        """Remove this item from the profile."""
        item_dict = self._omoospace.get(self._dict_name)
        if item_dict is None:
            raise AttributeError(f"{self._dict_name} not found in profile.")

        if self._item_name in item_dict:
            del item_dict[self._item_name]
            self._omoospace.set(self._dict_name, item_dict)
        else:
            raise AttributeError(f"{self._item_name} not found in {self._dict_name}.")

    @property
    def name(self) -> str:
        """Get the name from the latest profile data."""
        return self._item_name

    @name.setter
    def name(self, value: str):
        item_dict = self._omoospace.get(self._dict_name)

        if self.name in item_dict:
            del item_dict[self.name]

        item_dict[value] = self.data
        self._omoospace.set(self._dict_name, item_dict)

        self._item_name = value

name: str property writable

Get the name from the latest profile data.

get(key)

Get the latest data for this item from the profile file.

Source code in src\omoospace\common.py 
108
109
110
def get(self, key: str) -> Any:
    """Get the latest data for this item from the profile file."""
    return self.data.get(self._key(key)) if isinstance(self.data, dict) else None

remove()

Remove this item from the profile.

Source code in src\omoospace\common.py 
120
121
122
123
124
125
126
127
128
129
130
def remove(self):
    """Remove this item from the profile."""
    item_dict = self._omoospace.get(self._dict_name)
    if item_dict is None:
        raise AttributeError(f"{self._dict_name} not found in profile.")

    if self._item_name in item_dict:
        del item_dict[self._item_name]
        self._omoospace.set(self._dict_name, item_dict)
    else:
        raise AttributeError(f"{self._item_name} not found in {self._dict_name}.")

set(key, value)

Update the profile with current data.

Source code in src\omoospace\common.py 
112
113
114
115
116
117
118
def set(self, key: str, value: Any):
    """Update the profile with current data."""
    data = self.data if isinstance(self.data, dict) else {}

    data[self._key(key)] = value

    self.data = data