arizona-forum-api-async 1.0__py3-none-any.whl

arizona_forum_async/consts.py

@@ -0,0 +1,24 @@
+MAIN_URL = "https://forum.arizona-rp.com"
+
+REACTIONS = {
+    1: 'Мне нравится',
+    2: 'Любовь',
+    3: 'Ха-ха',
+    4: 'Ух ты',
+    5: 'Грустно',
+    6: 'Гнев',
+    7: 'Мне не нравится'
+}
+
+ROLE_COLOR = {
+    'style71': 'green',
+    'style73': '#6DB36D',
+    'style72': '#efef12',
+    'style74': 'blue',
+    'style76': '#642CD0',
+    'style84': '#ffc0cb',
+    'style75': 'Skyblue',
+    'style3': 'red',
+    'style76': '#FF1493',
+    'style80': '#ff5733'
+}

arizona_forum_async/exceptions.py

@@ -0,0 +1,18 @@
+class ArizonaException(Exception):
+    pass
+
+
+class IncorrectLoginData(Exception):
+    def __init__(self, *args: object) -> None:
+        super().__init__(*args)
+
+    def __str__(self) -> str:
+        return "Вы ввели неверные cookie!"
+
+
+class ThisIsYouError(ArizonaException):
+    def __init__(self, user_id):
+        self.user_id = user_id
+
+    def __str__(self) -> str:
+        return f"Вы не можете совершить данное действие самому себе\nID пользователя: {self.user_id}"

arizona_forum_async/models/__init__.py

@@ -0,0 +1,4 @@
+from .category_object import *
+from .member_object import *
+from .other import *
+from .thread_object import *

arizona_forum_async/models/category_object.py

@@ -0,0 +1,111 @@
+import aiohttp
+from typing import TYPE_CHECKING
+from arizona_forum_async.consts import MAIN_URL
+
+if TYPE_CHECKING:
+    from arizona_forum_async import ArizonaAPI
+
+
+class Category:
+    def __init__(self, API: 'ArizonaAPI', id: int, title: str, pages_count: int) -> None:
+        self.API = API
+        self.id = id
+        """**ID категории**"""
+        self.title = title
+        """**Название категории**"""
+        self.pages_count = pages_count
+        """**Количество страниц в категории**"""
+        self.url = f"{MAIN_URL}/forums/{self.id}/"
+        """Ссылка на объект"""
+
+    async def create_thread(self, title: str, message_html: str, discussion_type: str = 'discussion', watch_thread: int = 1) -> aiohttp.ClientResponse:
+        """Создать тему в категории
+
+        Attributes:
+            title (str): Название темы
+            message_html (str): Содержание темы. Рекомендуется использование HTML
+            discussion_type (str): - Тип темы | Возможные варианты: 'discussion' - обсуждение (по умолчанию), 'article' - статья, 'poll' - опрос (необяз.)
+            watch_thread (str): - Отслеживать ли тему. По умолчанию True (необяз.)
+        
+        Returns:
+            Объект Response модуля requests
+
+        Todo:
+            Cделать возврат ID новой темы
+        """
+
+        return await self.API.create_thread(self.id, title, message_html, discussion_type, watch_thread)
+    
+
+    async def get_parent_category(self) -> 'Category':
+        """Получить родительский раздел
+
+        Attributes:
+            thread_id (int): ID темы
+        
+        Returns:
+            Объект Catrgory, в котормо создана тема
+        """
+
+        return await self.API.get_parent_category_of_category(self.id)
+
+
+    async def set_read(self) -> aiohttp.ClientResponse:
+        """Отметить категорию как прочитанную
+        
+        Returns:
+            Объект Response модуля requests
+        """
+
+        return await self.API.set_read_category(self.id)
+    
+
+    async def watch(self, notify: str, send_alert: bool = True, send_email: bool = False, stop: bool = False) -> aiohttp.ClientResponse:
+        """Настроить отслеживание категории
+
+        Attributes:
+            notify (str): Объект отслеживания. Возможные варианты: "thread", "message", ""
+            send_alert (bool): - Отправлять ли уведомления на форуме. По умолчанию True (необяз.)
+            send_email (bool): - Отправлять ли уведомления на почту. По умолчанию False (необяз.)
+            stop (bool): - Принудительное завершение отслеживания. По умолчанию False (необяз.)
+
+        Returns:
+            Объект Response модуля requests    
+        """
+
+        return await self.API.watch_category(self.id, notify, send_alert, send_email, stop)
+    
+
+    async def get_threads(self, page: int = 1) -> dict:
+        """Получить темы из раздела
+
+        Attributes:
+            page (int): Cтраница для поиска. По умолчанию 1 (необяз.)
+            
+        Returns:
+            Словарь (dict), состоящий из списков закрепленных ('pins') и незакрепленных ('unpins') тем
+        """
+
+        return await self.API.get_threads(self.id, page)
+    
+    async def get_threads_extended(self, page: int = 1) -> dict:
+        """Получить темы из раздела с дополнительной информацией
+
+        Attributes:
+            page (int): Cтраница для поиска. По умолчанию 1 (необяз.)
+            
+        Returns:
+            Словарь (dict), состоящий из списков закрепленных ('pins') и незакрепленных ('unpins') тем
+        """
+
+        return await self.API.get_threads_extended(self.id, page)
+
+
+    async def get_categories(self) -> list:
+        """Получить дочерние категории из раздела
+        
+        Returns:
+            Список (list), состоящий из ID дочерних категорий раздела
+        """
+
+        return await self.API.get_categories(self.id)

arizona_forum_async/models/member_object.py

@@ -0,0 +1,125 @@
+from bs4 import BeautifulSoup
+import aiohttp
+from re import compile
+from typing import TYPE_CHECKING
+
+from arizona_forum_async.consts import MAIN_URL
+
+if TYPE_CHECKING:
+    from arizona_forum_async.api import ArizonaAPI
+
+
+class Member:
+    def __init__(self, API : 'ArizonaAPI', id: int, username: str, user_title: str, avatar: str, roles: list, messages_count: int, reactions_count: int, trophies_count: int, username_color: str) -> None:
+        self.API = API
+        self.id = id
+        """**ID пользователя**"""
+        self.username = username
+        """**Имя пользователя**"""
+        self.user_title = user_title
+        """**Звание пользователя**"""
+        self.avatar = avatar
+        """**Ссылка на аватарку пользователя**"""
+        self.roles = roles
+        """Роль пользователя на форуме ('покраска')"""
+
+        self.messages_count = messages_count
+        """**Количество сообщений в счетчике**"""
+        self.reactions_count = reactions_count
+        """**Количество реакций в счетчике**"""
+        self.trophies_count = trophies_count
+        """**Количество баллов в счетчике**"""
+
+        self.username_color = username_color
+
+        self.url = f"{MAIN_URL}/members/{self.id}/"
+        """Ссылка на объект"""
+        
+
+    async def follow(self) -> aiohttp.ClientResponse:
+        """Изменить статус подписки на пользователя
+        
+        Returns:
+            Объект Response модуля requests
+        """
+
+        return await self.API.follow_member(self.id)
+    
+    async def ignore(self) -> aiohttp.ClientResponse:
+        """Изменить статус игнорирования пользователя
+        
+        Returns:
+            Объект Response модуля requests
+        """
+
+        return await self.API.ignore_member(self.id)
+    
+    async def add_message(self, message_html: str) -> aiohttp.ClientResponse:
+        """Отправить сообщение на стенку пользователя
+
+        Attributes:
+            message_html (str): Текст сообщения. Рекомендуется использование HTML
+            
+        Returns:
+            Объект Response модуля requests
+        """
+
+        return await self.API.answer_thread(self.id, message_html)
+    
+    async def get_profile_messages(self, page: int = 1) -> list:
+        """Возвращает ID всех сообщений со стенки пользователя на странице
+
+        Attributes:
+            page (int): Страница для поиска. По умолчанию 1 (необяз.)
+            
+        Returns:
+            Cписок (list) с ID всех сообщений профиля
+        """
+
+        return await self.API.get_profile_messages(self.id, page)
+
+
+class CurrentMember(Member):
+    follow = property(doc='Forbidden method for Current Member object')
+    ignore = property(doc='Forbidden method for Current Member object')
+
+    async def edit_avatar(self, upload_photo: str) -> aiohttp.ClientResponse:
+        """Изменить аватарку пользователя
+
+        Attributes:
+            upload_photo (str): Относительный или полный путь до изображения
+        
+        Returns:
+            Объект Response модуля requests
+        """
+
+        with open(upload_photo, 'rb') as image:
+            file_dict = {'upload': (upload_photo, image.read())}
+        
+        token = BeautifulSoup(self.API.session.get(f"{MAIN_URL}/help/terms/").content, 'lxml').find('html')['data-csrf']
+        data = {
+            "avatar_crop_x": 0, 
+            "avatar_crop_y": 0,
+            "_xfToken": token, 
+            "use_custom": 1,
+        }
+        return await self.API.session.post(f"{MAIN_URL}/account/avatar", files=file_dict, data=data)
+    
+
+    async def delete_avatar(self) -> aiohttp.ClientResponse:
+        """Удалить автарку пользователя
+        
+        Returns:
+            Объект Response модуля requests
+        """
+        token = BeautifulSoup(self.API.session.get(f"{MAIN_URL}/help/terms/").content, 'lxml').find('html')['data-csrf']
+        file_dict = {'upload': ("", "")}
+        data = {
+            "avatar_crop_x": 0, 
+            "avatar_crop_y": 0,
+            "_xfToken": token, 
+            "use_custom": 1,
+            "delete_avatar": 1
+        }
+
+        return await self.API.session.post(f"{MAIN_URL}/account/avatar", files=file_dict, data=data)

arizona_forum_async/models/other.py

@@ -0,0 +1,14 @@
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from arizona_forum_async import ArizonaAPI
+    from arizona_forum_async.models.member_object import Member
+
+
+class Statistic:
+    def __init__(self, API: 'ArizonaAPI', threads_count: int, posts_count: int, users_count: int, last_register_member: 'Member') -> None:
+        self.API = API
+        self.threads_count = threads_count
+        self.posts_count = posts_count
+        self.users_count = users_count
+        self.last_register_member = last_register_member

arizona_forum_async/models/post_object.py

@@ -0,0 +1,152 @@
+import aiohttp
+from typing import TYPE_CHECKING
+from arizona_forum_async.consts import MAIN_URL
+
+if TYPE_CHECKING:
+    from arizona_forum_async import ArizonaAPI
+    from arizona_forum_async.models import Member, Thread
+
+
+class Post:
+    def __init__(self, API: 'ArizonaAPI', id: int, creator: 'Member', thread: 'Thread', create_date: int, html_content: str, text_content: str) -> None:
+        self.API = API
+        self.id = id
+        """**ID сообщения**"""
+        self.creator = creator
+        """**Объект Member отправителя сообщения**"""
+        self.thread = thread
+        """**Объект Thread темы, в которой оставлено сообщение**"""
+        self.create_date = create_date
+        """**Дата отправки сообщения в UNIX**"""
+        self.html_content = html_content
+        """**Сырое содержимое сообщения**"""
+        self.text_content = text_content
+        """**Текст из сообщения**"""
+        self.url = f"{MAIN_URL}/posts/{self.id}/"
+        """Ссылка на объект"""
+
+    async def bbcode_content(self) -> aiohttp.ClientResponse:
+        """Получить bbcode поста
+            
+        Returns:
+            Str текст bbcode
+        """
+
+        return await self.API.get_post_bbcode(self.thread.id, self.id)
+
+    async def react(self, reaction_id: int = 1) -> aiohttp.ClientResponse:
+        """Поставить реакцию на сообщение
+
+        Attributes:
+            reaction_id (int): ID реакции. По умолчанию 1 (необяз.)
+            
+        Returns:
+            Объект Response модуля requests
+        """
+
+        return await self.API.react_post(self.id, reaction_id)
+    
+
+    async def edit(self, message_html: str) -> aiohttp.ClientResponse:
+        """Отредактировать сообщение
+
+        Attributes:
+            message_html (str): Новое содержание сообщения. Рекомендуется использование HTML
+        
+        Returns:
+            Объект Response модуля requests
+        """
+
+        return await self.API.edit_post(self.id, message_html)
+
+
+    async def delete(self, reason: str, hard_delete: bool = False) -> aiohttp.ClientResponse:
+        """Удалить сообщение
+
+        Attributes:
+            reason (str): Причина для удаления
+            hard_delete (bool): Полное удаление сообщения. По умолчанию False (необяз.)
+            
+        Returns:
+            Объект Response модуля requests
+        """
+
+        return await self.API.delete_post(self.id, reason, hard_delete)
+    
+    
+    async def bookmark(self) -> aiohttp.ClientResponse:
+        """Добавить сообщение в закладки
+        
+        Returns:
+            Объект Response модуля requests"""
+        return await self.API.bookmark_post(self.id)
+
+class ProfilePost:
+    def __init__(self, API: 'ArizonaAPI', id: int, creator: 'Member', profile: 'Member', create_date: int, html_content: str, text_content: str) -> None:
+        self.API = API
+        self.id = id
+        """**ID сообщения профиля**"""
+        self.creator = creator
+        """**Объект Member отправителя сообщения**"""
+        self.profile = profile
+        """**Объект Member профиля, в котором оставлено сообщение**"""
+        self.create_date = create_date
+        """**Дата отправки сообщения в UNIX**"""
+        self.html_content = html_content
+        """**Сырое содержимое сообщения**"""
+        self.text_content = text_content
+        """**Текст из сообщения**"""
+        self.url = f"{MAIN_URL}/profile-posts/{self.id}/"
+        """Ссылка на объект"""
+
+    async def react(self, reaction_id: int = 1) -> aiohttp.ClientResponse:
+        """Поставить реакцию на сообщение профиля
+
+        Attributes:
+            reaction_id (int): ID реакции. По умолчанию 1 (необяз.)
+            
+        Returns:
+            Объект Response модуля requests
+        """
+
+        return await self.API.react_profile_post(self.id, reaction_id)
+
+
+    async def comment(self, message_html: str) -> aiohttp.ClientResponse:
+        """Прокомментировать сообщение профиля
+
+        Attributes:
+            message_html (str): Текст комментария. Рекомендуется использование HTML
+        
+        Returns:
+            Объект Response модуля requests
+        """
+
+        return await self.API.comment_profile_post(self.id, message_html)
+
+
+    async def delete(self, reason: str, hard_delete: bool = False) -> aiohttp.ClientResponse:
+        """Удалить сообщение
+
+        Attributes:
+            reason (str): Причина для удаления
+            hard_delete (bool): Полное удаление сообщения. По умолчанию False (необяз.)
+            
+        Returns:
+            Объект Response модуля requests
+        """
+
+        return await self.API.delete_profile_post(self.id, reason, hard_delete)
+    
+
+    async def edit(self, message_html: str) -> aiohttp.ClientResponse:
+        """Отредактировать сообщение профиля
+
+        Attributes:
+            message_html (str): Новое содержание сообщения профиля. Рекомендуется использование HTML
+        
+        Returns:
+            Объект Response модуля requests
+        """
+
+        return await self.API.edit_profile_post(self.id, message_html)

arizona_forum_async/models/thread_object.py

@@ -0,0 +1,140 @@
+import aiohttp
+from typing import TYPE_CHECKING
+from arizona_forum_async.consts import MAIN_URL
+
+if TYPE_CHECKING:
+    from arizona_forum_async.models.member_object import Member
+    from arizona_forum_async.models.category_object import Category
+    from arizona_forum_async import ArizonaAPI
+
+
+class Thread:
+    def __init__(self, API: 'ArizonaAPI', id: int, creator: 'Member', create_date: int, title: str, prefix: str, text_content: str, html_content: str, pages_content: int, thread_post_id: int, is_closed: bool) -> None:
+        self.API = API
+        self.id = id
+        """**ID темы**"""
+        self.creator = creator
+        """**Объект Member создателя темы**"""
+        self.create_date = create_date
+        """**Дата создания темы в UNIX**"""
+        self.title = title
+        """**Заголовок темы**"""
+        self.prefix = prefix
+        """**Префикс темы**"""
+        self.text_content = text_content
+        """**Текст из темы**"""
+        self.html_content = html_content
+        """**Сырой контент темы**"""
+        self.pages_count = pages_content
+        """**Количество страниц с ответами в теме**"""
+        self.is_closed = is_closed
+        """**Закрыта ли тема**"""
+        self.thread_post_id = thread_post_id
+        """**ID сообщения темы (post_id)**"""
+        self.url = f"{MAIN_URL}/threads/{self.id}/"
+        """Ссылка на объект"""
+    
+
+    async def answer(self, message_html: str) -> aiohttp.ClientResponse:
+        """Оставить сообщение в теме
+
+        Attributes:
+            message_html (str): Cодержание ответа. Рекомендуется использование HTML
+        
+        Returns:
+            Объект Response модуля requests
+        """
+
+        return await self.API.answer_thread(self.id, message_html)
+
+
+    async def watch(self, email_subscribe: bool = False, stop: bool = False) -> aiohttp.ClientResponse:
+        """Изменить статус отслеживания темы
+
+        Attributes:
+            email_subscribe (bool): Отправлять ли уведомления на почту. По умолчанию False (необяз.)
+            stop (bool): - Принудительно прекратить отслеживание. По умолчанию False (необяз.)
+        
+        Returns:
+            Объект Response модуля requests
+        """
+
+        return await self.API.watch_thread(self.id, email_subscribe, stop)
+    
+
+    async def delete(self, reason: str, hard_delete: bool = False) -> aiohttp.ClientResponse:
+        """Удалить тему
+
+        Attributes:
+            reason (str): Причина для удаления
+            hard_delete (bool): Полное удаление сообщения. По умолчанию False (необяз.)
+            
+        Returns:
+            Объект Response модуля requests
+        """
+
+        return await self.API.delete_thread(self.id, reason, hard_delete)
+    
+
+    async def edit(self, message_html: str) -> aiohttp.ClientResponse:
+        """Отредактировать содержимое темы
+
+        Attributes:
+            message_html (str): Новое содержимое ответа. Рекомендуется использование HTML
+        
+        Returns:
+            Объект Response модуля requests
+        """
+
+        return await self.API.edit_thread(self.id, message_html)
+
+    async def edit_info(self, title: str = None, prefix_id: int = None, sticky: bool = True, opened: bool = True) -> aiohttp.ClientResponse:
+        """Изменить заголовок и/или префикс темы
+
+        Attributes:
+            title (str): Новое название
+            prefix_id (int): Новый ID префикса
+            sticky (bool): Закрепить (True - закреп / False - не закреп)
+            opened (bool): Открыть/закрыть тему (True - открыть / False - закрыть)
+        
+        Returns:
+            Объект Response модуля requests
+        """
+
+        return await self.API.edit_thread_info(self.id, title, prefix_id, sticky, opened)
+    
+
+    async def get_posts(self, page: int = 1) -> list:
+        """Получить все ID сообщений из темы на странице
+
+        Attributes:
+            page (int): Cтраница для поиска. По умолчанию 1 (необяз.)
+        
+        Returns:
+            Список (list), состоящий из ID всех сообщений на странице
+        """
+
+        return await self.API.get_thread_posts(self.id, page)
+
+
+    async def react(self, reaction_id: int = 1) -> aiohttp.ClientResponse:
+        """Поставить реакцию на тему
+
+        Attributes:
+            reaction_id (int): ID реакции. По умолчанию 1 (необяз.)
+            
+        Returns:
+            Объект Response модуля requests
+        """
+
+        return await self.API.react_thread(self.id, reaction_id)
+    
+
+    async def get_category(self) -> 'Category':
+        """Получить родительский раздел раздела
+        
+        Returns:
+            Объект Catrgory, в котором создан раздел
+        """
+
+        return await self.API.get_thread_category(self.id)