ddns 4.0.0b6__tar.gz → 4.0.0b8__tar.gz

{ddns-4.0.0b6 → ddns-4.0.0b8}/PKG-INFO

@@ -1,14 +1,15 @@
 Metadata-Version: 2.4
 Name: ddns
-Version: 4.0.0b6
-Summary: automatically update DNS records to my IP [域名自动指向本机IP]
-Home-page: https://ddns.newfuture.cc
-Author: NewFuture
-Author-email: python@newfuture.cc
-License: MIT
-Project-URL: Bug Reports, https://github.com/NewFuture/DDNS/issues
+Version: 4.0.0b8
+Summary: Dynamic DNS client for multiple providers, supporting IPv4 and IPv6.
+Author-email: NewFuture <python@newfuture.cc>
+License-Expression: MIT
+Project-URL: Homepage, https://ddns.newfuture.cc
+Project-URL: Documentation, https://ddns.newfuture.cc
+Project-URL: Repository, https://github.com/NewFuture/DDNS
+Project-URL: Bug Tracker, https://github.com/NewFuture/DDNS/issues
 Project-URL: Source, https://github.com/NewFuture/DDNS
-Keywords: ddns ipv6 ipv4 dns dnspod alidns cloudflare
+Keywords: ddns,ipv6,ipv4,dns,dnspod,alidns,cloudflare
 Platform: any
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
@@ -19,27 +20,25 @@ Classifier: Topic :: Internet
 Classifier: Topic :: Internet :: Name Service (DNS)
 Classifier: Topic :: System :: Networking
 Classifier: Topic :: Software Development
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 2.7
 Classifier: Programming Language :: Python :: 3
-Requires-Python: >=2.5, <4
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=2.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
 Dynamic: license-file
-Dynamic: platform
-Dynamic: project-url
-Dynamic: requires-python
-Dynamic: summary
 
-# [<img src="doc/img/ddns.svg" width="32px" height="32px"/>](https://ddns.newfuture.cc) [DDNS](https://github.com/NewFuture/DDNS)
+# [<img src="https://ddns.newfuture.cc/doc/img/ddns.svg" width="32px" height="32px"/>](https://ddns.newfuture.cc) [DDNS](https://github.com/NewFuture/DDNS)
 
 > 自动更新 DNS 解析 到本机 IP 地址，支持 IPv4 和 IPv6，本地（内网）IP 和公网 IP。
 > 代理模式，支持自动创建 DNS 记录。
@@ -60,9 +59,9 @@ Dynamic: summary
   - [二进制文件](https://github.com/NewFuture/DDNS/releases/latest) ![cross platform](https://img.shields.io/badge/system-windows_%7C%20linux_%7C%20mac-success.svg?style=social)
   
 - 配置方式:
-  - [命令行参数](#详细配置)
-  - [JSON 配置文件](#详细配置)
-  - [环境变量配置](doc/env.md) 📖
+  - [命令行参数](https://ddns.newfuture.cc/doc/cli.html)
+  - [JSON 配置文件](https://ddns.newfuture.cc/doc/json.html)
+  - [环境变量配置](https://ddns.newfuture.cc/doc/env.html)
 
 - 域名支持:
   - 多个域名支持
@@ -138,6 +137,8 @@ Dynamic: summary
       newfuture/ddns
     ```
 
+  更多详细说明和高级用法请查看 [Docker 使用文档](doc/docker.md)。
+
 ### ② 快速配置
 
 1. 申请 api `token`，填写到对应的 `id` 和 `token` 字段:
@@ -155,12 +156,27 @@ Dynamic: summary
 
 ## 详细配置
 
-所有字段可通过三种方式进行配置
+所有字段可通过三种方式进行配置，优先级为：**命令行参数 > JSON配置文件 > 环境变量**
 
-1. 命令行参数 `ddns --key=value`（`ddns -h` 查看详情），优先级最高
-2. JSON 配置文件（值为 null 认为是有效值，会覆盖环境变量的设置，如果没有对应的 key 则会尝试使用环境变量）
+1. [命令行参数](doc/cli.md) `ddns --key=value`（`ddns -h` 查看详情），优先级最高
+2. [JSON 配置文件](doc/json.md)（值为 null 认为是有效值，会覆盖环境变量的设置，如果没有对应的 key 则会尝试使用环境变量）
 3. 环境变量 DDNS_ 前缀加上 key 全大写或者全小写，点转下划线（`${ddns_id}` 或 `${DDNS_ID}`，`${DDNS_LOG_LEVEL}`）
 
+### 配置优先级和字段覆盖关系
+
+如果同一个配置项在多个地方设置，将按照以下优先级规则生效：
+
+- **命令行参数**：优先级最高，会覆盖其他所有设置
+- **JSON配置文件**：介于命令行和环境变量之间，会覆盖环境变量中的设置
+- **环境变量**：优先级最低，当其他方式未设置时使用
+
+**特殊情况**：
+- JSON配置中明确设为`null`的值会覆盖环境变量设置
+- `debug`参数只在命令行中有效，JSON配置文件中的同名设置无效
+- 多值参数（如`ipv4`、`ipv6`等）在命令行中使用方式为重复使用参数，如`--ipv4 domain1 --ipv4 domain2`
+
+各配置方式的详细说明请查看对应文档：[命令行](doc/cli.md)、[JSON配置](doc/json.md)、[环境变量](doc/env.md)
+
 > 📖 **环境变量详细配置**: 查看 [环境变量配置文档](doc/env.md) 了解所有环境变量的详细用法和示例
 
 <details open>
@@ -169,6 +185,7 @@ Dynamic: summary
 - 首次运行会自动生成一个模板配置文件
 - 可以使用 `-c` 使用指定的配置文件（默认读取当前目录的 config.json）
 - 推荐使用 vscode 等支持 JsonSchema 的编辑器编辑配置文件
+- 查看 [JSON配置文件详细文档](doc/json.md) 了解完整的配置选项和示例
 
 ```bash
 ddns -c path/to/config.json
@@ -189,9 +206,9 @@ python run.py -c /path/to/config.json
 | index6   | string\|int\|array |    No    | `"default"` |   ipv6 获取方式   | 可设置 `网卡`、`内网`、`公网`、`正则` 等方式                                                                |
 |  ttl     |       number       |    No    |   `null`    | DNS 解析 TTL 时间 | 不设置采用 DNS 默认策略                                                                                     |
 |  proxy   |       string\|array       |    No    |     无      | http 代理 `;` 分割 | 多代理逐个尝试直到成功，`DIRECT` 为直连                                                                     |
-| ~~debug~~|        bool        |    No    |   `false`   |   是否开启调试    | v4 中弃用，请改用 log.level=DEBUG                                                                           |
+|  debug  |        bool        |    No    |   `false`   |   是否开启调试    | 等同于设置 log.level=DEBUG，仅命令行参数`--debug`有效                                                  |
 |  cache   |    string\|bool    |    No    |   `true`    |   是否缓存记录    | 正常情况打开避免频繁更新，默认位置为临时目录下 `ddns.cache`，也可以指定一个具体路径                          |
-|  log     | {"level":string,"file":string} | No | `null` | 日志配置（可选） | 日志配置，日志级别和路径（默认命令行），例如：`{ "level": "DEBUG", "file": "dns.log" }`                    |
+|  log     | object | No | `null` | 日志配置（可选） | 日志配置对象，支持`level`、`file`、`format`、`datefmt`参数                   |
 
 #### index4 和 index6 参数说明
 
@@ -237,7 +254,9 @@ python run.py -c /path/to/config.json
   "proxy": "127.0.0.1:1080;DIRECT",
   "log": {
     "level": "DEBUG",
-    "file": "dns.log"
+    "file": "dns.log",
+    "format": "%(asctime)s %(levelname)s [%(module)s]: %(message)s",
+    "datefmt": "%Y-%m-%dT%H:%M:%S"
   }
 }
 ```

{ddns-4.0.0b6 → ddns-4.0.0b8}/README.md

@@ -1,4 +1,4 @@
-# [<img src="doc/img/ddns.svg" width="32px" height="32px"/>](https://ddns.newfuture.cc) [DDNS](https://github.com/NewFuture/DDNS)
+# [<img src="https://ddns.newfuture.cc/doc/img/ddns.svg" width="32px" height="32px"/>](https://ddns.newfuture.cc) [DDNS](https://github.com/NewFuture/DDNS)
 
 > 自动更新 DNS 解析 到本机 IP 地址，支持 IPv4 和 IPv6，本地（内网）IP 和公网 IP。
 > 代理模式，支持自动创建 DNS 记录。
@@ -19,9 +19,9 @@
   - [二进制文件](https://github.com/NewFuture/DDNS/releases/latest) ![cross platform](https://img.shields.io/badge/system-windows_%7C%20linux_%7C%20mac-success.svg?style=social)
   
 - 配置方式:
-  - [命令行参数](#详细配置)
-  - [JSON 配置文件](#详细配置)
-  - [环境变量配置](doc/env.md) 📖
+  - [命令行参数](https://ddns.newfuture.cc/doc/cli.html)
+  - [JSON 配置文件](https://ddns.newfuture.cc/doc/json.html)
+  - [环境变量配置](https://ddns.newfuture.cc/doc/env.html)
 
 - 域名支持:
   - 多个域名支持
@@ -97,6 +97,8 @@
       newfuture/ddns
     ```
 
+  更多详细说明和高级用法请查看 [Docker 使用文档](doc/docker.md)。
+
 ### ② 快速配置
 
 1. 申请 api `token`，填写到对应的 `id` 和 `token` 字段:
@@ -114,12 +116,27 @@
 
 ## 详细配置
 
-所有字段可通过三种方式进行配置
+所有字段可通过三种方式进行配置，优先级为：**命令行参数 > JSON配置文件 > 环境变量**
 
-1. 命令行参数 `ddns --key=value`（`ddns -h` 查看详情），优先级最高
-2. JSON 配置文件（值为 null 认为是有效值，会覆盖环境变量的设置，如果没有对应的 key 则会尝试使用环境变量）
+1. [命令行参数](doc/cli.md) `ddns --key=value`（`ddns -h` 查看详情），优先级最高
+2. [JSON 配置文件](doc/json.md)（值为 null 认为是有效值，会覆盖环境变量的设置，如果没有对应的 key 则会尝试使用环境变量）
 3. 环境变量 DDNS_ 前缀加上 key 全大写或者全小写，点转下划线（`${ddns_id}` 或 `${DDNS_ID}`，`${DDNS_LOG_LEVEL}`）
 
+### 配置优先级和字段覆盖关系
+
+如果同一个配置项在多个地方设置，将按照以下优先级规则生效：
+
+- **命令行参数**：优先级最高，会覆盖其他所有设置
+- **JSON配置文件**：介于命令行和环境变量之间，会覆盖环境变量中的设置
+- **环境变量**：优先级最低，当其他方式未设置时使用
+
+**特殊情况**：
+- JSON配置中明确设为`null`的值会覆盖环境变量设置
+- `debug`参数只在命令行中有效，JSON配置文件中的同名设置无效
+- 多值参数（如`ipv4`、`ipv6`等）在命令行中使用方式为重复使用参数，如`--ipv4 domain1 --ipv4 domain2`
+
+各配置方式的详细说明请查看对应文档：[命令行](doc/cli.md)、[JSON配置](doc/json.md)、[环境变量](doc/env.md)
+
 > 📖 **环境变量详细配置**: 查看 [环境变量配置文档](doc/env.md) 了解所有环境变量的详细用法和示例
 
 <details open>
@@ -128,6 +145,7 @@
 - 首次运行会自动生成一个模板配置文件
 - 可以使用 `-c` 使用指定的配置文件（默认读取当前目录的 config.json）
 - 推荐使用 vscode 等支持 JsonSchema 的编辑器编辑配置文件
+- 查看 [JSON配置文件详细文档](doc/json.md) 了解完整的配置选项和示例
 
 ```bash
 ddns -c path/to/config.json
@@ -148,9 +166,9 @@ python run.py -c /path/to/config.json
 | index6   | string\|int\|array |    No    | `"default"` |   ipv6 获取方式   | 可设置 `网卡`、`内网`、`公网`、`正则` 等方式                                                                |
 |  ttl     |       number       |    No    |   `null`    | DNS 解析 TTL 时间 | 不设置采用 DNS 默认策略                                                                                     |
 |  proxy   |       string\|array       |    No    |     无      | http 代理 `;` 分割 | 多代理逐个尝试直到成功，`DIRECT` 为直连                                                                     |
-| ~~debug~~|        bool        |    No    |   `false`   |   是否开启调试    | v4 中弃用，请改用 log.level=DEBUG                                                                           |
+|  debug  |        bool        |    No    |   `false`   |   是否开启调试    | 等同于设置 log.level=DEBUG，仅命令行参数`--debug`有效                                                  |
 |  cache   |    string\|bool    |    No    |   `true`    |   是否缓存记录    | 正常情况打开避免频繁更新，默认位置为临时目录下 `ddns.cache`，也可以指定一个具体路径                          |
-|  log     | {"level":string,"file":string} | No | `null` | 日志配置（可选） | 日志配置，日志级别和路径（默认命令行），例如：`{ "level": "DEBUG", "file": "dns.log" }`                    |
+|  log     | object | No | `null` | 日志配置（可选） | 日志配置对象，支持`level`、`file`、`format`、`datefmt`参数                   |
 
 #### index4 和 index6 参数说明
 
@@ -196,7 +214,9 @@ python run.py -c /path/to/config.json
   "proxy": "127.0.0.1:1080;DIRECT",
   "log": {
     "level": "DEBUG",
-    "file": "dns.log"
+    "file": "dns.log",
+    "format": "%(asctime)s %(levelname)s [%(module)s]: %(message)s",
+    "datefmt": "%Y-%m-%dT%H:%M:%S"
   }
 }
 ```

ddns-4.0.0b8/ddns/__init__.py

@@ -0,0 +1,19 @@
+# -*- coding:utf-8 -*-
+"""
+ddns Package
+"""
+
+__description__ = "automatically update DNS records to my IP [域名自动指向本机IP]"
+
+# 编译时，版本会被替换
+__version__ = "4.0.0b8"
+
+# 时间也会被替换掉
+build_date = "2025-06-19T10:36:16Z"
+
+__doc__ = """
+ddns[{}@{}]
+(i) homepage or docs [文档主页]: https://ddns.newfuture.cc/
+(?) issues or bugs [问题和反馈]: https://github.com/NewFuture/DDNS/issues
+Copyright (c) New Future (MIT License)
+""".format(__version__, build_date)

ddns-4.0.0b6/run.py → ddns-4.0.0b8/ddns/__main__.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python
 # -*- coding:utf-8 -*-
 """
 DDNS
@@ -10,24 +9,16 @@ from os import path, environ, name as os_name
 from io import TextIOWrapper
 from subprocess import check_output
 from tempfile import gettempdir
-from logging import basicConfig, info, warning, error, debug
+from logging import basicConfig, info, warning, error, debug, DEBUG, NOTSET
 
 import sys
 
-from util import ip
-from util.cache import Cache
-from util.config import init_config, get_config
+from .__init__ import __version__, __description__, __doc__, build_date
+from .util import ip
+from .util.cache import Cache
+from .util.config import init_config, get_config
 
-__version__ = "v4.0.0-beta6@2025-06-12T17:22:06+00:00"  # CI 时会被Tag替换
-__description__ = "automatically update DNS records to my IP [域名自动指向本机IP]"
-__doc__ = """
-ddns[%s]
-(i) homepage or docs [文档主页]: https://ddns.newfuture.cc/
-(?) issues or bugs [问题和帮助]: https://github.com/NewFuture/DDNS/issues
-Copyright (c) New Future (MIT License)
-""" % (__version__)
-
-environ["DDNS_VERSION"] = "v4.0.0-beta6"
+environ["DDNS_VERSION"] = __version__
 
 
 def is_false(value):
@@ -99,44 +90,62 @@ def update_ip(ip_type, cache, dns, proxy_list):
     if not domains:
         return None
     if not isinstance(domains, list):
-        domains = domains.strip('; ').replace(
-            ',', ';').replace(' ', ';').split(';')
-    index_rule = get_config('index' + ip_type, "default")  # 从配置中获取index配置
+        domains = domains.strip('; ').replace(',', ';').replace(' ', ';').split(';')
+
+    index_rule = get_config('index' + ip_type, "default")
     address = get_ip(ip_type, index_rule)
     if not address:
         error('Fail to get %s address!', ipname)
         return False
-    elif cache and (address == cache[ipname]):
+
+    if cache and (address == cache.get(ipname)):
         info('%s address not changed, using cache.', ipname)
         return True
-    record_type = (ip_type == '4') and 'A' or 'AAAA'
-    update_fail = False  # https://github.com/NewFuture/DDNS/issues/16
+
+    record_type = 'A' if ip_type == '4' else 'AAAA'
+    update_success = False
     for domain in domains:
-        domain = domain.lower()  # https://github.com/NewFuture/DDNS/issues/431
+        domain = domain.lower()
         if change_dns_record(dns, proxy_list, domain=domain, ip=address, record_type=record_type):
-            update_fail = True
-    if cache is not False:
-        # 如果更新失败删除缓存
-        cache[ipname] = update_fail and address
+            update_success = True
+
+    if isinstance(cache, dict):
+        cache[ipname] = update_success and address
+
+    return update_success
 
 
 def main():
     """
     更新
     """
-    init_config(__description__, __doc__, __version__)
+    encode = sys.stdout.encoding
+    if encode is not None and encode.lower() != 'utf-8' and hasattr(sys.stdout, 'buffer'):
+        # 兼容windows 和部分ASCII编码的老旧系统
+        sys.stdout = TextIOWrapper(sys.stdout.buffer, encoding='utf-8')
+        sys.stderr = TextIOWrapper(sys.stderr.buffer, encoding='utf-8')
+    init_config(__description__, __doc__, __version__, build_date)
 
+    log_level = get_config('log.level')
+    log_format = get_config('log.format', '%(asctime)s %(levelname)s [%(module)s]: %(message)s')
+    # Override log format in debug mode to include filename and line number for detailed debugging
+    if (log_level == DEBUG or log_level == NOTSET) and not log_format:
+        log_format = '%(asctime)s %(levelname)s [%(filename)s:%(lineno)d]: %(message)s'
     basicConfig(
-        level=get_config('log.level'),
-        format='%(asctime)s [%(levelname)s] %(message)s',
-        datefmt='%m-%d %H:%M:%S',
+        level=log_level,
+        format=log_format,
+        datefmt=get_config('log.datefmt', '%Y-%m-%dT%H:%M:%S'),
         filename=get_config('log.file'),
     )
+
     info("DDNS[ %s ] run: %s %s", __version__, os_name, sys.platform)
 
     # Dynamically import the dns module as configuration
     dns_provider = str(get_config('dns', 'dnspod').lower())
-    dns = getattr(__import__('dns', fromlist=[dns_provider]), dns_provider)
+    # dns_module = __import__(
+    #     '.dns', fromlist=[dns_provider], package=__package__)
+    dns = getattr(__import__('ddns.provider', fromlist=[dns_provider]), dns_provider)
+    # dns = getattr(dns_module, dns_provider)
     dns.Config.ID = get_config('id')
     dns.Config.TOKEN = get_config('token')
     dns.Config.TTL = get_config('ttl')
@@ -168,23 +177,4 @@ def main():
 
 
 if __name__ == '__main__':
-    encode = sys.stdout.encoding
-    if encode is not None and encode.lower() != 'utf-8' and hasattr(sys.stdout, 'buffer'):
-        # 兼容windows 和部分ASCII编码的老旧系统
-        sys.stdout = TextIOWrapper(sys.stdout.buffer, encoding='utf-8')
-        sys.stderr = TextIOWrapper(sys.stderr.buffer, encoding='utf-8')
     main()
-
-# Nuitka Project Configuration
-# nuitka-project: --mode=onefile
-# nuitka-project: --output-filename=ddns
-# nuitka-project: --product-name=DDNS
-# nuitka-project: --product-version=0.0.0
-# nuitka-project: --onefile-tempdir-spec="{TEMP}/{PRODUCT}_{VERSION}"
-# nuitka-project: --no-deployment-flag=self-execution
-# nuitka-project: --company-name="New Future"
-# nuitka-project: --copyright=https://ddns.newfuture.cc
-# nuitka-project: --assume-yes-for-downloads
-# nuitka-project: --python-flag=no_site,no_asserts,no_docstrings,isolated,static_hashes
-# nuitka-project: --nofollow-import-to=tkinter,unittest,pydoc,doctest,distutils,setuptools,lib2to3,test,idlelib,lzma
-# nuitka-project: --noinclude-dlls=liblzma.*

{ddns-4.0.0b6/dns → ddns-4.0.0b8/ddns/provider}/dnspod_com.py

@@ -6,7 +6,7 @@ http://www.dnspod.com/docs/domains.html
 @author: New Future
 """
 
-from dns.dnspod import *  # noqa: F403
+from .dnspod import *  # noqa: F403
 
 API.SITE = "api.dnspod.com"  # noqa: F405
 API.DEFAULT = "default"  # noqa: F405