MIUI Auto Tasks

https://github.com/0-8-4/miui-auto-tasks
Admin
A Python script that automates MIUI Community 4.0 tasks and simulates network requests, supporting...
Tokens:58,551
Snippets:391
Trust Score:7.6
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Example: call print_info()

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.system_info.md

Example usage of print_info() to run at the start of a task run.

```python
from utils.system_info import print_info

print_info()   # run at the start of a task run
```

--------------------------------

### Example: call system_info()

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.system_info.md

Example usage of system_info() to log platform information.

```python
from utils.system_info import system_info

system_info()   # logs "操作系统平台: ..." etc.
```

--------------------------------

### External usage example

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.api.sign.md

Shows how to instantiate BaseSign, check daily tasks, get a token, perform a sign-in with CheckIn, and fetch user info.

```python
from utils.config import Account
from utils.api.sign import BaseSign, CheckIn
from utils.utils import get_token

acc = Account(uid="100000", user_agent="Mozilla/5.0 (Linux; Android 13) ...", CheckIn=True)
acc.cookies = {"miui_vip_a_ph": "from-login", "cUserId": "100000"}

sign = BaseSign(acc)
tasks = sign.check_daily_tasks()          # -> list[DailyTasksResult]
token = get_token(acc.cookies["cUserId"])
status, reason = CheckIn(acc, token).sign()  # -> (True, "None") | (False, "cookie"|"None")
ui = sign.user_info()                     # -> UserInfoResult

```

--------------------------------

### Example: call show_info()

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.system_info.md

Example usage of show_info() to format a label and value.

```python
from utils.system_info import show_info

print(show_info("版本", "1.0.0"))   # "版本: 1.0.0"
```

--------------------------------

### Config usage example

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.config.md

Example usage of Config.from_dict() and to_dict(). It imports Config, creates an instance from a dictionary with an account uid, and then converts it back to a dictionary.

```python
from utils.config import Config

cfg = Config.from_dict({"preference": {}, "accounts": [{"uid": "100000"}], "ONEPUSH": {}})
cfg.to_dict()  # {"preference": {...}, "accounts": [{...}], "ONEPUSH": {...}}
```

--------------------------------

### Account instantiation example with assertions

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.config.md

Example of creating an Account instance with a plain password that is auto-hashed, and verifying the resulting attributes. Shows that CheckIn and ThumbUp are enabled while WxSign remains False.

```python
from utils.config import Account, md5_crypto

acc = Account(
    uid="12345678",
    password="my-plain-password",          # auto MD5-hashed, uppercased
    login_user_agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) Chrome/120.0",
    device="MIUI:V816.0.23.12.11.DEV",
    device_model="Xiaomi 14",
    CheckIn=True,
    ThumbUp=True,
)
assert acc.password == md5_crypto("my-plain-password")
assert acc.CheckIn is True and acc.WxSign is False
```

--------------------------------

### Example: Using get_cookies

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.api.login.md

Example usage of get_cookies, showing how to obtain cookies for the MIUI community URL and asserting the result is a dict.

```python
cookies = Login(account).get_cookies("https://web.vip.miui.com/")
assert isinstance(cookies, dict)
```

--------------------------------

### QR login example

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.api.login.md

Example usage of qr_login and check_login to perform QR code login and retrieve user ID and cookies.

```python
check_url, _ = Login(account).qr_login()
user_id, cookies = Login(account).check_login(check_url)
```

--------------------------------

### DailyTasksResult usage example (from utils.api.sign import BaseSign)

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/types.md

Shows how to consume DailyTasksResult: call BaseSign(account).check_daily_tasks() to get a list, unpack the first item, and access its fields. The example prints the task name, completion status, and description.

```python
from utils.api.sign import BaseSign

task, *_ = BaseSign(account).check_daily_tasks()
print(f"{task.name!r} completed={task.showType} desc={task.desc!r}")
```

--------------------------------

### Call get wrapper with cookies and allow_redirects

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.request.md

Example usage of the get wrapper. Passes cookies and allow_redirects via **kwargs. Prints the response status code and JSON body.

```python
from utils.request import get

resp = get(
    "https://api-alpha.vip.miui.com/mtop/planet/vip/member/getCheckinPageCakeList",
    cookies={"miui_vip_a_ph": "..."},
    allow_redirects=False,
)
print(resp.status_code, resp.json())
```

--------------------------------

### Login usage example

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.api.login.md

Shows how to instantiate Login with an Account and call login() to obtain cookies. The Account constructor requires uid, password (MD5 hash), and login_user_agent.

```python
from utils.config import Account
from utils.api.login import Login

acc = Account(uid="100000", password="<md5>", login_user_agent="Mozilla/5.0 ...")
login_obj = Login(acc)
cookies = login_obj.login()

```

--------------------------------

### Example: Using get_token_by_captcha

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.utils.md

Shows how to call get_token_by_captcha with a URL and handle failure by raising a RuntimeError.

```python
from utils.utils import get_token_by_captcha

token = get_token_by_captcha("https://verify.sec.xiaomi.com/...?...c=gt&l=challenge&e=...")
if not token:
    raise RuntimeError("captcha solving failed")
```

--------------------------------

### check_login usage example

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.api.login.md

Example usage of check_login to verify QR login status and raise a TimeoutError if the user ID is None.

```python
uid, cookies = Login(account).check_login(check_url)
if uid is None:
    raise TimeoutError("QR login not confirmed in time")
```

--------------------------------

### rsa_encrypt usage example

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.utils.md

Example of calling rsa_encrypt with a PEM public key and a string to encrypt.

```python
from utils.utils import rsa_encrypt, PUBLIC_KEY_PEM

s = rsa_encrypt(PUBLIC_KEY_PEM, "aes-key-material")
```

--------------------------------

### TokenResultHandler usage example

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.data_model.md

Shows how to instantiate TokenResultHandler with sample data and verify the success and need_verify properties.

```python
from utils.data_model import TokenResultHandler

h1 = TokenResultHandler({"data": {"token": "T123"}})
assert h1.success

h2 = TokenResultHandler({"data": {"result": False, "url": "https://verify.sec.xiaomi.com/..."}})
assert h2.need_verify and not h2.success
```

--------------------------------

### Example: Using is_incorrect_return

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.utils.md

Shows how to use is_incorrect_return to check if a caught exception is an incorrect return. The example accesses a missing key and asserts the function returns True.

```python
from utils.utils import is_incorrect_return

try:
    payload["missing"][0]
except Exception as e:
    assert is_incorrect_return(e) is True   # KeyError/IndexError in IncorrectReturn
```

--------------------------------

### Example: Using get_cookies_by_passtk

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.api.login.md

Example usage of get_cookies_by_passtk, passing a user ID and passToken, then asserting the returned cookies contain the community token cookie 'miui_vip_a_ph'.

```python
cookies = Login(account).get_cookies_by_passtk("100000", "session-passToken-value")
assert "miui_vip_a_ph" in cookies  # community token cookie
```

--------------------------------

### Configure accounts and OnePush programmatically

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/configuration.md

Programmatic configuration example showing how to set accounts and OnePush settings via ConfigManager, then persist changes with write_plugin_data().

```python
from utils.config import Account, ConfigManager, OnePush, Preference

ConfigManager.data_obj.accounts = [
    Account(
        uid="12345678",
        password="<plain or md5>",
        login_user_agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) Chrome/120.0",
        CheckIn=True,
        ThumbUp=True,
    )
]
ConfigManager.data_obj.ONEPUSH = OnePush(notifier="serverchan", params={"token": "abc"})
ConfigManager.write_plugin_data()
```

--------------------------------

### aes_encrypt usage example

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.utils.md

Example of calling aes_encrypt with a 16-byte key and a JSON string.

```python
from utils.utils import aes_encrypt

enc = aes_encrypt("0123456789abcdef", '{"a": 1}')
```

--------------------------------

### request usage example

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.request.md

Example of calling request with method "POST" to a solve endpoint, passing params and json. This is used by utils.captcha.get_validate and get_validate_other for Geetest solver endpoints.

```python
from utils.request import request

resp = request(
    "POST",
    "https://example.com/solve",
    params={"gt": "abc"},
    json={"challenge": "def"},
)

```

--------------------------------

### LoginResultHandler usage example

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.data_model.md

Shows how to instantiate LoginResultHandler with a login response dictionary and check success, wrong password, or captcha requirements. The example prints the pass_token and user_id (coerced to string) on success, and suggests fallback actions for other cases.

```python
from utils.data_model import LoginResultHandler

api_data = LoginResultHandler({"passToken": "abc", "userId": 42, "status": 0, "message": "成功"})
if api_data.success:
    print(api_data.pass_token, api_data.user_id)   # "abc" "42"
elif api_data.pwd_wrong:
    print("bad credentials -> QR login fallback")
elif api_data.need_captcha:
    print("SMS captcha required")
```

--------------------------------

### get_random_chars_as_string usage example

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.utils.md

Example of generating a 16-character random string from a custom alphabet and asserting its length.

```python
from utils.utils import get_random_chars_as_string

key = get_random_chars_as_string(16, "abcdef0123456789")
assert len(key) == 16
```

--------------------------------

### Preference usage example

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.config.md

Example of instantiating Preference with a Geetest solving URL and a polling URL. The geetest_params dict uses {gt} and {challenge} placeholders that are substituted before sending. The get_geetest_try_count is set to 10 poll attempts.

```python
from utils.config import Preference

p = Preference(
    geetest_url="https://example.com/solve",
    geetest_params={"gt": "{gt}", "challenge": "{challenge}"},
    get_geetest_url="https://example.com/result",
    get_geetest_try_count=10,
)
```

--------------------------------

### Example usage of ConfigManager

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.config.md

Shows how to load the config, modify the accounts list, persist changes, and reload after editing the file. Uses the ConfigManager and Account classes from utils.config.

```python
from utils.config import ConfigManager, Account

ConfigManager.load_config()
ConfigManager.data_obj.accounts.append(Account(uid="999999", CheckIn=True))
ConfigManager.write_plugin_data()          # persists data_obj to data/config.{json|yaml}

# after editing the file, reload
ConfigManager.load_config()
```

--------------------------------

### Usage example: importing and calling main()

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/miuitask.md

Shows how to run the main() function from the miuitask module. The only way to influence main() is via the configuration file, the MIUITASK_CONFIG_PATH environment variable, and the GITHUB_REPOSITORY_OWNER opt-out. The function takes no arguments and returns nothing; all failures are logged, not raised.

```python
from miuitask import main

if __name__ == "__main__":
    main()
```

--------------------------------

### Example usage of generate_qrcode

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.utils.md

Shows how to import and call `generate_qrcode` with a URL string. The function prints the QR code to the terminal.

```python
from utils.utils import generate_qrcode

generate_qrcode("https://account.xiaomi.com/...")  # prints QR to terminal
```

--------------------------------

### Example usage of checkin_info with KeyError handling

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.api.login.md

Example usage of checkin_info with a try-except to handle the KeyError that occurs when the miui_vip_a_ph cookie is missing. The comment notes that the login may not have completed the STS exchange.

```python
login_obj = Login(account)
login_obj.login()
try:
    login_obj.checkin_info()   # ensures cookies["miui_vip_a_ph"] exists
except KeyError:
    # miui_vip_a_ph cookie missing — login did not complete the STS exchange
    pass
```

--------------------------------

### Example usage of get_validate with full pipeline

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.captcha.md

Shows how to configure the geetest_url, call get_validate, and handle the result. If validation fails, the token flow falls back or errors.

```python
from utils.config import ConfigManager
from utils.captcha import get_validate
from utils.utils import get_token_by_captcha

ConfigManager.data_obj.preference.geetest_url = "https://solver.example.com/api/v1/geetest"
result = get_validate(gt="<gt from URL>", challenge="<challenge from URL>")

if result.validate:
    print("solved:", result.validate)
else:
    # not configured or solver failed -> token flow falls back / errors
    print("unsolved; check utils/logs/日志文件.log")
```

--------------------------------

### ApiResultHandler usage example

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.data_model.md

Shows how to instantiate ApiResultHandler with a raw response dict and verify normalized fields. The example uses a payload with 'code', 'desc', and 'entity' keys.

```python
from utils.data_model import ApiResultHandler

h = ApiResultHandler({"code": 200, "desc": "OK", "entity": {"a": 1}})
assert h.status == 200
assert h.message == "OK"
assert h.data == {"a": 1}
assert h.success is True
```

--------------------------------

### GeetestResult usage example

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.data_model.md

Demonstrates how to use get_validate to obtain a GeetestResult and build a seccode string when validation succeeds.

```python
from utils.captcha import get_validate
from utils.data_model import GeetestResult

r: GeetestResult = get_validate(gt="<gt>", challenge="<challenge>")
if r.validate:
    seccode = f"{r.validate}|jordan"
```

--------------------------------

### find_key usage example

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.captcha.md

Example usage of find_key with assertions. Demonstrates finding a value in a nested dict, nested recursion for value types, and returning None when the key is absent.

```python
from utils.captcha import find_key

assert find_key({"a": {"b": 1}}, "b") == 1
assert find_key({"a": {"b": {"c": 2}}}, "c") == 2   # nested dict recursion works for value types
assert find_key({"a": 1}, "z") is None
```

--------------------------------

### get_token(uid)

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.utils.md

Documentation for the get_token function, including parameters, behavior, return values, and an example.

```APIDOC
## Function `get_token(uid: str) -> str | bool`

### Description
Retrieves a token for the given user ID by interacting with Xiaomi's captcha verification service. It handles captcha challenges and retries automatically.

### Method
Function call

### Endpoint
`get_token(uid)`

### Parameters
- `uid` (str) - Required - The account `cUserId` cookie value.

### Behavior
1. Builds the `GROW_UP_CHECKIN` risk-profile payload: `type=0`, `startTs`/`endTs` (both = now ms), a large `env` dict (`p1…p34`), `action` dict (`a1…a14`), `force=False`, `talkBack=False`, `uid`, `nonce={"t": now, "r": now}`, `version="2.0"`, `scene="GROW_UP_CHECKIN"`.
2. `key = get_random_chars_as_string(16)`; wraps the payload as `{"s": rsa_encrypt(PUBLIC_KEY_PEM, key), "d": aes_encrypt(key, str(data)), "a": "GROW_UP_CHECKIN"}` and `POST https://verify.sec.xiaomi.com/captcha/v2/data` with params `k`, `locale=zh_CN`, `_t`.
3. `TokenResultHandler`:
   - `success` → return token.
   - `need_verify` → log `遇到人机验证码, 尝试调用解决方案`; `get_token_by_captcha(api_data.data["url"])`; success → return token, else `raise ValueError("人机验证失败")`.
   - else → return `False`.
4. Wrapped in `Retrying(stop=stop_after_attempt(3))`; on `RetryError`: if `is_incorrect_return(error)` log `TOKEN - 服务器没有正确返回 {response.text}`, else `获取TOKEN异常`; return `False`.

### Returns
- `str` — the obtained token.
- `bool` — `False` when the verify API rejected the request without a solvable captcha or when retries were exhausted.

### Example with error handling
```python
from utils.utils import get_token

token = get_token(cookies["cUserId"])
if token:
    CheckIn(account, token).sign()
else:
    log.error("no token — captcha required but not configured")
```
```

--------------------------------

### user_info usage example

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.api.sign.md

Calls user_info on a BaseSign instance and prints the title and point attributes of the result.

```python
ui = BaseSign(account).user_info()
print(ui.title, ui.point)
```

--------------------------------

### login() with error handling

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.api.login.md

Example of calling login() with error handling. If login returns False, it raises RuntimeError; otherwise the returned cookies contain passToken and are usable for BaseSign.

```python
from utils.api.login import Login

cookies = Login(account).login()
if not cookies:
    # check logs: "请设置 login_user_agent" / "小米账号登录失败：..." /
    # "当前账号需要短信验证码, ..." / "获取Cookie失败，可能是 login_user_agent 异常"
    raise RuntimeError("login failed")
# cookies["passToken"] and community cookies are usable for BaseSign

```

--------------------------------

### Class ConfigManager

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.config.md

Documentation for the ConfigManager class, including its class attributes, load_config and write_plugin_data class methods, and usage example.

```APIDOC
## Class `ConfigManager`

Source: `utils/config.py`, line 215. Class-method style manager for loading and persisting the config file.

```python
class ConfigManager:
    """配置管理器"""

    data_obj = Config()
    platform = "platform_example"  # 示例平台

    @classmethod
    def load_config(cls):
        """
        加载插件数据文件
        """

    @classmethod
    def write_plugin_data(cls, data: Config = None):
        """
        写入插件数据文件
        :param data: 配置对象
        """
```

| Class attribute | Type | Description |
|-----------------|------|-------------|
| `data_obj` | `Config` | Global config instance; replaced on every `load_config()` call. Read by `utils/request.py`, `utils/captcha.py` and `miuitask.py` at import time |
| `platform` | str | `"platform_example"` placeholder; not used in the current source |

### `load_config()` behavior

- If `CONFIG_PATH` exists and is a file: parse as JSON or YAML depending on `CONFIG_TYPE`, build a `Config` via `Config.from_dict`, assign `cls.data_obj`, then call `write_plugin_data(cls.data_obj)` ("sync" write-back). On any exception: `log.exception(...)` and **re-raise**.
- If not: create `DATA_PATH` if needed, write the default `cls.data_obj` to disk, log `数据文件 {CONFIG_PATH} 不存在，已创建默认数据文件。`. On failure: `log.exception(...)` and **re-raise**.

### `write_plugin_data(data: Config = None)` behavior

- `data=None` → uses `cls.data_obj`.
- JSON type: `json.dump(data.to_dict(), file, indent=4, ensure_ascii=False)`.
- YAML type: `yaml.dump(data.to_dict(), file, indent=4, allow_unicode=True, sort_keys=False)`.
- Returns `True` on success; on `json.JSONDecodeError` / `yaml.YAMLError` logs via `log.exception(...)` and returns `False`. (Note: JSON *write* errors are `JSONDecodeError`, i.e. only raised on malformed serialization, not on I/O problems.)

### Example

```python
from utils.config import ConfigManager, Account

ConfigManager.load_config()
ConfigManager.data_obj.accounts.append(Account(uid="999999", CheckIn=True))
ConfigManager.write_plugin_data()          # persists data_obj to data/config.{json|yaml}

# after editing the file, reload
ConfigManager.load_config()
```
```

--------------------------------

### Define print_info() function

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.system_info.md

Defines print_info(), which logs the project banner and platform information. It takes no parameters, returns None, and is called once at the start of miuitask.main().

```python
def print_info():
    """打印系统信息"""
    log.info(f"MIUI-AUTO-TASK {VERSION}")
    log.info("---------- 系统信息 -------------")
    system_info()
    log.info("---------- 项目信息 -------------")
    log.info("这是一个免费且开源的项目，如果你是付费购买获得请务必退款")
    log.info("项目地址：https://github.com/0-8-4/miui-auto-tasks")
    log.info("欢迎 star，感谢所有项目贡献者，已经提交issues的人，帮助项目发展的人")
    log.info("---------- 脚本日志 -------------")
```

--------------------------------

### Iterate daily tasks with check_daily_tasks()

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.api.sign.md

Example usage of check_daily_tasks() to iterate over daily tasks and print their name, status (done/pending), and description.

```python
from utils.api.sign import BaseSign

for task in BaseSign(account).check_daily_tasks():
    print(task.name, "done" if task.showType else "pending", task.desc)
```

--------------------------------

### DailyTasksResult usage example

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.data_model.md

Shows how to instantiate DailyTasksResult and verify the showType field. The assertion checks that showType is False, indicating the task is not yet completed.

```python
from utils.data_model import DailyTasksResult

t = DailyTasksResult(name="每日签到", showType=False, desc="每日签到")
assert t.showType == False  # still to be executed
```

--------------------------------

### Define get wrapper for requests.get

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.request.md

Thin wrapper around requests.get with keyword-only parameters. The docstring advertises data/json parameters, but they are not explicit parameters and must be passed through **kwargs. Returns whatever requests.get returns, typically a requests.Response.

```python
def get(
    url: str,
    *,
    headers: Optional[Dict[str, str]] = None,
    params: Optional[Dict[str, Any]] = None,
    timeout: Optional[int] = 20,
    **kwargs,
):
    """
    说明：
        get请求封装
    参数：
        :param url: url
        :param headers: 请求头
        :param params: params
        :param data: data
        :param json: json
        :param timeout: 超时时间
    """
    return requests.get(url, headers=headers, params=params, timeout=timeout, **kwargs)
```

--------------------------------

### SignResultHandler usage example

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.data_model.md

Demonstrates SignResultHandler usage: a successful response yields growth as a string and bool True; a 401 response sets ck_invalid True and bool False.

```python
from utils.data_model import SignResultHandler

ok = SignResultHandler({"entity": {"score": 5}, "status": 200, "message": "成功"})
assert bool(ok) is True and ok.growth == "5"

bad = SignResultHandler({"status": 401})
assert bad.ck_invalid is True and bool(bad) is False
```

--------------------------------

### get

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.request.md

A thin wrapper around `requests.get` that forwards all arguments to the underlying library. It accepts a URL, optional headers, query parameters, and a timeout, and returns a `requests.Response` object.

```APIDOC
## Function `get`

### Description
A thin wrapper around `requests.get` that forwards all arguments to the underlying library. It accepts a URL, optional headers, query parameters, and a timeout, and returns a `requests.Response` object.

### Signature
python
def get(
    url: str,
    *,
    headers: Optional[Dict[str, str]] = None,
    params: Optional[Dict[str, Any]] = None,
    timeout: Optional[int] = 20,
    **kwargs,
):


### Parameters
- **url** (str) - Required - Request URL
- **headers** (Optional[Dict[str, str]]) - Optional - Request headers; any `headers=` passed in `**kwargs` would conflict (duplicate keyword)
- **params** (Optional[Dict[str, Any]]) - Optional - Query parameters
- **timeout** (Optional[int]) - Optional - Timeout seconds for the underlying `requests.get` (default: `20`)
- **kwargs** (Any) - Optional - Forwarded to `requests.get` (e.g. `cookies=`, `data=`, `json=`, `allow_redirects=`, `follow_redirects=` is NOT a requests kwarg)

### Returns
Returns whatever `requests.get` returns — a `requests.Response`.

### Example
python
from utils.request import get

resp = get(
    "https://api-alpha.vip.miui.com/mtop/planet/vip/member/getCheckinPageCakeList",
    cookies={"miui_vip_a_ph": "..."},
    allow_redirects=False,
)
print(resp.status_code, resp.json())


> The docstring advertises `data`/`json` parameters, but they are not explicit parameters — they must be passed through `**kwargs`.
```

--------------------------------

### Account.__init__

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.config.md

Constructor for the Account class. Initializes an account with credentials, user agents, device info, and task flags.

```APIDOC
## Account.__init__

### Description
Initializes a new Account instance with the provided parameters. All parameters are stored as instance attributes with the same names.

### Method
Constructor

### Parameters
#### Constructor Parameters
- **uid** (str) - Optional - Account ID, not the username or phone number. Default: `"100000"`
- **password** (str) - Optional - Password or its 32-char MD5 hash. Shorter values are MD5-hashed via `_password`. Default: `""`
- **cookies** (Union[dict, str]) - Optional - Logged-in cookies; string form is parsed with `cookies_to_dict`. Normalized to `{}` when falsy. Default: `None`
- **login_user_agent** (str) - Optional - Browser User-Agent used during account login (required — `Login.login()` aborts if empty). Default: `""`
- **user_agent** (str) - Optional - User-Agent used when talking to the community API. Default: `"Mozilla/5.0 (Linux; Android 13) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/116.0.0.0 Safari/537.36"`
- **device** (str) - Optional - Device code (`device` param in `BaseSign` request params). Default: `""`
- **device_model** (str) - Optional - Device name (`model` param in `BaseSign` request params). Default: `""`
- **CheckIn** (bool) - Optional - Enable daily check-in. Enabling implies accepting the associated risk. Default: `False`
- **BrowseUserPage** (bool) - Optional - Browse user home page 10 s task. Default: `False`
- **BrowsePost** (bool) - Optional - Browse a post 10 s task. Default: `False`
- **BrowseVideoPost** (bool) - Optional - Browse video posts 5 min task. Default: `False`
- **ThumbUp** (bool) - Optional - Like a post. Default: `False`
- **BrowseSpecialPage** (bool) - Optional - Browse limited-time special pages. Default: `False`
- **BoardFollow** (bool) - Optional - Join a board (“加入圈子”). Default: `False`
- **CarrotPull** (bool) - Optional - Carrot-pull (“拔萝卜”) task. Default: `False`
- **WxSign** (bool) - Optional - WeChat mini-program check-in. Default: `False`

### Request Example
```python
from utils.config import Account, md5_crypto

acc = Account(
    uid="12345678",
    password="my-plain-password",          # auto MD5-hashed, uppercased
    login_user_agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) Chrome/120.0",
    device="MIUI:V816.0.23.12.11.DEV",
    device_model="Xiaomi 14",
    CheckIn=True,
    ThumbUp=True,
)
```

### Response
#### Success Response
- **uid** (str) - Account ID
- **password** (str) - Password (possibly MD5-hashed)
- **cookies** (dict) - Cookies dictionary
- **login_user_agent** (str) - Login User-Agent
- **user_agent** (str) - User-Agent for community API
- **device** (str) - Device code
- **device_model** (str) - Device model
- **CheckIn** (bool) - Daily check-in flag
- **BrowseUserPage** (bool) - Browse user page flag
- **BrowsePost** (bool) - Browse post flag
- **BrowseVideoPost** (bool) - Browse video post flag
- **ThumbUp** (bool) - Like post flag
- **BrowseSpecialPage** (bool) - Browse special page flag
- **BoardFollow** (bool) - Join board flag
- **CarrotPull** (bool) - Carrot pull flag
- **WxSign** (bool) - WeChat sign flag

#### Response Example
```python
assert acc.password == md5_crypto("my-plain-password")
assert acc.CheckIn is True and acc.WxSign is False
```
```

--------------------------------

### Account class __init__ with default parameters

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.config.md

Defines the Account class constructor with all configurable parameters. The uid is the account ID, not username; password can be plain or MD5-hashed; cookies can be dict or string; login_user_agent is required for login; task flags default to False.

```python
# pylint: disable=too-many-instance-attributes
class Account:
    """账号处理器"""

    # pylint: disable=too-many-arguments, too-many-positional-arguments, too-many-locals
    def __init__(
        self,
        uid="100000",
        password="",
        cookies=None,
        login_user_agent="",
        user_agent="Mozilla/5.0 (Linux; Android 13) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/116.0.0.0 Safari/537.36",
        device="",
        device_model="",
        CheckIn=False,
        BrowseUserPage=False,
        BrowsePost=False,
        BrowseVideoPost=False,
        ThumbUp=False,
        BrowseSpecialPage=False,
        BoardFollow=False,
        CarrotPull=False,
        WxSign=False,
    ):
```

--------------------------------

### get_validate_other usage example

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.captcha.md

Example usage of get_validate_other. Calls it with sample gt, challenge, and result, then builds a seccode string from the returned validate value if present.

```python
from utils.captcha import get_validate_other

r = get_validate_other(gt="G1", challenge="C1", result="{}")
if r.validate:
    seccode = f"{r.validate}|jordan"
```

--------------------------------

### Function main() definition

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/miuitask.md

Defines the main() function with a docstring '启动签到'. This function is the core entry point that orchestrates the sign-in process for all configured accounts.

```python
def main():
    """启动签到"""
```

--------------------------------

### show_info(tip: str, info: str)

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.system_info.md

Simple string formatter `"{tip}: {info}"`.

```APIDOC
## Function `show_info(tip: str, info: str)`

### Description
Simple string formatter `"{tip}: {info}"`.

### Signature
```python
def show_info(tip: str, info: str):
    """格式化输出"""
    return f"{tip}: {info}"
```

### Parameters
- **tip** (str) - Required - Label prefix
- **info** (str) - Required - Value

### Returns
Formatted string `"{tip}: {info}"`.

### Example
```python
from utils.system_info import show_info

print(show_info("版本", "1.0.0"))   # "版本: 1.0.0"
```
```

--------------------------------

### Register all task classes in BaseSign.AVAILABLE_SIGNS

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.api.sign.md

Maps each task name to its class in the registry. miuitask.main() resolves tasks by these names and gates them via getattr(account, task_cls.__name__), e.g., account.CheckIn.

```python
BaseSign.AVAILABLE_SIGNS[WxSign.NAME] = WxSign
BaseSign.AVAILABLE_SIGNS[CheckIn.NAME] = CheckIn
BaseSign.AVAILABLE_SIGNS[BrowsePost.NAME] = BrowsePost
BaseSign.AVAILABLE_SIGNS[BrowseVideoPost.NAME] = BrowseVideoPost
BaseSign.AVAILABLE_SIGNS[BrowseUserPage.NAME] = BrowseUserPage
BaseSign.AVAILABLE_SIGNS[BrowseSpecialPage.NAME] = BrowseSpecialPage
BaseSign.AVAILABLE_SIGNS[BoardFollow.NAME] = BoardFollow
BaseSign.AVAILABLE_SIGNS[BoardUnFollow.NAME] = BoardUnFollow
BaseSign.AVAILABLE_SIGNS[ThumbUp.NAME] = ThumbUp
BaseSign.AVAILABLE_SIGNS[CarrotPull.NAME] = CarrotPull
```

--------------------------------

### system_info()

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.system_info.md

Logs seven platform fields (`platform.platform()`, `platform.version()`, `platform.system()`, `platform.architecture()`, `platform.machine()`, `platform.processor()`, Python version + build) and, only when `urllib.request.getproxies()` returns a non-empty dict, the detected system proxy configuration.

```APIDOC
## Function `system_info()`

### Description
Logs seven platform fields and, when detected, the system proxy configuration.

### Signature
```python
def system_info():
    """系统信息"""
    log.info(show_info("操作系统平台", platform.platform()))
    log.info(show_info("操作系统版本", platform.version()))
    log.info(show_info("操作系统名称", platform.system()))
    log.info(show_info("操作系统位元", platform.architecture()))
    log.info(show_info("操作系统类型", platform.machine()))
    log.info(show_info("处理器信息", platform.processor()))
    log.info(
        show_info(
            "Python 版本",
            str(platform.python_version()) + " " + str(platform.python_build()),
        )
    )
    if getproxies():
        log.info(show_info("系统代理", getproxies()))
```

### Parameters
None.

### Returns
`None`

### Example
```python
from utils.system_info import system_info

system_info()   # logs "操作系统平台: ..." etc.
```
```

--------------------------------

### print_info()

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.system_info.md

Logs the project banner and platform information through the `log` logger. Called once at the very beginning of `miuitask.main()`.

```APIDOC
## Function `print_info()`

### Description
Logs the project banner and platform information through the `log` logger. Called once at the very beginning of `miuitask.main()`.

### Signature
```python
def print_info():
    """打印系统信息"""
    log.info(f"MIUI-AUTO-TASK {VERSION}")
    log.info("---------- 系统信息 -------------")
    system_info()
    log.info("---------- 项目信息 -------------")
    log.info("这是一个免费且开源的项目，如果你是付费购买获得请务必退款")
    log.info("项目地址：https://github.com/0-8-4/miui-auto-tasks")
    log.info("欢迎 star，感谢所有项目贡献者，已经提交issues的人，帮助项目发展的人")
    log.info("---------- 脚本日志 -------------")
```

### Parameters
None.

### Returns
`None`

### Example
```python
from utils.system_info import print_info

print_info()   # run at the start of a task run
```
```

--------------------------------

### BaseSign.__init__(account, token=None)

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.api.sign.md

Constructor for the BaseSign class. Initializes headers and base request parameters from the provided account and optional token.

```APIDOC
## BaseSign.__init__(account, token=None)

### Description
Constructor for the BaseSign class. Initializes headers and base request parameters from the provided account and optional token.

### Method
Constructor

### Parameters
- **account** (utils.config.Account) - Required - Source of cookies, user_agent, device, device_model
- **token** (Optional[str]) - Optional - The GROW_UP_CHECKIN token (from utils.get_token) used by CheckIn

### Request Example
```python
acc = Account(uid="100000", user_agent="Mozilla/5.0 (Linux; Android 13) ...", CheckIn=True)
acc.cookies = {"miui_vip_a_ph": "from-login", "cUserId": "100000"}
sign = BaseSign(acc)
```

### Response
#### Success Response
- **self.headers** (dict) - Fixed browser headers including Host, Accept, Origin, X-Requested-With, Referer, and User-Agent
- **self.params** (dict) - Base request parameters including ref, pathname, version, miui_version, android_version, oaid, device, restrict_imei, miui_big_version, model, androidVersion, miuiBigVersion, miui_vip_a_ph
```

--------------------------------

### get_cookies: Fetch community cookies via GET

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.api.login.md

Performs a single GET request without following redirects and returns the response cookie jar as a dict. Returns False on any exception, logging the failure. This method is public for external use and is not called anywhere in the current source.

```python
def get_cookies(self, url: str) -> Union[Dict[str, str], bool]:
    """获取社区 Cookie"""
    try:
        response = get(url, follow_redirects=False)
        log.debug(response.text)
        return dict(response.cookies)
    except Exception:  # pylint: disable=broad-exception-caught
        log.exception("社区获取 Cookie 失败")
        return False
```

--------------------------------

### BrowseVideoPost.sign()

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.api.sign.md

Adds growth points for browsing videos for over 5 minutes.

```APIDOC
## BrowseVideoPost.sign()

### Description
浏览指定页面的多个视频超过5分钟（中途退出重新计算时间）。

### Method
POST

### Endpoint
https://api-alpha.vip.miui.com/mtop/planet/vip/member/addCommunityGrowUpPointByActionV2

### Parameters
#### Request Body
- action (string) - Required - BROWSE_VIDEO_POST
- miui_vip_a_ph (string) - Required - 用户标识
- token (string) - Required - 用户 token

### Response
- Returns a tuple (success: bool, message: str).
```

--------------------------------

### Define system_info() function

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.system_info.md

Defines system_info(), which logs seven platform fields and, only when urllib.request.getproxies() returns a non-empty dict, the detected system proxy configuration. Takes no parameters and returns None.

```python
def system_info():
    """系统信息"""
    log.info(show_info("操作系统平台", platform.platform()))
    log.info(show_info("操作系统版本", platform.version()))
    log.info(show_info("操作系统名称", platform.system()))
    log.info(show_info("操作系统位元", platform.architecture()))
    log.info(show_info("操作系统类型", platform.machine()))
    log.info(show_info("处理器信息", platform.processor()))
    log.info(
        show_info(
            "Python 版本",
            str(platform.python_version()) + " " + str(platform.python_build()),
        )
    )
    if getproxies():
        log.info(show_info("系统代理", getproxies()))
```

--------------------------------

### Login(account: Account)

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.api.login.md

Constructor for the Login class, initializing with an Account object.

```APIDOC
## Login(account: Account)

### Description
Constructor for the `Login` class. Initializes the instance with account credentials and cookies.

### Parameters
- **account** (utils.config.Account) - Required - The account to authenticate. Copies `login_user_agent`, `uid`, `password`, `cookies` into instance attributes.

### Example
```python
from utils.config import Account
from utils.api.login import Login

acc = Account(uid="100000", password="<md5>", login_user_agent="Mozilla/5.0 ...")
login_obj = Login(acc)
cookies = login_obj.login()
```
```

--------------------------------

### get_cookies_by_passtk(user_id: str, pass_token: str) -> dict

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.api.login.md

使用 passToken 获取签到 cookies。通过固定流程（两次 GET 请求）获取社区 Cookie 字典，异常时返回空字典。

```APIDOC
## get_cookies_by_passtk(user_id: str, pass_token: str) -> dict

### Description
使用 passToken 获取签到 cookies。通过固定流程（两次 GET 请求）获取社区 Cookie 字典，异常时返回空字典。

### Method
GET

### Endpoint
`https://api-alpha.vip.miui.com/page/login`（首次请求）

### Parameters
#### Path Parameters
- **user_id** (str) - Required - 小米数字用户 ID
- **pass_token** (str) - Required - 从密码或二维码登录获取的 `passToken`

#### Query Parameters
- **destUrl** (str) - Required - 固定值 `https://web.vip.miui.com/page/info/mio/mio/checkIn?app_version=dev.230904`
- **time** (str) - Required - 毫秒级时间戳

### Request Example
```python
cookies = Login(account).get_cookies_by_passtk("100000", "session-passToken-value")
```

### Response
#### Success Response (200)
- **cookies** (dict) - 最终跳转的 Cookie 字典

#### Response Example
```python
assert "miui_vip_a_ph" in cookies  # 社区 token cookie
```

### Error Handling
异常时返回空字典 `{}`。
```

--------------------------------

### get_cookies(url: str) -> Union[Dict[str, str], bool]

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.api.login.md

获取社区 Cookie。发送单个 GET 请求（不跟随重定向，无自定义请求头），返回响应 Cookie 字典，异常时返回 False。

```APIDOC
## get_cookies(url: str) -> Union[Dict[str, str], bool]

### Description
获取社区 Cookie。发送单个 GET 请求（不跟随重定向，无自定义请求头），返回响应 Cookie 字典，异常时返回 False。

### Method
GET

### Endpoint
任意 URL（由调用方提供）

### Parameters
#### Path Parameters
- **url** (str) - Required - 任意 URL，其重定向链会设置社区 Cookie

### Request Example
```python
cookies = Login(account).get_cookies("https://web.vip.miui.com/")
```

### Response
#### Success Response (200)
- **cookies** (Dict[str, str]) - 响应 Cookie 字典

#### Response Example
```python
assert isinstance(cookies, dict)
```

### Error Handling
异常时返回 `False`。
```

--------------------------------

### Define show_info() function

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.system_info.md

Defines show_info(), a simple string formatter that returns "{tip}: {info}". The annotation str is not strictly enforced at runtime; platform.architecture() and getproxies() return tuples/dicts that are interpolated via f-string.

```python
def show_info(tip: str, info: str):
    """格式化输出"""
    return f"{tip}: {info}"
```

--------------------------------

### sign() with cookie error handling

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.api.sign.md

Example usage of sign() with error handling. Raises ValueError when the reason is 'cookie', matching the handling in miuitask.main().

```python
from utils.api.sign import ThumbUp

status, reason = ThumbUp(account).sign()
if not status and reason == "cookie":
    raise ValueError("Cookie失效")   # same handling as miuitask.main()
```

--------------------------------

### Using UserInfoResult with BaseSign.user_info()

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/types.md

Shows how to obtain a UserInfoResult instance via BaseSign.user_info() and access its title and point attributes. The ui.title and ui.point are used in logging.

```python
from utils.api.sign import BaseSign

ui = BaseSign(account).user_info()
log.info(f"{ui.title} 成长值: {ui.point}")
```

--------------------------------

### user_info method definition

Source: https://github.com/0-8-4/miui-auto-tasks/blob/master/_autodocs/api-reference/utils.api.sign.md

Defines the user_info method that returns a UserInfoResult. It makes a GET request to the mineInfo endpoint with retries and returns a default UserInfoResult on failure.

```python
def user_info(self) -> UserInfoResult:
    """获取用户信息"""
```
Tokens:
Raw