在Python中，如何使用点号表示法来组织层级化的字符串常量？

Question

我正在编写一个Python客户端，该客户端将访问HTTP端点。这些端点具有树状结构，其中几乎任何节点都可能是一个端点。我希望能够在该层次结构的任意位置调用并根据定义的常量构建字符串。

例如，我希望Endpoints.CONFIGURATION能够扩展为/configuration，同时Endpoints.CONFIGURATION.ACTIVE能够扩展为/configuration/active。

为了减少代码量，我希望以编程方式实现这一目标，并且不希望用户必须调用函数来完成这个任务，因此理想情况下，可以通过某种继承自某个类并重写__str__方法的方式来实现。

我尝试利用Python类系统实现类似功能。以上述示例为例，我编写的代码如下：

class EndpointClass:
    class CONFIGURATION:
        ACTIVE = '/configuration/active'

然而，这段代码并未实现所需的功能，即需要.CONFIGURATION扩展为/configuration，而且我还必须手动编写/configuration，而我更倾向于基于它所在的类自动展开。

我考虑过基于字典的解决方案，但据我所知，这种方法不支持点表示法（dot notation）和自动补全，并且可能无法返回层次结构中任意层级的值。

我也参考了What is the best way to define a (maybe hierarchical) set of constants in python?，但它并不适用于像我这样深的层级结构，也不支持自动展开，而且不能在层次结构的不同层级停止并返回相应结果。

Peter Bailey · Answer

我认为这可能正是您需要的。这是一个简单的父/子追踪类，它可以为子项启用点表示法（dot-completion）功能，并在转换为str时展开端点的祖先链。

from collections.abc import Iterable

class Endpoint:
    def __init__(self, name: str) -> None:
        self._name = name
        self._children = {}
        self._parent = None

    def __dir__(self) -> Iterable[str]:
        cls_attrs = object.__dir__(self)
        return [n for n in self._children] + cls_attrs
    
    def __repr__(self) -> str:
        return f''
    
    def __str__(self) -> str:
        if self._parent:
            up = f'{str(self._parent)}/'
        else:
            up = ''
        return f'{up}{self._name.lower()}'
    
    def append_endpoint(self, endpoint_name: str):
        if any(c.lower()==endpoint_name for c in self._children):
            raise KeyError(f'A sub-endpoint {endpoint_name!r} already exists.')
        new_endpoint = self.__class__(endpoint_name)
        new_endpoint._parent = self
        self._children[endpoint_name] = new_endpoint

    def __getattr__(self, _attr: str):
        if _attr in self._children:
            return self._children[_attr]
        return object.__getattribute__(self, _attr)
    
    def __iadd__(self, endpoint_name: str):
        if not isinstance(endpoint_name, str):
            return NotImplemented
        self.append_endpoint(endpoint_name)
        return self

# 使用该类的例子如下：

config = Endpoint('CONFIGURATION')
config += 'ACTIVE'  # ACTIVE 将出现在点完成提示中
config.ACTIVE += 'LAST'
config += 'INACTIVE'
config.INACTIVE += 'HISTORY'
config.INACTIVE.HISTORY += 'Y2020'
config.INACTIVE.HISTORY += 'Y2021'
config.INACTIVE.HISTORY += 'Y2022'
config.INACTIVE.HISTORY += 'Y2023'

print(str(config.ACTIVE.LAST))
# 输出：'configuration/active/last'

codaddict · Answer

这可能是一个略显非正统的解决方案，但它确实实现了您想要的功能。

class Notation(type):
    def __str__(cls):
        return '/' + cls.__qualname__.casefold().replace(".", "/")

# 使用自定义元类Notation创建层级路径
class CONFIGURATION(metaclass=Notation):
    class ACTIVE(metaclass=Notation):
        pass

# 输出结果
print(f"CONFIGURATION = {CONFIGURATION}")
print(f"CONFIGURATION.ACTIVE = {CONFIGURATION.ACTIVE}")

# 输出：
# CONFIGURATION = /configuration
# CONFIGURATION.ACTIVE = /configuration/active

另一种不太取巧的方法可能是使用下划线来表示层级关系，例如：

CONFIGURATION = '/configuration'
CONFIGURATION_ACTIVE = '/configuration/active'
...