Unicode Slugify 项目教程

Unicode Slugify 项目教程

unicode-slugifyA slugifier that works in unicode项目地址:https://gitcode.com/gh_mirrors/un/unicode-slugify

1. 项目的目录结构及介绍

Unicode Slugify 项目的目录结构相对简单，主要包含以下几个部分：

unicode-slugify/
├── LICENSE
├── README.md
├── setup.py
├── slugify/
│   ├── __init__.py
│   ├── slugify.py
│   └── tests.py
└── requirements.txt

• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。
• setup.py: 用于安装项目的脚本。
• slugify/: 核心代码目录。
  • init.py: 初始化文件，使 slugify 成为一个 Python 包。
  • slugify.py: 实现 slugify 功能的主要文件。
  • tests.py: 测试文件，包含项目的单元测试。
• requirements.txt: 项目依赖的 Python 包列表。

2. 项目的启动文件介绍

项目的启动文件是 slugify/slugify.py，其中定义了 slugify 函数，用于将字符串转换为 slug。以下是该文件的主要内容：

from unidecode import unidecode
import re

def slugify(string, allow_unicode=False):
    """
    Convert to ASCII if 'allow_unicode' is False. Convert spaces to hyphens.
    Remove characters that aren't alphanumerics, underscores, or hyphens.
    Convert to lowercase. Also strip leading and trailing whitespace.
    """
    if allow_unicode:
        string = unicodedata.normalize('NFKC', string)
    else:
        string = unidecode(unicodedata.normalize('NFKC', string))
    string = re.sub(r'[^\w\s-]', '', string).strip().lower()
    return re.sub(r'[-\s]+', '-', string)

3. 项目的配置文件介绍

Unicode Slugify 项目没有专门的配置文件，所有的配置都是通过函数参数传递的。例如，slugify 函数的 allow_unicode 参数用于控制是否允许 Unicode 字符。

from slugify import slugify

txt = "This is a test ---"
r = slugify(txt)
print(r)  # 输出: this-is-a-test

txt = '影師嗎'
r = slugify(txt, allow_unicode=True)
print(r)  # 输出: 影師嗎

通过这种方式，用户可以根据需要灵活地配置 slugify 的行为。

---

以上是 Unicode Slugify 项目的教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！

unicode-slugifyA slugifier that works in unicode项目地址:https://gitcode.com/gh_mirrors/un/unicode-slugify