Expose resource roots

未关闭
#125 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
python
领域
tooling

调研方向

Start by reading the existing ResourcePath and ResourceRoot implementations, especially resource_to_file_path() and file_to_resource_path(). Compare the proposed resource inspection and loading operations with the current internal root list, then define the exposed root API and verify that callers can identify providers, overrides, packaging, and modification changes.

由索引模型根据 Issue 内容生成。

描述

In order to implement ResourcePath.from_file_path() and Resource_path.file_path(), we internally keep a list of ResourceRoot objects. Exposing these roots could allow users to answer various tricky questions about resources:

  • Is a given resource from a zipped or unzipped package?
  • Does a given resource have overrides?
  • When was a given resource last modified?

This functionality could be useful for packages like OverrideAudit. In addition, it could be used to implement resource caching (#24): a resource must be reloaded if either the modification time or the resource root has changed.

As a first thought, a resource root could support the following operations:

  • resource_to_file_path(path) -> Path (already implemented)
  • file_to_resource_path(path) -> ResourcePath (already implemented)
  • resource_exists(path) → boolean
  • resource_modified(path) → timestamp
  • load_resource(path) → string
  • load_binary_resource(path) → bytes

The following operation would be provided at the ResourcePath level (or perhaps in a new class?):

  • roots_providing_resource(path) → List[ResourceRoot]
主要语言
Python
星标
56
派生
5
平均合并
19 分钟
30 天内合并 PR
4

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

SublimeText/sublime_lib 的其他 Issue

查看 SublimeText/sublime_lib 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。