ShortUUID 使用教程

ShortUUID 使用教程

shortuuidA generator library for concise, unambiguous and URL-safe UUIDs.项目地址:https://gitcode.com/gh_mirrors/sh/shortuuid

项目介绍

ShortUUID 是一个用于生成简洁、明确且URL安全的UUID的Python库。它基于Python内置的UUID模块，通过Base57编码生成短UUID，避免了使用易混淆的字符（如l, 1, I, O, 0）。ShortUUID 适用于需要生成短标识符的场景，如API密钥、短链接等。

项目快速启动

安装

首先，确保你已经安装了Python 3.6或更高版本。然后，使用pip安装ShortUUID：

pip install shortuuid

基本使用

导入ShortUUID库并生成一个短UUID：

import shortuuid

# 生成一个短UUID
short_uuid = shortuuid.uuid()
print(short_uuid)

自定义字符集

你可以设置自定义的字符集来生成UUID：

import shortuuid

# 设置自定义字符集
shortuuid.set_alphabet("21345687654123456")

# 生成一个短UUID
short_uuid = shortuuid.uuid()
print(short_uuid)

应用案例和最佳实践

Django 字段

ShortUUID 提供了一个Django字段，可以方便地在Django模型中使用：

from shortuuid.django_fields import ShortUUIDField
from django.db import models

class MyModel(models.Model):
    # 一个长度为16的短UUID字段
    id = ShortUUIDField(length=16, max_length=40, prefix="id_", primary_key=True)
    # 一个默认长度的短UUID字段
    api_key = ShortUUIDField()

命令行使用

ShortUUID 还提供了命令行工具，方便在终端中生成短UUID：

shortuuid

典型生态项目

ShortUUID 可以与其他Python库和工具结合使用，例如：

• Django: 用于Web应用中生成短标识符。
• Flask: 用于微服务中生成API密钥。
• SQLAlchemy: 用于数据库模型中生成唯一标识符。

通过这些组合，ShortUUID 可以广泛应用于各种需要短且唯一标识符的场景。

shortuuidA generator library for concise, unambiguous and URL-safe UUIDs.项目地址:https://gitcode.com/gh_mirrors/sh/shortuuid