Experimental support of asyncLuoguAPI(Tag 0.0.2)

Author: bzy-nya

README.md

@@ -1,5 +1,5 @@
 # luogu-api-python
-A Python implementation of the Luogu API
+A Python implementation of the Luogu API.
 
 ## Project Description
 
@@ -30,6 +30,8 @@ To install the package from source, follow these steps:
 
 ## Usage
 
+### Synchronous API
+
 Here is an example of how to use the package:
 
 ```python
@@ -44,6 +46,28 @@ for problem in problems:
     print(problem.title)
 ```
 
+### Asynchronous API (Experimental)
+
+The package also provides experimental support for async operations:
+
+```python
+import asyncio
+import pyLuogu
+
+# Initialize the async API without cookies
+luogu = pyLuogu.asyncLuoguAPI()
+
+async def main():
+    async with luogu:
+        problems = (await luogu.get_problem_list()).problems
+        for problem in problems:
+            print(problem.title)
+
+asyncio.run(main())
+```
+
+Note: The async API is currently experimental and subject to changes.
+
 ## Contributing
 
 Contributions are welcome! Please open an issue or submit a pull request.
@@ -77,42 +101,64 @@ If you find a bug or have a feature request, please open an issue on GitHub. Pro
 
 ## Todo List
 
-Methods of class `LuoguAPI`
-
- - [x] Problem
-   - [x] get_problem_list
-   - [x] get_team_problem_list 
-   - [x] get_problem
-   - [x] get_problem_settings
-   - [x] update_problem_settings
-   - [x] update_testcases_settings
-   - [x] create_problem
-   - [x] delete_problem
-   - [x] transfer_problem
-   - [ ] download_testcases
-   - [ ] upload_testcases
- - [x] User
-   - [x] get_user
-   - [x] get_user_info
-   - [x] get_user_followings_list
-   - [x] get_user_followers_list
-   - [x] get_user_blacklist
-   - [x] search_user
- - [x] UserOperation
-   - [ ] login
-   - [ ] logout
-   - [x] me
-   - [ ] submit_code
-   - [x] get_created_problem_list
-   - [ ] get_created_problemset_list
-   - [ ] get_created_content_list
-   - [ ] update_setting
- - [x] Miscs
-   - [x] get_tags
-   - [ ] get_captcha
-   - [ ] sign_up
-
-Others
-
- - [ ] asyncLuoguAPI
- - [ ] staticLuoguAPI
+API Implementation Status
+
+### Core APIs
+
+- [x] Problem API
+  - [x] get_problem_list
+  - [x] get_team_problem_list 
+  - [x] get_problem
+  - [x] get_problem_settings
+  - [x] update_problem_settings
+  - [x] update_testcases_settings
+  - [x] create_problem
+  - [x] delete_problem
+  - [x] transfer_problem
+  - [ ] download_testcases
+  - [ ] upload_testcases
+
+- [x] User API
+  - [x] get_user
+  - [x] get_user_info
+  - [x] get_user_followings_list
+  - [x] get_user_followers_list
+  - [x] get_user_blacklist
+  - [x] search_user
+
+- [-] User Operations
+  - [ ] login
+  - [ ] logout
+  - [x] me
+  - [ ] submit_code
+  - [x] get_created_problem_list
+  - [ ] get_created_problemset_list
+  - [ ] get_created_content_list
+  - [ ] update_setting
+
+- [-] Miscellaneous
+  - [x] get_tags
+  - [ ] get_captcha
+  - [ ] sign_up
+
+### Alternative API Implementations
+
+- [x] asyncLuoguAPI (Experimental)
+  - [x] Async versions of all implemented core APIs
+  - [ ] Performance optimizations
+  - [ ] Comprehensive error handling
+
+- [ ] staticLuoguAPI
+  - [ ] Initial implementation
+  - [ ] Documentation
+
+### Test Cases and Documentation
+
+Note: Test suite and documentation are planned for implementation after API features are stabilized. This includes:
+
+- Comprehensive test coverage for both sync and async APIs
+- API reference documentation with examples
+- Integration test scenarios
+- Development guides and best practices
+
+These will be prioritized once the core functionality reaches a stable state.

examples/readme_example_async.py

@@ -0,0 +1,13 @@
+import asyncio
+import pyLuogu
+
+# Initialize the async API without cookies
+luogu = pyLuogu.asyncLuoguAPI()
+
+async def main():
+    async with luogu:
+        problems = (await luogu.get_problem_list()).problems
+        for problem in problems:
+            print(problem.title)
+
+asyncio.run(main())

examples/async_store_problem.py renamed to examples/store_problem_async.py

@@ -373,12 +373,10 @@ async def upload_testcases(
 
     async def get_user(self, uid: int) -> UserDataRequestResponse:
         res = await self._send_request(endpoint=f"user/{uid}")
-
         return UserDataRequestResponse(res)
 
     async def get_user_info(self, uid: int) -> UserDetails:
         res = await self._send_request(endpoint=f"api/user/info/{uid}")
-
         return UserDetails(res["user"])
 
     async def get_user_following_list(self, uid: int, page: int | None = None) -> List[UserDetails]:
@@ -398,7 +396,6 @@ async def get_user_blacklist(self, uid: int, page: int | None = None) -> List[Us
 
     async def search_user(self, keyword: str) -> List[UserSummary]:
         params = UserSearchRequestParams({"keyword" : keyword})
-        
         res = await self._send_request(endpoint="api/user/search", params=params)
         return [UserSummary(user) for user in res["users"]]
 

pyLuogu/async_api.py

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "luogu-api-python"
-version = "0.0.2-rc"
+version = "0.0.2"
 description = "A Python library to interact with the Luogu online judge system"
 readme = "README.md"
 authors = [