mkdocs-document-dates 3.8.0__tar.gz → 3.8.1__tar.gz

{mkdocs_document_dates-3.8.0/mkdocs_document_dates.egg-info → mkdocs_document_dates-3.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.8.0
+Version: 3.8.1
 Summary: A new generation MkDocs plugin for displaying exact creation date, last updated date, authors, email of documents
 Author-email: Aaron Wang <aaronwqt@gmail.com>
 License-Expression: MIT
@@ -44,6 +44,8 @@ A new generation MkDocs plugin for displaying exact **creation date, last update
 | git-revision-date-localized<br />git-authors |  ＞ 3 s   |  ＞ 30 s   |    O(n)    |
 | document-dates              | < 0.1 s  | < 0.15 s  |    O(1)    |
 
+> It's 20-500 times faster than `git-revision-date-localized` and `git-authors`
+
 ## Installation
 
 ```bash

{mkdocs_document_dates-3.8.0 → mkdocs_document_dates-3.8.1}/README.md

@@ -26,6 +26,8 @@ A new generation MkDocs plugin for displaying exact **creation date, last update
 | git-revision-date-localized<br />git-authors |  ＞ 3 s   |  ＞ 30 s   |    O(n)    |
 | document-dates              | < 0.1 s  | < 0.15 s  |    O(1)    |
 
+> It's 20-500 times faster than `git-revision-date-localized` and `git-authors`
+
 ## Installation
 
 ```bash

{mkdocs_document_dates-3.8.0 → mkdocs_document_dates-3.8.1}/mkdocs_document_dates/cache_manager.py

@@ -10,13 +10,19 @@ from .utils import read_jsonl_cache, write_jsonl_cache, load_file_creation_date,
 logger = logging.getLogger("mkdocs.plugins.document_dates")
 _LOGGING_CONFIGURED = False
 
+CONFIG_PRIORITY = {
+    "mkdocs.yml": 0,
+    "properdocs.yml": 1,
+    "mkdocs.yaml": 2,
+    "properdocs.yaml": 3,
+}
 
 def _default_log_file() -> Path:
     try:
         git_root = Path(subprocess.check_output(
-            ['git', 'rev-parse', '--show-toplevel'],
+            ["git", "rev-parse", "--show-toplevel"],
             env=_clean_git_env(),
-            encoding='utf-8'
+            encoding="utf-8"
         ).strip())
         base_dir = git_root
     except Exception:
@@ -82,20 +88,29 @@ def _clean_git_env():
 
     return env
 
-def find_mkdocs_projects():
-    projects = set()
+def find_mkdocs_projects() -> dict[Path, Path]:
+    projects = {}
 
     try:
         git_root = Path(subprocess.check_output(
-            ['git', 'rev-parse', '--show-toplevel'],
+            ["git", "rev-parse", "--show-toplevel"],
             env=_clean_git_env(),
-            encoding='utf-8'
+            encoding="utf-8"
         ).strip())
 
-        target_names = {'mkdocs.yml', 'properdocs.yml'}
-        for config_file in git_root.rglob('*.yml'):
-            if config_file.name.lower() in target_names:
-                projects.add(config_file.parent)
+        for pattern in ("*.yml", "*.yaml"):
+            for config_file in git_root.rglob(pattern):
+                name = config_file.name.lower()
+                if name not in CONFIG_PRIORITY:
+                    continue
+
+                project_dir = config_file.parent
+                existing = projects.get(project_dir)
+                if existing is None:
+                    projects[project_dir] = config_file
+                    continue
+                if CONFIG_PRIORITY[name] < CONFIG_PRIORITY[existing.name.lower()]:
+                    projects[project_dir] = config_file
 
         if not projects:
             logger.warning("No MkDocs/ProperDocs projects found in the repository")
@@ -105,19 +120,19 @@ def find_mkdocs_projects():
     except Exception as e:
         logger.error(f"Unexpected error while searching for projects: {e}")
 
-    return list(projects)
+    return projects
 
 def setup_gitattributes(docs_dir: Path):
     try:
-        gitattributes_path = docs_dir / '.gitattributes'
+        gitattributes_path = docs_dir / ".gitattributes"
         union_merge_line = ".dates_cache.jsonl merge=union"
         # custom_merge_line = ".dates_cache.json merge=custom_json_merge"
-        content = gitattributes_path.read_text(encoding='utf-8') if gitattributes_path.exists() else ""
+        content = gitattributes_path.read_text(encoding="utf-8") if gitattributes_path.exists() else ""
         if union_merge_line not in content:
-            if content and not content.endswith('\n'):
-                content += '\n'
+            if content and not content.endswith("\n"):
+                content += "\n"
             content += f"{union_merge_line}\n"
-            gitattributes_path.write_text(content, encoding='utf-8')
+            gitattributes_path.write_text(content, encoding="utf-8")
             subprocess.run(["git", "add", str(gitattributes_path)], cwd=docs_dir, env=_clean_git_env(), check=True)
             logger.info(f"Updated .gitattributes file: {gitattributes_path}")
             return True
@@ -134,18 +149,14 @@ def update_cache():
         configure_file_logging(_default_log_file())
 
     global_updated = False
-    for project_dir in find_mkdocs_projects():
+    for project_dir, mkdocs_yml in find_mkdocs_projects().items():
         try:
             project_updated = False
 
-            docs_dir = project_dir / 'docs'
+            docs_dir = project_dir / "docs"
 
             # 从 mkdocs.yml 中读取 docs_dir 配置覆盖默认值
             try:
-                mkdocs_yml = project_dir / "properdocs.yml"
-                if not mkdocs_yml.exists():
-                    mkdocs_yml = project_dir / "mkdocs.yml"
-
                 mkdocs_config = yaml.load(
                     mkdocs_yml.read_text(encoding="utf-8"),
                     Loader=yaml.BaseLoader,
@@ -156,16 +167,16 @@ def update_cache():
             except (IOError, OSError, yaml.YAMLError) as e:
                 logger.warning(f"Failed to read docs_dir: {e}")
 
-            if not docs_dir.exists():
+            if not docs_dir.is_dir():
                 logger.info(f"Document directory does not exist: {docs_dir}")
                 continue
 
             # 设置.gitattributes文件
-            global_updated = setup_gitattributes(docs_dir)
+            global_updated |= setup_gitattributes(docs_dir)
 
             # 获取docs目录下已跟踪(tracked)的markdown文件
-            cmd = ['git', '-c', 'core.quotepath=false', 'ls-files', '*.md']
-            result = subprocess.run(cmd, cwd=docs_dir, env=_clean_git_env(), capture_output=True, encoding='utf-8')
+            cmd = ["git", "-c", "core.quotepath=false", "ls-files", "*.md"]
+            result = subprocess.run(cmd, cwd=docs_dir, env=_clean_git_env(), capture_output=True, encoding="utf-8")
             tracked_files = result.stdout.splitlines() if result.stdout else []
 
             if not tracked_files:
@@ -173,7 +184,7 @@ def update_cache():
                 continue
 
             # 读取 JSONL 缓存
-            jsonl_cache_file = docs_dir / '.dates_cache.jsonl'
+            jsonl_cache_file = docs_dir / ".dates_cache.jsonl"
             jsonl_dates_cache = read_jsonl_cache(jsonl_cache_file)
 
             # 根据 git已跟踪的文件来更新
@@ -204,7 +215,7 @@ def update_cache():
 
             # 如果有更新，写入 JSONL 缓存文件
             if project_updated or not jsonl_cache_file.exists():
-                global_updated = write_jsonl_cache(jsonl_cache_file, jsonl_dates_cache, tracked_files)
+                global_updated |= write_jsonl_cache(jsonl_cache_file, jsonl_dates_cache, tracked_files)
         except subprocess.CalledProcessError as e:
             logger.error(f"Failed to execute git command: {e}")
             continue

{mkdocs_document_dates-3.8.0 → mkdocs_document_dates-3.8.1}/mkdocs_document_dates/plugin.py

@@ -53,8 +53,14 @@ class DocumentDatesPlugin(BasePlugin):
         docs_dir_path = Path(config.docs_dir)
 
         # 加载 author 配置
-        authors_file = docs_dir_path / 'authors.yml'
-        if not authors_file.exists():
+        authors_file = None
+        for name in ("authors.yml", "authors.yaml"):
+            candidate = docs_dir_path / name
+            if candidate.exists():
+                authors_file = candidate
+                break
+
+        if authors_file is None:
             try:
                 blog_config = config.plugins.get(f"{config.theme.name}/blog").config
                 authors_file_resolved = blog_config.authors_file.format(blog=blog_config.blog_dir)
@@ -199,7 +205,7 @@ class DocumentDatesPlugin(BasePlugin):
         limit = recently_updated_config.get('limit', 10)
 
         # 获取站点 URL 路径前缀
-        site_url = config.get("site_url", "")
+        site_url = config.get("site_url") or ""
         base_path = urlparse(site_url).path.rstrip("/")
         prefix = f"{base_path}/" if base_path else "/"
 

{mkdocs_document_dates-3.8.0 → mkdocs_document_dates-3.8.1}/mkdocs_document_dates/utils.py

@@ -255,12 +255,15 @@ def read_jsonl_cache(jsonl_file: Path):
                         if entry and isinstance(entry, dict) and len(entry) == 1:
                             file_path, file_info = next(iter(entry.items()))
                             if isinstance(file_info, dict):
-                                if file_info.get('created'):
-                                    file_info['created'] = int(datetime.fromisoformat(file_info['created']).timestamp())
-                            dates_cache[file_path] = file_info
-                    except (json.JSONDecodeError, StopIteration, ValueError) as e:
+                                created = file_info.get('created')
+                                if isinstance(created, str):
+                                    file_info['created'] = int(datetime.fromisoformat(created).timestamp())
+                                elif isinstance(created, (int, float)):
+                                    file_info['created'] = int(created)
+                                dates_cache[file_path] = file_info
+                    except (json.JSONDecodeError, StopIteration, ValueError, TypeError,) as e:
                         logger.warning(f"Skipping invalid JSONL line: {e}")
-        except IOError as e:
+        except OSError as e:
             logger.warning(f"Error reading from '.dates_cache.jsonl': {str(e)}")
     return dates_cache
 
@@ -272,9 +275,10 @@ def write_jsonl_cache(jsonl_file: Path, dates_cache, tracked_files):
             for file_path in tracked_files:
                 if file_path in dates_cache:
                     file_info = dates_cache[file_path].copy()
-                    if file_info.get('created') is not None:
-                        file_info['created'] = datetime.fromtimestamp(file_info['created'], tz=timezone.utc).isoformat()
-                    entry = {file_path: dates_cache[file_path]}
+                    created = file_info.get('created')
+                    if created is not None:
+                        file_info['created'] = datetime.fromtimestamp(created, tz=timezone.utc).isoformat()
+                    entry = {file_path: file_info}
                     f.write(json.dumps(entry, ensure_ascii=False) + '\n')
         
         # 替换原文件
@@ -284,7 +288,7 @@ def write_jsonl_cache(jsonl_file: Path, dates_cache, tracked_files):
         subprocess.run(["git", "add", str(jsonl_file)], check=True)
         logger.info(f"Successfully updated JSONL cache file: {jsonl_file}")
         return True
-    except IOError as e:
+    except OSError as e:
         logger.warning(f"Failed to write JSONL cache file {jsonl_file}: {e}")
     except Exception as e:
         logger.warning(f"Failed to add JSONL cache file to git: {e}")

{mkdocs_document_dates-3.8.0 → mkdocs_document_dates-3.8.1/mkdocs_document_dates.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-document-dates
-Version: 3.8.0
+Version: 3.8.1
 Summary: A new generation MkDocs plugin for displaying exact creation date, last updated date, authors, email of documents
 Author-email: Aaron Wang <aaronwqt@gmail.com>
 License-Expression: MIT
@@ -44,6 +44,8 @@ A new generation MkDocs plugin for displaying exact **creation date, last update
 | git-revision-date-localized<br />git-authors |  ＞ 3 s   |  ＞ 30 s   |    O(n)    |
 | document-dates              | < 0.1 s  | < 0.15 s  |    O(1)    |
 
+> It's 20-500 times faster than `git-revision-date-localized` and `git-authors`
+
 ## Installation
 
 ```bash

{mkdocs_document_dates-3.8.0 → mkdocs_document_dates-3.8.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "mkdocs-document-dates"
-version = "3.8.0"
+version = "3.8.1"
 description = "A new generation MkDocs plugin for displaying exact creation date, last updated date, authors, email of documents"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.7"

{mkdocs_document_dates-3.8.0 → mkdocs_document_dates-3.8.1}/setup.py

@@ -4,7 +4,7 @@ from setuptools import find_packages, setup
 def legacy_setup():
     setup(
         name="mkdocs-document-dates",
-        version="3.8.0",
+        version="3.8.1",
         author="Aaron Wang",
         author_email="aaronwqt@gmail.com",
         license="MIT",