route-rules 0.2.2__py3-none-any.whl

route_rules/__init__.py

@@ -0,0 +1,3 @@
+import lazy_loader as lazy
+
+__getattr__, __dir__, __all__ = lazy.attach_stub(__name__, __file__)

route_rules/__init__.pyi

@@ -0,0 +1,42 @@
+from . import core, gen, provider, utils
+from ._recipe import Recipe
+from .core import RuleSet
+from .gen import (
+    ArtifactMeta,
+    Builder,
+    Config,
+    Meta,
+    ProviderMeta,
+    RecipeMeta,
+    RecipeWrapper,
+)
+from .provider import (
+    Behavior,
+    Format,
+    Provider,
+    ProviderMihomo,
+    ProviderRegistry,
+)
+from .utils import download
+
+__all__ = [
+    "ArtifactMeta",
+    "Behavior",
+    "Builder",
+    "Config",
+    "Format",
+    "Meta",
+    "Provider",
+    "ProviderMeta",
+    "ProviderMihomo",
+    "ProviderRegistry",
+    "Recipe",
+    "RecipeMeta",
+    "RecipeWrapper",
+    "RuleSet",
+    "core",
+    "download",
+    "gen",
+    "provider",
+    "utils",
+]

route_rules/_recipe.py

@@ -0,0 +1,33 @@
+import asyncio
+
+import attrs
+import cachetools
+import cachetools_async as cta
+
+from . import utils
+from .core import RuleSet
+from .provider import ProviderRegistry
+
+
+@attrs.define
+class Recipe:
+    name: str = attrs.field()
+    providers: list[str] = attrs.field()
+    registry: ProviderRegistry = attrs.field(
+        factory=ProviderRegistry.presets, kw_only=True
+    )
+    slug: str = attrs.field(
+        default=attrs.Factory(utils.default_slug, takes_self=True), kw_only=True
+    )
+
+    _cache: cachetools.Cache = attrs.field(
+        factory=lambda: cachetools.Cache(maxsize=1), kw_only=True
+    )
+
+    @cta.cachedmethod(lambda self: self._cache)
+    async def build(self) -> RuleSet:
+        ruleset: RuleSet = RuleSet.union(
+            *(await asyncio.gather(*(self.registry.load(p) for p in self.providers)))
+        )
+        ruleset = ruleset.optimize()
+        return ruleset

route_rules/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '0.2.2'
+__version_tuple__ = version_tuple = (0, 2, 2)
+
+__commit_id__ = commit_id = None

route_rules/_version.pyi

@@ -0,0 +1,8 @@
+# This file is @generated by <https://github.com/liblaf/copier-python>.
+# DO NOT EDIT!
+
+# ref: <https://github.com/ofek/hatch-vcs>
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+version: str

route_rules/core/__init__.py

@@ -0,0 +1,5 @@
+# tangerine-start: lazy-loader.py
+import lazy_loader as _lazy
+
+__getattr__, __dir__, __all__ = _lazy.attach_stub(__name__, __file__)
+# tangerine-end

route_rules/core/__init__.pyi

@@ -0,0 +1,3 @@
+from ._ruleset import RuleSet
+
+__all__ = ["RuleSet"]

route_rules/core/_ruleset.py

@@ -0,0 +1,53 @@
+import collections
+from collections.abc import Mapping
+from collections.abc import Set as AbstractSet
+from typing import Self, override
+
+
+class RuleSet(collections.UserDict[str, set[str]]):
+    """.
+
+    References:
+        1. <https://wiki.metacubex.one/en/config/rules/>
+    """
+
+    @override
+    def __or__(self, other: Mapping[str, AbstractSet[str]], /) -> Self:  # pyright: ignore[reportIncompatibleMethodOverride]
+        result: Self = type(self)()
+        for typ in self.keys() | other.keys():
+            result[typ] = self.get(typ, set()) | other.get(typ, set())
+        return result
+
+    def __missing__(self, key: str) -> set[str]:
+        self[key] = set()
+        return self[key]
+
+    @property
+    def domain(self) -> set[str]:
+        return self["DOMAIN"]
+
+    @property
+    def domain_suffix(self) -> set[str]:
+        return self["DOMAIN-SUFFIX"]
+
+    @property
+    def ip_cidr(self) -> set[str]:
+        return self["IP-CIDR"]
+
+    def add(self, typ: str, value: str) -> None:
+        # IP-CIDR and IP-CIDR6 have the same effect, with IP-CIDR6 being an alias.
+        if typ == "IP-CIDR6":
+            typ = "IP-CIDR"
+        self[typ].add(value)
+
+    def optimize(self) -> Self:
+        # TODO: implement
+        return self
+
+    def union(self, *others: Mapping[str, AbstractSet[str]]) -> Self:
+        result: Self = type(self)()
+        for typ in set(self.keys()).union(*(m.keys() for m in others)):
+            result[typ] = self.get(typ, set()).union(
+                *(m.get(typ, set()) for m in others)
+            )
+        return result

route_rules/export/__init__.py

@@ -0,0 +1,5 @@
+# tangerine-start: lazy-loader.py
+import lazy_loader as _lazy
+
+__getattr__, __dir__, __all__ = _lazy.attach_stub(__name__, __file__)
+# tangerine-end

route_rules/export/__init__.pyi

@@ -0,0 +1,4 @@
+from ._abc import Exporter
+from ._mihomo import ExporterMihomo
+
+__all__ = ["Exporter", "ExporterMihomo"]

route_rules/export/_abc.py

@@ -0,0 +1,19 @@
+import abc
+import os
+from pathlib import Path
+
+import attrs
+
+from route_rules.core import RuleSet
+
+
+@attrs.define
+class Exporter(abc.ABC):
+    export_path_template: str = attrs.field(kw_only=True)
+
+    @abc.abstractmethod
+    def export(self, file: str | os.PathLike[str], ruleset: RuleSet) -> int:
+        raise NotImplementedError
+
+    def export_path(self, slug: str) -> Path:
+        return Path(self.export_path_template.format(slug=slug))

route_rules/export/_mihomo.py

@@ -0,0 +1,121 @@
+import os
+import subprocess
+import tempfile
+from collections.abc import Generator, Iterable
+from pathlib import Path
+from typing import override
+
+import attrs
+import msgspec
+
+from route_rules.core import RuleSet
+from route_rules.provider.mihomo import Behavior, Format
+
+from ._abc import Exporter
+
+
+@attrs.define
+class ExporterMihomo(Exporter):
+    behavior: Behavior = attrs.field()
+    format: Format = attrs.field()
+    export_path_template: str = attrs.field(
+        default="mihomo/{slug}.{behavior}{format.ext}", kw_only=True
+    )
+
+    @override
+    def export(
+        self,
+        file: str | os.PathLike[str],
+        ruleset: RuleSet,
+    ) -> int:
+        data: bytes = encode(ruleset, behavior=self.behavior, format=self.format)
+        if not data:
+            return 0
+        file = Path(file)
+        file.parent.mkdir(parents=True, exist_ok=True)
+        file.write_bytes(data)
+        return len(data)
+
+    @override
+    def export_path(self, slug: str) -> Path:
+        return Path(
+            self.export_path_template.format(
+                slug=slug, behavior=self.behavior, format=self.format
+            )
+        )
+
+
+@attrs.define
+class EncodeError(RuntimeError):
+    behavior: Behavior = attrs.field()
+    format: Format = attrs.field()
+
+
+def encode(ruleset: RuleSet, behavior: Behavior, format: Format) -> bytes:  # noqa: A002
+    payload: Iterable[str]
+    match behavior:
+        case Behavior.DOMAIN:
+            payload = _encode_domain(ruleset)
+        case Behavior.IPCIDR:
+            payload = _encode_ipcidr(ruleset)
+        case Behavior.CLASSICAL:
+            payload = _encode_classical(ruleset)
+        case _:
+            raise EncodeError(behavior=behavior, format=format)
+    match format:
+        case Format.YAML:
+            return _encode_yaml(payload)
+        case Format.TEXT:
+            return _encode_text(payload).encode()
+        case Format.MRS:
+            return _encode_mrs(payload, behavior=behavior)
+        case _:
+            raise EncodeError(behavior=behavior, format=format)
+
+
+def _encode_domain(ruleset: RuleSet) -> Generator[str]:
+    yield from ruleset.domain
+    for domain in ruleset.domain_suffix:
+        yield f"+.{domain}"
+
+
+def _encode_ipcidr(ruleset: RuleSet) -> set[str]:
+    return ruleset.ip_cidr
+
+
+def _encode_classical(ruleset: RuleSet) -> Generator[str]:
+    for typ, values in ruleset.data.items():
+        if typ in {"DOMAIN", "DOMAIN-SUFFIX", "IP-CIDR"}:
+            continue
+        for value in values:
+            yield f"{typ},{value}"
+
+
+def _encode_yaml(payload: Iterable[str]) -> bytes:
+    payload = list(payload)
+    if not payload:
+        return b""
+    return msgspec.yaml.encode({"payload": list(payload)})
+
+
+def _encode_text(payload: Iterable[str]) -> str:
+    payload = list(payload)
+    if not payload:
+        return ""
+    return "\n".join(payload)
+
+
+def _encode_mrs(payload: Iterable[str], behavior: Behavior) -> bytes:
+    payload = list(payload)
+    if not payload:
+        return b""
+    with tempfile.TemporaryDirectory() as tmpdir_str:
+        tmpdir = Path(tmpdir_str)
+        yaml_file: Path = tmpdir / "rule-set.yaml"
+        mrs_file: Path = tmpdir / "rule-set.mrs"
+        yaml_file.write_bytes(_encode_yaml(payload))
+        subprocess.run(
+            ["mihomo", "convert-ruleset", behavior, "yaml", yaml_file, mrs_file],
+            check=True,
+        )
+        return mrs_file.read_bytes()

route_rules/gen/__init__.py

@@ -0,0 +1,5 @@
+# tangerine-start: lazy-loader.py
+import lazy_loader as _lazy
+
+__getattr__, __dir__, __all__ = _lazy.attach_stub(__name__, __file__)
+# tangerine-end

route_rules/gen/__init__.pyi

@@ -0,0 +1,14 @@
+from ._builder import Builder
+from ._config import Config
+from ._meta import ArtifactMeta, Meta, ProviderMeta, RecipeMeta
+from ._recipe import RecipeWrapper
+
+__all__ = [
+    "ArtifactMeta",
+    "Builder",
+    "Config",
+    "Meta",
+    "ProviderMeta",
+    "RecipeMeta",
+    "RecipeWrapper",
+]

route_rules/gen/_builder.py

@@ -0,0 +1,87 @@
+import collections
+import datetime
+import os
+from pathlib import Path
+from typing import Self
+
+import attrs
+
+from route_rules.core import RuleSet
+from route_rules.export import ExporterMihomo
+from route_rules.provider import Behavior, Format
+
+from ._config import Config
+from ._meta import ArtifactMeta, Meta, ProviderMeta, RecipeMeta, RecipeStatistics
+from ._recipe import RecipeWrapper
+
+
+def _default_exporters() -> list[ExporterMihomo]:
+    return [
+        ExporterMihomo(behavior=Behavior.DOMAIN, format=Format.MRS),
+        ExporterMihomo(behavior=Behavior.DOMAIN, format=Format.TEXT),
+        ExporterMihomo(behavior=Behavior.IPCIDR, format=Format.MRS),
+        ExporterMihomo(behavior=Behavior.IPCIDR, format=Format.TEXT),
+        ExporterMihomo(behavior=Behavior.CLASSICAL, format=Format.TEXT),
+    ]
+
+
+@attrs.define
+class Builder:
+    dist_dir: Path = attrs.field(default=Path("dist"))
+    exporters: list[ExporterMihomo] = attrs.field(factory=_default_exporters)
+    recipes: list[RecipeWrapper] = attrs.field(factory=list)
+
+    @classmethod
+    def load(cls, file: str | os.PathLike[str]) -> Self:
+        config: Config = Config.load(file)
+        self: Self = cls()
+        for recipe_config in config.recipes:
+            self.recipes.append(RecipeWrapper.from_config(recipe_config))
+        return self
+
+    async def build(self) -> None:
+        meta = Meta(build_time=datetime.datetime.now().astimezone())
+        for recipe in self.recipes:
+            meta.recipes.append(await self.build_recipe(recipe))
+        (self.dist_dir / "meta.json").write_bytes(meta.json_encode())
+
+    async def build_recipe(self, recipe: RecipeWrapper) -> RecipeMeta:
+        ruleset: RuleSet = await recipe.build()
+        meta = RecipeMeta(
+            name=recipe.name,
+            slug=recipe.slug,
+            statistics=await self._build_statistics(recipe, ruleset),
+        )
+        for provider in recipe.providers:
+            meta.providers.append(
+                ProviderMeta(
+                    name=provider,
+                    download_url=recipe.registry.download_url(provider),
+                    preview_url=recipe.registry.preview_url(provider),
+                )
+            )
+        for exporter in self.exporters:
+            path: Path = exporter.export_path(recipe.slug)
+            size: int = exporter.export(self.dist_dir / path, ruleset)
+            if size == 0:
+                continue
+            meta.artifacts.append(
+                ArtifactMeta(
+                    behavior=exporter.behavior,
+                    format=exporter.format,
+                    path=path,
+                    size=size,
+                )
+            )
+        return meta
+
+    async def _build_statistics(
+        self, recipe: RecipeWrapper, ruleset: RuleSet
+    ) -> RecipeStatistics:
+        outputs: dict[str, int] = {typ: len(values) for typ, values in ruleset.items()}
+        inputs: dict[str, int] = collections.defaultdict(lambda: 0)
+        for provider in recipe.providers:
+            ruleset: RuleSet = await recipe.registry.load(provider)
+            for typ, values in ruleset.items():
+                inputs[typ] += len(values)
+        return RecipeStatistics(inputs=inputs, outputs=outputs)

route_rules/gen/_config.py

@@ -0,0 +1,21 @@
+import os
+from pathlib import Path
+from typing import Any, Self
+
+import msgspec
+import pydantic
+
+
+class RecipeConfig(pydantic.BaseModel):
+    name: str
+    providers: list[str]
+
+
+class Config(pydantic.BaseModel):
+    recipes: list[RecipeConfig]
+
+    @classmethod
+    def load(cls, file: str | os.PathLike[str]) -> Self:
+        file = Path(file)
+        data: Any = msgspec.yaml.decode(file.read_bytes())
+        return cls.model_validate(data)

route_rules/gen/_meta.py

@@ -0,0 +1,58 @@
+import datetime
+from collections.abc import Buffer
+from pathlib import Path
+from typing import Any, Self
+
+import msgspec
+
+from route_rules.provider import Behavior, Format
+
+
+class ArtifactMeta(msgspec.Struct):
+    behavior: Behavior
+    format: Format
+    path: Path
+    size: int
+
+
+class ProviderMeta(msgspec.Struct):
+    name: str
+    download_url: str
+    preview_url: str
+
+
+class RecipeStatistics(msgspec.Struct):
+    inputs: dict[str, int] = msgspec.field(default_factory=dict)
+    outputs: dict[str, int] = msgspec.field(default_factory=dict)
+
+
+class RecipeMeta(msgspec.Struct):
+    name: str
+    slug: str
+    artifacts: list[ArtifactMeta] = msgspec.field(default_factory=list)
+    providers: list[ProviderMeta] = msgspec.field(default_factory=list)
+    statistics: RecipeStatistics = msgspec.field(default_factory=RecipeStatistics)
+
+
+class Meta(msgspec.Struct):
+    build_time: datetime.datetime
+    recipes: list[RecipeMeta] = msgspec.field(default_factory=list)
+
+    @classmethod
+    def json_decode(cls, data: Buffer | str) -> Self:
+        return msgspec.json.decode(data, type=cls, dec_hook=dec_hook)
+
+    def json_encode(self) -> bytes:
+        return msgspec.json.encode(self, enc_hook=enc_hook)
+
+
+def dec_hook(typ: type, obj: Any) -> Any:
+    return typ(obj)
+
+
+def enc_hook(obj: Any) -> Any:
+    match obj:
+        case Path():
+            return obj.as_posix()
+        case _:
+            return obj

route_rules/gen/_recipe.py

@@ -0,0 +1,14 @@
+from typing import Self
+
+import attrs
+
+from route_rules._recipe import Recipe
+
+from ._config import RecipeConfig
+
+
+@attrs.define
+class RecipeWrapper(Recipe):
+    @classmethod
+    def from_config(cls, config: RecipeConfig) -> Self:
+        return cls(name=config.name, providers=config.providers)

route_rules/provider/__init__.py

@@ -0,0 +1,5 @@
+# tangerine-start: lazy-loader.py
+import lazy_loader as _lazy
+
+__getattr__, __dir__, __all__ = _lazy.attach_stub(__name__, __file__)
+# tangerine-end

route_rules/provider/__init__.pyi

@@ -0,0 +1,13 @@
+from . import mihomo
+from ._abc import Provider
+from ._registry import ProviderRegistry
+from .mihomo import Behavior, Format, ProviderMihomo
+
+__all__ = [
+    "Behavior",
+    "Format",
+    "Provider",
+    "ProviderMihomo",
+    "ProviderRegistry",
+    "mihomo",
+]

route_rules/provider/_abc.py

@@ -0,0 +1,36 @@
+import abc
+import urllib.parse
+
+import attrs
+import cachetools
+
+from route_rules.core import RuleSet
+
+
+def _default_preview_url_template(self: "Provider") -> str:
+    return self.download_url_template
+
+
+@attrs.define
+class Provider(abc.ABC):
+    name: str = attrs.field()
+    download_url_template: str = attrs.field()
+    preview_url_template: str = attrs.field(
+        default=attrs.Factory(_default_preview_url_template, takes_self=True),
+    )
+
+    _cache: cachetools.Cache = attrs.field(
+        factory=lambda: cachetools.LRUCache(maxsize=65536), kw_only=True
+    )
+
+    def download_url(self, name: str) -> str:
+        name = urllib.parse.quote(name)
+        return self.download_url_template.format(name=name)
+
+    @abc.abstractmethod
+    async def load(self, name: str) -> RuleSet:
+        raise NotImplementedError
+
+    def preview_url(self, name: str) -> str:
+        name = urllib.parse.quote(name)
+        return self.preview_url_template.format(name=name)

route_rules/provider/_registry.py

@@ -0,0 +1,91 @@
+import functools
+from typing import Self
+
+import attrs
+
+from route_rules.core import RuleSet
+
+from ._abc import Provider
+from .mihomo import Behavior, Format, ProviderMihomo
+
+
+@attrs.define
+class ProviderRegistry:
+    registry: dict[str, Provider] = attrs.field(factory=dict)
+
+    @classmethod
+    @functools.cache
+    def presets(cls) -> Self:
+        self: Self = cls()
+        self.register(
+            ProviderMihomo(
+                "blackmatrix7",
+                "https://raw.githubusercontent.com/blackmatrix7/ios_rule_script/master/rule/Clash/{name}/{name}.list",
+                "https://github.com/blackmatrix7/ios_rule_script/tree/master/rule/Clash/{name}",
+                behavior=Behavior.CLASSICAL,
+                format=Format.TEXT,
+            ),
+            ProviderMihomo(
+                "dler-io",
+                "https://raw.githubusercontent.com/dler-io/Rules/main/Clash/Provider/{name}.yaml",
+                "https://github.com/dler-io/Rules/blob/main/Clash/Provider/{name}.yaml",
+                behavior=Behavior.CLASSICAL,
+                format=Format.YAML,
+            ),
+            ProviderMihomo(
+                "liblaf",
+                "https://raw.githubusercontent.com/liblaf/route-rules/main/rules/{name}.list",
+                "https://github.com/liblaf/route-rules/blob/main/rules/{name}.list",
+                behavior=Behavior.DOMAIN,
+                format=Format.TEXT,
+            ),
+            ProviderMihomo(
+                "MetaCubeX/geosite",
+                "https://raw.githubusercontent.com/MetaCubeX/meta-rules-dat/meta/geo/geosite/{name}.yaml",
+                "https://github.com/MetaCubeX/meta-rules-dat/blob/meta/geo/geosite/{name}.yaml",
+                behavior=Behavior.DOMAIN,
+                format=Format.YAML,
+            ),
+            ProviderMihomo(
+                "SukkaW/classical",
+                "https://ruleset.skk.moe/Clash/{name}.txt",
+                behavior=Behavior.CLASSICAL,
+                format=Format.TEXT,
+            ),
+            ProviderMihomo(
+                "SukkaW/domain",
+                "https://ruleset.skk.moe/Clash/{name}.txt",
+                behavior=Behavior.DOMAIN,
+                format=Format.TEXT,
+            ),
+        )
+        return self
+
+    def download_url(self, name: str) -> str:
+        provider: Provider
+        ruleset_name: str
+        provider, ruleset_name = self._parse_name(name)
+        return provider.download_url(ruleset_name)
+
+    async def load(self, name: str) -> RuleSet:
+        provider: Provider
+        ruleset_name: str
+        provider, ruleset_name = self._parse_name(name)
+        return await provider.load(ruleset_name)
+
+    def preview_url(self, name: str) -> str:
+        provider: Provider
+        ruleset_name: str
+        provider, ruleset_name = self._parse_name(name)
+        return provider.preview_url(ruleset_name)
+
+    def register(self, *providers: Provider) -> None:
+        for provider in providers:
+            self.registry[provider.name] = provider
+
+    def _parse_name(self, name: str) -> tuple[Provider, str]:
+        provider_name: str
+        ruleset_name: str
+        provider_name, _, ruleset_name = name.partition(":")
+        provider: Provider = self.registry[provider_name]
+        return provider, ruleset_name

route_rules/provider/mihomo/__init__.py

@@ -0,0 +1,5 @@
+# tangerine-start: lazy-loader.py
+import lazy_loader as _lazy
+
+__getattr__, __dir__, __all__ = _lazy.attach_stub(__name__, __file__)
+# tangerine-end

route_rules/provider/mihomo/__init__.pyi

@@ -0,0 +1,5 @@
+from ._decode import decode
+from ._enum import Behavior, Format
+from ._provider import ProviderMihomo
+
+__all__ = ["Behavior", "Format", "ProviderMihomo", "decode"]

route_rules/provider/mihomo/_decode.py

@@ -0,0 +1,73 @@
+import re
+from collections.abc import Iterable
+
+import attrs
+import msgspec
+from loguru import logger
+
+from route_rules.core import RuleSet
+
+from ._enum import Behavior, Format
+
+
+@attrs.define
+class DecodeError(RuntimeError):
+    behavior: Behavior = attrs.field()
+    format: Format = attrs.field()
+
+
+def decode(data: str | bytes, behavior: Behavior, format: Format) -> RuleSet:  # noqa: A002
+    payload: list[str]
+    match format:
+        case Format.YAML:
+            payload = _decode_yaml(data)
+        case Format.TEXT:
+            payload = _decode_text(data)
+        case _:
+            raise DecodeError(behavior=behavior, format=format)
+    match behavior:
+        case Behavior.DOMAIN:
+            return _decode_domain(payload)
+        case Behavior.CLASSICAL:
+            return _decode_classical(payload)
+        case _:
+            raise DecodeError(behavior=behavior, format=format)
+
+
+def _decode_domain(payload: Iterable[str]) -> RuleSet:
+    # ref: <https://wiki.metacubex.one/en/handbook/syntax/#domain-wildcards>
+    ruleset = RuleSet()
+    for line in payload:
+        if line.startswith("*."):
+            logger.warning("Unsupported: Domain Wildcard `*`.", once=True)
+        elif line.startswith("+."):
+            ruleset.domain_suffix.add(line[2:])
+        elif line.startswith("."):
+            logger.warning("Unsupported: Domain Wildcard `.`.", once=True)
+        else:
+            ruleset.domain.add(line)
+    return ruleset
+
+
+def _decode_classical(payload: Iterable[str]) -> RuleSet:
+    ruleset = RuleSet()
+    for line in payload:
+        typ: str
+        value: str
+        typ, value, *_ = line.split(",", maxsplit=2)
+        ruleset.add(typ, value)
+    return ruleset
+
+
+def _decode_yaml(data: str | bytes) -> list[str]:
+    return msgspec.yaml.decode(data)["payload"]
+
+
+def _decode_text(text: str | bytes) -> list[str]:
+    if isinstance(text, bytes):
+        text = text.decode()
+    text = re.sub(r"#.*", "", text, flags=re.MULTILINE)
+    lines: list[str] = text.splitlines()
+    lines = [line.strip() for line in lines]
+    lines = [line for line in lines if line]
+    return lines

route_rules/provider/mihomo/_enum.py

@@ -0,0 +1,21 @@
+import enum
+
+
+class Behavior(enum.StrEnum):
+    DOMAIN = enum.auto()
+    IPCIDR = enum.auto()
+    CLASSICAL = enum.auto()
+
+
+class Format(enum.StrEnum):
+    YAML = enum.auto()
+    TEXT = enum.auto()
+    MRS = enum.auto()
+
+    @property
+    def ext(self) -> str:
+        return {
+            Format.YAML: ".yaml",
+            Format.TEXT: ".list",
+            Format.MRS: ".mrs",
+        }[self]

route_rules/provider/mihomo/_provider.py

@@ -0,0 +1,24 @@
+from typing import override
+
+import attrs
+import cachetools_async as cta
+import httpx
+
+from route_rules import utils
+from route_rules.core import RuleSet
+from route_rules.provider._abc import Provider
+
+from ._decode import decode
+from ._enum import Behavior, Format
+
+
+@attrs.define
+class ProviderMihomo(Provider):
+    behavior: Behavior = attrs.field(kw_only=True)
+    format: Format = attrs.field(default=Format.YAML, kw_only=True)
+
+    @override
+    @cta.cachedmethod(lambda self: self._cache)
+    async def load(self, name: str) -> RuleSet:
+        response: httpx.Response = await utils.download(self.download_url(name))
+        return decode(response.text, behavior=self.behavior, format=self.format)

route_rules/utils/__init__.py

@@ -0,0 +1,3 @@
+import lazy_loader as lazy
+
+__getattr__, __dir__, __all__ = lazy.attach_stub(__name__, __file__)

route_rules/utils/__init__.pyi

@@ -0,0 +1,4 @@
+from ._download import download
+from ._slugify import default_slug
+
+__all__ = ["default_slug", "download"]

route_rules/utils/_download.py

@@ -0,0 +1,16 @@
+import hishel
+import httpx
+from loguru import logger
+
+storage = hishel.AsyncFileStorage(ttl=86400)  # seconds
+client = hishel.AsyncCacheClient(follow_redirects=True, storage=storage)
+
+
+async def download(url: str) -> httpx.Response:
+    response: httpx.Response = await client.get(url)
+    response = response.raise_for_status()
+    if response.extensions["from_cache"]:
+        logger.success("Cache Hit: {}", url)
+    else:
+        logger.info("Cache Miss: {}", url)
+    return response

route_rules/utils/_slugify.py

@@ -0,0 +1,7 @@
+from typing import Any
+
+from slugify import slugify
+
+
+def default_slug(self: Any) -> str:
+    return slugify(self.name)

route_rules-0.2.2.dist-info/METADATA

@@ -0,0 +1,40 @@
+Metadata-Version: 2.4
+Name: route-rules
+Version: 0.2.2
+Project-URL: Changelog, https://github.com/liblaf/route-rules/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://liblaf.github.io/route-rules/
+Project-URL: Funding, https://github.com/liblaf/route-rules?sponsor=1
+Project-URL: Homepage, https://github.com/liblaf/route-rules
+Project-URL: Issue Tracker, https://github.com/liblaf/route-rules/issues
+Project-URL: Release Notes, https://github.com/liblaf/route-rules/releases
+Project-URL: Source Code, https://github.com/liblaf/route-rules
+Author-email: liblaf <30631553+liblaf@users.noreply.github.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: anyio<5,>=4
+Requires-Dist: autoregistry<3,>=1
+Requires-Dist: cachetools-async<0.0.6,>=0.0.5
+Requires-Dist: cachetools<7,>=6
+Requires-Dist: cytoolz<2,>=1
+Requires-Dist: hishel<0.2,>=0.1
+Requires-Dist: httpx[socks]<0.29,>=0.28
+Requires-Dist: lazy-loader<0.5,>=0.4
+Requires-Dist: liblaf-grapes<5,>=4
+Requires-Dist: loguru<0.8,>=0.7
+Requires-Dist: prettytable<4,>=3
+Requires-Dist: python-slugify<9,>=8
+Requires-Dist: validators<0.36,>=0.35
+Description-Content-Type: text/markdown
+
+# Route Rules

route_rules-0.2.2.dist-info/RECORD

@@ -0,0 +1,36 @@
+route_rules/__init__.py,sha256=OHb6Xou2v6u42swTgjRfzej4CIlRg4OmgOIQXUiRjKA,97
+route_rules/__init__.pyi,sha256=jJ6rZmgqtqyUrq-Ar3N4MAE1DOUAjIlr_HXZ0_7Iy4E,682
+route_rules/_recipe.py,sha256=jZLj8DUY2vWKxVyUmIQRKVWyYY_7alxV-BKoJ3sjegA,890
+route_rules/_version.py,sha256=o3ZTescp-19Z9cvBGq9dQnbppljgzdUYUf98Nov0spY,704
+route_rules/_version.pyi,sha256=orSoCtn5mtEK2EOwbIDrqDsAe9HFoRVuN4ssTxbz-Xg,239
+route_rules/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+route_rules/core/__init__.py,sha256=LDgi9R9sVRcyI8T-oOMzoXQl_F5SmAEM85WIY1TBZgw,149
+route_rules/core/__init__.pyi,sha256=xlq2AY-Trk9Levivi38gIz6heHv3gxrv4QEep2NbrEQ,53
+route_rules/core/_ruleset.py,sha256=p7_NS_h5bPDbBlYduHIuZEkVtZ205WJ6AqjRKvltlHA,1572
+route_rules/export/__init__.py,sha256=LDgi9R9sVRcyI8T-oOMzoXQl_F5SmAEM85WIY1TBZgw,149
+route_rules/export/__init__.pyi,sha256=Xn-_8BA4u19PkAKlw0UsSZcOgVuAFLmU9fAchtcp7gQ,105
+route_rules/export/_abc.py,sha256=IcfuToIx0Jxv1osVNdkM7_aCwHzocLgT4rFt_Ni-A1c,445
+route_rules/export/_mihomo.py,sha256=33gPlJPH0Tt8vVS6wv6esW8h0p_HwGIWBj4D_LvtB04,3413
+route_rules/gen/__init__.py,sha256=LDgi9R9sVRcyI8T-oOMzoXQl_F5SmAEM85WIY1TBZgw,149
+route_rules/gen/__init__.pyi,sha256=Rwqed9KhIkySASk5ah5u39G0JcPF6Ymthd9YCZXWqCA,292
+route_rules/gen/_builder.py,sha256=nb5-t5IV2PNg93uyxgVArCOc4vAzKMf6xgrKvSnHGmg,3228
+route_rules/gen/_config.py,sha256=N1A1kLuWn8KiyTasBhOSO-DXxO99PIJDS8cIYa0xAD0,445
+route_rules/gen/_meta.py,sha256=1SxIKXq-hNzqlOSVD2rbz3KYI11TbllOBdompUbRKJI,1417
+route_rules/gen/_recipe.py,sha256=VGw_XDSazJtyrKnw7kI9TkH2B_Jb9HcJslO_uqpWAXA,296
+route_rules/provider/__init__.py,sha256=LDgi9R9sVRcyI8T-oOMzoXQl_F5SmAEM85WIY1TBZgw,149
+route_rules/provider/__init__.pyi,sha256=mnZ8D2EUwlN0tmzjuSEgom5I2-ykv_hOJg9oKoTlfRE,262
+route_rules/provider/_abc.py,sha256=dhGnyK4oz-051r-S4pN0lwPqwxQNMjyKvjwGwXhH6p0,972
+route_rules/provider/_registry.py,sha256=7sWLYEXOyCXVhpzxNqF7A261_lR7PQNJ_uGjtioI9dw,3293
+route_rules/provider/mihomo/__init__.py,sha256=LDgi9R9sVRcyI8T-oOMzoXQl_F5SmAEM85WIY1TBZgw,149
+route_rules/provider/mihomo/__init__.pyi,sha256=Pzs9HVc0nPvnCXoA-WmL14q1EteLAFvZE8t9vBAk04I,164
+route_rules/provider/mihomo/_decode.py,sha256=I0W-4r2KnJ21Gdp14QVNetrexURtUzIgGCmfqKfBOgk,2123
+route_rules/provider/mihomo/_enum.py,sha256=DVigBAhPzevaRvIQHn6CqUpsJuqpDAyV-Y3mXWNuV40,394
+route_rules/provider/mihomo/_provider.py,sha256=4tPsZ7HsiZYUEFgxF5x7-NojDOssHTO_4oSUw2vnnjc,706
+route_rules/utils/__init__.py,sha256=OHb6Xou2v6u42swTgjRfzej4CIlRg4OmgOIQXUiRjKA,97
+route_rules/utils/__init__.pyi,sha256=TjlslbdFPF7BLhFRf5ct7ckzeAg14cqcRVFQjZMi_bk,107
+route_rules/utils/_download.py,sha256=vvo0WbfEBjKTMZy2-__tNqPzus4_U_5VgoZOGQO08ds,489
+route_rules/utils/_slugify.py,sha256=EdTTIiouSPgNEXaWOTP4pJcCjWX5LVyxFhXcS5aXjDw,120
+route_rules-0.2.2.dist-info/METADATA,sha256=srhyveQTu39phBVU5ZtZYxawZdMMjYK3fWzXF0Y2m7U,1631
+route_rules-0.2.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+route_rules-0.2.2.dist-info/licenses/LICENSE,sha256=buKmmsDdpMgyd9Nu_4brBJuv_Lytvnk1Ikq3v-QRX7I,1063
+route_rules-0.2.2.dist-info/RECORD,,

route_rules-0.2.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

route_rules-0.2.2.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 liblaf
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.