378 Filesystem 5eb9a720

文件系统

OpenViking 提供类 Unix 的文件系统操作来管理上下文。

API 参考

abstract()

读取 L0 摘要（~100 tokens 摘要）。

签名

def abstract(self, uri: str) -> str

参数

返回值

示例

import openviking as ov

client = ov.OpenViking(path="./data")
client.initialize()

abstract = client.abstract("viking://resources/docs/")
print(f"摘要: {abstract}")
# 输出: "项目 API 文档，涵盖认证、端点..."

client.close()

overview()

读取 L1 概览，针对目录生效。

签名

def overview(self, uri: str) -> str

参数

返回值

示例

import openviking as ov

client = ov.OpenViking(path="./data")
client.initialize()

overview = client.overview("viking://resources/docs/")
print(f"概览:\n{overview}")

client.close()

read()

读取 L2 完整内容。

签名

def read(self, uri: str) -> str

参数

返回值

示例

import openviking as ov

client = ov.OpenViking(path="./data")
client.initialize()

content = client.read("viking://resources/docs/api.md")
print(f"内容:\n{content}")

client.close()

ls()

列出目录内容。

签名

def ls(self, uri: str, **kwargs) -> List[Any]

参数

返回值

条目结构

{
    "name": "docs",           # 文件/目录名
    "size": 4096,             # 字节大小
    "mode": 16877,            # 文件模式
    "modTime": "2024-01-01T00:00:00Z",  # ISO 时间戳
    "isDir": True,            # 是否为目录
    "uri": "viking://resources/docs/",  # Viking URI
    "meta": {}                # 可选元数据
}

示例：基本列出

import openviking as ov

client = ov.OpenViking(path="./data")
client.initialize()

entries = client.ls("viking://resources/")
for entry in entries:
    type_str = "目录" if entry['isDir'] else "文件"
    print(f"{entry['name']} - {type_str}")

client.close()

tree()

获取目录树结构。

签名

def tree(self, uri: str) -> List[Dict]

参数

返回值

条目结构

[
    {
        "name": "docs",
        "size": 4096,
        "mode": 16877,
        "modTime": "2024-01-01T00:00:00Z",
        "isDir": True,
        "rel_path": "docs/",      # 相对于基础 URI 的路径
        "uri": "viking://resources/docs/"
    },
    ...
]

示例

import openviking as ov

client = ov.OpenViking(path="./data")
client.initialize()

entries = client.tree("viking://resources/")
for entry in entries:
    type_str = "目录" if entry['isDir'] else "文件"
    print(f"{entry['rel_path']} - {type_str}")

client.close()

rm()

删除文件或目录。

签名

def rm(self, uri: str, recursive: bool = False) -> None

参数

返回值

示例

import openviking as ov

client = ov.OpenViking(path="./data")
client.initialize()

# 删除单个文件
client.rm("viking://resources/docs/old.md")

# 递归删除目录
client.rm("viking://resources/old-project/", recursive=True)

client.close()

mv()

移动文件或目录。

签名

def mv(self, from_uri: str, to_uri: str) -> None

参数

返回值

示例

import openviking as ov

client = ov.OpenViking(path="./data")
client.initialize()

client.mv(
    "viking://resources/old-name/",
    "viking://resources/new-name/"
)

client.close()

grep()

按模式搜索内容。

签名

def grep(
    self,
    uri: str,
    pattern: str,
    case_insensitive: bool = False
) -> Dict

参数

返回值

返回结构

{
    "matches": [
        {
            "uri": "viking://resources/docs/auth.md",
            "line": 15,
            "content": "用户认证由..."
        }
    ],
    "count": 1
}

示例

import openviking as ov

client = ov.OpenViking(path="./data")
client.initialize()

results = client.grep(
    "viking://resources/",
    "认证",
    case_insensitive=True
)

print(f"找到 {results['count']} 个匹配")
for match in results['matches']:
    print(f"  {match['uri']}:{match['line']}")
    print(f"    {match['content']}")

client.close()

glob()

按模式匹配文件。

签名

def glob(self, pattern: str, uri: str = "viking://") -> Dict

参数

返回值

返回结构

{
    "matches": [
        "viking://resources/docs/api.md",
        "viking://resources/docs/guide.md"
    ],
    "count": 2
}

示例

import openviking as ov

client = ov.OpenViking(path="./data")
client.initialize()

# 查找所有 markdown 文件
results = client.glob("**/*.md", "viking://resources/")
print(f"找到 {results['count']} 个 markdown 文件:")
for uri in results['matches']:
    print(f"  {uri}")

# 查找所有 Python 文件
results = client.glob("**/*.py", "viking://resources/")
print(f"找到 {results['count']} 个 Python 文件")

client.close()

link()

创建资源之间的关联。

签名

def link(
    self,
    from_uri: str,
    uris: Any,
    reason: str = ""
) -> None

参数

返回值

示例

import openviking as ov

client = ov.OpenViking(path="./data")
client.initialize()

# 单个链接
client.link(
    "viking://resources/docs/auth/",
    "viking://resources/docs/security/",
    reason="认证的安全最佳实践"
)

# 多个链接
client.link(
    "viking://resources/docs/api/",
    [
        "viking://resources/docs/auth/",
        "viking://resources/docs/errors/"
    ],
    reason="相关文档"
)

client.close()

relations()

获取资源的关联。

签名

def relations(self, uri: str) -> List[Dict[str, Any]]

参数

返回值

返回结构

[
    {"uri": "viking://resources/docs/security/", "reason": "安全最佳实践"},
    {"uri": "viking://resources/docs/errors/", "reason": "错误处理"}
]

示例

import openviking as ov

client = ov.OpenViking(path="./data")
client.initialize()

relations = client.relations("viking://resources/docs/auth/")
for rel in relations:
    print(f"相关: {rel['uri']}")
    print(f"  原因: {rel['reason']}")

client.close()

unlink()

删除关联。

签名

def unlink(self, from_uri: str, uri: str) -> None

参数

返回值

示例

import openviking as ov

client = ov.OpenViking(path="./data")
client.initialize()

client.unlink(
    "viking://resources/docs/auth/",
    "viking://resources/docs/security/"
)

client.close()

相关文档

• Viking URI - URI 规范
• 上下文层级 - L0/L1/L2
• 资源管理 - 资源管理