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

Question

我正在编写一个Python客户端，该客户端会调用具有树状结构的HTTP端点。在这个结构中，几乎任何层级都可能是一个端点。我希望能够在该层次结构中的任意节点处进行访问，并根据定义的常量动态构建字符串路径。

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

为了减少代码量，我希望建立一种程序化的方式实现这一目标。此外，我还希望避免让终端用户调用函数来获取这些路径，因此考虑一个所有路径均继承自某个基类，并重写 __str__ 方法的理想方案可能是合适的。

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

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

然而，这种方式并未实现我所期望的功能，即.CONFIGURATION自动扩展成/configuration。另外，“ACTIVE”路径值是手动编写的，而我更希望它能基于所在类自动构建。

我也曾考虑过使用字典解决方案，但据我所知，字典方式无法支持点标记法（dot notation）及自动补全，并且可能无法返回层次结构任意级别的值。

我还参考了Stack Overflow上的一个问题：“在Python中定义（可能带层级关系的）一组常量的最佳方法是什么？”，但其中的方法并不适用于我可能遇到的深度层级，并且不支持自动扩展以及在不同层级停止时仍能得到有效返回值。

Craig Stuntz · Answer

我认为这可能正是你想要的。以下是一个简单的父/子跟踪类，它可以为子项启用点标记法完成，并在转换为 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.keys()] + cls_attrs
    
    def __repr__(self) -> str:
        return f''
    
    def __str__(self) -> str:
        if self._parent is not None:
            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.keys()):
            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 super().__getattribute__(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'

Bhojendra Rauniyar · Answer

这个解决方案或许略显巧妙（hackish），但它确实实现了你的要求。

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

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

一个更为正规（less hackish）的方法可能是使用下划线来表示层级关系，例如：

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