dimp 2.3.2__tar.gz → 2.3.4__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dimp
-Version: 2.3.2
+Version: 2.3.4
 Summary: Decentralized Instant Messaging Protocol
 Home-page: https://github.com/dimchat/core-py
 Author: Albert Moky
@@ -18,7 +18,7 @@ License-File: LICENSE
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/dimchat/core-py/pulls)
 [![Platform](https://img.shields.io/badge/Platform-Python%203-brightgreen.svg)](https://github.com/dimchat/core-py/wiki)
 [![Issues](https://img.shields.io/github/issues/dimchat/core-py)](https://github.com/dimchat/core-py/issues)
-[![Repo Size](https://img.shields.io/github/repo-size/dimchat/core-py)](https://github.com/dimchat/core-py/archive/refs/heads/main.zip)
+[![Repo Size](https://img.shields.io/github/repo-size/dimchat/core-py)](https://github.com/dimchat/core-py/archive/refs/heads/master.zip)
 [![Tags](https://img.shields.io/github/tag/dimchat/core-py)](https://github.com/dimchat/core-py/tags)
 [![Version](https://img.shields.io/pypi/v/dimp)](https://pypi.org/project/dimp)
 
@@ -36,7 +36,7 @@ License-File: LICENSE
 
 ## Examples
 
-### extends Command
+### Extends Command
 
 * _Handshake Command Protocol_
   0. (C-S) handshake start
@@ -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,108 +142,82 @@ 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
+### Extends Content
 
 ```python
-from abc import ABC, abstractmethod
 from typing import Any, Dict
 
-from dimp import ContentType
-from dimp import Content
-from dimp import BaseContent
+from dimp import *
 
 
-class CustomizedContent(Content, ABC):
+class ApplicationContent(BaseContent, AppContent):
     """
         Application Customized message
         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
         data format: {
-            type : 0xCC,
+            type : i2s(0xA0),
             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
-
-    @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[str, Any] = None,
-                 msg_type: int = None,
-                 app: str = None, mod: str = None, act: str = None):
+                 msg_type: str = None, app: 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)
+            # 1. new content with type, app_id
+            assert app is not None, 'customized content error: %s, %s' % (msg_type, app)
             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
-            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)
+            assert msg_type is None and app is None, 'params error: %s, %s, %s' % (content, msg_type, app)
             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='')
 ```
 
-### extends ID Address
+### Extends ID Address
 
 * Examples in [dim plugins](https://pypi.org/project/dimplugins)
 
 ----
 
-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.4}/README.md

@@ -4,7 +4,7 @@
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/dimchat/core-py/pulls)
 [![Platform](https://img.shields.io/badge/Platform-Python%203-brightgreen.svg)](https://github.com/dimchat/core-py/wiki)
 [![Issues](https://img.shields.io/github/issues/dimchat/core-py)](https://github.com/dimchat/core-py/issues)
-[![Repo Size](https://img.shields.io/github/repo-size/dimchat/core-py)](https://github.com/dimchat/core-py/archive/refs/heads/main.zip)
+[![Repo Size](https://img.shields.io/github/repo-size/dimchat/core-py)](https://github.com/dimchat/core-py/archive/refs/heads/master.zip)
 [![Tags](https://img.shields.io/github/tag/dimchat/core-py)](https://github.com/dimchat/core-py/tags)
 [![Version](https://img.shields.io/pypi/v/dimp)](https://pypi.org/project/dimp)
 
@@ -22,7 +22,7 @@
 
 ## Examples
 
-### extends Command
+### Extends Command
 
 * _Handshake Command Protocol_
   0. (C-S) handshake start
@@ -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,108 +128,82 @@ 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
+### Extends Content
 
 ```python
-from abc import ABC, abstractmethod
 from typing import Any, Dict
 
-from dimp import ContentType
-from dimp import Content
-from dimp import BaseContent
+from dimp import *
 
 
-class CustomizedContent(Content, ABC):
+class ApplicationContent(BaseContent, AppContent):
     """
         Application Customized message
         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
         data format: {
-            type : 0xCC,
+            type : i2s(0xA0),
             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
-
-    @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[str, Any] = None,
-                 msg_type: int = None,
-                 app: str = None, mod: str = None, act: str = None):
+                 msg_type: str = None, app: 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)
+            # 1. new content with type, app_id
+            assert app is not None, 'customized content error: %s, %s' % (msg_type, app)
             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
-            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)
+            assert msg_type is None and app is None, 'params error: %s, %s, %s' % (content, msg_type, app)
             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='')
 ```
 
-### extends ID Address
+### Extends ID Address
 
 * Examples in [dim plugins](https://pypi.org/project/dimplugins)
 
 ----
 
-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.4}/dimp/__init__.py

@@ -65,7 +65,6 @@ __all__ = [
     'DataCoder', 'Hex', 'Base58', 'Base64',
     'ObjectCoder', 'JSON',
     'MapCoder', 'JSONMap',
-    'ListCoder', 'JSONList',
     'StringCoder', 'UTF8',
 
     'hex_encode', 'hex_decode',
@@ -81,10 +80,9 @@ __all__ = [
     #   Digest
     #
 
-    'DataDigester',
-    'MD5', 'SHA1', 'SHA256', 'KECCAK256', 'RIPEMD160',
-
-    'md5', 'sha1', 'sha256', 'keccak256', 'ripemd160',
+    'MessageDigester',
+    'SHA256', 'KECCAK256', 'RIPEMD160',
+    'sha256', 'keccak256', 'ripemd160',
 
     #
     #   Crypto
@@ -119,6 +117,8 @@ __all__ = [
     'Meta',
     'Document', 'Visa', 'Bulletin',
 
+    'MetaType', 'DocumentType',
+
     'AddressFactory',
     'IDFactory',
     'MetaFactory',
@@ -132,8 +132,6 @@ __all__ = [
     'BaseMeta',
     'BaseDocument', 'BaseVisa', 'BaseBulletin',
 
-    'MetaType', 'DocumentType',
-
     #
     #   DaoKeDao
     #
@@ -145,11 +143,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',
@@ -158,16 +157,17 @@ __all__ = [
 
     # group history
     'HistoryCommand', 'GroupCommand',
-    'InviteCommand', 'ExpelCommand', 'JoinCommand', 'QuitCommand', 'QueryCommand', 'ResetCommand',
+    'InviteCommand', 'ExpelCommand', 'JoinCommand', 'QuitCommand', 'ResetCommand',
     'HireCommand', 'FireCommand', 'ResignCommand',
 
     # 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',
@@ -176,8 +176,8 @@ __all__ = [
 
     # extend group history
     'BaseHistoryCommand', 'BaseGroupCommand',
-    'InviteGroupCommand', 'ExpelGroupCommand', 'JoinGroupCommand',
-    'QuitGroupCommand', 'QueryGroupCommand', 'ResetGroupCommand',
+    'InviteGroupCommand', 'ExpelGroupCommand',
+    'JoinGroupCommand', 'QuitGroupCommand', 'ResetGroupCommand',
     'HireGroupCommand', 'FireGroupCommand', 'ResignGroupCommand',
 
     #

{dimp-2.3.2 → dimp-2.3.4}/dimp/crypto/__init__.py

@@ -42,12 +42,12 @@ from .pnf import BaseFileWrapper
 __all__ = [
 
     #
-    #   Data Digest
+    #   Digest
     #
 
-    'DataDigester',
-    'MD5', 'SHA1', 'SHA256', 'KECCAK256', 'RIPEMD160',
-    'md5', 'sha1', 'sha256', 'keccak256', 'ripemd160',
+    'MessageDigester',
+    'SHA256', 'KECCAK256', 'RIPEMD160',
+    'sha256', 'keccak256', 'ripemd160',
 
     #
     #   Crypto