mirror of
https://github.com/agentscope-ai/ReMe.git
synced 2026-10-03 02:24:31 +00:00
83bfddb4a4
* refactor(config): streamline job descriptions and parameter docs - Simplify descriptions for search, traverse, list, read, stat, frontmatter:read, write, edit, append, frontmatter:update, frontmatter:delete, move, delete, upload, upload_resource, and download jobs - Shorten parameter descriptions to be more concise - Maintain essential information while reducing verbosity refactor(steps): rename daily steps and consolidate functionality - Rename daily_resolve_step to daily_read_step - Rename daily_create_step to daily_write_step - Update __init__.py imports to reflect new step names - Consolidate daily operations documentation refactor(daily): extract helper functions and improve structure - Rename _day_index.py to _daily_io.py - Extract validate_slug function for Windows-safe filename validation - Move scan_notes function to public interface - Add comprehensive docstrings explaining slug validation and day-index rebuild concerns feat(daily): decouple list operation from index refresh - Remove automatic day index refresh from daily_list_step - Change daily_list_step to pure read operation with no side effects - Sort notes by slug for stable output - Update documentation to clarify read/write separation refactor(daily): remove deprecated create step - Remove unused daily/create.py module - Simplify daily operations to focus on CRUD patterns * refactor(daily): replace module imports with explicit step class imports
91 lines
2.9 KiB
Python
91 lines
2.9 KiB
Python
"""``daily_read`` — read a daily note by slug + date; return body + parsed frontmatter.
|
|
|
|
Convenience wrapper around the generic ``read`` step for the
|
|
``daily/<YYYY-MM-DD>/<slug>.md`` path shape. The value over a raw
|
|
``file_read`` is two-fold:
|
|
|
|
* slug validation (Windows-safe filename rules) up front
|
|
* frontmatter parsed into a dict in metadata, so callers don't need a
|
|
separate ``frontmatter_read`` round-trip
|
|
|
|
Inputs:
|
|
slug (required, validated)
|
|
date (default today, ISO ``YYYY-MM-DD``)
|
|
|
|
Outputs:
|
|
answer = note body (frontmatter stripped)
|
|
metadata = {date, slug, path, exists, frontmatter: dict}
|
|
|
|
For arbitrary-path reads or ranged reads use the generic ``read`` step.
|
|
"""
|
|
|
|
from datetime import date as _date
|
|
|
|
import frontmatter
|
|
|
|
from ._daily_io import validate_slug
|
|
from ..crud._file_io import read_file_safe
|
|
from ..base_step import BaseStep
|
|
from ...components import R
|
|
|
|
|
|
@R.register("daily_read_step")
|
|
class DailyReadStep(BaseStep):
|
|
"""Read ``daily/<date>/<slug>.md`` → body + parsed frontmatter."""
|
|
|
|
def _fail(self, message: str, **meta) -> None:
|
|
assert self.context is not None
|
|
self.context.response.success = False
|
|
self.context.response.answer = f"Error: {message}"
|
|
if meta:
|
|
self.context.response.metadata.update(meta)
|
|
|
|
async def execute(self):
|
|
assert self.context is not None
|
|
slug: str = self.context.get("slug", "") or ""
|
|
day: str = (self.context.get("date") or "").strip() or _date.today().isoformat()
|
|
|
|
err = validate_slug(slug)
|
|
if err:
|
|
self._fail(err)
|
|
return None
|
|
|
|
daily_dir = self.app_context.app_config.daily_dir if self.app_context is not None else "daily"
|
|
path_rel = f"{daily_dir}/{day}/{slug}.md"
|
|
path_abs = (self.vault_path / path_rel).resolve()
|
|
|
|
if not path_abs.is_file():
|
|
self._fail(
|
|
f"note {path_rel} does not exist",
|
|
date=day,
|
|
slug=slug,
|
|
path=path_rel,
|
|
exists=False,
|
|
)
|
|
return None
|
|
|
|
try:
|
|
text = await read_file_safe(path_abs)
|
|
except Exception as e: # pylint: disable=broad-except
|
|
self._fail(f"read failed: {e}", date=day, slug=slug, path=path_rel)
|
|
return None
|
|
|
|
post = frontmatter.loads(text)
|
|
body = post.content
|
|
meta = dict(post.metadata or {})
|
|
|
|
self.context.response.success = True
|
|
self.context.response.answer = body
|
|
self.context.response.metadata.update(
|
|
{
|
|
"date": day,
|
|
"slug": slug,
|
|
"path": path_rel,
|
|
"exists": True,
|
|
"frontmatter": meta,
|
|
},
|
|
)
|
|
self.logger.info(
|
|
f"[{self.name}] read path={path_rel} " f"bytes={len(body.encode('utf-8'))} fm_keys={list(meta)}",
|
|
)
|
|
return self.context.response
|