Skip to content

update ConfigModel to prevent api key output in a debug log #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hmasdev merged 8 commits into from
Nov 16, 2025
Merged

update ConfigModel to prevent api key output in a debug log #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6f897ac
Refactor configuration handling in key monitor, sentence generator, a…
hmasdev Nov 15, 2025
a82aba7
Refactor test factories to use model instances instead of model dumps…
hmasdev Nov 15, 2025
a096759
Update simple_typing_application/ui/factory.py
hmasdev Nov 15, 2025
4d7cfb2
Update simple_typing_application/sentence_generator/factory.py
hmasdev Nov 15, 2025
cd93345
Update simple_typing_application/key_monitor/factory.py
hmasdev Nov 15, 2025
d6b5217
Update tests/key_monitor/test_factory.py
hmasdev Nov 15, 2025
8481fbe
Merge remote-tracking branch 'origin/chore/fix-code-style' into fix/f…
hmasdev Nov 15, 2025
814b2a5
Update tests/test_config.py
hmasdev Nov 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions simple_typing_application/key_monitor/factory.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ def _select_class_and_config_model(key_monitor_type: EKeyMonitorType) -> tuple[t

def create_key_monitor(
key_monitor_type: EKeyMonitorType,
dict_config: dict[str, str | float | int | bool | None | dict | list],
config: BaseKeyMonitorConfigModel,
logger: Logger = getLogger(__name__),
) -> BaseKeyMonitor:
# select key monitor class and config model
Expand All @@ -37,7 +37,10 @@ def create_key_monitor(

# create key monitor
logger.debug(f"create {key_monitor_cls.__name__}")
key_monitor_config: BaseKeyMonitorConfigModel = key_monitor_config_model(**dict_config) # noqa
if isinstance(config, key_monitor_config_model):
key_monitor_config: BaseKeyMonitorConfigModel = config
else:
key_monitor_config: BaseKeyMonitorConfigModel = key_monitor_config_model(**config.model_dump()) # noqa
key_monitor: BaseKeyMonitor = key_monitor_cls(**key_monitor_config.model_dump()) # type: ignore # noqa

return key_monitor
37 changes: 27 additions & 10 deletions simple_typing_application/models/config_models/general_config_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,43 @@
from __future__ import annotations
from pydantic import BaseModel

from .key_monitor_config_model import BaseKeyMonitorConfigModel
from .sentence_generator_config_model import BaseSentenceGeneratorConfigModel
from .user_interface_config_model import BaseUserInterfaceConfigModel
from .key_monitor_config_model import (
BaseKeyMonitorConfigModel,
PynputBasedKeyMonitorConfigModel,
SSHKeyboardBasedKeyMonitorConfigModel,
)
from .sentence_generator_config_model import (
BaseSentenceGeneratorConfigModel,
HuggingfaceSentenceGeneratorConfigModel,
OpenAISentenceGeneratorConfigModel,
StaticSentenceGeneratorConfigModel,
)
from .user_interface_config_model import (
BaseUserInterfaceConfigModel,
ConsoleUserInterfaceConfigModel,
)
from ...const.key_monitor import EKeyMonitorType
from ...const.sentence_generator import ESentenceGeneratorType
from ...const.user_interface import EUserInterfaceType


class ConfigModel(BaseModel):
sentence_generator_type: ESentenceGeneratorType = ESentenceGeneratorType.OPENAI # noqa
sentence_generator_config: dict[str, str | float | int | bool | None | dict | list] = (
BaseSentenceGeneratorConfigModel().model_dump()
) # noqa
sentence_generator_config: (
BaseSentenceGeneratorConfigModel
| HuggingfaceSentenceGeneratorConfigModel
| OpenAISentenceGeneratorConfigModel
| StaticSentenceGeneratorConfigModel
) = BaseSentenceGeneratorConfigModel()

user_interface_type: EUserInterfaceType = EUserInterfaceType.CONSOLE
user_interface_config: dict[str, str | float | int | None | dict | list] = (
BaseUserInterfaceConfigModel().model_dump()
) # noqa
user_interface_config: BaseUserInterfaceConfigModel | ConsoleUserInterfaceConfigModel = (
BaseUserInterfaceConfigModel()
)

key_monitor_type: EKeyMonitorType = EKeyMonitorType.PYNPUT
key_monitor_config: dict[str, str | float | int | None | dict | list] = BaseKeyMonitorConfigModel().model_dump() # noqa
key_monitor_config: (
BaseKeyMonitorConfigModel | PynputBasedKeyMonitorConfigModel | SSHKeyboardBasedKeyMonitorConfigModel

Copilot AI Nov 15, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Inconsistent formatting: The union types for key_monitor_config are all on one line (line 40), while sentence_generator_config splits each union type onto separate lines (lines 27-30). For consistency and readability, consider formatting key_monitor_config the same way:

key_monitor_config: (
    BaseKeyMonitorConfigModel 
    | PynputBasedKeyMonitorConfigModel 
    | SSHKeyboardBasedKeyMonitorConfigModel
) = BaseKeyMonitorConfigModel()
Suggested change
BaseKeyMonitorConfigModel | PynputBasedKeyMonitorConfigModel | SSHKeyboardBasedKeyMonitorConfigModel
BaseKeyMonitorConfigModel
| PynputBasedKeyMonitorConfigModel
| SSHKeyboardBasedKeyMonitorConfigModel

Copilot uses AI. Check for mistakes.
) = BaseKeyMonitorConfigModel()

record_direc: str = "./record"
7 changes: 5 additions & 2 deletions simple_typing_application/sentence_generator/factory.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ def _select_class_and_config_model(sentence_generator_type: ESentenceGeneratorTy

def create_sentence_generator(
sentence_generator_type: ESentenceGeneratorType,
dict_config: dict[str, str | float | int | bool | None | dict | list],
config: BaseSentenceGeneratorConfigModel,
logger: Logger = getLogger(__name__),
) -> BaseSentenceGenerator:
# select sentence generator class and config model
Expand All @@ -50,7 +50,10 @@ def create_sentence_generator(

# create sentence generator
logger.debug(f"create {sentence_generator_cls.__name__}")
sentence_generator_config: BaseSentenceGeneratorConfigModel = sentence_generator_config_model(**dict_config) # noqa
if isinstance(config, sentence_generator_config_model):
sentence_generator_config: BaseSentenceGeneratorConfigModel = config
else:
sentence_generator_config: BaseSentenceGeneratorConfigModel = sentence_generator_config_model(**config.model_dump()) # noqa
sentence_generator: BaseSentenceGenerator = sentence_generator_cls(**sentence_generator_config.model_dump()) # type: ignore # noqa

return sentence_generator
7 changes: 5 additions & 2 deletions simple_typing_application/ui/factory.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ def _select_class_and_config_model(user_interface_type: EUserInterfaceType) -> t

def create_user_interface(
user_interface_type: EUserInterfaceType,
dict_config: dict[str, str | float | int | bool | None | dict | list],
config: BaseUserInterfaceConfigModel,
logger: Logger = getLogger(__name__),
) -> BaseUserInterface:
# select user interface class and config model
Expand All @@ -32,7 +32,10 @@ def create_user_interface(

# create user interface
logger.debug(f"create {user_interface_cls.__name__}")
user_interface_config: BaseUserInterfaceConfigModel = user_interface_config_model(**dict_config) # noqa
if isinstance(config, user_interface_config_model):
user_interface_config: BaseUserInterfaceConfigModel = config
else:
user_interface_config: BaseUserInterfaceConfigModel = user_interface_config_model(**config.model_dump()) # noqa
user_interface: BaseUserInterface = user_interface_cls(**user_interface_config.model_dump()) # type: ignore # noqa

return user_interface
18 changes: 11 additions & 7 deletions tests/key_monitor/test_factory.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

from simple_typing_application.const.key_monitor import EKeyMonitorType # noqa
from simple_typing_application.models.config_models.key_monitor_config_model import ( # noqa
BaseKeyMonitorConfigModel,
SSHKeyboardBasedKeyMonitorConfigModel,
PynputBasedKeyMonitorConfigModel,
)
Expand Down Expand Up @@ -38,26 +39,29 @@ def test_select_class_and_config_model_raise_value_error():


@pytest.mark.parametrize(
"key_monitor_type, key_monitor_config_dict, expected_class",
"key_monitor_type, key_monitor_config, expected_class",
[
(
EKeyMonitorType.PYNPUT,
PynputBasedKeyMonitorConfigModel().model_dump(),
PynputBasedKeyMonitorConfigModel(),
PynputBasedKeyMonitor,
),
(
EKeyMonitorType.PYNPUT,
{},
BaseKeyMonitorConfigModel(),
PynputBasedKeyMonitor,
),
(EKeyMonitorType.SSHKEYBOARD, SSHKeyboardBasedKeyMonitorConfigModel().model_dump(), SSHKeyboardBasedKeyMonitor), # noqa
(
EKeyMonitorType.SSHKEYBOARD,
SSHKeyboardBasedKeyMonitorConfigModel(),
SSHKeyboardBasedKeyMonitor,
), # noqa
],
)
def test_create_key_monitor(
key_monitor_type: EKeyMonitorType,
key_monitor_config_dict: dict[str, str | float | int | bool | None | dict | list], # noqa
key_monitor_config: BaseKeyMonitorConfigModel,
expected_class: type,
mocker,
):
# mock
# for PynputBasedKeyMonitor
Expand All @@ -66,7 +70,7 @@ def test_create_key_monitor(
# execute
key_monitor = create_key_monitor(
key_monitor_type,
key_monitor_config_dict,
key_monitor_config,
)

# assert
Expand Down
21 changes: 11 additions & 10 deletions tests/sentence_generator/test_factory.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@

from simple_typing_application.const.sentence_generator import ESentenceGeneratorType # noqa
from simple_typing_application.models.config_models.sentence_generator_config_model import ( # noqa
OpenAISentenceGeneratorConfigModel,
BaseSentenceGeneratorConfigModel,
HuggingfaceSentenceGeneratorConfigModel,
OpenAISentenceGeneratorConfigModel,
StaticSentenceGeneratorConfigModel,
)
from simple_typing_application.sentence_generator.factory import (
Expand Down Expand Up @@ -67,39 +68,39 @@ def test_select_class_and_config_model_raise_value_error():


@pytest.mark.parametrize(
"sentence_generator_type, sentence_generator_config_dict, expected_class",
"sentence_generator_type, sentence_generator_config, expected_class",
[
(
ESentenceGeneratorType.OPENAI,
OpenAISentenceGeneratorConfigModel().model_dump(),
OpenAISentenceGeneratorConfigModel(),
OpenaiSentenceGenerator,
),
(
ESentenceGeneratorType.STATIC,
StaticSentenceGeneratorConfigModel(text_kana_map={}).model_dump(),
StaticSentenceGeneratorConfigModel(text_kana_map={}),
StaticSentenceGenerator,
),
(
ESentenceGeneratorType.OPENAI,
{},
BaseSentenceGeneratorConfigModel(),
OpenaiSentenceGenerator,
),
(
ESentenceGeneratorType.STATIC,
{},
BaseSentenceGeneratorConfigModel(),
StaticSentenceGenerator,
),
]
+ (
[
(
ESentenceGeneratorType.HUGGINGFACE,
HuggingfaceSentenceGeneratorConfigModel().model_dump(),
HuggingfaceSentenceGeneratorConfigModel(),
HuggingfaceSentenceGenerator,
),
(
ESentenceGeneratorType.HUGGINGFACE,
{},
BaseSentenceGeneratorConfigModel(),
HuggingfaceSentenceGenerator,
),
]
Expand All @@ -109,7 +110,7 @@ def test_select_class_and_config_model_raise_value_error():
)
def test_create_sentence_generator(
sentence_generator_type: ESentenceGeneratorType,
sentence_generator_config_dict: dict[str, str | float | int | bool | None | dict | list], # noqa
sentence_generator_config: BaseSentenceGeneratorConfigModel,
expected_class: type,
mocker,
):
Expand All @@ -131,7 +132,7 @@ def test_create_sentence_generator(
# execute
sentence_generator = create_sentence_generator(
sentence_generator_type,
sentence_generator_config_dict,
sentence_generator_config,
)

# assert
Expand Down
8 changes: 6 additions & 2 deletions tests/test_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,14 @@ def test_load_config_json(mocker):
)

# run
actual = load_config(path)
actual: ConfigModel = load_config(path)

# postprocess
Comment thread
hmasdev marked this conversation as resolved.

# assert
assert actual == expected
actual_dic = actual.model_dump(exclude={"sentence_generator_config": {"openai_api_key"}})
expected_dic = expected.model_dump(exclude={"sentence_generator_config": {"openai_api_key"}})
assert actual_dic == expected_dic


def test_load_config_json_not_found(mocker):
Expand Down
12 changes: 6 additions & 6 deletions tests/ui/test_factory.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

from simple_typing_application.const.user_interface import EUserInterfaceType
from simple_typing_application.models.config_models.user_interface_config_model import ( # noqa
BaseUserInterfaceConfigModel,
ConsoleUserInterfaceConfigModel,
)
from simple_typing_application.ui.cui import ConsoleUserInterface
Expand Down Expand Up @@ -42,25 +43,24 @@ def test_select_class_and_config_model_raise_value_error():


@pytest.mark.parametrize(
"user_interface_type, user_interface_config_dict, expected_class",
"user_interface_type, user_interface_config, expected_class",
[
(
EUserInterfaceType.CONSOLE,
ConsoleUserInterfaceConfigModel().model_dump(),
ConsoleUserInterfaceConfigModel(),
ConsoleUserInterface,
),
(
EUserInterfaceType.CONSOLE,
{},
BaseUserInterfaceConfigModel(),
ConsoleUserInterface,
),
],
)
def test_create_user_interface(
user_interface_type: EUserInterfaceType,
user_interface_config_dict: dict[str, str | float | int | bool | None | dict | list], # noqa
user_interface_config: BaseUserInterfaceConfigModel,
expected_class: type,
mocker,
):
# mock
# for ConsoleUserInterface
Expand All @@ -69,7 +69,7 @@ def test_create_user_interface(
# execute
user_interface = create_user_interface(
user_interface_type,
user_interface_config_dict,
user_interface_config,
)

# assert
Expand Down
Loading