StarMirror/py-libp2p
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fix validator return type and add docstring

Browse Source
This commit is contained in:
NIC619 2019-08-04 12:33:22 +08:00
parent f8ca4fa1ef
commit ec2c566e5a
No known key found for this signature in database
GPG Key ID: 570C35F5C2D51B17
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
libp2p/pubsub/pubsub.py
View File

@ -24,7 +24,7 @@ def get_msg_id(msg: rpc_pb2.Message) -> Tuple[bytes, bytes]:
TopicValidator = namedtuple("TopicValidator", ["validator", "is_async"]) TopicValidator = namedtuple("TopicValidator", ["validator", "is_async"])
ValidatorFn = Union[Callable[[ID, rpc_pb2.Message], bool], Awaitable[None]] ValidatorFn = Union[Callable[[ID, rpc_pb2.Message], bool], Awaitable[bool]]
class Pubsub: class Pubsub:
@ -164,13 +164,22 @@ class Pubsub:
def set_topic_validator( def set_topic_validator(
self, topic: str, validator: ValidatorFn, is_async_validator: bool self, topic: str, validator: ValidatorFn, is_async_validator: bool
) -> None: ) -> None:
"""
Register a validator under the given topic. One topic can only have one validtor.
"""
self.topic_validators[topic] = TopicValidator(validator, is_async_validator) self.topic_validators[topic] = TopicValidator(validator, is_async_validator)
def remove_topic_validator(self, topic: str) -> None: def remove_topic_validator(self, topic: str) -> None:
"""
Remove the validator from the given topic.
"""
if topic in self.topic_validators: if topic in self.topic_validators:
del self.topic_validators[topic] del self.topic_validators[topic]
def get_msg_validators(self, msg: rpc_pb2.Message) -> Tuple[TopicValidator, ...]: def get_msg_validators(self, msg: rpc_pb2.Message) -> Tuple[TopicValidator, ...]:
"""
Get all validators corresponding to the topics in the message.
"""
return ( return (
self.topic_validators[topic] self.topic_validators[topic]
for topic in msg.topicIDs for topic in msg.topicIDs