首页
/ shortuuid 技术文档

shortuuid 技术文档

2024-12-25 09:31:53作者:姚月梅Lane

1. 安装指南

环境要求

  • Python 3.6 及以上版本

安装方式

shortuuid 可以通过以下几种方式进行安装:

  1. 使用 pip 安装(推荐):

    pip install shortuuid
    
  2. 使用 setuptools 安装

    easy_install shortuuid
    
  3. 源码安装: 从 GitHub 仓库 下载源码,然后运行以下命令:

    python setup.py install
    

2. 项目使用说明

基本使用

在项目中使用 shortuuid,只需导入模块:

import shortuuid

生成一个短 UUID:

shortuuid.uuid()
# 输出示例: 'vytxeTZskVKR7C7WgdSP3d'

生成特定版本的 UUID

如果需要生成版本 5 的 UUID,可以传入一个名称(DNS 或 URL):

shortuuid.uuid(name="example.com")
# 输出示例: 'exu3DTbj2ncsn9tLdLWspw'

生成加密安全的随机字符串

使用 os.urandom() 生成加密安全的随机字符串:

shortuuid.ShortUUID().random(length=22)
# 输出示例: 'RaF56o2r58hTKT7AYS9doj'

自定义字母表

查看当前使用的字母表:

shortuuid.get_alphabet()
# 输出示例: '23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz'

设置自定义字母表:

shortuuid.set_alphabet("aaaaabcdefgh1230123")
shortuuid.uuid()
# 输出示例: '0agee20aa1hehebcagddhedddc0d2chhab3b'

序列化现有 UUID

使用 encode()decode() 方法序列化和反序列化 UUID:

import uuid
u = uuid.uuid4()
s = shortuuid.encode(u)
shortuuid.decode(s) == u
# 输出示例: True

3. 项目 API 使用文档

shortuuid.uuid()

生成一个短 UUID。

shortuuid.uuid(name=None)

生成一个版本 5 的 UUID,使用指定的名称作为命名空间。

shortuuid.ShortUUID().random(length=22)

生成一个加密安全的随机字符串。

shortuuid.get_alphabet()

获取当前使用的字母表。

shortuuid.set_alphabet(alphabet, dont_sort_alphabet=False)

设置自定义字母表,并可以选择是否对字母表进行排序。

shortuuid.encode(uuid)

将标准的 UUID 编码为短 UUID。

shortuuid.decode(shortuuid_str, legacy=False)

将短 UUID 解码为标准的 UUID。如果使用旧版本的 shortuuid,可以设置 legacy=True

4. 项目安装方式

使用 pip 安装

pip install shortuuid

使用 setuptools 安装

easy_install shortuuid

源码安装

从 GitHub 仓库下载源码并安装:

python setup.py install

通过以上步骤,您可以轻松安装并使用 shortuuid 库,生成简洁、URL 安全的 UUID。

登录后查看全文
热门项目推荐
相关项目推荐