configuration: improved config file format

Reviewed-on: #6

chatmastermind/ai.py

@@ -66,3 +66,9 @@ class AI(Protocol):
         and is not implemented for all AIs.
         """
         raise NotImplementedError
+
+    def print(self) -> None:
+        """
+        Print some info about the current AI, like system message.
+        """
+        pass

chatmastermind/ais/openai.py

@@ -43,16 +43,20 @@ class OpenAI(AI):
             n=num_answers,
             frequency_penalty=self.config.frequency_penalty,
             presence_penalty=self.config.presence_penalty)
-        answers: list[Message] = []
-        for choice in response['choices']:  # type: ignore
+        question.answer = Answer(response['choices'][0]['message']['content'])
+        question.tags = otags
+        question.ai = self.ID
+        question.model = self.config.model
+        answers: list[Message] = [question]
+        for choice in response['choices'][1:]:  # type: ignore
             answers.append(Message(question=question.question,
                                    answer=Answer(choice['message']['content']),
                                    tags=otags,
-                                   ai=self.name,
+                                   ai=self.ID,
                                    model=self.config.model))
-        return AIResponse(answers, Tokens(response['usage']['prompt'],
-                                          response['usage']['completion'],
-                                          response['usage']['total']))
+        return AIResponse(answers, Tokens(response['usage']['prompt_tokens'],
+                                          response['usage']['completion_tokens'],
+                                          response['usage']['total_tokens']))
 
     def models(self) -> list[str]:
         """
@@ -95,3 +99,8 @@ class OpenAI(AI):
 
     def tokens(self, data: Union[Message, Chat]) -> int:
         raise NotImplementedError
+
+    def print(self) -> None:
+        print(f"MODEL: {self.config.model}")
+        print("=== SYSTEM ===")
+        print(self.config.system)

chatmastermind/chat.py

@@ -386,3 +386,19 @@ class ChatDB(Chat):
         msgs = iter(messages if messages else self.messages)
         while (m := next(msgs, None)):
             m.to_file()
+
+    def update_messages(self, messages: list[Message], write: bool = True) -> None:
+        """
+        Update existing messages. A message is determined as 'existing' if a message with
+        the same base filename (i. e. 'file_path.name') is already in the list. Only accepts
+        existing messages.
+        """
+        if any(not message_in(m, self.messages) for m in messages):
+            raise ChatError("Can't update messages that are not in the internal list")
+        # remove old versions and add new ones
+        self.messages = [m for m in self.messages if not message_in(m, messages)]
+        self.messages += messages
+        self.sort()
+        # write the UPDATED messages if requested
+        if write:
+            self.write_messages(messages)

chatmastermind/commands/question.py

@@ -3,7 +3,7 @@ from pathlib import Path
 from itertools import zip_longest
 from ..configuration import Config
 from ..chat import ChatDB
-from ..message import Message, Question
+from ..message import Message, MessageFilter, Question, source_code
 from ..ai_factory import create_ai
 from ..ai import AI, AIResponse
 
@@ -14,10 +14,10 @@ def create_message(chat: ChatDB, args: argparse.Namespace) -> Message:
     """
     question_parts = []
     question_list = args.ask if args.ask is not None else []
-    source_list = args.source if args.source is not None else []
-    code_list = args.source_code if args.source_code is not None else []
+    text_files = args.source_text if args.source_text is not None else []
+    code_files = args.source_code if args.source_code is not None else []
 
-    for question, source, code in zip_longest(question_list, source_list, code_list, fillvalue=None):
+    for question, source, code in zip_longest(question_list, text_files, code_files, fillvalue=None):
         if question is not None and len(question.strip()) > 0:
             question_parts.append(question)
         if source is not None and len(source) > 0:
@@ -28,7 +28,14 @@ def create_message(chat: ChatDB, args: argparse.Namespace) -> Message:
         if code is not None and len(code) > 0:
             with open(code) as r:
                 content = r.read().strip()
-                if len(content) > 0:
+                if len(content) == 0:
+                    continue
+                # try to extract and add source code
+                code_parts = source_code(content, include_delims=True)
+                if len(code_parts) > 0:
+                    question_parts += code_parts
+                # if there's none, add the whole file
+                else:
                     question_parts.append(f"```\n{content}\n```")
 
     full_question = '\n\n'.join(question_parts)
@@ -45,8 +52,12 @@ def question_cmd(args: argparse.Namespace, config: Config) -> None:
     """
     Handler for the 'question' command.
     """
+    mfilter = MessageFilter(tags_or=args.or_tags if args.or_tags is not None else set(),
+                            tags_and=args.and_tags if args.and_tags is not None else set(),
+                            tags_not=args.exclude_tags if args.exclude_tags is not None else set())
     chat = ChatDB.from_dir(cache_path=Path('.'),
-                           db_path=Path(config.db))
+                           db_path=Path(config.db),
+                           mfilter=mfilter)
     # if it's a new question, create and store it immediately
     if args.ask or args.create:
         message = create_message(chat, args)
@@ -56,23 +67,28 @@ def question_cmd(args: argparse.Namespace, config: Config) -> None:
     # create the correct AI instance
     ai: AI = create_ai(args, config)
     if args.ask:
+        ai.print()
+        chat.print(paged=False)
         response: AIResponse = ai.request(message,
                                           chat,
                                           args.num_answers,  # FIXME
                                           args.output_tags)  # FIXME
-        assert response
-        # TODO:
-        # * add answer to the message above (and create
-        #   more messages for any additional answers)
-        pass
-    elif args.repeat:
+        chat.update_messages([response.messages[0]])
+        chat.add_to_cache(response.messages[1:])
+        for idx, msg in enumerate(response.messages):
+            print(f"=== ANSWER {idx+1} ===")
+            print(msg.answer)
+        if response.tokens:
+            print("===============")
+            print(response.tokens)
+    elif args.repeat is not None:
         lmessage = chat.latest_message()
         assert lmessage
         # TODO: repeat either the last question or the
         # one(s) given in 'args.repeat' (overwrite
         # existing ones if 'args.overwrite' is True)
         pass
-    elif args.process:
+    elif args.process is not None:
         # TODO: process either all questions without an
         # answer or the one(s) given in 'args.process'
         pass

chatmastermind/configuration.py

@@ -17,6 +17,18 @@ class ConfigError(Exception):
     pass
 
 
+def str_presenter(dumper: yaml.Dumper, data: str) -> yaml.ScalarNode:
+    """
+    Changes the YAML dump style to multiline syntax for multiline strings.
+    """
+    if len(data.splitlines()) > 1:
+        return dumper.represent_scalar('tag:yaml.org,2002:str', data, style='|')
+    return dumper.represent_scalar('tag:yaml.org,2002:str', data)
+
+
+yaml.add_representer(str, str_presenter)
+
+
 @dataclass
 class AIConfig:
     """
@@ -48,13 +60,13 @@ class OpenAIConfig(AIConfig):
     # a default configuration
     ID: str = 'default'
     api_key: str = '0123456789'
-    system: str = 'You are an assistant'
     model: str = 'gpt-3.5-turbo-16k'
     temperature: float = 1.0
     max_tokens: int = 4000
     top_p: float = 1.0
     frequency_penalty: float = 0.0
     presence_penalty: float = 0.0
+    system: str = 'You are an assistant'
 
     @classmethod
     def from_dict(cls: Type[OpenAIConfigInst], source: dict[str, Any]) -> OpenAIConfigInst:
@@ -62,14 +74,14 @@ class OpenAIConfig(AIConfig):
         Create OpenAIConfig from a dict.
         """
         res = cls(
-            system=str(source['system']),
             api_key=str(source['api_key']),
             model=str(source['model']),
             max_tokens=int(source['max_tokens']),
             temperature=float(source['temperature']),
             top_p=float(source['top_p']),
             frequency_penalty=float(source['frequency_penalty']),
-            presence_penalty=float(source['presence_penalty'])
+            presence_penalty=float(source['presence_penalty']),
+            system=str(source['system'])
         )
         # overwrite default ID if provided
         if 'ID' in source:
@@ -148,6 +160,8 @@ class Config:
 
     def as_dict(self) -> dict[str, Any]:
         res = asdict(self)
+        # add the AI name manually (as first element)
+        # (not done by 'asdict' because it's a class variable)
         for ID, conf in res['ais'].items():
-            conf.update({'name': self.ais[ID].name})
+            res['ais'][ID] = {**{'name': self.ais[ID].name}, **conf}
         return res

chatmastermind/main.py

@@ -67,7 +67,7 @@ def create_parser() -> argparse.ArgumentParser:
     question_group.add_argument('-p', '--process', nargs='*', help='Process existing questions')
     question_cmd_parser.add_argument('-O', '--overwrite', help='Overwrite existing messages when repeating them',
                                      action='store_true')
-    question_cmd_parser.add_argument('-s', '--source', nargs='+', help='Add content of a file to the query')
+    question_cmd_parser.add_argument('-s', '--source-text', nargs='+', help='Add content of a file to the query')
     question_cmd_parser.add_argument('-S', '--source-code', nargs='+', help='Add source code file content to the chat history')
 
     # 'hist' command parser

chatmastermind/message.py

@@ -312,7 +312,7 @@ class Message():
                                           mfilter.tags_not if mfilter else None)
         else:
             message = cls.__from_file_yaml(file_path)
-        if message and (not mfilter or (mfilter and message.match(mfilter))):
+        if message and (mfilter is None or message.match(mfilter)):
             return message
         else:
             return None
@@ -414,7 +414,7 @@ class Message():
         return '\n'.join(output)
 
     def __str__(self) -> str:
-        return self.to_str(False, False, False)
+        return self.to_str(True, True, False)
 
     def to_file(self, file_path: Optional[pathlib.Path]=None) -> None:  # noqa: 11
         """
@@ -508,7 +508,7 @@ class Message():
         Return True if all attributes match, else False.
         """
         mytags = self.tags or set()
-        if (((mfilter.tags_or or mfilter.tags_and or mfilter.tags_not)
+        if (((mfilter.tags_or is not None or mfilter.tags_and is not None or mfilter.tags_not is not None)
             and not match_tags(mytags, mfilter.tags_or, mfilter.tags_and, mfilter.tags_not))  # noqa: W503
            or (mfilter.ai and (not self.ai or mfilter.ai != self.ai))  # noqa: W503
            or (mfilter.model and (not self.model or mfilter.model != self.model))  # noqa: W503

tests/test_chat.py

@@ -202,7 +202,25 @@ class TestChatDB(unittest.TestCase):
         self.assertEqual(chat_db.messages[1].file_path,
                          pathlib.Path(self.db_path.name, '0003.txt'))
 
-    def test_chat_db_filter(self) -> None:
+    def test_chat_db_from_dir_filter_tags(self) -> None:
+        chat_db = ChatDB.from_dir(pathlib.Path(self.cache_path.name),
+                                  pathlib.Path(self.db_path.name),
+                                  mfilter=MessageFilter(tags_or={Tag('tag1')}))
+        self.assertEqual(len(chat_db.messages), 1)
+        self.assertEqual(chat_db.cache_path, pathlib.Path(self.cache_path.name))
+        self.assertEqual(chat_db.db_path, pathlib.Path(self.db_path.name))
+        self.assertEqual(chat_db.messages[0].file_path,
+                         pathlib.Path(self.db_path.name, '0001.txt'))
+
+    def test_chat_db_from_dir_filter_tags_empty(self) -> None:
+        chat_db = ChatDB.from_dir(pathlib.Path(self.cache_path.name),
+                                  pathlib.Path(self.db_path.name),
+                                  mfilter=MessageFilter(tags_or=set(),
+                                                        tags_and=set(),
+                                                        tags_not=set()))
+        self.assertEqual(len(chat_db.messages), 0)
+
+    def test_chat_db_from_dir_filter_answer(self) -> None:
         chat_db = ChatDB.from_dir(pathlib.Path(self.cache_path.name),
                                   pathlib.Path(self.db_path.name),
                                   mfilter=MessageFilter(answer_contains='Answer 2'))
@@ -213,7 +231,7 @@ class TestChatDB(unittest.TestCase):
                          pathlib.Path(self.db_path.name, '0002.yaml'))
         self.assertEqual(chat_db.messages[0].answer, 'Answer 2')
 
-    def test_chat_db_from_messges(self) -> None:
+    def test_chat_db_from_messages(self) -> None:
         chat_db = ChatDB.from_messages(pathlib.Path(self.cache_path.name),
                                        pathlib.Path(self.db_path.name),
                                        messages=[self.message1, self.message2,
@@ -440,3 +458,26 @@ class TestChatDB(unittest.TestCase):
         cache_dir_files = self.message_list(self.cache_path)
         self.assertEqual(len(cache_dir_files), 1)
         self.assertIn(pathlib.Path(self.cache_path.name, '123456.txt'), cache_dir_files)
+
+    def test_chat_db_update_messages(self) -> None:
+        # create a new ChatDB instance
+        chat_db = ChatDB.from_dir(pathlib.Path(self.cache_path.name),
+                                  pathlib.Path(self.db_path.name))
+
+        db_dir_files = self.message_list(self.db_path)
+        self.assertEqual(len(db_dir_files), 4)
+        cache_dir_files = self.message_list(self.cache_path)
+        self.assertEqual(len(cache_dir_files), 0)
+
+        message = chat_db.messages[0]
+        message.answer = Answer("New answer")
+        # update message without writing
+        chat_db.update_messages([message], write=False)
+        self.assertEqual(chat_db.messages[0].answer, Answer("New answer"))
+        # re-read the message and check for old content
+        chat_db.read_db()
+        self.assertEqual(chat_db.messages[0].answer, Answer("Answer 1"))
+        # now check with writing (message should be overwritten)
+        chat_db.update_messages([message], write=True)
+        chat_db.read_db()
+        self.assertEqual(chat_db.messages[0].answer, Answer("New answer"))

tests/test_message.py

@@ -300,6 +300,12 @@ This is a question.
                                     MessageFilter(tags_or={Tag('tag1')}))
         self.assertIsNone(message)
 
+    def test_from_file_txt_empty_tags_dont_match(self) -> None:
+        message = Message.from_file(self.file_path_min,
+                                    MessageFilter(tags_or=set(),
+                                                  tags_and=set()))
+        self.assertIsNone(message)
+
     def test_from_file_txt_no_tags_match_tags_not(self) -> None:
         message = Message.from_file(self.file_path_min,
                                     MessageFilter(tags_not={Tag('tag1')}))

tests/test_question_cmd.py

@@ -22,18 +22,19 @@ class TestMessageCreate(unittest.TestCase):
                                     db_path=Path(self.db_path.name))
         # create arguments mock
         self.args = MagicMock(spec=argparse.Namespace)
-        self.args.source = None
+        self.args.source_text = None
         self.args.source_code = None
         self.args.AI = None
         self.args.model = None
         self.args.output_tags = None
-        # create some files for sourcing
+        # File 1 : no source code block, only text
         self.source_file1 = tempfile.NamedTemporaryFile(delete=False)
         self.source_file1_content = """This is just text.
 No source code.
 Nope. Go look elsewhere!"""
         with open(self.source_file1.name, 'w') as f:
             f.write(self.source_file1_content)
+        # File 2 : one embedded source code block
         self.source_file2 = tempfile.NamedTemporaryFile(delete=False)
         self.source_file2_content = """This is just text.
 ```
@@ -42,12 +43,26 @@ This is embedded source code.
 And some text again."""
         with open(self.source_file2.name, 'w') as f:
             f.write(self.source_file2_content)
+        # File 3 : all source code
         self.source_file3 = tempfile.NamedTemporaryFile(delete=False)
         self.source_file3_content = """This is all source code.
 Yes, really.
 Language is called 'brainfart'."""
         with open(self.source_file3.name, 'w') as f:
             f.write(self.source_file3_content)
+        # File 4 : two source code blocks
+        self.source_file4 = tempfile.NamedTemporaryFile(delete=False)
+        self.source_file4_content = """This is just text.
+```
+This is embedded source code.
+```
+And some text again.
+```
+This is embedded source code.
+```
+Aaaand again some text."""
+        with open(self.source_file4.name, 'w') as f:
+            f.write(self.source_file4_content)
 
     def tearDown(self) -> None:
         os.remove(self.source_file1.name)
@@ -86,40 +101,62 @@ Language is called 'brainfart'."""
 
 Is it good?"""))
 
-    def test_single_question_with_text_only_source(self) -> None:
+    def test_single_question_with_text_only_file(self) -> None:
         self.args.ask = ["What is this?"]
-        self.args.source = [f"{self.source_file1.name}"]
+        self.args.source_text = [f"{self.source_file1.name}"]
         message = create_message(self.chat, self.args)
         self.assertIsInstance(message, Message)
-        # source file contains no source code
+        # file contains no source code (only text)
         # -> don't expect any in the question
         self.assertEqual(len(message.question.source_code()), 0)
         self.assertEqual(message.question, Question(f"""What is this?
 
 {self.source_file1_content}"""))
 
-    def test_single_question_with_embedded_source_source(self) -> None:
-        self.args.ask = ["What is this?"]
-        self.args.source = [f"{self.source_file2.name}"]
-        message = create_message(self.chat, self.args)
-        self.assertIsInstance(message, Message)
-        # source file contains 1 source code block
-        # -> expect it in the question
-        self.assertEqual(len(message.question.source_code()), 1)
-        self.assertEqual(message.question, Question(f"""What is this?
-
-{self.source_file2_content}"""))
-
-    def test_single_question_with_embedded_source_code_source(self) -> None:
+    def test_single_question_with_text_file_and_embedded_code(self) -> None:
         self.args.ask = ["What is this?"]
         self.args.source_code = [f"{self.source_file2.name}"]
         message = create_message(self.chat, self.args)
         self.assertIsInstance(message, Message)
-        # source file contains 1 source code block
+        # file contains 1 source code block
         # -> expect it in the question
-        self.assertEqual(len(message.question.source_code()), 2)
+        self.assertEqual(len(message.question.source_code()), 1)
+        self.assertEqual(message.question, Question("""What is this?
+
+```
+This is embedded source code.
+```
+"""))
+
+    def test_single_question_with_code_only_file(self) -> None:
+        self.args.ask = ["What is this?"]
+        self.args.source_code = [f"{self.source_file3.name}"]
+        message = create_message(self.chat, self.args)
+        self.assertIsInstance(message, Message)
+        # file is complete source code
+        self.assertEqual(len(message.question.source_code()), 1)
         self.assertEqual(message.question, Question(f"""What is this?
 
 ```
-{self.source_file2_content}
+{self.source_file3_content}
 ```"""))
+
+    def test_single_question_with_text_file_and_multi_embedded_code(self) -> None:
+        self.args.ask = ["What is this?"]
+        self.args.source_code = [f"{self.source_file4.name}"]
+        message = create_message(self.chat, self.args)
+        self.assertIsInstance(message, Message)
+        # file contains 2 source code blocks
+        # -> expect them in the question
+        self.assertEqual(len(message.question.source_code()), 2)
+        self.assertEqual(message.question, Question("""What is this?
+
+```
+This is embedded source code.
+```
+
+
+```
+This is embedded source code.
+```
+"""))