目录：轻量级函数注册库的革命性解决方案

catalogue是一个小巧且零依赖的库，它使得为你的代码添加功能（或对象）注册表变得异常简单。在需要可序列化并且高度自定义的对象时，功能注册表尤其有用。不必直接将函数传递给对象，而是传递一个标识符名称，对象可以从注册表中查找该函数。这样，对象就易于序列化，因为名称只是一个简单的字符串。如果保存的是函数，那么你需要使用Pickle进行序列化，而它有许多缺点。

快速安装与更新

pip install catalogue

或者

conda install -c conda-forge catalogue

请注意，catalogue v2.0及以上版本仅兼容Python 3.6及以上版本。若需Python 2.7+的兼容性，请使用catalogue v1.x。

简单易用

通过catalogue.create，你可以为你的包创建一个新的注册表，例如命名空间your_package下的loaders。

# 在你的包中
import catalogue

loaders = catalogue.create("your_package", "loaders")

这提供了一个loaders.register装饰器，用户可以导入并用于装饰其自定义加载器函数。

# 用户代码
from your_package import loaders

@loaders.register("custom_loader")
def custom_loader(data):
    # 加载数据...
    return data

装饰过的函数会自动注册，在你的包中，你可以通过调用loaders.get_all获取所有加载器。

# 在你的包中
def load_data(data, loader_id):
    print("所有加载器:", loaders.get_all()) # {"custom_loader": <custom_loader>}
    loader = loaders.get(loader_id)
    return loader(data)

现在，用户只需使用字符串标识符"custom_loader"引用他们的自定义加载器，你的应用就会知道如何处理，并使用他们提供的函数。

# 用户代码
from your_package import load_data

load_data(data, loader_id="custom_loader")

常见问题解答

问：为什么不能直接传入custom_loader函数？

答：当然可以，这是经典的回调方式。若不需要用字符串参数来参数化函数，以便方便地记录和序列化哪些函数被传递进来，那么你确实不需要这样的库。catalogue在保持可扩展性的同时，使你的函数可以通过字符串进行参数化，从而使日志记录和序列化变得更加轻松。

问：我怎么确保所有的注册装饰器都已运行？

答：装饰器通常在导入模块时运行。然而，这种副作用有时会导致困惑，尤其是当没有其他原因需要导入该模块时。一种解决方案是利用入口点。以spaCy为例，我们开始使用函数注册表来使管道组件更具有可定制性。假设用户Jo开发了更好的标记模型，用户应该能直接写spacy.load("jo_tagging_model")，而不必记住先写import jos_tagged_model来运行装饰器作为副作用。通过入口点，注册可以在安装时完成，避免依赖导入的副作用。

应用场景

catalogue适用于任何需要：

• 可序列化的配置：比如在机器学习环境中，用户可能希望保存他们使用的特定组件或模型。
• 插件式系统：允许用户扩展核心功能而无需修改源代码。
• 日志和跟踪：跟踪哪个函数是在何时何地注册的，以供以后分析或审计。

特点一览

• 轻量级: 零外部依赖，小巧高效。
• 简单API: 装饰器模式使注册和检索函数易如反掌。
• 灵活性: 允许通过Python入口点自动注册功能，支持第三方扩展。
• 串行化友好: 通过字符串ID，简化了序列化过程并保持了可扩展性。

借助catalogue，你可以构建出更加灵活、可扩展且易于维护的应用程序。现在就加入，体验它的强大之处吧！