Skip to content

SlugConfig

slugany.SlugConfig dataclass

Immutable configuration for the slugify pipeline.

All fields have sensible defaults. Use :meth:from_kwargs to create a config from keyword arguments with validation and style preset merging.

Source code in slugany/_config.py 
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
@dataclass(frozen=True, slots=True)
class SlugConfig:
    """Immutable configuration for the slugify pipeline.

    All fields have sensible defaults. Use :meth:`from_kwargs` to create
    a config from keyword arguments with validation and style preset merging.
    """

    separator: str = "-"
    lowercase: bool = True
    max_length: int = 0
    word_boundary: bool = False
    stopwords: frozenset[str] = field(default_factory=frozenset)
    allow_unicode: bool = False
    replacements: tuple[tuple[str, str], ...] = field(default_factory=tuple)
    style: str | None = None
    lang: str = "auto"
    fallback: str = ""
    emoji_mode: str = "strip"
    css_safe: bool = False
    html_entities: bool = True
    smart_punctuation: bool = True

    @classmethod
    def from_kwargs(cls, **kwargs: Any) -> SlugConfig:
        """Build a validated SlugConfig from keyword arguments.

        Validates style, lang, emoji_mode, and separator. Merges style
        presets with explicit overrides (explicit kwargs take precedence).

        Args:
            **kwargs: Configuration fields as keyword arguments.

        Returns:
            A frozen SlugConfig instance.

        Raises:
            ValueError: If an invalid style, lang, emoji_mode, empty
                separator, or empty replacement key is provided.
        """
        style = kwargs.get("style")
        if style is not None and style not in _STYLE_PRESETS:
            msg = f"Invalid style: {style!r}. Must be one of {list(_STYLE_PRESETS)} or None."
            raise ValueError(msg)

        lang = kwargs.get("lang", "auto")
        if lang not in _VALID_LANGS:
            msg = f"Invalid lang: {lang!r}. Must be one of {sorted(_VALID_LANGS)}."
            raise ValueError(msg)

        emoji_mode = kwargs.get("emoji_mode", "strip")
        if emoji_mode not in _VALID_EMOJI_MODES:
            msg = (
                f"Invalid emoji_mode: {emoji_mode!r}. Must be one of {sorted(_VALID_EMOJI_MODES)}."
            )
            raise ValueError(msg)

        separator = kwargs.get("separator")
        if separator is not None and (not isinstance(separator, str) or not separator):
            msg = "separator must be a non-empty string."
            raise ValueError(msg)
        if separator is not None and any(c.isalnum() for c in separator):
            msg = f"separator must not contain alphanumeric characters, got {separator!r}."
            raise ValueError(msg)

        fallback = kwargs.get("fallback")
        if fallback is not None and not isinstance(fallback, str):
            msg = f"fallback must be a string, got {type(fallback).__name__}."
            raise TypeError(msg)

        max_length = kwargs.get("max_length")
        if max_length is not None and (
            not isinstance(max_length, int) or isinstance(max_length, bool)
        ):
            msg = f"max_length must be an integer, got {type(max_length).__name__}."
            raise TypeError(msg)

        for bool_field in (
            "lowercase",
            "word_boundary",
            "allow_unicode",
            "css_safe",
            "html_entities",
            "smart_punctuation",
        ):
            val = kwargs.get(bool_field)
            if val is not None and not isinstance(val, bool):
                msg = f"{bool_field} must be a boolean, got {type(val).__name__}."
                raise TypeError(msg)

        replacements = kwargs.get("replacements")
        if replacements is not None:
            if isinstance(replacements, dict):
                replacements = tuple(replacements.items())
            else:
                replacements = tuple(replacements)
            for pair in replacements:
                if not isinstance(pair, tuple) or len(pair) != 2:
                    msg = f"replacements entries must be (str, str) tuples, got {pair!r}."
                    raise TypeError(msg)
                old, new = pair
                if not isinstance(old, str) or not isinstance(new, str):
                    msg = f"replacements keys and values must be strings, got {pair!r}."
                    raise TypeError(msg)
                if not old:
                    msg = "replacements keys must be non-empty strings."
                    raise ValueError(msg)
            kwargs["replacements"] = replacements
        else:
            kwargs.pop("replacements", None)

        stopwords = kwargs.get("stopwords")
        if stopwords is not None:
            kwargs["stopwords"] = frozenset(stopwords)
        else:
            kwargs.pop("stopwords", None)

        if style is not None:
            preset = _STYLE_PRESETS[style]
            merged: dict[str, Any] = dict(preset)
            for key, value in kwargs.items():
                if key in ("separator", "lowercase"):
                    if value is not None:
                        merged[key] = value
                elif value != _CONFIG_DEFAULTS.get(key):
                    merged[key] = value
            kwargs = merged

        if kwargs.get("separator") is None:
            kwargs["separator"] = "-"
        if kwargs.get("lowercase") is None:
            kwargs["lowercase"] = True

        return cls(**kwargs)

from_kwargs classmethod 

from_kwargs(**kwargs: Any) -> SlugConfig

Build a validated SlugConfig from keyword arguments.

Validates style, lang, emoji_mode, and separator. Merges style presets with explicit overrides (explicit kwargs take precedence).

Parameters:

Name Type Description Default
**kwargs Any

Configuration fields as keyword arguments.

 {}

Returns:

Type Description
SlugConfig

A frozen SlugConfig instance.

Raises:

Type Description
ValueError

If an invalid style, lang, emoji_mode, empty separator, or empty replacement key is provided.
Source code in slugany/_config.py 
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
@classmethod
def from_kwargs(cls, **kwargs: Any) -> SlugConfig:
    """Build a validated SlugConfig from keyword arguments.

    Validates style, lang, emoji_mode, and separator. Merges style
    presets with explicit overrides (explicit kwargs take precedence).

    Args:
        **kwargs: Configuration fields as keyword arguments.

    Returns:
        A frozen SlugConfig instance.

    Raises:
        ValueError: If an invalid style, lang, emoji_mode, empty
            separator, or empty replacement key is provided.
    """
    style = kwargs.get("style")
    if style is not None and style not in _STYLE_PRESETS:
        msg = f"Invalid style: {style!r}. Must be one of {list(_STYLE_PRESETS)} or None."
        raise ValueError(msg)

    lang = kwargs.get("lang", "auto")
    if lang not in _VALID_LANGS:
        msg = f"Invalid lang: {lang!r}. Must be one of {sorted(_VALID_LANGS)}."
        raise ValueError(msg)

    emoji_mode = kwargs.get("emoji_mode", "strip")
    if emoji_mode not in _VALID_EMOJI_MODES:
        msg = (
            f"Invalid emoji_mode: {emoji_mode!r}. Must be one of {sorted(_VALID_EMOJI_MODES)}."
        )
        raise ValueError(msg)

    separator = kwargs.get("separator")
    if separator is not None and (not isinstance(separator, str) or not separator):
        msg = "separator must be a non-empty string."
        raise ValueError(msg)
    if separator is not None and any(c.isalnum() for c in separator):
        msg = f"separator must not contain alphanumeric characters, got {separator!r}."
        raise ValueError(msg)

    fallback = kwargs.get("fallback")
    if fallback is not None and not isinstance(fallback, str):
        msg = f"fallback must be a string, got {type(fallback).__name__}."
        raise TypeError(msg)

    max_length = kwargs.get("max_length")
    if max_length is not None and (
        not isinstance(max_length, int) or isinstance(max_length, bool)
    ):
        msg = f"max_length must be an integer, got {type(max_length).__name__}."
        raise TypeError(msg)

    for bool_field in (
        "lowercase",
        "word_boundary",
        "allow_unicode",
        "css_safe",
        "html_entities",
        "smart_punctuation",
    ):
        val = kwargs.get(bool_field)
        if val is not None and not isinstance(val, bool):
            msg = f"{bool_field} must be a boolean, got {type(val).__name__}."
            raise TypeError(msg)

    replacements = kwargs.get("replacements")
    if replacements is not None:
        if isinstance(replacements, dict):
            replacements = tuple(replacements.items())
        else:
            replacements = tuple(replacements)
        for pair in replacements:
            if not isinstance(pair, tuple) or len(pair) != 2:
                msg = f"replacements entries must be (str, str) tuples, got {pair!r}."
                raise TypeError(msg)
            old, new = pair
            if not isinstance(old, str) or not isinstance(new, str):
                msg = f"replacements keys and values must be strings, got {pair!r}."
                raise TypeError(msg)
            if not old:
                msg = "replacements keys must be non-empty strings."
                raise ValueError(msg)
        kwargs["replacements"] = replacements
    else:
        kwargs.pop("replacements", None)

    stopwords = kwargs.get("stopwords")
    if stopwords is not None:
        kwargs["stopwords"] = frozenset(stopwords)
    else:
        kwargs.pop("stopwords", None)

    if style is not None:
        preset = _STYLE_PRESETS[style]
        merged: dict[str, Any] = dict(preset)
        for key, value in kwargs.items():
            if key in ("separator", "lowercase"):
                if value is not None:
                    merged[key] = value
            elif value != _CONFIG_DEFAULTS.get(key):
                merged[key] = value
        kwargs = merged

    if kwargs.get("separator") is None:
        kwargs["separator"] = "-"
    if kwargs.get("lowercase") is None:
        kwargs["lowercase"] = True

    return cls(**kwargs)