route_rules.provider

Modules:

• mihomo –

Classes:

• Behavior –
• Format –
• Provider –
• ProviderMihomo –
• ProviderRegistry –

Behavior

Bases: StrEnum

              flowchart TD
              route_rules.provider.Behavior[Behavior]

              

              click route_rules.provider.Behavior href "" "route_rules.provider.Behavior"
            

Returned by:

• Reference route_rules
  •  route_rules  ArtifactMeta  behavior
  • export  export  ExporterMihomo  behavior
  • gen  gen  ArtifactMeta  behavior

Used by:

• Reference route_rules
  •  route_rules  ArtifactMeta
  • export  export  ExporterMihomo
  • gen  gen  ArtifactMeta

Attributes:

• CLASSICAL –
• DOMAIN –
• IPCIDR –

CLASSICAL class-attribute instance-attribute

CLASSICAL = auto()

DOMAIN class-attribute instance-attribute

DOMAIN = auto()

IPCIDR class-attribute instance-attribute

IPCIDR = auto()

Format

Bases: StrEnum

              flowchart TD
              route_rules.provider.Format[Format]

              

              click route_rules.provider.Format href "" "route_rules.provider.Format"
            

Returned by:

• Reference route_rules
  •  route_rules  ArtifactMeta  format
  • export  export  ExporterMihomo  format
  • gen  gen  ArtifactMeta  format

Used by:

• Reference route_rules
  •  route_rules  ArtifactMeta
  • export  export  ExporterMihomo
  • gen  gen  ArtifactMeta

Attributes:

• MRS –
• TEXT –
• YAML –
• ext (str) –

MRS class-attribute instance-attribute

MRS = auto()

TEXT class-attribute instance-attribute

TEXT = auto()

YAML class-attribute instance-attribute

YAML = auto()

ext property

ext: str

Provider

Bases: ABC

              flowchart TD
              route_rules.provider.Provider[Provider]

              

              click route_rules.provider.Provider href "" "route_rules.provider.Provider"
            

Parameters:

• name

  (str) –

• download_url_template

  (str) –

• preview_url_template

  (str, default: <dynamic> ) –

Methods:

• download_url –
• load –
• preview_url –

Attributes:

• download_url_template (str) –
• name (str) –
• preview_url_template (str) –

download_url_template class-attribute instance-attribute

download_url_template: str = field()

name class-attribute instance-attribute

name: str = field()

preview_url_template class-attribute instance-attribute

preview_url_template: str = field(
    default=Factory(
        _default_preview_url_template, takes_self=True
    )
)

download_url

download_url(name: str) -> str

Source code in src/route_rules/provider/_abc.py

def download_url(self, name: str) -> str:
    name = urllib.parse.quote(name)
    return self.download_url_template.format(name=name)

load abstractmethod async

load(name: str) -> RuleSet

Source code in src/route_rules/provider/_abc.py

@abc.abstractmethod
async def load(self, name: str) -> RuleSet:
    raise NotImplementedError

preview_url

preview_url(name: str) -> str

Source code in src/route_rules/provider/_abc.py

def preview_url(self, name: str) -> str:
    name = urllib.parse.quote(name)
    return self.preview_url_template.format(name=name)

ProviderMihomo

Bases: Provider

              flowchart TD
              route_rules.provider.ProviderMihomo[ProviderMihomo]
              route_rules.provider._abc.Provider[Provider]

                              route_rules.provider._abc.Provider --> route_rules.provider.ProviderMihomo
                


              click route_rules.provider.ProviderMihomo href "" "route_rules.provider.ProviderMihomo"
              click route_rules.provider._abc.Provider href "" "route_rules.provider._abc.Provider"
            

Parameters:

• name

  (str) –

• download_url_template

  (str) –

• preview_url_template

  (str, default: <dynamic> ) –

• behavior

  (Behavior) –

• format

  (Format, default: <Format.YAML: 'yaml'> ) –

Methods:

• download_url –
• load –
• preview_url –

Attributes:

• behavior (Behavior) –
• download_url_template (str) –
• format (Format) –
• name (str) –
• preview_url_template (str) –

behavior class-attribute instance-attribute

behavior: Behavior = field(kw_only=True)

download_url_template class-attribute instance-attribute

download_url_template: str = field()

format class-attribute instance-attribute

format: Format = field(default=YAML, kw_only=True)

name class-attribute instance-attribute

name: str = field()

preview_url_template class-attribute instance-attribute

preview_url_template: str = field(
    default=Factory(
        _default_preview_url_template, takes_self=True
    )
)

download_url

download_url(name: str) -> str

Source code in src/route_rules/provider/_abc.py

def download_url(self, name: str) -> str:
    name = urllib.parse.quote(name)
    return self.download_url_template.format(name=name)

load async

load(name: str) -> RuleSet

Source code in src/route_rules/provider/mihomo/_provider.py

@override
@cta.cachedmethod(lambda self: self._cache)
async def load(self, name: str) -> RuleSet:
    url: str = self.download_url(name)
    response: httpx.Response = await utils.download(url)
    return decode(response.text, behavior=self.behavior, format=self.format)

preview_url

preview_url(name: str) -> str

Source code in src/route_rules/provider/_abc.py

def preview_url(self, name: str) -> str:
    name = urllib.parse.quote(name)
    return self.preview_url_template.format(name=name)

ProviderRegistry

Parameters:

• registry

  (dict[str, Provider], default: <class 'dict'> ) –

  dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

Returned by:

• Reference route_rules
  •  route_rules  Recipe  registry
  • gen  gen  Recipe  registry

Used by:

• Reference route_rules
  •  route_rules  Recipe
  • gen  gen  Recipe

Methods:

• download_url –
• load –
• presets –
• preview_url –
• register –

Attributes:

• registry (dict[str, Provider]) –

registry class-attribute instance-attribute

registry: dict[str, Provider] = field(factory=dict)

download_url

download_url(name: str) -> str

Source code in src/route_rules/provider/_registry.py

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)

load async

load(name: str) -> RuleSet

Source code in src/route_rules/provider/_registry.py

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)

presets cached classmethod

presets() -> Self

Used by:

• Reference route_rules
  •  route_rules  Recipe  registry
  • gen  gen  Recipe  registry

Source code in src/route_rules/provider/_registry.py

@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/domain",
            "https://raw.githubusercontent.com/liblaf/route-rules/main/rules/{name}.domain.list",
            "https://github.com/liblaf/route-rules/blob/main/rules/{name}.domain.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

preview_url

preview_url(name: str) -> str

Source code in src/route_rules/provider/_registry.py

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)

register

register(*providers: Provider) -> None

Source code in src/route_rules/provider/_registry.py

def register(self, *providers: Provider) -> None:
    for provider in providers:
        self.registry[provider.name] = provider