跳转到主要内容

从字符串创建便于人类使用的ID。

项目描述

humidifier

从字符串创建便于人类使用的ID。

License Tests Linting Codecov PyPI Versions

humidifier 的典型用例是您有一些字符串(一个单词、一个名字、一个短语等),您希望将其转换为便于人类使用的ID。例如,您的项目URL包含ID,使用 /record/an-example 而不是 /record/21937218 会更好。这样的ID易于记忆,并且可以作为数据库条目的预览。这可以通过出色的 python-slugify 实现,humidifier 为其添加了生成唯一ID的选项

用法

使用 humidifier 非常简单

from humidifier import humidify

id_1 = humidify("dog", unique=True)  # 'dog'
id_2 = humidify("dog", unique=True)  # 'dog-1'
id_3 = humidify("dög", unique=True)  # 'dog-2'
id_4 = humidify("ʔɚ", unique=True)  # 'null'
id_5 = humidify("ʔɚ", unique=True)  # 'null-1'

如果您的字符串来自不同的群体,您希望保持生成的ID之间的区别,则有一个可选的 key 参数

from humidifier import humidify

id_1 = humidify("dog", key="animals", unique=True)  # 'dog'
id_2 = humidify("dog", key="quadripeds", unique=True)  # 'dog'
id_3 = humidify("dög", key="animals", unique=True)  # 'dog-1'
id_4 = humidify("dög", key="animals", unique=True)  # 'dog-2'

如果您正在处理现有的ID集

from humidifier import Humidifier
hum = Humidifier(["dog"])
hum.humidify("dog", unique=True)  # 'dog-1'

如果您只想为每个不同的字符串生成一个新的ID

from humidifier import humidify

humidify("dög")  # 'dog'
humidify("dög")  # 'dog'
humidify("dog")  # 'dog-1'

您也可以使用 python-slugify 中描述的任何参数。在生成ID时,max_length 参数用于截断,separator 参数用于在部分之间使用除 - 之外的内容,以及 replacements 参数可能特别有趣。

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。

源代码分发

humidifier-0.0.2.tar.gz (7.9 kB 查看哈希值)

上传时间 源代码

构建分发

humidifier-0.0.2-py3-none-any.whl (7.4 kB 查看哈希值)

上传时间 Python 3

由以下支持