Merge pull request #5 from FengzihangCode/main

功能常规性更新

Author: RyouDYFZ

pyproject.toml

@@ -4,13 +4,13 @@ build-backend = "hatchling.build"
 
 [project]
 name = "usf"
-version = "1.0.0"
+version = "0.1.2"
 description = "A lightweight Universal Schedule Format (USF) parser and generator."
 authors = [{ name = "USF-org", email = "USF-org@outlook.com" }]
 license = { text = "MIT" }
 readme = "README.md"
 requires-python = ">=3.6"
-dependencies = []
+dependencies = ["jsonschema"]
 
 [project.urls]
 Homepage = "https://github.com/USF-org"

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name="usf",
-    version="1.0.0",
+    version="0.1.2",
     packages=find_packages(),
     install_requires=[],
     python_requires=">=3.6",

tests/test_generator.py

@@ -0,0 +1,69 @@
+import json
+import unittest
+from usf.generator import USFGenerator
+from usf.parser import USFParser
+from usf.validator import USFValidator
+
+class TestUSF(unittest.TestCase):
+    def setUp(self):
+        """初始化测试用例"""
+        self.generator = USFGenerator(version=1)
+
+        # 添加科目
+        self.generator.add_subject("Mathematics", simplified_name="Math", teacher="Dr. Smith", room="Room 101")
+        self.generator.add_subject("Physics", simplified_name="Phys", teacher="Dr. Johnson", room="Room 102")
+
+        # 添加时间段（每天适用）
+        self.generator.add_period("08:00:00", "09:30:00")  # 第一节课
+        self.generator.add_period("10:00:00", "11:30:00")  # 第二节课
+
+        # 添加课程表（星期一的第一节课为数学，第二节课为物理）
+        self.generator.add_schedule(1, "all", "Mathematics", 1)  # 星期一，第一节，数学
+        self.generator.add_schedule(1, "all", "Physics", 2)      # 星期一，第二节，物理
+
+        # 生成 USF 数据
+        self.usf_data = self.generator.generate_usf_data()
+
+    def test_usf_generation(self):
+        """测试 USF 生成"""
+        self.assertIn("version", self.usf_data)
+        self.assertIn("subjects", self.usf_data)
+        self.assertIn("periods", self.usf_data)
+        self.assertIn("timetable", self.usf_data)
+
+        self.assertEqual(self.usf_data["version"], 1)
+        self.assertEqual(len(self.usf_data["subjects"]), 2)
+        self.assertEqual(len(self.usf_data["periods"]), 2)
+        self.assertEqual(len(self.usf_data["timetable"]), 2)
+
+    def test_usf_parser(self):
+        """测试 USF 解析"""
+        json_data = json.dumps(self.usf_data, indent=2)
+        parser = USFParser(json_data)
+
+        self.assertEqual(len(parser.get_subjects()), 2)
+        self.assertEqual(len(parser.get_periods()), 2)
+        self.assertEqual(len(parser.get_timetable()), 2)
+
+        # 验证解析出的数据是否正确
+        subjects = parser.get_subjects()
+        self.assertEqual(subjects["Mathematics"]["teacher"], "Dr. Smith")
+        self.assertEqual(subjects["Physics"]["room"], "Room 102")
+
+    def test_usf_validation(self):
+        """测试 USF 校验"""
+        validator = USFValidator()
+
+        # 校验正确的数据
+        self.assertTrue(validator.validate(self.usf_data))
+
+        # 校验错误的数据（缺少 timetable）
+        invalid_data = {
+            "version": 1,
+            "subjects": self.usf_data["subjects"],
+            "periods": self.usf_data["periods"]
+        }
+        self.assertFalse(validator.validate(invalid_data))
+
+if __name__ == "__main__":
+    unittest.main()

tests/test_parser.py

@@ -1,5 +1,5 @@
-from .parser import USFParser
 from .generator import USFGenerator
+from .parser import USFParser
 from .validator import USFValidator
 
-__all__ = ["USFParser", "USFGenerator", "USFValidator"]
+__all__ = ["USFGenerator", "USFParser", "USFValidator"]

tests/test_usf.py

@@ -1,25 +1,84 @@
 import json
 
 class USFGenerator:
-    def __init__(self):
-        self.data = {"subjects": [], "schedule": []}
-
-    def add_subject(self, name, teacher, location):
-        """添加课程"""
-        subject = {"name": name, "teacher": teacher, "location": location}
-        self.data["subjects"].append(subject)
-
-    def add_schedule(self, subject_index, day, time, week_rule="all"):
-        """添加课程表项"""
-        schedule_item = {
-            "subject_index": subject_index,
-            "day": day,
-            "time": time,
-            "week_rule": week_rule
+    def __init__(self, version=1):
+        """
+        Initialize USF Generator.
+
+        Args:
+            version (int, optional): USF format version. Defaults to 1.
+        """
+        self.version = version
+        self.subjects = {}
+        self.periods = []
+        self.timetable = []
+
+    def add_subject(self, name, simplified_name=None, teacher=None, room=None):
+        """
+        Add a subject to USF.
+
+        Args:
+            name (str): Subject name.
+            simplified_name (str, optional): Shortened subject name.
+            teacher (str, optional): Teacher's name.
+            room (str, optional): Classroom.
+        """
+        self.subjects[name] = {
+            "simplified_name": simplified_name or name,
+            "teacher": teacher or "",
+            "room": room or "",
+        }
+
+    def add_period(self, start_time, end_time):
+        """
+        Add a class period to USF.
+
+        Args:
+            start_time (str): Start time (HH:MM:SS).
+            end_time (str): End time (HH:MM:SS).
+
+        Returns:
+            int: Index of the added period (1-based).
+        """
+        self.periods.append([start_time, end_time])
+        return len(self.periods)  # Return 1-based index
+
+    def add_schedule(self, day, week_type, subject, period_index):
+        """
+        Add a schedule entry.
+
+        Args:
+            day (int): Day of the week (1=Monday, ..., 7=Sunday).
+            week_type (str): "all", "even", or "odd".
+            subject (str): Subject name (must exist in subjects).
+            period_index (int): Index of the period (1-based).
+        """
+        if subject not in self.subjects:
+            raise ValueError(f"Subject '{subject}' is not defined.")
+        if period_index < 1 or period_index > len(self.periods):
+            raise ValueError(f"Invalid period index {period_index}.")
+        self.timetable.append([day, week_type, subject, period_index])
+
+    def generate(self):
+        """
+        Generate USF data as a dictionary.
+
+        Returns:
+            dict: USF formatted data.
+        """
+        return {
+            "version": self.version,
+            "subjects": self.subjects,
+            "periods": self.periods,
+            "timetable": self.timetable,
         }
-        self.data["schedule"].append(schedule_item)
 
-    def save(self, filename):
-        """保存USF文件"""
+    def save_to_file(self, filename):
+        """
+        Save USF data to a JSON file.
+
+        Args:
+            filename (str): Output filename.
+        """
         with open(filename, "w", encoding="utf-8") as f:
-            json.dump(self.data, f, ensure_ascii=False, indent=2)
+            json.dump(self.generate(), f, indent=2, ensure_ascii=False)

usf/__init__.py

@@ -1,23 +1,24 @@
 import json
 
 class USFParser:
-    def __init__(self, usf_file):
-        self.usf_file = usf_file
-        self.data = None
+    def __init__(self, filename):
+        """
+        Initialize USF Parser.
 
-    def load(self):
-        """加载USF文件"""
-        with open(self.usf_file, "r", encoding="utf-8") as f:
+        Args:
+            filename (str): Path to USF JSON file.
+        """
+        with open(filename, "r", encoding="utf-8") as f:
             self.data = json.load(f)
 
     def get_subjects(self):
-        """获取课程列表"""
-        if self.data is None:
-            self.load()
-        return self.data.get("subjects", [])
+        """Return the subjects dictionary."""
+        return self.data.get("subjects", {})
 
-    def is_valid(self):
-        """检查USF文件是否合法"""
-        from .validator import USFValidator
-        validator = USFValidator(self.data)
-        return validator.validate()
+    def get_periods(self):
+        """Return the list of periods."""
+        return self.data.get("periods", [])
+
+    def get_timetable(self):
+        """Return the timetable list."""
+        return self.data.get("timetable", [])

usf/generator.py

@@ -1,11 +1,28 @@
+import json
+import jsonschema
+from jsonschema import validate
+
 class USFValidator:
-    def __init__(self, data):
-        self.data = data
-
-    def validate(self):
-        """校验USF数据格式"""
-        if not isinstance(self.data, dict):
-            return False
-        if "subjects" not in self.data or "schedule" not in self.data:
-            return False
+    def __init__(self, schema_file="schema.json"):
+        """
+        Initialize USF Validator.
+
+        Args:
+            schema_file (str, optional): Path to JSON Schema. Defaults to "schema.json".
+        """
+        with open(schema_file, "r", encoding="utf-8") as f:
+            self.schema = json.load(f)
+
+    def validate(self, data):
+        """
+        Validate USF data.
+
+        Args:
+            data (dict): USF formatted dictionary.
+
+        Returns:
+            bool: True if valid, raises an error if invalid.
+        """
+        validate(instance=data, schema=self.schema)
         return True
+