python - 如何最好地根据配置指定要使用的接口(interface)子类

Question

我想创建一个“接口(interface)”类(在interface.py中)，通过它我可以访问底层类的功能，其中访问的类依赖于xml config_file设置。以通过ssh、ftp连接为例。

我在我的配置文件中设置了一个变量，例如“接口(interface)”:“ssh”

然后我希望代码看起来像这样:

# file = interface.py
class Interface(?)
    def connect(self, *args, **kwargs):
        return self

# file = ssh.py
class SSH(?)
    def connect(self, *args, **kwargs):
        # Setup a connection
        connection = paramiko.SSHClient()
        return connection

#file = ftp.py
class FTP(?)
    def connect(self, *args, **kwargs):
        # Setup a connection
        return connection

# And in my calling code I would just like a generic call e.g.
from path.interface import Interface

foo = Interface()
foo.connect(bar)    # Where "INTERFACE" : "ssh"

然后，SSH 类将(覆盖？)执行其 connect() 版本中定义的代码。如果我随后将配置设置更改为 config.INTERFACE = "ftp"，则相同的调用将“找到它的方式”到 ftp 类以建立 ftp 连接。

理想情况下，我可以通过我的代码在不同版本的 connect() 之间切换，只需设置:

config.INTERFACE = "ssh"
config.INTERFACE = "ftp"

我想这不是什么遥不可及的事情吧？我什至不知道该用谷歌搜索什么来找出如何做到这一点!这是压倒一切的吗？如有任何建议，我们将不胜感激。只是谷歌的一个主题将是一个起点。 :)

Answer 1

执行此操作的标准模式如下所示:

from abc import abstractmethod, ABCMeta

class Interface(metaclass=ABCMeta):
    @abstractmethod
    def upload(self):
        raise NotImplementedError('Must implement upload in subclasses')

class SSH(Interface):

    def upload(self):
        # ssh implementation

class FTP(Interface):

    def upload(self):
        # ftp implementation

def InterfaceForConfigurationValue(interface_value):
    if interface_value == 'ssh':
        return SSH()

    if interface_value == 'ftp':
        return FTP()

    raise NotImplementedError('Interface not available for value %s' % (
        interface_value,))

• Interface 是定义您要使用的接口(interface)的抽象基类。它本身没有用，需要具体的子类来实现它。

  请注意，要使其成为有用的抽象并值得付出努力，您希望使其更适合您的应用程序并提供更高级别的 API，例如 upload() 或 get ()，否则有点毫无意义，而且您可能会发现很难推广到不同的协议(protocol)。

• SSH 和 FTP 都重写其父类(super class)(Interface)的 upload() 方法，因此您可以在您的 Interface 实例上调用 upload()，而不必担心它是哪个特定子类。
• InterfaceForConfigurationValue 是一个工厂函数，可根据配置选项为您提供正确的接口(interface)子类。

一般来说，最重要的是确保 Interface、SSH 或 FTP 不知道或关心配置文件中的内容，因为您可能希望在其他地方使用不同的配置系统。他们只知道自己需要做什么。您添加一个工厂函数，该函数很小并且包含如何将配置转换为子类的知识。

注意:您的工厂函数不必是全局函数。通常您会发现您的配置系统和代码之间需要执行许多类似的链接，因此您可能需要使用一个类并将工厂作为该类的方法。 ConfigParser 的子类通常是一个不错的选择。