from MacroMen/cseslib4py #1
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…d add default values for attr simplified_name, teacher, room
审阅者指南本次 PR 重构了 CSES Python 库：用统一的 CSES 类（由基于 pydantic 的数据模型支持）替换了遗留的解析器/生成器类，引入了自定义错误处理和实用函数，并全面修订了文档和打包。 新 CSES YAML 数据结构的 ER 图erDiagram
SUBJECTS {
string name
string simplified_name
string teacher
string room
}
SCHEDULES {
string name
int enable_day
string weeks
}
CLASSES {
string subject
string start_time
string end_time
}
SUBJECTS ||--o{ CLASSES : "referenced by"
SCHEDULES ||--o{ CLASSES : "contains"
SCHEDULES {
string name
}
CLASSES {
string subject
}
新 CSES 数据模型及支持类型的类图classDiagram
class CSES {
+schedule: list[SingleDaySchedule]
+version: int
+subjects: dict[str, Subject]
+__init__(content: str)
-_load(content: str)
}
class Subject {
+name: str
+simplified_name: str
+teacher: str
+room: str
}
class Lesson {
+subject: Subject
+start_time: datetime.time
+end_time: datetime.time
}
class WeekType {
<<enum>>
+ALL
+ODD
+EVEN
}
class SingleDaySchedule {
+enable_day: int
+classes: list[Lesson]
+name: str
+weeks: WeekType
+is_enabled_on_week(week: int): bool
+is_enabled_on_day(start_day: datetime.date, day: datetime.date): bool
}
class Schedule {
<<UserList[SingleDaySchedule]>>
+__getitem__(index: int): SingleDaySchedule
}
CSES --> "*" SingleDaySchedule : schedule
CSES --> "*" Subject : subjects
SingleDaySchedule --> "*" Lesson : classes
Lesson --> Subject : subject
SingleDaySchedule --> WeekType : weeks
Schedule --> "*" SingleDaySchedule
自定义错误类型的类图classDiagram
class CSESError {
<<Exception>>
}
class ParseError {
<<Exception>>
}
class VersionError {
<<Exception>>
}
ParseError --|> CSESError
VersionError --|> CSESError
遗留解析器/生成器移除和替换的类图classDiagram
class CSESParser {
-file_path: str
-data: dict
-version: int
-subjects: list
-schedules: list
-_load_file()
-_parse_data()
+get_subjects()
+get_schedules()
+get_schedule_by_day(day)
+is_cses_file(file_path)
}
class CSESGenerator {
-version: int
-subjects: list
-schedules: list
+add_subject(...)
+add_schedule(...)
+generate_cses_data()
+save_to_file(file_path)
}
class CSES {
}
CSES ..> CSESParser : "replacement for CSESParser"
CSES ..> CSESGenerator : "replacement for CSESGenerator"
文件级别更改
提示和命令与 Sourcery 互动
自定义您的体验访问您的 仪表板 以：
获取帮助Original review guide in EnglishReviewer's GuideThis PR refactors the CSES Python library: replacing legacy parser/generator classes with a unified CSES class backed by pydantic-based data models, introduces custom error handling and utility functions, and overhauls documentation and packaging. ER diagram for new CSES YAML data structureerDiagram
SUBJECTS {
string name
string simplified_name
string teacher
string room
}
SCHEDULES {
string name
int enable_day
string weeks
}
CLASSES {
string subject
string start_time
string end_time
}
SUBJECTS ||--o{ CLASSES : "referenced by"
SCHEDULES ||--o{ CLASSES : "contains"
SCHEDULES {
string name
}
CLASSES {
string subject
}
Class diagram for new CSES data model and supporting typesclassDiagram
class CSES {
+schedule: list[SingleDaySchedule]
+version: int
+subjects: dict[str, Subject]
+__init__(content: str)
-_load(content: str)
}
class Subject {
+name: str
+simplified_name: str
+teacher: str
+room: str
}
class Lesson {
+subject: Subject
+start_time: datetime.time
+end_time: datetime.time
}
class WeekType {
<<enum>>
+ALL
+ODD
+EVEN
}
class SingleDaySchedule {
+enable_day: int
+classes: list[Lesson]
+name: str
+weeks: WeekType
+is_enabled_on_week(week: int): bool
+is_enabled_on_day(start_day: datetime.date, day: datetime.date): bool
}
class Schedule {
<<UserList[SingleDaySchedule]>>
+__getitem__(index: int): SingleDaySchedule
}
CSES --> "*" SingleDaySchedule : schedule
CSES --> "*" Subject : subjects
SingleDaySchedule --> "*" Lesson : classes
Lesson --> Subject : subject
SingleDaySchedule --> WeekType : weeks
Schedule --> "*" SingleDaySchedule
Class diagram for custom error typesclassDiagram
class CSESError {
<<Exception>>
}
class ParseError {
<<Exception>>
}
class VersionError {
<<Exception>>
}
ParseError --|> CSESError
VersionError --|> CSESError
Class diagram for legacy parser/generator removal and replacementclassDiagram
class CSESParser {
-file_path: str
-data: dict
-version: int
-subjects: list
-schedules: list
-_load_file()
-_parse_data()
+get_subjects()
+get_schedules()
+get_schedule_by_day(day)
+is_cses_file(file_path)
}
class CSESGenerator {
-version: int
-subjects: list
-schedules: list
+add_subject(...)
+add_schedule(...)
+generate_cses_data()
+save_to_file(file_path)
}
class CSES {
}
CSES ..> CSESParser : "replacement for CSESParser"
CSES ..> CSESGenerator : "replacement for CSESGenerator"
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
嗨，我已审阅了你的更改——以下是一些反馈：
- 在你的错误处理 f 字符串中，你在单引号字符串内使用了单引号（例如
{data['subjects']}），这将导致语法错误——请将外部引号切换为双引号或转义内部引号。 - 考虑将
CSES.schedule属性重命名为schedules（或类似复数形式），以更好地反映它包含多个SingleDaySchedule对象并避免混淆。 - 在加载 YAML 后添加显式检查，以确保
subjects和schedules等必需的顶级键存在，这样你就可以快速失败并提供清晰的错误，而不是稍后引发KeyError。
给 AI 代理的提示
请处理此代码审查中的评论：
## 总体评论
- 在你的错误处理 f 字符串中，你在单引号字符串内使用了单引号（例如 `{data['subjects']}`），这将导致语法错误——请将外部引号切换为双引号或转义内部引号。
- 考虑将 `CSES.schedule` 属性重命名为 `schedules`（或类似复数形式），以更好地反映它包含多个 `SingleDaySchedule` 对象并避免混淆。
- 在加载 YAML 后添加显式检查，以确保 `subjects` 和 `schedules` 等必需的顶级键存在，这样你就可以快速失败并提供清晰的错误，而不是稍后引发 `KeyError`。
## 单独评论
### 评论 1
<location> `cses/__init__.py:52` </location>
<code_context>
+ data = yaml.safe_load(content)
+
+ # 版本处理&检查
+ self.version = data['version']
+ if self.version != 1:
+ raise err.VersionError(f'不支持的版本号: {self.version}')
</code_context>
<issue_to_address>
**issue:** 如果缺少 'version' 键，直接访问可能会引发 KeyError。
请使用 data.get('version') 并处理 None 情况，以避免 KeyError 并在缺少 'version' 时提供更清晰的错误消息。
</issue_to_address>
### 评论 2
<location> `cses/__init__.py:25-34` </location>
<code_context>
+ raise err.VersionError(f'不支持的版本号: {self.version}')
+
+ # 科目处理&检查
try:
- with open(file_path, 'r', encoding='utf-8') as f:
- data = yaml.safe_load(f)
- return 'version' in data and 'subjects' in data and 'schedules' in data
- except:
- return False
-
-# 生成器
-class CSESGenerator:
- def __init__(self, version=1):
- """
- 初始化 CSES 生成器
-
- Args:
- version (int, optional): CSES 格式的版本号，默认为 1
- """
- self.version = version
- self.subjects = []
- self.schedules = []
+ self.subjects = {s['name']: st.Subject(**s) for s in data['subjects']}
+ except st.ValidationError as e:
+ raise err.ParseError(f'科目数据有误: {data['subjects']}') from e
</code_context>
<issue_to_address>
**suggestion:** 科目构建假设所有必需字段都存在且有效。
在引发的 ParseError 中包含特定的验证错误详细信息（e.errors() 或 str(e)）以改进调试。
</issue_to_address>
### 评论 3
<location> `cses/__init__.py:66` </location>
<code_context>
- for cls in schedule['classes']:
- print(f"- {cls['subject']} ({cls['start_time']} - {cls['end_time']})")
+ # 先构造课程列表，再构造课表
+ schedule_classes = {i['name']: i['classes'] for i in schedules}
+ built_lessons = {i['name']: [] for i in schedules}
+ for name, classes in schedule_classes.items():
</code_context>
<issue_to_address>
**issue:** 假设每个日程条目都存在 'name' 和 'classes' 键。
验证每个日程条目都包含 'name' 和 'classes' 键，以防止 KeyError 异常。
</issue_to_address>
### 评论 4
<location> `cses/__init__.py:70-71` </location>
<code_context>
+ built_lessons = {i['name']: [] for i in schedules}
+ for name, classes in schedule_classes.items():
+ for lesson in classes:
+ built_lessons[name].append(
+ st.Lesson(**(lesson | {'subject': self.subjects[lesson['subject']]}))
+ ) # 从self.subjects中获取合法的Subject对象
+
</code_context>
<issue_to_address>
**issue:** 依赖 Python 3.9+ 字典联合运算符和科目查找。
如果 self.subjects 中缺少 lesson['subject']，将发生 KeyError。请添加错误处理以在这种情况下提供更清晰的消息。
</issue_to_address>
### 评论 5
<location> `cses/__init__.py:75-83` </location>
<code_context>
+ enable_day=day['enable_day'],
+ classes=built_lessons[day['name']],
+ name=day['name'],
+ weeks=st.WeekType(day['weeks']),
+ )
+ for day in schedules
</code_context>
<issue_to_address>
**suggestion (bug_risk):** WeekType 构造假设有效值。
捕获来自 st.WeekType(day['weeks']) 的 ValueError，并在遇到无效值时引发带有清晰消息的 ParseError。
```suggestion
self.schedule = []
for day in schedules:
try:
week_type = st.WeekType(day['weeks'])
except ValueError as ve:
raise err.ParseError(
f"Invalid weeks value '{day['weeks']}' for day '{day['name']}': {ve}"
) from ve
self.schedule.append(
st.SingleDaySchedule(
enable_day=day['enable_day'],
classes=built_lessons[day['name']],
name=day['name'],
weeks=week_type,
)
)
```
</issue_to_address>
### 评论 6
<location> `cses/utils.py:26` </location>
<code_context>
+ >>> week_num(datetime.date(2025, 9, 1), datetime.date(2025, 10, 24))
+ 8
+ """
+ return (day - start_day).days // 7 + 1
</code_context>
<issue_to_address>
**suggestion (bug_risk):** week_num 未验证 day >= start_day。
如果 day 在 start_day 之前，函数可能会返回 0 或负值。请添加检查以适当处理这种情况。
</issue_to_address>
### 评论 7
<location> `docs/source/conf.py:10` </location>
<code_context>
project = 'cseslib4py'
copyright = '2025, MacrosMeng'
author = 'MacrosMeng'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
import os
import sys
sys.path.insert(0, os.path.abspath('../../'))
extensions = [
'sphinx.ext.napoleon',
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
]
templates_path = ['_templates']
exclude_patterns = []
language = 'zh-cn'
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = 'furo'
html_static_path = ['_static']
</code_context>
<issue_to_address>
**issue (code-quality):** 不要将值赋给内置变量 `copyright` ([`avoid-builtin-shadow`](https://docs.sourcery.ai/Reference/Default-Rules/comments/avoid-builtin-shadow/))
<br/><details><summary>Explanation</summary>Python 有许多 `builtin` 变量：构成语言一部分的函数和常量，例如 `list`、`getattr` 和 `type`（参见 https://docs.python.org/3/library/functions.html）。在语言中，重新绑定此类变量是有效的：
```python
list = [1, 2, 3]
```
但是，这被认为是不良实践。
- 它会混淆其他开发人员。
- 它会混淆语法高亮器和 linter。
- 这意味着你不能再将该内置函数用于其原始目的。
你如何解决这个问题？
将变量重命名为更具体的内容，例如 `integers`。在紧急情况下，`my_list` 和类似名称是约定俗成的占位符。</details>
</issue_to_address>帮助我更有用！请点击每个评论上的 👍 或 👎，我将使用反馈来改进你的评论。
Original comment in English
Hey there - I've reviewed your changes - here's some feedback:
- In your error handling f-strings you’re using single quotes inside single-quoted strings (e.g.
{data['subjects']}), which will cause a syntax error—switch the outer quotes to double quotes or escape the inner ones. - Consider renaming the
CSES.scheduleattribute toschedules(or something plural) to better reflect that it holds multipleSingleDayScheduleobjects and to avoid confusion. - Add an explicit check after loading YAML to ensure that required top-level keys like
subjectsandschedulesexist, so you can fail fast with a clear error instead of raising aKeyErrorlater.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In your error handling f-strings you’re using single quotes inside single-quoted strings (e.g. `{data['subjects']}`), which will cause a syntax error—switch the outer quotes to double quotes or escape the inner ones.
- Consider renaming the `CSES.schedule` attribute to `schedules` (or something plural) to better reflect that it holds multiple `SingleDaySchedule` objects and to avoid confusion.
- Add an explicit check after loading YAML to ensure that required top-level keys like `subjects` and `schedules` exist, so you can fail fast with a clear error instead of raising a `KeyError` later.
## Individual Comments
### Comment 1
<location> `cses/__init__.py:52` </location>
<code_context>
+ data = yaml.safe_load(content)
+
+ # 版本处理&检查
+ self.version = data['version']
+ if self.version != 1:
+ raise err.VersionError(f'不支持的版本号: {self.version}')
</code_context>
<issue_to_address>
**issue:** Direct access to 'version' key may raise KeyError if missing.
Use data.get('version') and handle the None case to avoid KeyError and provide a clearer error message if 'version' is missing.
</issue_to_address>
### Comment 2
<location> `cses/__init__.py:25-34` </location>
<code_context>
+ raise err.VersionError(f'不支持的版本号: {self.version}')
+
+ # 科目处理&检查
try:
- with open(file_path, 'r', encoding='utf-8') as f:
- data = yaml.safe_load(f)
- return 'version' in data and 'subjects' in data and 'schedules' in data
- except:
- return False
-
-# 生成器
-class CSESGenerator:
- def __init__(self, version=1):
- """
- 初始化 CSES 生成器
-
- Args:
- version (int, optional): CSES 格式的版本号，默认为 1
- """
- self.version = version
- self.subjects = []
- self.schedules = []
+ self.subjects = {s['name']: st.Subject(**s) for s in data['subjects']}
+ except st.ValidationError as e:
+ raise err.ParseError(f'科目数据有误: {data['subjects']}') from e
</code_context>
<issue_to_address>
**suggestion:** Subject construction assumes all required fields are present and valid.
Include the specific validation error details (e.errors() or str(e)) in the raised ParseError to improve debugging.
</issue_to_address>
### Comment 3
<location> `cses/__init__.py:66` </location>
<code_context>
- for cls in schedule['classes']:
- print(f"- {cls['subject']} ({cls['start_time']} - {cls['end_time']})")
+ # 先构造课程列表，再构造课表
+ schedule_classes = {i['name']: i['classes'] for i in schedules}
+ built_lessons = {i['name']: [] for i in schedules}
+ for name, classes in schedule_classes.items():
</code_context>
<issue_to_address>
**issue:** Assumes 'name' and 'classes' keys exist for every schedule entry.
Validate that each schedule entry contains both 'name' and 'classes' keys to prevent KeyError exceptions.
</issue_to_address>
### Comment 4
<location> `cses/__init__.py:70-71` </location>
<code_context>
+ built_lessons = {i['name']: [] for i in schedules}
+ for name, classes in schedule_classes.items():
+ for lesson in classes:
+ built_lessons[name].append(
+ st.Lesson(**(lesson | {'subject': self.subjects[lesson['subject']]}))
+ ) # 从self.subjects中获取合法的Subject对象
+
</code_context>
<issue_to_address>
**issue:** Relies on Python 3.9+ dict union operator and subject lookup.
If lesson['subject'] is missing from self.subjects, a KeyError will occur. Please add error handling to provide a clearer message in this case.
</issue_to_address>
### Comment 5
<location> `cses/__init__.py:75-83` </location>
<code_context>
+ enable_day=day['enable_day'],
+ classes=built_lessons[day['name']],
+ name=day['name'],
+ weeks=st.WeekType(day['weeks']),
+ )
+ for day in schedules
</code_context>
<issue_to_address>
**suggestion (bug_risk):** WeekType construction assumes valid values.
Catch ValueError from st.WeekType(day['weeks']) and raise a ParseError with a clear message if an invalid value is encountered.
```suggestion
self.schedule = []
for day in schedules:
try:
week_type = st.WeekType(day['weeks'])
except ValueError as ve:
raise err.ParseError(
f"Invalid weeks value '{day['weeks']}' for day '{day['name']}': {ve}"
) from ve
self.schedule.append(
st.SingleDaySchedule(
enable_day=day['enable_day'],
classes=built_lessons[day['name']],
name=day['name'],
weeks=week_type,
)
)
```
</issue_to_address>
### Comment 6
<location> `cses/utils.py:26` </location>
<code_context>
+ >>> week_num(datetime.date(2025, 9, 1), datetime.date(2025, 10, 24))
+ 8
+ """
+ return (day - start_day).days // 7 + 1
</code_context>
<issue_to_address>
**suggestion (bug_risk):** week_num does not validate that day >= start_day.
If day is before start_day, the function may return 0 or negative values. Please add a check to handle this case appropriately.
</issue_to_address>
### Comment 7
<location> `docs/source/conf.py:10` </location>
<code_context>
project = 'cseslib4py'
copyright = '2025, MacrosMeng'
author = 'MacrosMeng'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
import os
import sys
sys.path.insert(0, os.path.abspath('../../'))
extensions = [
'sphinx.ext.napoleon',
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
]
templates_path = ['_templates']
exclude_patterns = []
language = 'zh-cn'
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = 'furo'
html_static_path = ['_static']
</code_context>
<issue_to_address>
**issue (code-quality):** Don't assign to builtin variable `copyright` ([`avoid-builtin-shadow`](https://docs.sourcery.ai/Reference/Default-Rules/comments/avoid-builtin-shadow/))
<br/><details><summary>Explanation</summary>Python has a number of `builtin` variables: functions and constants that
form a part of the language, such as `list`, `getattr`, and `type`
(See https://docs.python.org/3/library/functions.html).
It is valid, in the language, to re-bind such variables:
```python
list = [1, 2, 3]
```
However, this is considered poor practice.
- It will confuse other developers.
- It will confuse syntax highlighters and linters.
- It means you can no longer use that builtin for its original purpose.
How can you solve this?
Rename the variable something more specific, such as `integers`.
In a pinch, `my_list` and similar names are colloquially-recognized
placeholders.</details>
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| data = yaml.safe_load(content) | ||
|
|
||
| # 版本处理&检查 | ||
| self.version = data['version'] |
There was a problem hiding this comment.
issue: 如果缺少 'version' 键，直接访问可能会引发 KeyError。
请使用 data.get('version') 并处理 None 情况，以避免 KeyError 并在缺少 'version' 时提供更清晰的错误消息。
Original comment in English
issue: Direct access to 'version' key may raise KeyError if missing.
Use data.get('version') and handle the None case to avoid KeyError and provide a clearer error message if 'version' is missing.
Comment on lines
+25
to
+34
| '物理': Subject(name='物理', simplified_name='物', teacher='赵军', room='104')} | ||
| """ | ||
|
|
||
| def __init__(self, content: str): | ||
| """ | ||
| 根据星期获取课程安排 | ||
| 初始化 CSES。 | ||
| Args: | ||
| day (str): 星期（如 'mon', 'tue' 等） | ||
| Returns: | ||
| list: 该星期的课程安排 | ||
| content (str): CSES 课程文件的内容。 |
There was a problem hiding this comment.
suggestion: 科目构建假设所有必需字段都存在且有效。
在引发的 ParseError 中包含特定的验证错误详细信息（e.errors() 或 str(e)）以改进调试。
Original comment in English
suggestion: Subject construction assumes all required fields are present and valid.
Include the specific validation error details (e.errors() or str(e)) in the raised ParseError to improve debugging.
| for cls in schedule['classes']: | ||
| print(f"- {cls['subject']} ({cls['start_time']} - {cls['end_time']})") | ||
| # 先构造课程列表，再构造课表 | ||
| schedule_classes = {i['name']: i['classes'] for i in schedules} |
There was a problem hiding this comment.
issue: 假设每个日程条目都存在 'name' 和 'classes' 键。
验证每个日程条目都包含 'name' 和 'classes' 键，以防止 KeyError 异常。
Original comment in English
issue: Assumes 'name' and 'classes' keys exist for every schedule entry.
Validate that each schedule entry contains both 'name' and 'classes' keys to prevent KeyError exceptions.
Comment on lines
+70
to
+71
| built_lessons[name].append( | ||
| st.Lesson(**(lesson | {'subject': self.subjects[lesson['subject']]})) |
There was a problem hiding this comment.
issue: 依赖 Python 3.9+ 字典联合运算符和科目查找。
如果 self.subjects 中缺少 lesson['subject']，将发生 KeyError。请添加错误处理以在这种情况下提供更清晰的消息。
Original comment in English
issue: Relies on Python 3.9+ dict union operator and subject lookup.
If lesson['subject'] is missing from self.subjects, a KeyError will occur. Please add error handling to provide a clearer message in this case.
Comment on lines
+75
to
+83
| self.schedule = [ | ||
| st.SingleDaySchedule( | ||
| enable_day=day['enable_day'], | ||
| classes=built_lessons[day['name']], | ||
| name=day['name'], | ||
| weeks=st.WeekType(day['weeks']), | ||
| ) | ||
| for day in schedules | ||
| ] |
There was a problem hiding this comment.
suggestion (bug_risk): WeekType 构造假设有效值。
捕获来自 st.WeekType(day['weeks']) 的 ValueError，并在遇到无效值时引发带有清晰消息的 ParseError。
Suggested change
| self.schedule = [ | |
| st.SingleDaySchedule( | |
| enable_day=day['enable_day'], | |
| classes=built_lessons[day['name']], | |
| name=day['name'], | |
| weeks=st.WeekType(day['weeks']), | |
| ) | |
| for day in schedules | |
| ] | |
| self.schedule = [] | |
| for day in schedules: | |
| try: | |
| week_type = st.WeekType(day['weeks']) | |
| except ValueError as ve: | |
| raise err.ParseError( | |
| f"Invalid weeks value '{day['weeks']}' for day '{day['name']}': {ve}" | |
| ) from ve | |
| self.schedule.append( | |
| st.SingleDaySchedule( | |
| enable_day=day['enable_day'], | |
| classes=built_lessons[day['name']], | |
| name=day['name'], | |
| weeks=week_type, | |
| ) | |
| ) |
Original comment in English
suggestion (bug_risk): WeekType construction assumes valid values.
Catch ValueError from st.WeekType(day['weeks']) and raise a ParseError with a clear message if an invalid value is encountered.
Suggested change
| self.schedule = [ | |
| st.SingleDaySchedule( | |
| enable_day=day['enable_day'], | |
| classes=built_lessons[day['name']], | |
| name=day['name'], | |
| weeks=st.WeekType(day['weeks']), | |
| ) | |
| for day in schedules | |
| ] | |
| self.schedule = [] | |
| for day in schedules: | |
| try: | |
| week_type = st.WeekType(day['weeks']) | |
| except ValueError as ve: | |
| raise err.ParseError( | |
| f"Invalid weeks value '{day['weeks']}' for day '{day['name']}': {ve}" | |
| ) from ve | |
| self.schedule.append( | |
| st.SingleDaySchedule( | |
| enable_day=day['enable_day'], | |
| classes=built_lessons[day['name']], | |
| name=day['name'], | |
| weeks=week_type, | |
| ) | |
| ) |
| >>> week_num(datetime.date(2025, 9, 1), datetime.date(2025, 10, 24)) | ||
| 8 | ||
| """ | ||
| return (day - start_day).days // 7 + 1 |
There was a problem hiding this comment.
suggestion (bug_risk): week_num 未验证 day >= start_day。
如果 day 在 start_day 之前，函数可能会返回 0 或负值。请添加检查以适当处理这种情况。
Original comment in English
suggestion (bug_risk): week_num does not validate that day >= start_day.
If day is before start_day, the function may return 0 or negative values. Please add a check to handle this case appropriately.
| # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information | ||
|
|
||
| project = 'cseslib4py' | ||
| copyright = '2025, MacrosMeng' |
There was a problem hiding this comment.
issue (code-quality): 不要将值赋给内置变量 copyright (avoid-builtin-shadow)
Explanation
Python 有许多builtin 变量：构成语言一部分的函数和常量，例如 list、getattr 和 type（参见 https://docs.python.org/3/library/functions.html）。在语言中，重新绑定此类变量是有效的：
list = [1, 2, 3]但是，这被认为是不良实践。
- 它会混淆其他开发人员。
- 它会混淆语法高亮器和 linter。
- 这意味着你不能再将该内置函数用于其原始目的。
你如何解决这个问题？
将变量重命名为更具体的内容，例如 integers。在紧急情况下，my_list 和类似名称是约定俗成的占位符。
Original comment in English
issue (code-quality): Don't assign to builtin variable copyright (avoid-builtin-shadow)
Explanation
Python has a number ofbuiltin variables: functions and constants thatform a part of the language, such as
list, getattr, and type(See https://docs.python.org/3/library/functions.html).
It is valid, in the language, to re-bind such variables:
list = [1, 2, 3]However, this is considered poor practice.
- It will confuse other developers.
- It will confuse syntax highlighters and linters.
- It means you can no longer use that builtin for its original purpose.
How can you solve this?
Rename the variable something more specific, such as integers.
In a pinch, my_list and similar names are colloquially-recognized
placeholders.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Sourcery 总结
重构库以使用 Pydantic 模型进行 CSES 课表的健壮验证和解析，用统一的 CSES 类替换旧有的解析器/生成器，并更新项目元数据和文档工具
新功能：
改进：
文档：
Original summary in English
Summary by Sourcery
Refactor the library to use Pydantic models for robust validation and parsing of CSES schedules, replace legacy parser/generator with a unified CSES class, update project metadata and documentation tooling
New Features:
Enhancements:
Documentation: