dimp 2.3.2__tar.gz → 2.3.3__tar.gz

{dimp-2.3.2 → dimp-2.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dimp
-Version: 2.3.2
+Version: 2.3.3
 Summary: Decentralized Instant Messaging Protocol
 Home-page: https://github.com/dimchat/core-py
 Author: Albert Moky
@@ -45,8 +45,9 @@ License-File: LICENSE
   3. (S-C) handshake success
 
 ```python
+from abc import ABC, abstractmethod
 from enum import IntEnum
-from typing import Optional, Any, Dict
+from typing import Optional, Dict
 
 from dimp import Command, BaseCommand
 
@@ -58,7 +59,20 @@ class HandshakeState(IntEnum):
     Success = 3  # S -> C, handshake accepted
 
 
-class HandshakeCommand(BaseCommand):
+def handshake_state(title: str, session: str = None) -> HandshakeState:
+    # Server -> Client
+    if title == 'DIM!':  # or title == 'OK!':
+        return HandshakeState.Success
+    if title == 'DIM?':
+        return HandshakeState.Again
+    # Client -> Server: "Hello world!"
+    if session is None or len(session) == 0:
+        return HandshakeState.Start
+    else:
+        return HandshakeState.Restart
+
+
+class HandshakeCommand(Command, ABC):
     """
         Handshake Command
         ~~~~~~~~~~~~~~~~~
@@ -74,37 +88,24 @@ class HandshakeCommand(BaseCommand):
     """
     HANDSHAKE = 'handshake'
 
-    def __init__(self, content: Dict[str, Any] = None, title: str = None, session: str = None):
-        if content is None:
-            # 1. new command with title & session key
-            assert title is not None, 'handshake command error: %s' % session
-            cmd = self.HANDSHAKE
-            super().__init__(cmd=cmd)
-            self['title'] = title
-            self['message'] = title  # TODO: remove after all clients upgraded
-            if session is not None:
-                self['session'] = session
-        else:
-            # 2. command info from network
-            assert title is None and session is None, 'params error: %s, %s, %s' % (content, title, session)
-            super().__init__(content)
-
     @property
+    @abstractmethod
     def title(self) -> str:
-        # TODO: modify after all clients upgraded
-        text = self.get_str(key='title', default=None)
-        if text is None:
-            # compatible with v1.0
-            text = self.get_str(key='message', default='')
-        return text
+        raise NotImplemented
 
     @property
+    @abstractmethod
     def session(self) -> Optional[str]:
-        return self.get_str(key='session', default=None)
+        raise NotImplemented
 
     @property
+    @abstractmethod
     def state(self) -> HandshakeState:
-        return handshake_state(title=self.title, session=self.session)
+        raise NotImplemented
+
+    #
+    #   Factories
+    #
 
     @classmethod
     def offer(cls, session: str = None) -> Command:
@@ -114,7 +115,7 @@ class HandshakeCommand(BaseCommand):
         :param session: Old session key
         :return: HandshakeCommand object
         """
-        return HandshakeCommand(title='Hello world!', session=session)
+        return BaseHandshakeCommand(title='Hello world!', session=session)
 
     @classmethod
     def ask(cls, session: str) -> Command:
@@ -124,7 +125,7 @@ class HandshakeCommand(BaseCommand):
         :param session: New session key
         :return: HandshakeCommand object
         """
-        return HandshakeCommand(title='DIM?', session=session)
+        return BaseHandshakeCommand(title='DIM?', session=session)
 
     @classmethod
     def accepted(cls, session: str = None) -> Command:
@@ -133,7 +134,7 @@ class HandshakeCommand(BaseCommand):
 
         :return: HandshakeCommand object
         """
-        return HandshakeCommand(title='DIM!', session=session)
+        return BaseHandshakeCommand(title='DIM!', session=session)
 
     start = offer       # (1. C->S) first handshake, without session
     again = ask         # (2. S->C) ask client to handshake with new session key
@@ -141,17 +142,34 @@ class HandshakeCommand(BaseCommand):
     success = accepted  # (4. S->C) notice the client that handshake accepted
 
 
-def handshake_state(title: str, session: str = None) -> HandshakeState:
-    # Server -> Client
-    if title == 'DIM!':  # or title == 'OK!':
-        return HandshakeState.Success
-    if title == 'DIM?':
-        return HandshakeState.Again
-    # Client -> Server: "Hello world!"
-    if session is None or len(session) == 0:
-        return HandshakeState.Start
-    else:
-        return HandshakeState.Restart
+class BaseHandshakeCommand(BaseCommand, HandshakeCommand):
+
+    def __init__(self, content: Dict = None, title: str = None, session: str = None):
+        if content is None:
+            # 1. new command with title & session key
+            assert title is not None, 'handshake command error: %s' % session
+            cmd = self.HANDSHAKE
+            super().__init__(cmd=cmd)
+            self['title'] = title
+            self['message'] = title  # TODO: remove after all clients upgraded
+            if session is not None:
+                self['session'] = session
+        else:
+            # 2. command info from network
+            assert title is None and session is None, 'params error: %s, %s, %s' % (content, title, session)
+            super().__init__(content)
+
+    @property
+    def title(self) -> str:
+        return self.get_str(key='title', default='')
+
+    @property
+    def session(self) -> Optional[str]:
+        return self.get_str(key='session')
+
+    @property
+    def state(self) -> HandshakeState:
+        return handshake_state(title=self.title, session=self.session)
 ```
 
 ### extends Content
@@ -165,13 +183,13 @@ from dimp import Content
 from dimp import BaseContent
 
 
-class CustomizedContent(Content, ABC):
+class AppContent(Content, ABC):
     """
         Application Customized message
         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
         data format: {
-            type : 0xCC,
+            type : 0xA0,
             sn   : 123,
 
             app   : "{APP_ID}",  // application (e.g.: "chat.dim.sechat")
@@ -199,22 +217,25 @@ class CustomizedContent(Content, ABC):
         """ Action Name """
         raise NotImplemented
 
+    #
+    #   Factory
+    #
     @classmethod
     def create(cls, app: str, mod: str, act: str):
-        return AppCustomizedContent(app=app, mod=mod, act=act)
+        return ApplicationContent(app=app, mod=mod, act=act)
 
 
-class AppCustomizedContent(BaseContent, CustomizedContent):
+class ApplicationContent(BaseContent, AppContent):
 
     def __init__(self, content: Dict[str, Any] = None,
-                 msg_type: int = None,
+                 msg_type: str = None,
                  app: str = None, mod: str = None, act: str = None):
         if content is None:
             # 1. new content with type, application, module & action
             assert app is not None and mod is not None and act is not None, \
                 'customized content error: %s, %s, %s, %s' % (msg_type, app, mod, act)
             if msg_type is None:
-                msg_type = ContentType.CUSTOMIZED.value
+                msg_type = ContentType.APPLICATION
             super().__init__(None, msg_type)
             self['app'] = app
             self['mod'] = mod
@@ -244,5 +265,5 @@ class AppCustomizedContent(BaseContent, CustomizedContent):
 
 ----
 
-Copyright © 2018 Albert Moky
+Copyright © 2018-2025 Albert Moky
 [![Followers](https://img.shields.io/github/followers/moky)](https://github.com/moky?tab=followers)

{dimp-2.3.2 → dimp-2.3.3}/README.md

@@ -31,8 +31,9 @@
   3. (S-C) handshake success
 
 ```python
+from abc import ABC, abstractmethod
 from enum import IntEnum
-from typing import Optional, Any, Dict
+from typing import Optional, Dict
 
 from dimp import Command, BaseCommand
 
@@ -44,7 +45,20 @@ class HandshakeState(IntEnum):
     Success = 3  # S -> C, handshake accepted
 
 
-class HandshakeCommand(BaseCommand):
+def handshake_state(title: str, session: str = None) -> HandshakeState:
+    # Server -> Client
+    if title == 'DIM!':  # or title == 'OK!':
+        return HandshakeState.Success
+    if title == 'DIM?':
+        return HandshakeState.Again
+    # Client -> Server: "Hello world!"
+    if session is None or len(session) == 0:
+        return HandshakeState.Start
+    else:
+        return HandshakeState.Restart
+
+
+class HandshakeCommand(Command, ABC):
     """
         Handshake Command
         ~~~~~~~~~~~~~~~~~
@@ -60,37 +74,24 @@ class HandshakeCommand(BaseCommand):
     """
     HANDSHAKE = 'handshake'
 
-    def __init__(self, content: Dict[str, Any] = None, title: str = None, session: str = None):
-        if content is None:
-            # 1. new command with title & session key
-            assert title is not None, 'handshake command error: %s' % session
-            cmd = self.HANDSHAKE
-            super().__init__(cmd=cmd)
-            self['title'] = title
-            self['message'] = title  # TODO: remove after all clients upgraded
-            if session is not None:
-                self['session'] = session
-        else:
-            # 2. command info from network
-            assert title is None and session is None, 'params error: %s, %s, %s' % (content, title, session)
-            super().__init__(content)
-
     @property
+    @abstractmethod
     def title(self) -> str:
-        # TODO: modify after all clients upgraded
-        text = self.get_str(key='title', default=None)
-        if text is None:
-            # compatible with v1.0
-            text = self.get_str(key='message', default='')
-        return text
+        raise NotImplemented
 
     @property
+    @abstractmethod
     def session(self) -> Optional[str]:
-        return self.get_str(key='session', default=None)
+        raise NotImplemented
 
     @property
+    @abstractmethod
     def state(self) -> HandshakeState:
-        return handshake_state(title=self.title, session=self.session)
+        raise NotImplemented
+
+    #
+    #   Factories
+    #
 
     @classmethod
     def offer(cls, session: str = None) -> Command:
@@ -100,7 +101,7 @@ class HandshakeCommand(BaseCommand):
         :param session: Old session key
         :return: HandshakeCommand object
         """
-        return HandshakeCommand(title='Hello world!', session=session)
+        return BaseHandshakeCommand(title='Hello world!', session=session)
 
     @classmethod
     def ask(cls, session: str) -> Command:
@@ -110,7 +111,7 @@ class HandshakeCommand(BaseCommand):
         :param session: New session key
         :return: HandshakeCommand object
         """
-        return HandshakeCommand(title='DIM?', session=session)
+        return BaseHandshakeCommand(title='DIM?', session=session)
 
     @classmethod
     def accepted(cls, session: str = None) -> Command:
@@ -119,7 +120,7 @@ class HandshakeCommand(BaseCommand):
 
         :return: HandshakeCommand object
         """
-        return HandshakeCommand(title='DIM!', session=session)
+        return BaseHandshakeCommand(title='DIM!', session=session)
 
     start = offer       # (1. C->S) first handshake, without session
     again = ask         # (2. S->C) ask client to handshake with new session key
@@ -127,17 +128,34 @@ class HandshakeCommand(BaseCommand):
     success = accepted  # (4. S->C) notice the client that handshake accepted
 
 
-def handshake_state(title: str, session: str = None) -> HandshakeState:
-    # Server -> Client
-    if title == 'DIM!':  # or title == 'OK!':
-        return HandshakeState.Success
-    if title == 'DIM?':
-        return HandshakeState.Again
-    # Client -> Server: "Hello world!"
-    if session is None or len(session) == 0:
-        return HandshakeState.Start
-    else:
-        return HandshakeState.Restart
+class BaseHandshakeCommand(BaseCommand, HandshakeCommand):
+
+    def __init__(self, content: Dict = None, title: str = None, session: str = None):
+        if content is None:
+            # 1. new command with title & session key
+            assert title is not None, 'handshake command error: %s' % session
+            cmd = self.HANDSHAKE
+            super().__init__(cmd=cmd)
+            self['title'] = title
+            self['message'] = title  # TODO: remove after all clients upgraded
+            if session is not None:
+                self['session'] = session
+        else:
+            # 2. command info from network
+            assert title is None and session is None, 'params error: %s, %s, %s' % (content, title, session)
+            super().__init__(content)
+
+    @property
+    def title(self) -> str:
+        return self.get_str(key='title', default='')
+
+    @property
+    def session(self) -> Optional[str]:
+        return self.get_str(key='session')
+
+    @property
+    def state(self) -> HandshakeState:
+        return handshake_state(title=self.title, session=self.session)
 ```
 
 ### extends Content
@@ -151,13 +169,13 @@ from dimp import Content
 from dimp import BaseContent
 
 
-class CustomizedContent(Content, ABC):
+class AppContent(Content, ABC):
     """
         Application Customized message
         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
         data format: {
-            type : 0xCC,
+            type : 0xA0,
             sn   : 123,
 
             app   : "{APP_ID}",  // application (e.g.: "chat.dim.sechat")
@@ -185,22 +203,25 @@ class CustomizedContent(Content, ABC):
         """ Action Name """
         raise NotImplemented
 
+    #
+    #   Factory
+    #
     @classmethod
     def create(cls, app: str, mod: str, act: str):
-        return AppCustomizedContent(app=app, mod=mod, act=act)
+        return ApplicationContent(app=app, mod=mod, act=act)
 
 
-class AppCustomizedContent(BaseContent, CustomizedContent):
+class ApplicationContent(BaseContent, AppContent):
 
     def __init__(self, content: Dict[str, Any] = None,
-                 msg_type: int = None,
+                 msg_type: str = None,
                  app: str = None, mod: str = None, act: str = None):
         if content is None:
             # 1. new content with type, application, module & action
             assert app is not None and mod is not None and act is not None, \
                 'customized content error: %s, %s, %s, %s' % (msg_type, app, mod, act)
             if msg_type is None:
-                msg_type = ContentType.CUSTOMIZED.value
+                msg_type = ContentType.APPLICATION
             super().__init__(None, msg_type)
             self['app'] = app
             self['mod'] = mod
@@ -230,5 +251,5 @@ class AppCustomizedContent(BaseContent, CustomizedContent):
 
 ----
 
-Copyright © 2018 Albert Moky
+Copyright © 2018-2025 Albert Moky
 [![Followers](https://img.shields.io/github/followers/moky)](https://github.com/moky?tab=followers)

{dimp-2.3.2 → dimp-2.3.3}/dimp/__init__.py

@@ -119,6 +119,8 @@ __all__ = [
     'Meta',
     'Document', 'Visa', 'Bulletin',
 
+    'MetaType', 'DocumentType',
+
     'AddressFactory',
     'IDFactory',
     'MetaFactory',
@@ -132,8 +134,6 @@ __all__ = [
     'BaseMeta',
     'BaseDocument', 'BaseVisa', 'BaseBulletin',
 
-    'MetaType', 'DocumentType',
-
     #
     #   DaoKeDao
     #
@@ -145,11 +145,12 @@ __all__ = [
     'InstantMessage', 'SecureMessage', 'ReliableMessage',
 
     # contents
-    'TextContent', 'ArrayContent', 'ForwardContent',
-    'PageContent', 'NameCard',
+    'TextContent', 'PageContent', 'NameCard',
+    'ForwardContent', 'CombineContent', 'ArrayContent',
     'FileContent', 'ImageContent', 'AudioContent', 'VideoContent',
     'MoneyContent', 'TransferContent',
-    'QuoteContent', 'CombineContent',
+    'QuoteContent',
+    'CustomizedContent',
 
     # commands
     'Command',
@@ -163,11 +164,12 @@ __all__ = [
 
     # extend contents
     'BaseContent',
-    'BaseTextContent', 'ListContent', 'SecretContent',
-    'WebPageContent', 'NameCardContent',
+    'BaseTextContent', 'WebPageContent', 'NameCardContent',
+    'SecretContent', 'CombineForwardContent', 'ListContent',
     'BaseFileContent', 'ImageFileContent', 'AudioFileContent', 'VideoFileContent',
     'BaseMoneyContent', 'TransferMoneyContent',
-    'BaseQuoteContent', 'CombineForwardContent',
+    'BaseQuoteContent',
+    'AppCustomizedContent',
 
     # extend commands
     'BaseCommand',

{dimp-2.3.2 → dimp-2.3.3}/dimp/crypto/keys.py

@@ -60,7 +60,7 @@ class BaseKey(Dictionary, CryptographyKey, ABC):
     @classmethod
     def get_key_algorithm(cls, key: Dict) -> str:
         ext = SharedCryptoExtensions()
-        algorithm = ext.helper.get_key_algorithm(key=key, default=None)
+        algorithm = ext.helper.get_key_algorithm(key=key)
         return '' if algorithm is None else algorithm
 
     @classmethod

{dimp-2.3.2 → dimp-2.3.3}/dimp/crypto/pnf.py

@@ -100,7 +100,7 @@ class BaseFileWrapper(Dictionary):
 
     @property
     def filename(self) -> Optional[str]:
-        return self.get_str(key='filename', default=None)
+        return self.get_str(key='filename')
 
     @filename.setter
     def filename(self, name: Optional[str]):
@@ -117,7 +117,7 @@ class BaseFileWrapper(Dictionary):
     def url(self) -> Optional[URI]:
         remote = self.__url
         if remote is None:
-            remote = self.get_str(key='URL', default=None)
+            remote = self.get_str(key='URL')
             # TODO: convert str to URI
             self.__url = remote
         return remote

{dimp-2.3.2 → dimp-2.3.3}/dimp/crypto/ted.py

@@ -69,10 +69,10 @@ class BaseDataWrapper(Dictionary):
 
     # Override
     def __str__(self) -> str:
-        text = self.get_str(key='data', default=None)
+        text = self.get_str(key='data')
         if text is None:  # or len(text) == 0:
             return ''
-        alg = self.get_str(key='algorithm', default=None)
+        alg = self.get_str(key='algorithm')
         if alg is None or alg == EncodeAlgorithms.DEFAULT:
             alg = ''
         if len(alg) == 0:
@@ -85,7 +85,7 @@ class BaseDataWrapper(Dictionary):
     def encode(self, mime_type: str) -> str:
         """ toString(mimeType) """
         # get encoded data
-        text = self.get_str(key='data', default=None)
+        text = self.get_str(key='data')
         if text is None:  # or len(text) == 0:
             return ''
         alg = self.algorithm
@@ -98,7 +98,7 @@ class BaseDataWrapper(Dictionary):
 
     @property
     def algorithm(self) -> str:
-        alg = self.get_str(key='algorithm', default=None)
+        alg = self.get_str(key='algorithm')
         if alg is None or len(alg) == 0:
             alg = EncodeAlgorithms.DEFAULT
         return alg
@@ -118,7 +118,7 @@ class BaseDataWrapper(Dictionary):
     def data(self) -> Optional[bytes]:
         binary = self.__data
         if binary is None:
-            text = self.get_str(key='data', default=None)
+            text = self.get_str(key='data')
             if text is None or len(text) == 0:
                 # assert False, 'TED data empty: %s' % self.dictionary
                 return None

{dimp-2.3.2 → dimp-2.3.3}/dimp/dkd/__init__.py

@@ -37,6 +37,7 @@ from ..protocol.forward import SecretContent, CombineForwardContent, ListContent
 from ..protocol.files import BaseFileContent, ImageFileContent, AudioFileContent, VideoFileContent
 from ..protocol.money import BaseMoneyContent, TransferMoneyContent
 from ..protocol.quote import BaseQuoteContent
+from ..protocol.customized import AppCustomizedContent
 
 from ..protocol.base import BaseCommand
 from ..protocol.commands import BaseMetaCommand, BaseDocumentCommand
@@ -63,11 +64,12 @@ __all__ = [
     'InstantMessage', 'SecureMessage', 'ReliableMessage',
 
     # contents
-    'TextContent', 'ArrayContent', 'ForwardContent',
-    'PageContent', 'NameCard',
+    'TextContent', 'PageContent', 'NameCard',
+    'ForwardContent', 'CombineContent', 'ArrayContent',
     'FileContent', 'ImageContent', 'AudioContent', 'VideoContent',
     'MoneyContent', 'TransferContent',
-    'QuoteContent', 'CombineContent',
+    'QuoteContent',
+    'CustomizedContent',
 
     # commands
     'Command',
@@ -93,11 +95,12 @@ __all__ = [
 
     # contents
     'BaseContent',
-    'BaseTextContent', 'ListContent', 'SecretContent',
-    'WebPageContent', 'NameCardContent',
+    'BaseTextContent', 'WebPageContent', 'NameCardContent',
+    'SecretContent', 'CombineForwardContent', 'ListContent',
     'BaseFileContent', 'ImageFileContent', 'AudioFileContent', 'VideoFileContent',
     'BaseMoneyContent', 'TransferMoneyContent',
-    'BaseQuoteContent', 'CombineForwardContent',
+    'BaseQuoteContent',
+    'AppCustomizedContent',
 
     # commands
     'BaseCommand',

{dimp-2.3.2 → dimp-2.3.3}/dimp/mkm/document.py

@@ -114,7 +114,7 @@ class BaseDocument(Dictionary, Document):
         :return: JsON string
         """
         if self.__json is None:
-            self.__json = self.get_str(key='data', default=None)
+            self.__json = self.get_str(key='data')
         return self.__json
 
     @property  # private
@@ -259,12 +259,12 @@ class BaseDocument(Dictionary, Document):
     @property  # Override
     def time(self) -> Optional[DateTime]:
         seconds = self.get_property(name='time')
-        return Converter.get_datetime(value=seconds, default=None)
+        return Converter.get_datetime(value=seconds)
 
     @property  # Override
     def name(self) -> Optional[str]:
         text = self.get_property(name='name')
-        return Converter.get_str(value=text, default=None)
+        return Converter.get_str(value=text)
 
     @name.setter  # Override
     def name(self, text: str):

{dimp-2.3.2 → dimp-2.3.3}/dimp/msg/envelope.py

@@ -102,7 +102,7 @@ class MessageEnvelope(Dictionary, Envelope):
     @property  # Override
     def time(self) -> Optional[DateTime]:
         if self.__time is None:
-            self.__time = self.get_datetime(key='time', default=None)
+            self.__time = self.get_datetime(key='time')
         return self.__time
 
     @property  # Override
@@ -116,7 +116,7 @@ class MessageEnvelope(Dictionary, Envelope):
 
     @property  # Override
     def type(self) -> Optional[str]:
-        return self.get_str(key='type', default=None)
+        return self.get_str(key='type')
 
     @type.setter  # Override
     def type(self, value: str):

{dimp-2.3.2 → dimp-2.3.3}/dimp/protocol/__init__.py

@@ -52,6 +52,7 @@ from .forward import ForwardContent, CombineContent, ArrayContent
 from .files import FileContent, ImageContent, AudioContent, VideoContent
 from .money import MoneyContent, TransferContent
 from .quote import QuoteContent
+from .customized import CustomizedContent
 
 from .base import Command, CommandFactory
 from .commands import MetaCommand, DocumentCommand
@@ -108,6 +109,7 @@ __all__ = [
     'FileContent', 'ImageContent', 'AudioContent', 'VideoContent',
     'MoneyContent', 'TransferContent',
     'QuoteContent',
+    'CustomizedContent',
 
     # commands
     'Command',          # 'CommandFactory',

{dimp-2.3.2 → dimp-2.3.3}/dimp/protocol/base.py

@@ -226,7 +226,7 @@ class BaseContent(Dictionary, Content):
     @property  # Override
     def time(self) -> Optional[DateTime]:
         if self.__time is None:
-            self.__time = self.get_datetime(key='time', default=None)
+            self.__time = self.get_datetime(key='time')
         return self.__time
 
     @property  # Override

{dimp-2.3.2 → dimp-2.3.3}/dimp/protocol/commands.py

@@ -253,4 +253,4 @@ class BaseDocumentCommand(BaseMetaCommand, DocumentCommand):
 
     @property  # Override
     def last_time(self) -> Optional[DateTime]:
-        return self.get_datetime(key='last_time', default=None)
+        return self.get_datetime(key='last_time')

{dimp-2.3.2 → dimp-2.3.3}/dimp/protocol/contents.py

@@ -291,7 +291,7 @@ class WebPageContent(BaseContent, PageContent):
     def icon(self) -> Optional[PortableNetworkFile]:
         img = self.__icon
         if img is None:
-            base64 = self.get_str(key='icon', default=None)
+            base64 = self.get_str(key='icon')
             img = self.__icon = PortableNetworkFile.parse(base64)
         return img
 
@@ -309,7 +309,7 @@ class WebPageContent(BaseContent, PageContent):
 
     @property  # Override
     def desc(self) -> Optional[str]:
-        return self.get_str(key='desc', default=None)
+        return self.get_str(key='desc')
 
     @desc.setter  # Override
     def desc(self, text: Optional[str]):
@@ -325,7 +325,7 @@ class WebPageContent(BaseContent, PageContent):
     @property  # Override
     def url(self) -> URI:
         # TODO: convert str to URI
-        return self.get_str(key='URL', default=None)
+        return self.get_str(key='URL')
 
     @url.setter  # Override
     def url(self, locator: URI):
@@ -338,7 +338,7 @@ class WebPageContent(BaseContent, PageContent):
 
     @property  # Override
     def html(self) -> Optional[str]:
-        return self.get_str(key='desc', default=None)
+        return self.get_str(key='desc')
 
     @html.setter  # Override
     def html(self, content: Optional[str]):

dimp-2.3.3/dimp/protocol/customized.py

@@ -0,0 +1,113 @@
+# -*- coding: utf-8 -*-
+#
+#   DIMP : Decentralized Instant Messaging Protocol
+#
+#                                Written in 2019 by Moky <albert.moky@gmail.com>
+#
+# ==============================================================================
+# MIT License
+#
+# Copyright (c) 2019 Albert Moky
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+# ==============================================================================
+
+from abc import ABC, abstractmethod
+from typing import Dict
+
+from dkd import Content
+
+from .types import ContentType
+from .base import BaseContent
+
+
+class CustomizedContent(Content, ABC):
+    """
+        Application Customized message
+        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+        data format: {
+            type : i2s(0xCC),
+            sn   : 123,
+
+            app   : "{APP_ID}",  // application (e.g.: "chat.dim.sechat")
+            mod   : "{MODULE}",  // module name (e.g.: "drift_bottle")
+            act   : "{ACTION}",  // action name (e.g.: "throw")
+            extra : info         // action parameters
+        }
+    """
+
+    @property
+    @abstractmethod
+    def application(self) -> str:
+        """ App ID """
+        raise NotImplemented
+
+    @property
+    @abstractmethod
+    def module(self) -> str:
+        """ Module Name """
+        raise NotImplemented
+
+    @property
+    @abstractmethod
+    def action(self) -> str:
+        """ Action Name """
+        raise NotImplemented
+
+    #
+    #   Factory method
+    #
+    @classmethod
+    def create(cls, app: str, mod: str, act: str):
+        return AppCustomizedContent(app=app, mod=mod, act=act)
+
+
+class AppCustomizedContent(BaseContent, CustomizedContent):
+
+    def __init__(self, content: Dict = None,
+                 msg_type: str = None,
+                 app: str = None, mod: str = None, act: str = None):
+        if content is None:
+            # 1. new content with type, application, module & action
+            assert app is not None and mod is not None and act is not None, \
+                'customized content error: %s, %s, %s, %s' % (msg_type, app, mod, act)
+            if msg_type is None:
+                msg_type = ContentType.CUSTOMIZED
+            super().__init__(None, msg_type)
+            self['app'] = app
+            self['mod'] = mod
+            self['act'] = act
+        else:
+            # 2. content info from network
+            assert msg_type is None and app is None and mod is None and act is None, \
+                'params error: %s, %s, %s, %s, %s' % (content, msg_type, app, mod, act)
+            super().__init__(content)
+
+    @property  # Override
+    def application(self) -> str:
+        return self.get_str(key='app', default='')
+
+    @property  # Override
+    def module(self) -> str:
+        return self.get_str(key='mod', default='')
+
+    @property  # Override
+    def action(self) -> str:
+        return self.get_str(key='act', default='')

{dimp-2.3.2 → dimp-2.3.3}/dimp/protocol/files.py

@@ -341,7 +341,7 @@ class ImageFileContent(BaseFileContent, ImageContent):
     def thumbnail(self) -> Optional[PortableNetworkFile]:
         img = self.__thumbnail
         if img is None:
-            base64 = self.get_str(key='thumbnail', default=None)
+            base64 = self.get_str(key='thumbnail')
             img = self.__thumbnail = PortableNetworkFile.parse(base64)
         return img
 
@@ -365,7 +365,7 @@ class AudioFileContent(BaseFileContent, AudioContent):
 
     @property  # Override
     def text(self) -> Optional[str]:
-        return self.get_str(key='text', default=None)
+        return self.get_str(key='text')
 
     @text.setter  # Override
     def text(self, asr: str):
@@ -387,7 +387,7 @@ class VideoFileContent(BaseFileContent, VideoContent):
     def snapshot(self) -> Optional[PortableNetworkFile]:
         img = self.__snapshot
         if img is None:
-            base64 = self.get_str(key='snapshot', default=None)
+            base64 = self.get_str(key='snapshot')
             img = self.__snapshot = PortableNetworkFile.parse(base64)
         return img
 

{dimp-2.3.2 → dimp-2.3.3}/dimp/protocol/groups.py

@@ -385,7 +385,7 @@ class QueryGroupCommand(BaseGroupCommand, QueryCommand):
 
     @property  # Override
     def last_time(self) -> Optional[DateTime]:
-        return self.get_datetime(key='last_time', default=None)
+        return self.get_datetime(key='last_time')
 
 
 class ResetGroupCommand(BaseGroupCommand, ResetCommand):

{dimp-2.3.2 → dimp-2.3.3}/dimp.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dimp
-Version: 2.3.2
+Version: 2.3.3
 Summary: Decentralized Instant Messaging Protocol
 Home-page: https://github.com/dimchat/core-py
 Author: Albert Moky
@@ -45,8 +45,9 @@ License-File: LICENSE
   3. (S-C) handshake success
 
 ```python
+from abc import ABC, abstractmethod
 from enum import IntEnum
-from typing import Optional, Any, Dict
+from typing import Optional, Dict
 
 from dimp import Command, BaseCommand
 
@@ -58,7 +59,20 @@ class HandshakeState(IntEnum):
     Success = 3  # S -> C, handshake accepted
 
 
-class HandshakeCommand(BaseCommand):
+def handshake_state(title: str, session: str = None) -> HandshakeState:
+    # Server -> Client
+    if title == 'DIM!':  # or title == 'OK!':
+        return HandshakeState.Success
+    if title == 'DIM?':
+        return HandshakeState.Again
+    # Client -> Server: "Hello world!"
+    if session is None or len(session) == 0:
+        return HandshakeState.Start
+    else:
+        return HandshakeState.Restart
+
+
+class HandshakeCommand(Command, ABC):
     """
         Handshake Command
         ~~~~~~~~~~~~~~~~~
@@ -74,37 +88,24 @@ class HandshakeCommand(BaseCommand):
     """
     HANDSHAKE = 'handshake'
 
-    def __init__(self, content: Dict[str, Any] = None, title: str = None, session: str = None):
-        if content is None:
-            # 1. new command with title & session key
-            assert title is not None, 'handshake command error: %s' % session
-            cmd = self.HANDSHAKE
-            super().__init__(cmd=cmd)
-            self['title'] = title
-            self['message'] = title  # TODO: remove after all clients upgraded
-            if session is not None:
-                self['session'] = session
-        else:
-            # 2. command info from network
-            assert title is None and session is None, 'params error: %s, %s, %s' % (content, title, session)
-            super().__init__(content)
-
     @property
+    @abstractmethod
     def title(self) -> str:
-        # TODO: modify after all clients upgraded
-        text = self.get_str(key='title', default=None)
-        if text is None:
-            # compatible with v1.0
-            text = self.get_str(key='message', default='')
-        return text
+        raise NotImplemented
 
     @property
+    @abstractmethod
     def session(self) -> Optional[str]:
-        return self.get_str(key='session', default=None)
+        raise NotImplemented
 
     @property
+    @abstractmethod
     def state(self) -> HandshakeState:
-        return handshake_state(title=self.title, session=self.session)
+        raise NotImplemented
+
+    #
+    #   Factories
+    #
 
     @classmethod
     def offer(cls, session: str = None) -> Command:
@@ -114,7 +115,7 @@ class HandshakeCommand(BaseCommand):
         :param session: Old session key
         :return: HandshakeCommand object
         """
-        return HandshakeCommand(title='Hello world!', session=session)
+        return BaseHandshakeCommand(title='Hello world!', session=session)
 
     @classmethod
     def ask(cls, session: str) -> Command:
@@ -124,7 +125,7 @@ class HandshakeCommand(BaseCommand):
         :param session: New session key
         :return: HandshakeCommand object
         """
-        return HandshakeCommand(title='DIM?', session=session)
+        return BaseHandshakeCommand(title='DIM?', session=session)
 
     @classmethod
     def accepted(cls, session: str = None) -> Command:
@@ -133,7 +134,7 @@ class HandshakeCommand(BaseCommand):
 
         :return: HandshakeCommand object
         """
-        return HandshakeCommand(title='DIM!', session=session)
+        return BaseHandshakeCommand(title='DIM!', session=session)
 
     start = offer       # (1. C->S) first handshake, without session
     again = ask         # (2. S->C) ask client to handshake with new session key
@@ -141,17 +142,34 @@ class HandshakeCommand(BaseCommand):
     success = accepted  # (4. S->C) notice the client that handshake accepted
 
 
-def handshake_state(title: str, session: str = None) -> HandshakeState:
-    # Server -> Client
-    if title == 'DIM!':  # or title == 'OK!':
-        return HandshakeState.Success
-    if title == 'DIM?':
-        return HandshakeState.Again
-    # Client -> Server: "Hello world!"
-    if session is None or len(session) == 0:
-        return HandshakeState.Start
-    else:
-        return HandshakeState.Restart
+class BaseHandshakeCommand(BaseCommand, HandshakeCommand):
+
+    def __init__(self, content: Dict = None, title: str = None, session: str = None):
+        if content is None:
+            # 1. new command with title & session key
+            assert title is not None, 'handshake command error: %s' % session
+            cmd = self.HANDSHAKE
+            super().__init__(cmd=cmd)
+            self['title'] = title
+            self['message'] = title  # TODO: remove after all clients upgraded
+            if session is not None:
+                self['session'] = session
+        else:
+            # 2. command info from network
+            assert title is None and session is None, 'params error: %s, %s, %s' % (content, title, session)
+            super().__init__(content)
+
+    @property
+    def title(self) -> str:
+        return self.get_str(key='title', default='')
+
+    @property
+    def session(self) -> Optional[str]:
+        return self.get_str(key='session')
+
+    @property
+    def state(self) -> HandshakeState:
+        return handshake_state(title=self.title, session=self.session)
 ```
 
 ### extends Content
@@ -165,13 +183,13 @@ from dimp import Content
 from dimp import BaseContent
 
 
-class CustomizedContent(Content, ABC):
+class AppContent(Content, ABC):
     """
         Application Customized message
         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
         data format: {
-            type : 0xCC,
+            type : 0xA0,
             sn   : 123,
 
             app   : "{APP_ID}",  // application (e.g.: "chat.dim.sechat")
@@ -199,22 +217,25 @@ class CustomizedContent(Content, ABC):
         """ Action Name """
         raise NotImplemented
 
+    #
+    #   Factory
+    #
     @classmethod
     def create(cls, app: str, mod: str, act: str):
-        return AppCustomizedContent(app=app, mod=mod, act=act)
+        return ApplicationContent(app=app, mod=mod, act=act)
 
 
-class AppCustomizedContent(BaseContent, CustomizedContent):
+class ApplicationContent(BaseContent, AppContent):
 
     def __init__(self, content: Dict[str, Any] = None,
-                 msg_type: int = None,
+                 msg_type: str = None,
                  app: str = None, mod: str = None, act: str = None):
         if content is None:
             # 1. new content with type, application, module & action
             assert app is not None and mod is not None and act is not None, \
                 'customized content error: %s, %s, %s, %s' % (msg_type, app, mod, act)
             if msg_type is None:
-                msg_type = ContentType.CUSTOMIZED.value
+                msg_type = ContentType.APPLICATION
             super().__init__(None, msg_type)
             self['app'] = app
             self['mod'] = mod
@@ -244,5 +265,5 @@ class AppCustomizedContent(BaseContent, CustomizedContent):
 
 ----
 
-Copyright © 2018 Albert Moky
+Copyright © 2018-2025 Albert Moky
 [![Followers](https://img.shields.io/github/followers/moky)](https://github.com/moky?tab=followers)

{dimp-2.3.2 → dimp-2.3.3}/dimp.egg-info/SOURCES.txt

@@ -28,6 +28,7 @@ dimp/protocol/__init__.py
 dimp/protocol/base.py
 dimp/protocol/commands.py
 dimp/protocol/contents.py
+dimp/protocol/customized.py
 dimp/protocol/docs.py
 dimp/protocol/files.py
 dimp/protocol/forward.py

dimp-2.3.3/dimp.egg-info/requires.txt

@@ -0,0 +1,2 @@
+dkd>=2.3.3
+mkm>=2.3.3

{dimp-2.3.2 → dimp-2.3.3}/setup.py

@@ -14,7 +14,7 @@ import io
 
 from setuptools import setup, find_packages
 
-__version__ = '2.3.2'
+__version__ = '2.3.3'
 __author__ = 'Albert Moky'
 __contact__ = 'albert.moky@gmail.com'
 
@@ -38,7 +38,7 @@ setup(
         'Operating System :: OS Independent',
     ],
     install_requires=[
-        'dkd>=2.3.2',
-        'mkm>=2.3.2',
+        'dkd>=2.3.3',
+        'mkm>=2.3.3',
     ]
 )

dimp-2.3.2/dimp.egg-info/requires.txt

@@ -1,2 +0,0 @@
-dkd>=2.3.2
-mkm>=2.3.2