dimp 2.3.4__tar.gz → 2.4.1__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dimp
-Version: 2.3.4
+Version: 2.4.1
 Summary: Decentralized Instant Messaging Protocol
 Home-page: https://github.com/dimchat/core-py
 Author: Albert Moky
@@ -49,7 +49,7 @@ from abc import ABC, abstractmethod
 from enum import IntEnum
 from typing import Optional, Dict
 
-from dimp import Command, BaseCommand
+from dimp import *
 
 
 class HandshakeState(IntEnum):
@@ -78,12 +78,12 @@ class HandshakeCommand(Command, ABC):
         ~~~~~~~~~~~~~~~~~
 
         data format: {
-            type : 0x88,
-            sn   : 123,
+            "type" : i2s(0x88),
+            "sn"   : 12345,
 
-            command : "handshake",    // command name
-            title   : "Hello world!", // "DIM?", "DIM!"
-            session : "{SESSION_ID}", // session key
+            "command" : "handshake",    // command name
+            "title"   : "Hello world!", // "DIM?", "DIM!"
+            "session" : "{SESSION_ID}", // session key
         }
     """
     HANDSHAKE = 'handshake'
@@ -91,17 +91,23 @@ class HandshakeCommand(Command, ABC):
     @property
     @abstractmethod
     def title(self) -> str:
-        raise NotImplemented
+        raise NotImplementedError(
+            f'Not implemented: {type(self).__module__}.{type(self).__name__}.title getter'
+        )
 
     @property
     @abstractmethod
     def session(self) -> Optional[str]:
-        raise NotImplemented
+        raise NotImplementedError(
+            f'Not implemented: {type(self).__module__}.{type(self).__name__}.session getter'
+        )
 
     @property
     @abstractmethod
     def state(self) -> HandshakeState:
-        raise NotImplemented
+        raise NotImplementedError(
+            f'Not implemented: {type(self).__module__}.{type(self).__name__}.state getter'
+        )
 
     #
     #   Factories
@@ -175,42 +181,112 @@ class BaseHandshakeCommand(BaseCommand, HandshakeCommand):
 ### Extends Content
 
 ```python
-from typing import Any, Dict
+from abc import ABC, abstractmethod
 
 from dimp import *
 
 
-class ApplicationContent(BaseContent, AppContent):
+class AppContent(Content, ABC):
+    """
+        Content for Application 0nly
+        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+        data format: {
+            "type" : i2s(0xA0),
+            "sn"   : 12345,
+
+            "app"   : "{APP_ID}",  // application (e.g.: "chat.dim.sechat")
+            "extra" : info         // action parameters
+        }
+    """
+
+    @property
+    @abstractmethod
+    def application(self) -> str:
+        """ App ID """
+        raise NotImplementedError(
+            f'Not implemented: {type(self).__module__}.{type(self).__name__}.application getter'
+        )
+
+
+class CustomizedContent(Content, ABC):
     """
         Application Customized message
         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
         data format: {
-            type : i2s(0xA0),
-            sn   : 123,
+            "type" : i2s(0xCC),
+            "sn"   : 12345,
 
-            app   : "{APP_ID}",  // application (e.g.: "chat.dim.sechat")
-            extra : info         // action parameters
+            "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
         }
     """
 
-    def __init__(self, content: Dict[str, Any] = None,
-                 msg_type: str = None, app: str = None):
+    @property
+    @abstractmethod
+    def module(self) -> str:
+        """ Module Name """
+        raise NotImplementedError(
+            f'Not implemented: {type(self).__module__}.{type(self).__name__}.module getter'
+        )
+
+    @property
+    @abstractmethod
+    def action(self) -> str:
+        """ Action Name """
+        raise NotImplementedError(
+            f'Not implemented: {type(self).__module__}.{type(self).__name__}.action getter'
+        )
+
+    #
+    #   Factory method
+    #
+    @classmethod
+    def create(cls, app: str, mod: str, act: str):
+        return AppCustomizedContent(app=app, mod=mod, act=act)
+```
+
+```python
+from typing import Dict
+
+from dimp import *
+
+
+class AppCustomizedContent(BaseContent, AppContent, 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, app_id
-            assert app is not None, 'customized content error: %s, %s' % (msg_type, app)
+            # 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.APPLICATION
+                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, 'params error: %s, %s, %s' % (content, msg_type, app)
+            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='')
 ```
 
 ### Extends ID Address
@@ -219,5 +295,5 @@ class ApplicationContent(BaseContent, AppContent):
 
 ----
 
-Copyright © 2018-2025 Albert Moky
+Copyright © 2018-2026 Albert Moky
 [![Followers](https://img.shields.io/github/followers/moky)](https://github.com/moky?tab=followers)

{dimp-2.3.4 → dimp-2.4.1}/README.md

@@ -35,7 +35,7 @@ from abc import ABC, abstractmethod
 from enum import IntEnum
 from typing import Optional, Dict
 
-from dimp import Command, BaseCommand
+from dimp import *
 
 
 class HandshakeState(IntEnum):
@@ -64,12 +64,12 @@ class HandshakeCommand(Command, ABC):
         ~~~~~~~~~~~~~~~~~
 
         data format: {
-            type : 0x88,
-            sn   : 123,
+            "type" : i2s(0x88),
+            "sn"   : 12345,
 
-            command : "handshake",    // command name
-            title   : "Hello world!", // "DIM?", "DIM!"
-            session : "{SESSION_ID}", // session key
+            "command" : "handshake",    // command name
+            "title"   : "Hello world!", // "DIM?", "DIM!"
+            "session" : "{SESSION_ID}", // session key
         }
     """
     HANDSHAKE = 'handshake'
@@ -77,17 +77,23 @@ class HandshakeCommand(Command, ABC):
     @property
     @abstractmethod
     def title(self) -> str:
-        raise NotImplemented
+        raise NotImplementedError(
+            f'Not implemented: {type(self).__module__}.{type(self).__name__}.title getter'
+        )
 
     @property
     @abstractmethod
     def session(self) -> Optional[str]:
-        raise NotImplemented
+        raise NotImplementedError(
+            f'Not implemented: {type(self).__module__}.{type(self).__name__}.session getter'
+        )
 
     @property
     @abstractmethod
     def state(self) -> HandshakeState:
-        raise NotImplemented
+        raise NotImplementedError(
+            f'Not implemented: {type(self).__module__}.{type(self).__name__}.state getter'
+        )
 
     #
     #   Factories
@@ -161,42 +167,112 @@ class BaseHandshakeCommand(BaseCommand, HandshakeCommand):
 ### Extends Content
 
 ```python
-from typing import Any, Dict
+from abc import ABC, abstractmethod
 
 from dimp import *
 
 
-class ApplicationContent(BaseContent, AppContent):
+class AppContent(Content, ABC):
+    """
+        Content for Application 0nly
+        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+        data format: {
+            "type" : i2s(0xA0),
+            "sn"   : 12345,
+
+            "app"   : "{APP_ID}",  // application (e.g.: "chat.dim.sechat")
+            "extra" : info         // action parameters
+        }
+    """
+
+    @property
+    @abstractmethod
+    def application(self) -> str:
+        """ App ID """
+        raise NotImplementedError(
+            f'Not implemented: {type(self).__module__}.{type(self).__name__}.application getter'
+        )
+
+
+class CustomizedContent(Content, ABC):
     """
         Application Customized message
         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
         data format: {
-            type : i2s(0xA0),
-            sn   : 123,
+            "type" : i2s(0xCC),
+            "sn"   : 12345,
 
-            app   : "{APP_ID}",  // application (e.g.: "chat.dim.sechat")
-            extra : info         // action parameters
+            "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
         }
     """
 
-    def __init__(self, content: Dict[str, Any] = None,
-                 msg_type: str = None, app: str = None):
+    @property
+    @abstractmethod
+    def module(self) -> str:
+        """ Module Name """
+        raise NotImplementedError(
+            f'Not implemented: {type(self).__module__}.{type(self).__name__}.module getter'
+        )
+
+    @property
+    @abstractmethod
+    def action(self) -> str:
+        """ Action Name """
+        raise NotImplementedError(
+            f'Not implemented: {type(self).__module__}.{type(self).__name__}.action getter'
+        )
+
+    #
+    #   Factory method
+    #
+    @classmethod
+    def create(cls, app: str, mod: str, act: str):
+        return AppCustomizedContent(app=app, mod=mod, act=act)
+```
+
+```python
+from typing import Dict
+
+from dimp import *
+
+
+class AppCustomizedContent(BaseContent, AppContent, 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, app_id
-            assert app is not None, 'customized content error: %s, %s' % (msg_type, app)
+            # 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.APPLICATION
+                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, 'params error: %s, %s, %s' % (content, msg_type, app)
+            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='')
 ```
 
 ### Extends ID Address
@@ -205,5 +281,5 @@ class ApplicationContent(BaseContent, AppContent):
 
 ----
 
-Copyright © 2018-2025 Albert Moky
+Copyright © 2018-2026 Albert Moky
 [![Followers](https://img.shields.io/github/followers/moky)](https://github.com/moky?tab=followers)

{dimp-2.3.4 → dimp-2.4.1}/dimp/__init__.py

@@ -28,18 +28,12 @@
 # SOFTWARE.
 # ==============================================================================
 
-from mkm.types import *
-from mkm.format import *
-from mkm.crypto import *
-from mkm import *
-from dkd import *
-
-from .protocol.base import CommandFactory
-from .protocol import *
+from .format import *
 from .crypto import *
+from .protocol import *
 from .mkm import *
 from .dkd import *
-from .msg import *
+from .ext import *
 
 
 name = "DIMP"
@@ -53,6 +47,7 @@ __all__ = [
     'URI', 'DateTime',
 
     'Converter', 'DataConverter', 'BaseConverter',
+
     'Copier',
     'Wrapper', 'Stringer', 'Mapper',
     'ConstantString',  # 'String',
@@ -73,8 +68,42 @@ __all__ = [
     'json_encode', 'json_decode',
     'utf8_encode', 'utf8_decode',
 
-    'TransportableData', 'TransportableDataFactory',
-    'PortableNetworkFile', 'PortableNetworkFileFactory',
+    'TransportableResource',
+    'TransportableData',
+
+    'TransportableDataFactory',
+
+    'TransportableDataHelper',
+    'FormatExtensions', 'shared_format_extensions',
+
+    'Header', 'DataURI',
+
+    #
+    #   TED
+    #
+
+    'EncodeAlgorithms',
+
+    'BaseString', 'BaseData',
+
+    'Base64Data', 'PlainData',
+    'EmbedData',
+
+    #
+    #   PNF
+    #
+
+    'TransportableFile', 'TransportableFileFactory',
+    # 'TransportableFileHelper', 'TransportableFileExtension',
+    'TransportableFileWrapper', 'TransportableFileWrapperFactory',
+    # 'TransportableFileWrapperExtension',
+
+    'PortableNetworkFile',
+    'PortableNetworkFileWrapper',
+
+
+    # ================================================================
+
 
     #
     #   Digest
@@ -95,102 +124,153 @@ __all__ = [
 
     'SymmetricKeyFactory', 'PrivateKeyFactory', 'PublicKeyFactory',
 
-    'BaseKey', 'BaseSymmetricKey',
-    'BaseAsymmetricKey', 'BasePublicKey', 'BasePrivateKey',
+    'SymmetricKeyHelper', 'PublicKeyHelper', 'PrivateKeyHelper',
 
-    'BaseDataWrapper',
-    'BaseFileWrapper',
+    'SymmetricKeyExtension', 'PublicKeyExtension', 'PrivateKeyExtension',
+    'CryptoExtensions', 'shared_crypto_extensions',
 
     #
-    #   Algorithm
+    #   Algorithms
     #
+
     'AsymmetricAlgorithms', 'SymmetricAlgorithms',
-    'EncodeAlgorithms',
+
+
+    # ================================================================
+
 
     #
-    #   MingKeMing
+    #   Ming-Ke-Ming
     #
 
     'EntityType',
-    'Address',
-    'ID',
-    'Meta',
-    'Document', 'Visa', 'Bulletin',
-
-    'MetaType', 'DocumentType',
+    'Address', 'ID',
+    'Meta', 'TAI', 'Document',
 
-    'AddressFactory',
-    'IDFactory',
-    'MetaFactory',
-    'DocumentFactory',
+    'AddressFactory', 'IDFactory',
+    'MetaFactory', 'DocumentFactory',
 
-    'Identifier',
-    'ANYONE', 'EVERYONE', 'FOUNDER',
     'ANYWHERE', 'EVERYWHERE',
-    # 'BroadcastAddress',
+    'ANYONE', 'EVERYONE', 'FOUNDER',
+    'BroadcastAddress', 'Identifier',
 
-    'BaseMeta',
-    'BaseDocument', 'BaseVisa', 'BaseBulletin',
+    'AddressHelper', 'IDHelper',
+    'MetaHelper', 'DocumentHelper',
+
+    'AddressExtension', 'IDExtension',
+    'MetaExtension', 'DocumentExtension',
+    'AccountExtensions', 'shared_account_extensions',
 
     #
-    #   DaoKeDao
+    #   Dao-Ke-Dao
     #
 
-    'ContentType',
-    'Content',
-    'Envelope',
+    'Content', 'Envelope',
     'Message',
     'InstantMessage', 'SecureMessage', 'ReliableMessage',
 
-    # contents
+    'ContentFactory', 'EnvelopeFactory',
+    'InstantMessageFactory', 'SecureMessageFactory', 'ReliableMessageFactory',
+
+    'ContentHelper', 'EnvelopeHelper',
+    'InstantMessageHelper', 'SecureMessageHelper', 'ReliableMessageHelper',
+
+    'ContentExtension',
+    'InstantMessageExtension', 'SecureMessageExtension', 'ReliableMessageExtension',
+    'MessageExtensions', 'shared_message_extensions',
+
+    #
+    #   Core Protocols
+    #
+
+    'MetaType',
+    'DocumentType',
+    'Visa', 'Bulletin',
+
+    'ContentType',
+
+    'Command', 'CommandFactory',
+
+    # 'CommandHelper', 'GeneralCommandHelper',
+    # 'CommandExtension', 'CmdExtension',
+
+    #
+    #  Contents
+    #
+
     'TextContent', 'PageContent', 'NameCard',
-    'ForwardContent', 'CombineContent', 'ArrayContent',
-    'FileContent', 'ImageContent', 'AudioContent', 'VideoContent',
     'MoneyContent', 'TransferContent',
+    'FileContent', 'ImageContent', 'AudioContent', 'VideoContent',
+    'ForwardContent', 'CombineContent', 'ArrayContent',
     'QuoteContent',
-    'CustomizedContent',
+    # 'QuoteHelper', 'QuotePurifier', 'QuoteExtension',
+
+    #
+    #  Commands
+    #
 
-    # commands
-    'Command',
     'MetaCommand', 'DocumentCommand',
     'ReceiptCommand',
 
-    # group history
     'HistoryCommand', 'GroupCommand',
     'InviteCommand', 'ExpelCommand', 'JoinCommand', 'QuitCommand', 'ResetCommand',
-    'HireCommand', 'FireCommand', 'ResignCommand',
 
-    # extend contents
-    'BaseContent',
+
+    # ================================================================
+
+
+    #
+    #   Account Implementations
+    #
+
+    'BaseMeta',
+    'BaseDocument', 'BaseVisa', 'BaseBulletin',
+
+    #
+    #   Content Implementations
+    #
+
+    'BaseContent', 'BaseCommand',
+    # 'CommandHelper', 'GeneralCommandHelper',
+    # 'CommandExtension', 'CmdExtension',
+
     'BaseTextContent', 'WebPageContent', 'NameCardContent',
-    'SecretContent', 'CombineForwardContent', 'ListContent',
-    'BaseFileContent', 'ImageFileContent', 'AudioFileContent', 'VideoFileContent',
     'BaseMoneyContent', 'TransferMoneyContent',
+    'BaseFileContent', 'ImageFileContent', 'AudioFileContent', 'VideoFileContent',
+    'SecretContent', 'CombineForwardContent', 'ListContent',
     'BaseQuoteContent',
-    'AppCustomizedContent',
+    # 'QuoteHelper', 'QuotePurifier', 'QuoteExtension',
 
-    # extend commands
-    'BaseCommand',
     'BaseMetaCommand', 'BaseDocumentCommand',
     'BaseReceiptCommand',
-
-    # extend group history
     'BaseHistoryCommand', 'BaseGroupCommand',
-    'InviteGroupCommand', 'ExpelGroupCommand',
-    'JoinGroupCommand', 'QuitGroupCommand', 'ResetGroupCommand',
-    'HireGroupCommand', 'FireGroupCommand', 'ResignGroupCommand',
+    'InviteGroupCommand', 'ExpelGroupCommand', 'JoinGroupCommand', 'QuitGroupCommand', 'ResetGroupCommand',
 
     #
-    #   Message
+    #   Message Implementations
     #
 
     'MessageEnvelope',
     'BaseMessage',
     'PlainMessage', 'EncryptedMessage', 'NetworkMessage',
 
-    # factories
-    'ContentFactory', 'CommandFactory',
-    'EnvelopeFactory',
-    'InstantMessageFactory', 'SecureMessageFactory', 'ReliableMessageFactory',
+
+    # ================================================================
+
+
+    'GeneralCryptoHelper', 'GeneralCryptoExtension',
+    'GeneralAccountHelper', 'GeneralAccountExtension',
+
+    'GeneralMessageHelper', 'GeneralMessageExtension',
+
+    'TransportableFileHelper',
+    'TransportableFileExtension',
+    'TransportableFileWrapperExtension',
+
+    'CommandHelper', 'GeneralCommandHelper',
+    'CommandExtension', 'CmdExtension',
+
+    'QuoteHelper', 'QuotePurifier',
+    'QuoteExtension',
 
 ]