python_yapi package¶
Submodules¶
python_yapi.base module¶
- class python_yapi.base.ApiBase(base_url: str = 'http://localhost:3000')[source]¶
Bases:
objectBase class for YApi Http API
- get(**kwargs)¶
- post(**kwargs)¶
- request(method, url, **kwargs) dict | list | str[source]¶
Send general http request :param method: The HTTP method, eg: GET, POST, PUT, DELETE, … :param url: The URL of the request, can be relative api path to the base_url :param kwargs: keyword arguments that requests.request() supports
eg: params, headers, data, json, files, auth, … additional keyword argument: check_errcode (default as True)
- Returns:
JSON format response body as dictionary
- Raise:
TimeoutError if request timeout to get response
- Raise:
JSONDecodeError if response body is not a JSON
- Raise:
AssertionError if check_errcode(deafault as True) and errcode of response body not equals 0
python_yapi.cli module¶
python_yapi.collection module¶
python_yapi.constants module¶
python_yapi.exceptions module¶
python_yapi.follow module¶
python_yapi.group module¶
- class python_yapi.group.GroupMixIn(base_url: str = 'http://localhost:3000')[source]¶
Bases:
ApiBase- add_group(group_name: str, group_desc: str, owner_uids: list[str])[source]¶
Adds a new group
- Parameters:
group_name – Group name
group_desc – Group description
owner_uids – Group owner IDs
- Returns:
python_yapi.interface module¶
python_yapi.log module¶
python_yapi.models module¶
python_yapi.project module¶
python_yapi.user module¶
- class python_yapi.user.UserMixIn(base_url: str = 'http://localhost:3000')[source]¶
Bases:
ApiBase- change_password(uid: int, old_password: str, password: str)[source]¶
Change password. :param uid: user id :param old_password: user original password :param password: user new password :return:
- find_user(uid: int)[source]¶
Find a user by uid. :param uid: user id :return: user data
- eg: {“uid”: 13,
“username”: “superhin”, “email”: “superhin@126.com”, “role”: “member”, “type”: “site”, “add_time”: 1687943141, “up_time”: 1687943146}
- get_user_status()[source]¶
Get user status. :return:
- eg:{ “_id”: 15,
“username”: “zhangsan”, “email”: “zhangsan@126.com”, “up_time”: 1688116008, “add_time”: 1688116008, “role”: “member”, “type”: “site”, “study”: false}
- login(email: str, password: str) dict[source]¶
Login YApi :param email: user email :param password: user password :return: JSON response body as dictionary
- eg: {‘add_time’: 1688116008,
‘email’: ‘zhangsan@126.com’, ‘role’: ‘member’, ‘study’: False, ‘type’: ‘site’, ‘uid’: 15, ‘up_time’: 1688116008, ‘username’: ‘zhangsan’}
- register(username: str, email: str, password: str) dict[source]¶
- Parameters:
username –
email –
password –
- Returns:
- eg: {‘add_time’: 1688116008,
’email’: ‘zhangsan@126.com’, ‘role’: ‘member’, ‘study’: False, ‘type’: ‘site’, ‘uid’: 15, ‘up_time’: 1688116008, ‘username’: ‘zhangsan’}