Api
- api.create_post() Tuple[Response, Any][source]
Create a new post.
- Returns:
Creation data.
- Return type:
Tuple[Response, Any]
- api.delete_comment(post_id: str, comment_id: str) Tuple[Response, Any][source]
Delete a comment.
- Parameters:
post_id (str) – Post’s ID.
comment_id (str) – Comment’s ID.
- Returns:
Deletion data.
- Return type:
Tuple[Response, Any]
- api.delete_post(post_id: str) Tuple[Response, Any][source]
Delete a post.
- Parameters:
post_id (str) – Post’s ID.
- Returns:
Deletion data.
- Return type:
Tuple[Response, Any]
- api.edit_post(post_id: str) Tuple[Response, Any][source]
Edit a post.
- Parameters:
post_id (str) – Post’s ID.
- Returns:
Edition data.
- Return type:
Tuple[Response, Any]
- api.excepty(exception: Exception | CustomException) Tuple[Response, Any][source]
Manage the exceptions.
- Parameters:
exception (Exception | CustomException) – Exception ocurred.
- Raises:
exception – The exception
- Returns:
The error.
- Return type:
Tuple[Response, Any]
- api.follow_user(username: str) Tuple[Response, Any][source]
Follow or unfollows an user.
- Parameters:
username (str) – User’s username to follow or unfollow
- Raises:
Exception – If is himself.
- Returns:
Follow data.
- Return type:
Tuple[Response, Any]
- api.get_post(post_id: str) Tuple[Response, Any][source]
Fetch a post.
- Parameters:
post_id (str) – Post’s ID to fetch.
- Returns:
Post data.
- Return type:
Tuple[Response, Any]
- api.get_posts() Tuple[Response, Any][source]
Fetch all posts.
- Returns:
Posts data.
- Return type:
Tuple[Response, Any]
- api.get_user(username: str) Tuple[Response, Any][source]
Fetch an user.
- Parameters:
username (str) – User’s username to fetch.
- Returns:
User data.
- Return type:
Tuple[Response, Any]
- api.login() Response | Tuple[Response, Any][source]
Log an user.
- Returns:
Loggin info.
- Return type:
Response | Tuple[Response, Any]
- api.logout() Response[source]
Logout a user.
- Returns:
Delete the token and retuns {“data”: “Sesión cerrada”}
- Return type:
Response
- api.new_comment(post_id: str) Tuple[Response, Any][source]
Create a new comment.
- Parameters:
post_id (str) – Post’s ID.
- Returns:
Creation data.
- Return type:
Tuple[Response, Any]
- api.register() Response | Tuple[Response, Any][source]
Register an user
- Returns:
Register info.
- Return type:
Response | Tuple[Response, Any]
- api.returny(to_return: Any, code=200) Tuple[Response, Any][source]
Make a return witk code
- Parameters:
to_return (Any) – Data to return.
code (int, optional) – Code to return.. Defaults to 200.
- Returns:
The data with the code.
- Return type:
Tuple[Response, Any]
- api.serve_docs(filename)[source]
Give the filename.
- Parameters:
filename (_type_) – Filename.
- Returns:
The file.
- Return type:
_type_
- api.set_token(token: Dict[str, Any], code: int = 200) Response[source]
Set a safe token.
- Parameters:
token (Dict[str, Any]) – Token.
code (int, optional) – Code to returns. Defaults to 200.
- Returns:
Set the token.
- Return type:
Response
- api.verify_token(f) Response[source]
Verify a JWT.
- Parameters:
f (_type_) – Function
- Raises:
Unauthorized – Not token
Unauthorized – Invalid token
- Returns:
Function response
- Return type:
Response