dimp 2.4.2__tar.gz → 2.4.3__tar.gz

{dimp-2.4.2 → dimp-2.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dimp
-Version: 2.4.2
+Version: 2.4.3
 Summary: Decentralized Instant Messaging Protocol
 Home-page: https://github.com/dimchat/core-py
 Author: Albert Moky
@@ -47,7 +47,8 @@ License-File: LICENSE
 ```python
 from abc import ABC, abstractmethod
 from enum import IntEnum
-from typing import Optional, Dict
+from collections.abc import Mapping
+from typing import Optional
 
 from dimp import *
 
@@ -150,7 +151,7 @@ class HandshakeCommand(Command, ABC):
 
 class BaseHandshakeCommand(BaseCommand, HandshakeCommand):
 
-    def __init__(self, content: Dict = None, title: str = None, session: str = None):
+    def __init__(self, content: Mapping = 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
@@ -250,14 +251,14 @@ class CustomizedContent(Content, ABC):
 ```
 
 ```python
-from typing import Dict
+from collections.abc import Mapping
 
 from dimp import *
 
 
 class AppCustomizedContent(BaseContent, AppContent, CustomizedContent):
 
-    def __init__(self, content: Dict = None,
+    def __init__(self, content: Mapping = None,
                  msg_type: str = None,
                  app: str = None, mod: str = None, act: str = None):
         if content is None:

{dimp-2.4.2 → dimp-2.4.3}/README.md

@@ -33,7 +33,8 @@
 ```python
 from abc import ABC, abstractmethod
 from enum import IntEnum
-from typing import Optional, Dict
+from collections.abc import Mapping
+from typing import Optional
 
 from dimp import *
 
@@ -136,7 +137,7 @@ class HandshakeCommand(Command, ABC):
 
 class BaseHandshakeCommand(BaseCommand, HandshakeCommand):
 
-    def __init__(self, content: Dict = None, title: str = None, session: str = None):
+    def __init__(self, content: Mapping = 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
@@ -236,14 +237,14 @@ class CustomizedContent(Content, ABC):
 ```
 
 ```python
-from typing import Dict
+from collections.abc import Mapping
 
 from dimp import *
 
 
 class AppCustomizedContent(BaseContent, AppContent, CustomizedContent):
 
-    def __init__(self, content: Dict = None,
+    def __init__(self, content: Mapping = None,
                  msg_type: str = None,
                  app: str = None, mod: str = None, act: str = None):
         if content is None:

{dimp-2.4.2 → dimp-2.4.3}/dimp/__init__.py

@@ -44,6 +44,12 @@ __all__ = [
 
     'Singleton',
 
+    'final',
+
+    'Mapping', 'MutableMapping',
+    'StrMap', 'MutableStrMap',
+    'AnyList', 'StrList',
+
     'URI', 'DateTime',
 
     'Converter', 'DataConverter', 'BaseConverter',

{dimp-2.4.2 → dimp-2.4.3}/dimp/crypto/algorithms.py

@@ -23,7 +23,10 @@
 # SOFTWARE.
 # ==============================================================================
 
+from mkm.types import final
 
+
+@final
 class AsymmetricAlgorithms:
     """ Algorithms for Asymmetric Key """
 
@@ -31,6 +34,7 @@ class AsymmetricAlgorithms:
     ECC = 'ECC'
 
 
+@final
 class SymmetricAlgorithms:
     """ Algorithms for Symmetric Key """
 

{dimp-2.4.2 → dimp-2.4.3}/dimp/dkd/base.py

@@ -40,7 +40,7 @@
         |  time       |     |  time      |     |  time        |
         |             |     |            |     |              |
         |  content    |     |  data      |     |  data        |
-        +-------------+     |  key/keys  |     |  key/keys    |
+        +-------------+     |  keys      |     |  keys        |
                             +------------+     |  signature   |
                                                +--------------+
         Algorithm:
@@ -49,22 +49,23 @@
             signature = sender.private_key.sign(data)
 """
 
-
-from typing import Optional, Dict
+from typing import Optional
 
 from mkm.types import DateTime
+from mkm.types import StrMap
 from mkm.types import Dictionary
+
 from mkm.protocol import ID
 from dkd.protocol import Envelope, Message
 
 
 class BaseMessage(Dictionary, Message):
 
-    def __init__(self, msg: Dict = None, head: Envelope = None):
+    def __init__(self, msg: StrMap = None, head: Envelope = None):
         if msg is None:
             # 1. new message with envelope
             assert head is not None, 'message envelope should not be empty'
-            msg = head.to_dict()
+            msg = head.to_map()
         else:
             # 2. message info from network
             assert head is None, f'params error: {msg}, {head}'
@@ -77,7 +78,7 @@ class BaseMessage(Dictionary, Message):
         env = self.__envelope
         if env is None:
             # let envelope share the same dictionary with message
-            env = Envelope.parse(envelope=super().to_dict())
+            env = Envelope.parse(envelope=super().to_map())
             self.__envelope = env
         return env
 

{dimp-2.4.2 → dimp-2.4.3}/dimp/dkd/envelope.py

@@ -28,10 +28,12 @@
 # SOFTWARE.
 # ==============================================================================
 
-from typing import Optional, Dict
+from typing import Optional
 
 from mkm.types import DateTime
+from mkm.types import StrMap
 from mkm.types import Dictionary
+
 from mkm.protocol import ID, ANYONE
 from dkd.protocol import Envelope
 
@@ -52,7 +54,7 @@ from dkd.protocol import Envelope
 
 class MessageEnvelope(Dictionary, Envelope):
 
-    def __init__(self, envelope: Dict = None,
+    def __init__(self, envelope: StrMap = None,
                  sender: ID = None, receiver: Optional[ID] = None, time: Optional[DateTime] = None):
         if envelope is None:
             # 1. new envelope with sender, receiver & time
@@ -83,7 +85,7 @@ class MessageEnvelope(Dictionary, Envelope):
         if did is None:
             did = self.get('sender')
             did = ID.parse(identifier=did)
-            assert did is not None, 'message sender error: %s' % super().to_dict()
+            assert did is not None, 'message sender error: %s' % super().to_map()
             self.__sender = did
         return did
 

{dimp-2.4.2 → dimp-2.4.3}/dimp/dkd/instant.py

@@ -28,9 +28,11 @@
 # SOFTWARE.
 # ==============================================================================
 
-from typing import Optional, Dict
+from typing import Optional
 
 from mkm.types import DateTime
+from mkm.types import StrMap, MutableStrMap
+
 from mkm.protocol import ID
 from dkd.protocol import Content
 from dkd.protocol import Envelope
@@ -57,13 +59,13 @@ from .base import BaseMessage
 
 class PlainMessage(BaseMessage, InstantMessage):
 
-    def __init__(self, msg: Dict = None,
+    def __init__(self, msg: StrMap = None,
                  head: Envelope = None, body: Content = None):
         if msg is None:
             # 1. new instant message with envelope & content
             assert head is not None and body is not None, f'instant message error: {head}, {body}'
             super().__init__(None, head)
-            # self['content'] = body.to_dict()
+            # self['content'] = body.to_map()
         else:
             # 2. message info from network
             assert head is None and body is None, f'params error: {msg}, {head}, {body}'
@@ -93,7 +95,7 @@ class PlainMessage(BaseMessage, InstantMessage):
         if body is None:
             info = self.get('content')
             body = Content.parse(content=info)
-            assert body is not None, f'message content error: {self.to_dict()}'
+            assert body is not None, f'message content error: {self.to_map()}'
             self.__content = body
         return body
 
@@ -104,10 +106,10 @@ class PlainMessage(BaseMessage, InstantMessage):
         self.__content = value
 
     # Override
-    def to_dict(self) -> Dict:
+    def to_map(self) -> MutableStrMap:
         # serialize 'content'
         body = self.__content
         if body is not None and self.get('content') is None:
-            self['content'] = body.to_dict()
+            self['content'] = body.to_map()
         # OK
-        return super().to_dict()
+        return super().to_map()

{dimp-2.4.2 → dimp-2.4.3}/dimp/dkd/reliable.py

@@ -28,9 +28,11 @@
 # SOFTWARE.
 # ==============================================================================
 
-from typing import Optional, Dict
+from typing import Optional
 
+from mkm.types import StrMap
 from mkm.format import TransportableData
+
 from dkd.protocol import ReliableMessage
 
 from .secure import EncryptedMessage
@@ -48,7 +50,7 @@ from .secure import EncryptedMessage
         "receiver" : "hulk@yyy",
         "time"     : 123.45,
         
-        //-- content data and key/keys
+        //-- content data and keys
         "data"     : "...",    // base64_encode( symmetric_encrypt(content))
         "keys"     : {
             "ID1"    : "key1", // base64_encode(asymmetric_encrypt(password))
@@ -62,7 +64,7 @@ from .secure import EncryptedMessage
 
 class NetworkMessage(EncryptedMessage, ReliableMessage):
 
-    def __init__(self, msg: Dict):
+    def __init__(self, msg: StrMap):
         super().__init__(msg=msg)
         # lazy
         self.__signature: Optional[TransportableData] = None

{dimp-2.4.2 → dimp-2.4.3}/dimp/dkd/secure.py

@@ -28,9 +28,11 @@
 # SOFTWARE.
 # ==============================================================================
 
-from typing import Optional, Dict
+from typing import Optional
 
+from mkm.types import Mapping, StrMap
 from mkm.format import TransportableData
+
 from dkd.protocol import SecureMessage
 
 from ..format import PlainData
@@ -49,7 +51,7 @@ from .base import BaseMessage
         "receiver" : "hulk@yyy",
         "time"     : 123.45,
         
-        //-- content data and key/keys
+        //-- content data and keys
         "data"     : "...",    // base64_encode( symmetric_encrypt(content))
         "keys"     : {
             "ID1"    : "key1", // base64_encode(asymmetric_encrypt(password))
@@ -61,11 +63,11 @@ from .base import BaseMessage
 
 class EncryptedMessage(BaseMessage, SecureMessage):
 
-    def __init__(self, msg: Dict):
+    def __init__(self, msg: StrMap):
         super().__init__(msg=msg)
         # lazy
         self.__data: Optional[TransportableData] = None
-        self.__keys: Optional[Dict] = None
+        self.__keys: Optional[StrMap] = None
 
     @property  # Override
     def data(self) -> TransportableData:
@@ -73,7 +75,7 @@ class EncryptedMessage(BaseMessage, SecureMessage):
         if ted is None:
             text = self.get('data')
             if text is None:
-                assert False, 'message data not found: %s' % super().to_dict()
+                assert False, 'message data not found: %s' % super().to_map()
             elif not BaseMessage.is_broadcast(msg=self):
                 # message content had been encrypted by a symmetric key,
                 # so the data should be encoded here (with algorithm 'base64' as default).
@@ -89,11 +91,11 @@ class EncryptedMessage(BaseMessage, SecureMessage):
         return ted
 
     @property  # Override
-    def encrypted_keys(self) -> Optional[Dict]:
+    def encrypted_keys(self) -> Optional[StrMap]:
         keys = self.__keys
         if keys is None:
             keys = self.get('keys')
-            if isinstance(keys, Dict):
+            if isinstance(keys, Mapping):
                 self.__keys = keys
             else:
                 assert keys is None, f'message keys error: {keys}'

{dimp-2.4.2 → dimp-2.4.3}/dimp/format/__init__.py

@@ -46,6 +46,12 @@ __all__ = [
 
     'Singleton',
 
+    'final',
+
+    'Mapping', 'MutableMapping',
+    'StrMap', 'MutableStrMap',
+    'AnyList', 'StrList',
+
     'URI', 'DateTime',
 
     'Converter', 'DataConverter', 'BaseConverter',

{dimp-2.4.2 → dimp-2.4.3}/dimp/format/data.py

@@ -25,6 +25,7 @@
 
 from typing import Optional
 
+from mkm.types import final
 from mkm.format import base64_encode, base64_decode
 from mkm.format import utf8_encode, utf8_decode
 
@@ -70,6 +71,7 @@ class Base64Data(BaseData):
         return Base64Data(string=string, binary=binary)
 
 
+@final
 class PlainData(BaseData):
     """ UTF-8 encoding """
 

{dimp-2.4.2 → dimp-2.4.3}/dimp/format/duri.py

@@ -23,7 +23,8 @@
 # SOFTWARE.
 # ==============================================================================
 
-from typing import Optional, Dict
+from typing import Optional
+from typing import Mapping, MutableMapping
 
 from mkm.format import base64_decode, utf8_encode
 
@@ -39,7 +40,7 @@ from mkm.format import base64_decode, utf8_encode
 
 class Header:
 
-    def __init__(self, mime_type: str, encoding: str = None, extra: Dict[str, str] = None):
+    def __init__(self, mime_type: str, encoding: str = None, extra: Mapping[str, str] = None):
         super().__init__()
         self.__mime_type = mime_type
         self.__encoding = encoding
@@ -58,7 +59,7 @@ class Header:
         return self.__encoding
 
     @property
-    def extra(self) -> Optional[Dict[str, str]]:
+    def extra(self) -> Optional[Mapping[str, str]]:
         """ extra parameters """
         return self.__extra
 
@@ -78,7 +79,7 @@ class Header:
         else:
             name = name.lower()
         # get value by name in lowercase
-        return extra[name]
+        return extra.get(name)
 
     # Override
     def __str__(self) -> str:
@@ -145,7 +146,7 @@ class Header:
         mime_type: str = None
         encoding: str = None
         # split extra info
-        extra: Dict[str, str] = None
+        extra: MutableMapping[str, str] = None
         for item in array:
             if len(item) == 0:
                 # assert False, f'header error: {uri}'
@@ -202,7 +203,7 @@ class DataURI:
         return self.__body
 
     @property
-    def parameters(self) -> Optional[Dict[str, str]]:
+    def parameters(self) -> Optional[Mapping[str, str]]:
         """ extra parameters """
         return self.head.extra
 

{dimp-2.4.2 → dimp-2.4.3}/dimp/format/embed.py

@@ -23,7 +23,8 @@
 # SOFTWARE.
 # ==============================================================================
 
-from typing import Optional, Dict
+from typing import Optional
+from typing import Mapping
 
 from mkm.format import base64_encode
 
@@ -46,7 +47,7 @@ class EmbedData(BaseData):
         # lazy load
         self.__data_uri: Optional[DataURI] = None
         self.__mime_type: Optional[str] = None     # default is "text/plain"
-        self.__parameters: Optional[Dict[str, str]] = None
+        self.__parameters: Optional[Mapping[str, str]] = None
 
     @property
     def encoding(self) -> Optional[str]:
@@ -84,7 +85,7 @@ class EmbedData(BaseData):
     def header_value(self, name: str) -> Optional[str]:
         extra = self.parameters
         if extra is not None:
-            value = extra[name]
+            value = extra.get(name)
             if value is not None:
                 # charset
                 # filename
@@ -98,7 +99,7 @@ class EmbedData(BaseData):
         #     return self.encoding
 
     @property
-    def parameters(self) -> Optional[Dict[str, str]]:
+    def parameters(self) -> Optional[Mapping[str, str]]:
         extra = self.__parameters
         if extra is not None:
             return extra
@@ -171,7 +172,7 @@ class EmbedData(BaseData):
 
     @classmethod
     def new(cls, string: Optional[str], binary: Optional[bytes],
-            uri: DataURI = None, mime_type: str = None, parameters: Dict[str, str] = None):
+            uri: DataURI = None, mime_type: str = None, parameters: Mapping[str, str] = None):
         if parameters is None and uri is not None:
             parameters = uri.parameters
         embed = EmbedData(string=string, binary=binary)

{dimp-2.4.2 → dimp-2.4.3}/dimp/format/file.py

@@ -24,10 +24,12 @@
 # ==============================================================================
 
 from abc import ABC, abstractmethod
-from typing import Optional, Union, Any, Dict
+from typing import Optional, Union, Any
 
+from mkm.types import StrMap, MutableStrMap
 from mkm.types import Mapper
 from mkm.types import URI
+
 from mkm.crypto import DecryptKey
 from mkm.format import TransportableResource
 from mkm.format import TransportableData
@@ -145,15 +147,15 @@ class TransportableFile(Mapper, TransportableResource, ABC):
 
     # Override
     @abstractmethod
-    def to_dict(self) -> Dict:
+    def to_map(self) -> MutableStrMap:
         """ Serialize to map """
         raise NotImplementedError(
-            f'Not implemented: {type(self).__module__}.{type(self).__name__}.to_dict()'
+            f'Not implemented: {type(self).__module__}.{type(self).__name__}.to_map()'
         )
 
     # Override
     @abstractmethod
-    def serialize(self) -> Union[str, dict]:
+    def serialize(self) -> Union[str, StrMap]:
         """
         Serializes this PNF to a URL string or a map.
 
@@ -217,7 +219,7 @@ class TransportableFileFactory(ABC):
         )
 
     @abstractmethod
-    def parse_transportable_file(self, pnf: Dict) -> Optional[TransportableFile]:
+    def parse_transportable_file(self, pnf: StrMap) -> Optional[TransportableFile]:
         """
         Parse map object to PNF
 

{dimp-2.4.2 → dimp-2.4.3}/dimp/format/file_wrapper.py

@@ -24,9 +24,11 @@
 # ==============================================================================
 
 from abc import ABC, abstractmethod
-from typing import Optional, Dict
+from typing import Optional
 
 from mkm.types import URI
+from mkm.types import StrMap, MutableStrMap
+
 from mkm.crypto import DecryptKey
 from mkm.format import TransportableData
 from mkm.ext import shared_format_extensions
@@ -35,10 +37,10 @@ from mkm.ext import shared_format_extensions
 class TransportableFileWrapper(ABC):
 
     @abstractmethod
-    def to_dict(self) -> Dict:
+    def to_map(self) -> MutableStrMap:
         """ Serialize to map """
         raise NotImplementedError(
-            f'Not implemented: {type(self).__module__}.{type(self).__name__}.to_dict()'
+            f'Not implemented: {type(self).__module__}.{type(self).__name__}.to_map()'
         )
 
     #
@@ -126,7 +128,7 @@ class TransportableFileWrapper(ABC):
     #
 
     @classmethod
-    def create(cls, content: Dict,
+    def create(cls, content: StrMap,
                data: Optional[TransportableData] = None, filename: Optional[str] = None,
                url: Optional[URI] = None, password: Optional[DecryptKey] = None):
         factory = wrapper_factory()
@@ -139,7 +141,7 @@ class TransportableFileWrapperFactory(ABC):
     """ Wrapper factory """
 
     @abstractmethod
-    def create_transportable_file_wrapper(self, content: Dict,
+    def create_transportable_file_wrapper(self, content: StrMap,
                                           data: Optional[TransportableData],
                                           filename: Optional[str],
                                           url: Optional[URI],

{dimp-2.4.2 → dimp-2.4.3}/dimp/format/pnf.py

@@ -23,10 +23,12 @@
 # SOFTWARE.
 # ==============================================================================
 
-from typing import Optional, Union, Dict
+from typing import Optional, Union
 
 from mkm.types import URI
+from mkm.types import StrMap, MutableStrMap
 from mkm.types import Dictionary
+
 from mkm.crypto import DecryptKey
 from mkm.format import TransportableData
 from mkm.format import json_encode
@@ -37,13 +39,13 @@ from .file_wrapper import TransportableFileWrapper
 
 class PortableNetworkFile(Dictionary, TransportableFile):
 
-    def __init__(self, dictionary: Optional[Dict],
+    def __init__(self, dictionary: Optional[StrMap],
                  data: Optional[TransportableData] = None, filename: Optional[str] = None,
                  url: Optional[URI] = None, password: Optional[DecryptKey] = None,
                  wrapper: Optional[TransportableFileWrapper] = None):
         super().__init__(dictionary=dictionary)
         if wrapper is None:
-            wrapper = TransportableFileWrapper.create(super().to_dict(),
+            wrapper = TransportableFileWrapper.create(super().to_map(),
                                                       data=data, filename=filename,
                                                       url=url, password=password)
         self.__wrapper = wrapper
@@ -53,7 +55,7 @@ class PortableNetworkFile(Dictionary, TransportableFile):
     def uri_string(self) -> Optional[str]:
         # serialize
         wrapper = self.__wrapper
-        info = wrapper.to_dict()
+        info = wrapper.to_map()
         # check 'URL'
         remote = self.url
         if remote is not None and len(remote) > 0:
@@ -98,24 +100,25 @@ class PortableNetworkFile(Dictionary, TransportableFile):
             return uri_string
         # return JSON string
         wrapper = self.__wrapper
-        info = wrapper.to_dict()
+        info = wrapper.to_map()
         return json_encode(info)
 
     # Override
-    def to_dict(self) -> Dict:
+    def to_map(self) -> MutableStrMap:
         """ call wrapper to serialize 'data' & 'key" """
         wrapper = self.__wrapper
-        return wrapper.to_dict()
+        return wrapper.to_map()
         # return self.__dictionary
 
     # Override
-    def serialize(self) -> Union[str, dict]:
+    def serialize(self) -> Union[str, StrMap]:
         uri_string = self.uri_string
         if uri_string is not None:
             return uri_string
         # return inner map
         wrapper = self.__wrapper
-        return wrapper.to_dict()
+        info = wrapper.to_map()
+        return dict(info)
 
     #
     #   File data