Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Fix warnings about not calling superclass constructor
Browse files Browse the repository at this point in the history
Separate `SimpleCommand` from `Command`, so that things which don't want to use
the `data` property don't have to, and thus fix the warnings PyCharm was giving
me about not calling `__init__` in the base class.
  • Loading branch information
richvdh committed Apr 7, 2020
1 parent 6a519a0 commit c3e4b4e
Showing 1 changed file with 24 additions and 15 deletions.
39 changes: 24 additions & 15 deletions synapse/replication/tcp/commands.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
The VALID_SERVER_COMMANDS and VALID_CLIENT_COMMANDS define which commands are
allowed to be sent by which side.
"""

import abc
import logging
import platform
from typing import Tuple, Type
Expand All @@ -34,34 +34,29 @@
logger = logging.getLogger(__name__)


class Command(object):
class Command(metaclass=abc.ABCMeta):
"""The base command class.
All subclasses must set the NAME variable which equates to the name of the
command on the wire.
A full command line on the wire is constructed from `NAME + " " + to_line()`
The default implementation creates a command of form `<NAME> <data>`
"""

NAME = None # type: str

def __init__(self, data):
self.data = data

@classmethod
@abc.abstractmethod
def from_line(cls, line):
"""Deserialises a line from the wire into this command. `line` does not
include the command.
"""
return cls(line)

def to_line(self):
@abc.abstractmethod
def to_line(self) -> str:
"""Serialises the comamnd for the wire. Does not include the command
prefix.
"""
return self.data

def get_logcontext_id(self):
"""Get a suitable string for the logcontext when processing this command"""
Expand All @@ -70,7 +65,21 @@ def get_logcontext_id(self):
return self.NAME


class ServerCommand(Command):
class _SimpleCommand(Command):
"""An implementation of Command whose argument is just a 'data' string."""

def __init__(self, data):
self.data = data

@classmethod
def from_line(cls, line):
return cls(line)

def to_line(self) -> str:
return self.data


class ServerCommand(_SimpleCommand):
"""Sent by the server on new connection and includes the server_name.
Format::
Expand Down Expand Up @@ -155,22 +164,22 @@ def to_line(self):
return " ".join((self.stream_name, str(self.token)))


class ErrorCommand(Command):
class ErrorCommand(_SimpleCommand):
"""Sent by either side if there was an ERROR. The data is a string describing
the error.
"""

NAME = "ERROR"


class PingCommand(Command):
class PingCommand(_SimpleCommand):
"""Sent by either side as a keep alive. The data is arbitary (often timestamp)
"""

NAME = "PING"


class NameCommand(Command):
class NameCommand(_SimpleCommand):
"""Sent by client to inform the server of the client's identity. The data
is the name
"""
Expand Down Expand Up @@ -387,7 +396,7 @@ def to_line(self):
)


class RemoteServerUpCommand(Command):
class RemoteServerUpCommand(_SimpleCommand):
"""Sent when a worker has detected that a remote server is no longer
"down" and retry timings should be reset.
Expand Down

0 comments on commit c3e4b4e

Please sign in to comment.