route_rules.provider.mihomo

Classes:

• Behavior –
• Format –
• ProviderMihomo –

Functions:

• decode –

Behavior

Bases: StrEnum

              flowchart TD
              route_rules.provider.mihomo.Behavior[Behavior]

              

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

Returned by:

• Reference route_rules
  •  route_rules
    •  ArtifactMeta  behavior
    •  ProviderMihomo  behavior
  • provider
    •  provider  ProviderMihomo  behavior
    • mihomo  mihomo  ProviderMihomo  behavior
  • export  export  ExporterMihomo  behavior
  • gen  gen  ArtifactMeta  behavior

Used by:

• Reference route_rules
  •  route_rules
    •  ArtifactMeta
    •  ProviderMihomo
  • provider
    •  provider  ProviderMihomo
    • mihomo  mihomo
      •  ProviderMihomo
      •  decode
  • 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.mihomo.Format[Format]

              

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

Returned by:

• Reference route_rules
  •  route_rules
    •  ArtifactMeta  format
    •  ProviderMihomo  format
  • provider
    •  provider  ProviderMihomo  format
    • mihomo  mihomo  ProviderMihomo  format
  • export  export  ExporterMihomo  format
  • gen  gen  ArtifactMeta  format

Used by:

• Reference route_rules
  •  route_rules
    •  ArtifactMeta
    •  ProviderMihomo
  • provider
    •  provider  ProviderMihomo
    • mihomo  mihomo
      •  ProviderMihomo
      •  decode
  • 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()

Used by:

• Reference route_rules
  •  route_rules  ProviderMihomo  format
  • provider
    •  provider  ProviderMihomo  format
    • mihomo  mihomo  ProviderMihomo  format

ext property

ext: str

ProviderMihomo

Bases: Provider

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

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


              click route_rules.provider.mihomo.ProviderMihomo href "" "route_rules.provider.mihomo.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)

decode

decode(
    data: str | bytes, behavior: Behavior, format: Format
) -> RuleSet

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

def decode(data: str | bytes, behavior: Behavior, format: Format) -> RuleSet:  # noqa: A002
    payload: list[str] = _format_decoders[format](data)
    ruleset: RuleSet = _behavior_decoders[behavior](payload)
    return ruleset