### Install vk_api using pip

Source: https://vk-api.readthedocs.io/en/latest/_sources/index.rst.txt

Use this command to install the vk_api library via pip. Ensure you are using pip3 for Python 3.

```shell
# pip3 install vk_api
```

--------------------------------

### Basic vk_api Authentication and Wall Post

Source: https://vk-api.readthedocs.io/en/latest/_sources/index.rst.txt

This example demonstrates how to authenticate with vk_api using a phone number and password, and then post a message to the wall. Ensure you have imported the vk_api library.

```python
import vk_api

vk_session = vk_api.VkApi('+71234567890', 'mypassword')
vk_session.auth()

vk = vk_session.get_api()

print(vk.wall.post(message='Hello world!'))
```

--------------------------------

### Get Keyboard JSON

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/keyboard.html

Returns the keyboard configuration as a JSON string. This is the format required for sending to the VK API.

```python
def get_keyboard(self):
        """ Получить json клавиатуры """
        return sjson_dumps(self.keyboard)
```

--------------------------------

### Get Audio from Post

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/audio.html

Fetches a list of audio tracks embedded within a specific VK post. It parses the post's HTML to find audio elements.

```APIDOC
## GET /api/wall/{owner_id}/{post_id}/audios

### Description
Retrieves a list of audio tracks from a specified VK post.

### Method
GET

### Endpoint
`/api/wall/{owner_id}/{post_id}/audios`

### Parameters
#### Path Parameters
- **owner_id** (string) - Required - The ID of the post owner (negative values for groups).
- **post_id** (string) - Required - The ID of the post.

### Response
#### Success Response (200)
- **audio_list** (array) - An array of audio track objects.

#### Response Example
```json
{
  "audio_list": [
    {
      "artist": "Artist Name 1",
      "title": "Track Title 1",
      "url": "http://example.com/track1.mp3"
    },
    {
      "artist": "Artist Name 2",
      "title": "Track Title 2",
      "url": "http://example.com/track2.mp3"
    }
  ]
}
```
```

--------------------------------

### Get All Items (Python)

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/tools.html

Use this method only if you need to load all objects into memory. If you can process objects in parts, it is better to use get_all_slow_iter. For example, if you are writing objects to a database, there is no point in loading all the data into memory.

```python
def get_all_slow(self, method, max_count, values=None, key='items',
                     limit=None, stop_fn=None, negative_offset=False):
    """ Использовать только если нужно загрузить все объекты в память.

    Eсли вы можете обрабатывать объекты по частям, то лучше
    использовать get_all_slow_iter

    Например если вы записываете объекты в БД, то нет смысла загружать
    все данные в память
    """

    items = list(
        self.get_all_slow_iter(
            method, max_count, values, key, limit, stop_fn, negative_offset
        )
    )
    return {'count': len(items), key: items}
```

--------------------------------

### GET /audio?act=audio_playlists

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/audio.html

Retrieves a list of audio albums for a specific user or group.

```APIDOC
## GET https://m.vk.com/audio?act=audio_playlists

### Description
Retrieves a list of audio albums for a given owner.

### Method
GET

### Endpoint
https://m.vk.com/audio?act=audio_playlists

### Parameters
#### Query Parameters
- **owner_id** (int) - Optional - ID of the owner (negative values for groups)
- **offset** (int) - Optional - Offset for pagination
```

--------------------------------

### Get All Audio Tracks

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/audio.html

Retrieves all audio tracks for a user or album by converting the iterative getter to a list. This is a convenience method for fetching all tracks at once.

```python
return list(self.get_iter(owner_id, album_id, access_hash))
```

--------------------------------

### Get Audio Tracks Iteratively

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/audio.html

Retrieves audio tracks for a user or album iteratively. Handles pagination by loading sections of tracks. Raises `AccessDenied` if permissions are insufficient. Requires `scrap_ids` and `scrap_tracks` helper functions.

```python
response = self._vk.http.post(
                'https://m.vk.com/audio',
                data={
                    'act': 'load_section',
                    'owner_id': owner_id,
                    'playlist_id': album_id if album_id else -1,
                    'offset': offset,
                    'type': 'playlist',
                    'access_hash': access_hash,
                    'is_loading_all': 1
                },
                allow_redirects=False
            ).json()
```

```python
ids = scrap_ids(
                response['data'][0]['list']
            )
            if not ids:
                break

            yield from scrap_tracks(
                ids,
                self.user_id,
                self._vk.http,
                convert_m3u8_links=self.convert_m3u8_links,
            )
```

--------------------------------

### Get User Albums Iteratively

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/audio.html

Retrieves a list of user albums iteratively. Handles pagination by incrementing the offset. This method is used to fetch albums in chunks.

```python
offset = 0

        while True:
```

--------------------------------

### Get Audio from Post

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/audio.html

Extracts audio tracks from a specific VK post. It scrapes the audio list from the post's HTML content. Ensure the `owner_id` and `post_id` are correct.

```python
def get_post_audio(self, owner_id, post_id):
        """ Получить список аудиозаписей из поста пользователя или группы

        :param owner_id: ID владельца (отрицательные значения для групп)
        :param post_id: ID поста
        """
        response = self._vk.http.get(f'https://m.vk.com/wall{owner_id}_{post_id}')

        ids = scrap_ids_from_html(
            response.text,
            filter_root_el={'class': 'audios_list'}
        )

        return scrap_tracks(
            ids,
            self.user_id,
            http=self._vk.http,
            convert_m3u8_links=self.convert_m3u8_links,
        )
```

--------------------------------

### Initialize VkKeyboard

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/keyboard.html

Constructor for VkKeyboard. Set `one_time` to True if the keyboard should disappear after use, and `inline` to True for inline keyboards.

```python
class VkKeyboard(object):
    """ Класс для создания клавиатуры для бота (https://vk.com/dev/bots_docs_3)
    :param one_time: Если True, клавиатура исчезнет после нажатия на кнопку
    :type one_time: bool
    """

    __slots__ = ('one_time', 'lines', 'keyboard', 'inline')

    def __init__(self, one_time=False, inline=False):
        self.one_time = one_time
        self.inline = inline
        self.lines = [[]]

        self.keyboard = {
            'one_time': self.one_time,
            'inline': self.inline,
            'buttons': self.lines
        }
```

--------------------------------

### Initialize VkAudio Module

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/audio.html

Initializes the VkAudio module with a VkApi object. It sets default cookies and loads the main VK page to establish session cookies. The `convert_m3u8_links` parameter controls whether M3U8 links are converted to MP3.

```python
set_cookies_from_list(self._vk.http.cookies, self.DEFAULT_COOKIES)

        self._vk.http.get('https://m.vk.com/')  # load cookies
```

--------------------------------

### Captcha Exception

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/exceptions.html

Handles CAPTCHA challenges, providing methods to get the image and submit an answer.

```python
class Captcha(VkApiError):

    def __init__(self, vk, captcha_sid, func, args=None, kwargs=None, url=None):
        super(Captcha, self).__init__()

        self.vk = vk
        self.sid = captcha_sid
        self.func = func
        self.args = args or ()
        self.kwargs = kwargs or {}

        self.code = CAPTCHA_ERROR_CODE

        self.key = None
        self.url = url
        self.image = None


    def get_url(self):
        """ Получить ссылку на изображение капчи """

        if not self.url:
            self.url = f'https://api.vk.com/captcha.php?sid={self.sid}'

        return self.url




    def get_image(self):
        """ Получить изображение капчи (jpg) """

        if not self.image:
            self.image = self.vk.http.get(self.get_url()).content

        return self.image




    def try_again(self, key=None):
        """ Отправить запрос заново с ответом капчи

        :param key: ответ капчи
        """

        if key:
            self.key = key

            self.kwargs.update({
                'captcha_sid': self.sid,
                'captcha_key': self.key
            })

        return self.func(*self.args, **self.kwargs)

    def __str__(self):
        return 'Captcha needed'
```

--------------------------------

### File Handling in VkUpload

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/upload.html

This snippet demonstrates how to handle file uploads, differentiating between file-like objects and file paths. It prepares files for upload by creating tuples of filenames and file objects, ensuring proper handling of file extensions and binary read mode.

```python
if hasattr(file, 'read'):
                f = file

                filename = file.name if hasattr(file, 'name') else '.jpg'
            else:
                filename = file
                f = open(filename, 'rb')
                self.opened_files.append(f)

            ext = filename.split('.')[-1]
            files.append((self.key_format.format(x), (f'file{x}.{ext}', f)))
```

```python
def close_files(self):
        for f in self.opened_files:
            f.close()

        self.opened_files = []
```

--------------------------------

### POST /al_audio.php (Upload Audio)

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/audio.html

Uploads a new audio file to the user or group library.

```APIDOC
## POST https://vk.com/al_audio.php

### Description
Initiates and completes the upload process for an audio file.

### Method
POST

### Endpoint
https://vk.com/al_audio.php

### Parameters
#### Request Body
- **act** (string) - Required - Set to 'new_audio' or 'done_add'
- **gid** (int) - Optional - Group ID (0 for user)
```

--------------------------------

### Follow User

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/audio.html

Initiates a follow action for a specified user. This function first scrapes a necessary hash from the user's audio page and then sends a POST request to the VK API. Access to the user's audio page is required.

```python
def follow_user(self, user_id):
        data = self._vk.http.get(f"https://vk.com/audios{user_id}")

        user_hash = RE_USER_AUDIO_HASH.search(data.text)
        if user_hash is None:
            raise AccessDenied(f"You don't have permissions to browse {user_id}'s audio")
        user_hash = user_hash.groups()[1]

        response = self._vk.http.post(
            'https://vk.com/al_audio.php',
            data={
                'al': 1,
                'act': 'follow_owner',
                'owner_id': user_id,
                'hash': user_hash,
            }
        )
        return json.loads(response.text.replace('<!--', ''))
```

--------------------------------

### Get Empty Keyboard JSON

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/keyboard.html

Generates a JSON string for an empty keyboard. Sending an empty keyboard will remove the current keyboard from the user's chat.

```python
@classmethod
    def get_empty_keyboard(cls):
        """ Получить json пустой клавиатуры.
        Если отправить пустую клавиатуру, текущая у пользователя исчезнет.
        """
        keyboard = cls()
        keyboard.keyboard['buttons'] = []
        return keyboard.get_keyboard()
```

--------------------------------

### POST /method

Source: https://vk-api.readthedocs.io/en/latest/vk_api.html

Executes a specific VK API method.

```APIDOC
## POST /method

### Description
Calls a specific VK API method with provided parameters.

### Parameters
- **method** (str) - Required - Name of the API method.
- **values** (dict) - Optional - Parameters for the method.
- **captcha_sid** (str) - Optional - ID of the captcha.
- **captcha_key** (str) - Optional - Answer to the captcha.
- **raw** (bool) - Optional - If True, returns the full response object.
```

--------------------------------

### VkKeyboard Methods

Source: https://vk-api.readthedocs.io/en/latest/keyboard.html

Methods for manipulating and generating VkKeyboard objects.

```APIDOC
## VkKeyboard Methods

### get_keyboard()

#### Description
Get the JSON representation of the keyboard.

### get_empty_keyboard()

#### Description
Get the JSON for an empty keyboard. Sending an empty keyboard will remove the user's current keyboard.

### add_button(label, color, payload)

#### Description
Add a button with text. Maximum number of buttons per row: MAX_BUTTONS_ON_LINE.

#### Parameters
- **label** (str) - Required - The text on the button and the text sent when it is pressed.
- **color** (VkKeyboardColor or str) - Optional - The color of the button. Defaults to VkKeyboardColor.SECONDARY.
- **payload** (str or list or dict) - Optional - Parameter for callback API.

### add_callback_button(label, color, payload)

#### Description
Add a callback button with text. Maximum number of buttons per row: MAX_BUTTONS_ON_LINE.

#### Parameters
- **label** (str) - Required - The text on the button and the text sent when it is pressed.
- **color** (VkKeyboardColor or str) - Optional - The color of the button. Defaults to VkKeyboardColor.SECONDARY.
- **payload** (str or list or dict) - Optional - Parameter for callback API.

### add_location_button(payload)

#### Description
Add a button with location. Always occupies the full width of the row.

#### Parameters
- **payload** (str or list or dict) - Optional - Parameter for callback API.

### add_vkpay_button(hash, payload)

#### Description
Add a button for payment using VKPay. Always occupies the full width of the row.

#### Parameters
- **hash** (str) - Required - VKPay payment parameters and application ID (in the 'aid' field) separated by '&'.
- **payload** (str or list or dict) - Optional - Parameter for compatibility with older clients.

### add_vkapps_button(app_id, owner_id, label, hash, payload)

#### Description
Add a button for a VK Apps application. Always occupies the full width of the row.

#### Parameters
- **app_id** (int) - Required - The ID of the VK Apps application to launch.
- **owner_id** (int) - Required - The ID of the community where the application is installed, if it needs to be opened in the community context.
- **label** (str) - Required - The name of the application displayed on the button.
- **hash** (str) - Required - The hash for navigation within the application, will be passed in the launch parameters string after the '#' symbol.
- **payload** (str or list or dict) - Optional - Parameter for compatibility with older clients.

### add_openlink_button(label, link, payload)

#### Description
Add a button with a link. Maximum number of buttons per row: MAX_BUTTONS_ON_LINE.

#### Parameters
- **label** (str) - Required - The text on the button.
- **link** (str) - Required - The URL to open when the button is pressed.
- **payload** (str or list or dict) - Optional - Parameter for callback API.

### add_line()

#### Description
Creates a new row for placing buttons. Maximum number of rows: MAX_DEFAULT_LINES (standard display), MAX_INLINE_LINES (inline display).
```

--------------------------------

### Get Audio by ID

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/audio.html

Retrieves a specific audio track using its owner ID and audio ID. It scrapes the HTML content of the audio page to extract track information.

```APIDOC
## GET /api/audio/{owner_id}/{audio_id}

### Description
Retrieves a specific audio track by its owner ID and audio ID.

### Method
GET

### Endpoint
`/api/audio/{owner_id}/{audio_id}`

### Parameters
#### Path Parameters
- **owner_id** (string) - Required - The ID of the audio owner (negative values for groups).
- **audio_id** (string) - Required - The ID of the audio track.

### Response
#### Success Response (200)
- **audio_data** (object) - An object containing details of the audio track.

#### Response Example
```json
{
  "audio_data": {
    "artist": "Artist Name",
    "title": "Track Title",
    "url": "http://example.com/track.mp3"
  }
}
```
```

--------------------------------

### VkAudio Methods

Source: https://vk-api.readthedocs.io/en/latest/audio.html

Methods for interacting with VK audio content including retrieval, searching, and management.

```APIDOC
## VkAudio.get

### Description
Retrieve a list of audio recordings for a user or group.

### Parameters
#### Query Parameters
- **owner_id** (int) - Optional - ID of the owner (negative values for groups)
- **album_id** (int) - Optional - ID of the album
- **access_hash** (str) - Optional - ACCESS_HASH of the album

## VkAudio.edit_audio

### Description
Edit an existing audio recording.

### Parameters
#### Request Body
- **audio_id** (int) - Required - ID of the audio recording
- **owner_id** (int) - Required - ID of the owner
- **hash** (str) - Required - Hash for editing the audio
- **performer** (str) - Required - Name of the performer
- **title** (str) - Required - Title of the audio
- **text** (str) - Optional - Text of the audio
- **genre** (int) - Optional - Genre ID (default 1001)

## VkAudio.upload_audio

### Description
Upload an audio recording.

### Parameters
#### Request Body
- **audio** (str) - Required - Path or identifier of the audio file
- **group_id** (int) - Optional - ID of the group (0 for user)

## VkAudio.search

### Description
Search for audio recordings.

### Parameters
#### Query Parameters
- **q** (str) - Required - Search query
- **count** (int) - Optional - Number of results (default 100)
- **offset** (int) - Optional - Offset for pagination
```

--------------------------------

### VkKeyboard API

Source: https://vk-api.readthedocs.io/en/latest/keyboard.html

Methods and classes for constructing custom keyboards for VK bot interactions.

```APIDOC
## VkKeyboard

### Description
Provides methods to construct and manage custom keyboards for VK bot messages.

### Methods
- **get_keyboard()**: Returns the constructed keyboard object.
- **get_empty_keyboard()**: Returns an empty keyboard object.
- **add_button()**: Adds a standard text button.
- **add_callback_button()**: Adds a callback button.
- **add_location_button()**: Adds a location request button.
- **add_vkpay_button()**: Adds a VK Pay button.
- **add_vkapps_button()**: Adds a VK Apps button.
- **add_openlink_button()**: Adds a button to open a link.
- **add_line()**: Adds a new line to the keyboard layout.
```

--------------------------------

### BaseConfig Class Interface

Source: https://vk-api.readthedocs.io/en/latest/_modules/jconfig/base.html

Documentation for the BaseConfig abstract class, including initialization and configuration management methods.

```APIDOC
## CLASS BaseConfig

### Description
Abstract base class for configuration management. Inheriting classes must define `__slots__`.

### Parameters
- **section** (string) - Required - Name of the configuration subcategory.
- **kwargs** (dict) - Optional - Arguments passed to the load method.

### Methods
- **load(**kwargs)**: Abstract method that must return a dictionary containing the configuration.
- **save()**: Abstract method that must implement logic to save the configuration.
- **setdefault(k, d=None)**: Sets a default value for a key within the section if it does not exist.
- **clear_section()**: Clears all settings within the current section.
```

--------------------------------

### Get Audio by ID

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/audio.html

Retrieves a specific audio track using its owner ID and audio ID. This method scrapes the track information from a VK mobile URL. It requires the `_vk.http` object for making requests.

```python
def get_audio_by_id(self, owner_id, audio_id):
        """ Получить аудиозапись по ID

        :param owner_id: ID владельца (отрицательные значения для групп)
        :param audio_id: ID аудио
        """
        response = self._vk.http.get(
            f'https://m.vk.com/audio{owner_id}_{audio_id}', allow_redirects=False
        )

        ids = scrap_ids_from_html(
            response.text,
            filter_root_el={'class': 'basisDefault'}
        )

        track = scrap_tracks(
            ids,
            self.user_id,
            http=self._vk.http,
            convert_m3u8_links=self.convert_m3u8_links,
        )
        if track:
            return next(track)
        else:
            return []
```

--------------------------------

### POST /al_audio.php (Search)

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/audio.html

Searches for audio tracks within a user's or group's library.

```APIDOC
## POST https://vk.com/al_audio.php

### Description
Searches for audio tracks based on a query string.

### Method
POST

### Endpoint
https://vk.com/al_audio.php

### Parameters
#### Request Body
- **act** (string) - Required - Set to 'section'
- **owner_id** (int) - Optional - ID of the owner
- **section** (string) - Required - Set to 'search'
- **q** (string) - Required - Search query
```

--------------------------------

### Challenge Check

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/vk_api.html

Processes VK challenge pages, extracting necessary parameters like 'hash429' and 'salt' to generate a secure hash for continued authentication.

```python
if not response.url.startswith('https://vk.com/challenge.html?'):
            return response

        hash429 = urllib.parse.parse_qs(response.url.split('?', 1)[-1])['hash429'][0]
        salt = re.search(r"salt\s*=\s*'(.*)'", response.text).group(1)
        hash429_md5 = md5(hash429.encode('ascii') + b':' + salt.encode('ascii')).hexdigest()
        response = self.http.get(f'{response.url}&key={hash429_md5}')
        return response
```

--------------------------------

### VkApi Initialization

Source: https://vk-api.readthedocs.io/en/latest/vk_api.html

Initializes the main VkApi class for interacting with the VK API.

```APIDOC
## VkApi Initialization

### Description
Initializes the VkApi client with credentials, configuration, and session settings.

### Parameters
- **login** (str) - Optional - VK login (phone number recommended).
- **password** (str) - Optional - VK password.
- **token** (str) - Optional - Access token.
- **api_version** (str) - Optional - API version (default: '5.92').
- **app_id** (int) - Optional - Standalone app ID (default: 6222115).
- **scope** (int/str) - Optional - Requested permissions.
- **session** (requests.Session) - Optional - Custom requests session.
```

--------------------------------

### Fetch User Albums

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/audio.html

Retrieves a list of audio albums for a specific user or group.

```python
response = self._vk.http.get(
    f'https://m.vk.com/audio?act=audio_playlists{owner_id}',
    params={'offset': offset},
    allow_redirects=False,
)

if not response.text:
    raise AccessDenied(
        f"You don\'t have permissions to browse {owner_id}\'s albums"
    )

albums = scrap_albums(response.text)

if not albums:
    break

yield from albums
offset += ALBUMS_PER_USER_PAGE
```

```python
def get_albums(self, owner_id=None):
    """ Получить список альбомов пользователя

    :param owner_id: ID владельца (отрицательные значения для групп)
    """

    return list(self.get_albums_iter(owner_id))
```

--------------------------------

### POST /login

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/vk_api.html

Performs the VK login process to obtain cookies and authentication tokens.

```APIDOC
## POST /login

### Description
Authenticates the user against VK servers to obtain session cookies (remixsid) and access tokens.

### Method
POST

### Endpoint
https://vk.com/login

### Parameters
#### Request Body
- **captcha_sid** (int/str) - Optional - ID of the captcha if required.
- **captcha_key** (str) - Optional - The solved captcha response.
```

--------------------------------

### VkFunction Class

Source: https://vk-api.readthedocs.io/en/latest/execute.html

Documentation for initializing and calling the VkFunction wrapper for VKScript execution.

```APIDOC
## VkFunction

### Description
A wrapper class for the VK execute method, enabling the execution of VKScript code.

### Parameters
- **code** (string) - Required - The VKScript code to be executed.
- **args** (list) - Optional - A list of arguments to be converted into JSON.
- **clean_args** (list) - Optional - A list of raw arguments to be inserted as strings.
- **return_raw** (boolean) - Optional - Argument for the raw function of VkApi.method.

## VkFunction.__call__

### Description
Executes the defined VKScript using the provided VkApi instance.

### Parameters
- **vk** (VkApi/VkApiMethod) - Required - The VkApi or VkApiMethod instance.
- ***args** - Optional - Positional arguments.
- ***kwargs** - Optional - Keyword arguments.
```

--------------------------------

### Map Event Attributes and Helper Functions

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/longpoll.html

Configuration mapping event types to their expected attribute lists and utility functions for attribute extraction.

```python
MESSAGE_EXTRA_FIELDS = [
    'peer_id', 'timestamp', 'text', 'extra_values', 'attachments', 'random_id'
]
MSGID = 'message_id'

EVENT_ATTRS_MAPPING = {
    VkEventType.MESSAGE_FLAGS_REPLACE: [MSGID, 'flags'] + MESSAGE_EXTRA_FIELDS,
    VkEventType.MESSAGE_FLAGS_SET: [MSGID, 'mask'] + MESSAGE_EXTRA_FIELDS,
    VkEventType.MESSAGE_FLAGS_RESET: [MSGID, 'mask'] + MESSAGE_EXTRA_FIELDS,
    VkEventType.MESSAGE_NEW: [MSGID, 'flags'] + MESSAGE_EXTRA_FIELDS,
    VkEventType.MESSAGE_EDIT: [MSGID, 'mask'] + MESSAGE_EXTRA_FIELDS,

    VkEventType.READ_ALL_INCOMING_MESSAGES: ['peer_id', 'local_id'],
    VkEventType.READ_ALL_OUTGOING_MESSAGES: ['peer_id', 'local_id'],

    VkEventType.USER_ONLINE: ['user_id', 'extra', 'timestamp'],
    VkEventType.USER_OFFLINE: ['user_id', 'flags', 'timestamp'],

    VkEventType.PEER_FLAGS_RESET: ['peer_id', 'mask'],
    VkEventType.PEER_FLAGS_REPLACE: ['peer_id', 'flags'],
    VkEventType.PEER_FLAGS_SET: ['peer_id', 'mask'],

    VkEventType.PEER_DELETE_ALL: ['peer_id', 'local_id'],
    VkEventType.PEER_RESTORE_ALL: ['peer_id', 'local_id'],

    VkEventType.CHAT_EDIT: ['chat_id', 'self'],
    VkEventType.CHAT_UPDATE: ['type_id', 'peer_id', 'info'],

    VkEventType.USER_TYPING: ['user_id', 'flags'],
    VkEventType.USER_TYPING_IN_CHAT: ['user_id', 'chat_id'],
    VkEventType.USER_RECORDING_VOICE: ['peer_id', 'user_id', 'flags', 'timestamp'],

    VkEventType.USER_CALL: ['user_id', 'call_id'],

    VkEventType.MESSAGES_COUNTER_UPDATE: ['count'],
    VkEventType.NOTIFICATION_SETTINGS_UPDATE: ['values']
}


def get_all_event_attrs():
    keys = set()

    for l in EVENT_ATTRS_MAPPING.values():
        keys.update(l)

    return tuple(keys)


ALL_EVENT_ATTRS = get_all_event_attrs()

PARSE_PEER_ID_EVENTS = [
    k for k, v in EVENT_ATTRS_MAPPING.items() if 'peer_id' in v
]
PARSE_MESSAGE_FLAGS_EVENTS = [
    VkEventType.MESSAGE_FLAGS_REPLACE,
    VkEventType.MESSAGE_NEW
]
```

--------------------------------

### VkAudio API Methods

Source: https://vk-api.readthedocs.io/en/latest/index.html

Methods for interacting with VK Audio, including searching, retrieving, and editing audio tracks.

```APIDOC
## VkAudio Methods

### Description
Provides access to audio-related functionality within the VK API.

### Methods
- **get_iter()**: Returns an iterator for audio tracks.
- **get()**: Retrieves audio tracks.
- **get_albums_iter()**: Returns an iterator for audio albums.
- **get_albums()**: Retrieves audio albums.
- **search_user()**: Searches for audio by user.
- **edit_audio()**: Edits an existing audio track.
- **upload_audio()**: Uploads a new audio track.
- **search()**: Searches for audio tracks.
- **search_iter()**: Returns an iterator for audio search results.
- **get_updates_iter()**: Returns an iterator for audio updates.
- **get_popular_iter()**: Returns an iterator for popular audio tracks.
- **get_news_iter()**: Returns an iterator for audio news.
- **get_audio_by_id()**: Retrieves audio by specific ID.
- **get_post_audio()**: Retrieves audio attached to a post.
```

--------------------------------

### Upload Market Photo

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/upload.html

Uploads product images for a shop, supporting optional cropping and main photo designation.

```python
    def photo_market(self, photo, group_id, main_photo=False,
                     crop_x=None, crop_y=None, crop_width=None):
        """ Загрузка изображений для товаров в магазине

        :param photo: путь к изображению(ям) или file-like объект(ы)
        :type photo: str or list

        :param group_id: идентификатор сообщества, для которого необходимо загрузить фотографию товара
        :type group_id: int
        :param main_photo: является ли фотография обложкой товара
        :type main_photo: bool
        :param crop_x: координата x для обрезки фотографии (верхний правый угол)
        :type crop_x: int
        :param crop_y: координата y для обрезки фотографии (верхний правый угол)
        :type crop_y: int
        :param crop_width: ширина фотографии после обрезки в px
        :type crop_width: int
        """

        if group_id < 0:
            group_id = abs(group_id)

        values = {
            'main_photo': main_photo,
            'group_id': group_id,
        }

        if crop_x is not None:
            values['crop_x'] = crop_x
        if crop_y is not None:
            values['crop_y'] = crop_y
        if crop_width is not None:
            values['crop_width'] = crop_width

        response = self.vk.photos.getMarketUploadServer(**values)
        url = response['upload_url']

        with FilesOpener(photo) as photos_files:
            response = self.http.post(url, files=photos_files)

        values.update(response.json())

        return self.vk.photos.saveMarketPhoto(**values)
```

--------------------------------

### Authentication Methods

Source: https://vk-api.readthedocs.io/en/latest/vk_api.html

Methods for handling user and server authentication.

```APIDOC
## Authentication Methods

### auth(reauth=False, token_only=False)
Performs authentication. `reauth` ignores saved cookies/tokens. `token_only` optimizes for access_token retrieval.

### check_sid()
Checks the validity of the remixsid cookie.

### server_auth()
Performs server-side authorization.

### code_auth(code, redirect_url)
Retrieves an access_token using an authorization code.
```

--------------------------------

### Upload Audio Track

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/audio.html

Uploads a new audio file to a user or group profile.

```python
def upload_audio(self, audio: str, group_id: int = 0):
    """ Загрузка аудиозаписи

    :param group_id: ID группы, для юзера - 0
    """
    response = self._vk.http.post(
        'https://vk.com/al_audio.php',
        data={
            'al': 1,
            'act': 'new_audio',
            'boxhash': base36encode(),
            'gid': group_id
        }
    )
    url = re.search("(https?:[^']*)", json.loads(response.text.replace('<!--', ''))["payload"][1][2]).group(0)
    with FilesOpener(audio, key_format='file') as f:
        uploader_response = self._vk.http.post(url, files=f).json()
    response = self._vk.http.post(
        'https://vk.com/al_audio.php',
        data={
            'al': 1,
            'act': 'done_add',
            'go_uploader_response': json.dumps(uploader_response),
            'upldr': 1
        }
    )
    return json.loads(response.text.replace('<!--', ''))["payload"][1][0]
```

--------------------------------

### Retrieve news audio tracks

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/audio.html

Fetches new audio releases using a generator pattern. Handles pagination through catalog sections.

```python
    def get_news_iter(self, offset=0):
        """ Искать популярные аудиозаписи  (генератор)

        :param offset: смещение
        """

        offset_left = 0

        response = self._vk.http.post(
            'https://vk.com/audio',
            data={
                'block': 'new_songs',
                'section': 'recoms'
            }
        )
        json_response = json.loads(scrap_json(response.text))

        ids = scrap_ids(
            json_response['sectionData']['recoms']['playlist']['list']
        )

        if offset_left + len(ids) >= offset:
            yield from scrap_tracks(
                ids if offset_left >= offset else ids[offset - offset_left :],
                self.user_id,
                convert_m3u8_links=self.convert_m3u8_links,
                http=self._vk.http,
            )
        offset_left += len(ids)

        while True:
            response = self._vk.http.post(
                'https://vk.com/al_audio.php',
                data={
                    'al': 1,
                    'act': 'load_catalog_section',
                    'section_id': json_response['sectionData']['recoms']['sectionId'],
                    'start_from': json_response['sectionData']['recoms']['nextFrom']
                }
            )

            json_response = json.loads(response.text.replace('<!--', ''))

            ids = scrap_ids(
                json_response['payload'][1][1]['playlist']['list']
            )
            if not ids:
                break

            if offset_left + len(ids) >= offset:
                yield from scrap_tracks(
```

--------------------------------

### Upload Market Album Photo

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/upload.html

Uploads a photo for a market product collection.

```python
    def photo_market_album(self, photo, group_id):
        """ Загрузка фотографии для подборки товаров

        :param photo: путь к изображению(ям) или file-like объект(ы)
        :type photo: str or list

        :param group_id: идентификатор сообщества, для которого необходимо загрузить фотографию для подборки товаров
        :type group_id: int
        """

        if group_id < 0:
            group_id = abs(group_id)

        values = {
            'group_id': group_id,
        }

        response = self.vk.photos.getMarketAlbumUploadServer(**values)
        url = response['upload_url']

        with FilesOpener(photo) as photos_files:
            response = self.http.post(url, files=photos_files)

        values.update(response.json())

        return self.vk.photos.saveMarketAlbumPhoto(**values)
```

--------------------------------

### Upload Audio

Source: https://vk-api.readthedocs.io/en/latest/upload.html

Uploads an audio file to VK.

```APIDOC
## POST /upload/audio

### Description
Uploads an audio file to VK.

### Method
POST

### Endpoint
/upload/audio

### Parameters
#### Path Parameters
- None

#### Query Parameters
- **artist** (str) - Required - The artist of the audio file.
- **title** (str) - Required - The title of the audio file.

#### Request Body
- **audio** (str) - Required - Path to the audio file or a file-like object.

### Request Example
```json
{
  "audio": "/path/to/song.mp3",
  "artist": "Example Artist",
  "title": "Example Song"
}
```

### Response
#### Success Response (200)
- **response** (object) - Contains information about the uploaded audio file.

#### Response Example
```json
{
  "response": {
    "audio_hash": "abcdef1234567890",
    "audio_id": 444444444
  }
}
```
```

--------------------------------

### VK Login with Cookies

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/vk_api.html

Performs VK login to obtain 'remixsid' cookies. Requires a password and handles potential captcha challenges by including 'captcha_sid' and 'captcha_key' if provided.

```python
if not self.password:
            raise PasswordRequired('Password is required to login')

        self.http.cookies.clear()

        # Get cookies
        response = self.http.get('https://vk.com/login')

        if response.url.startswith('https://vk.com/429.html?'):
            # is this version still used???
            hash429_md5 = md5(self.http.cookies['hash429'].encode('ascii')).hexdigest()
            self.http.cookies.pop('hash429')
            response = self.http.get(f'{response.url}&key={hash429_md5}')

        response = self._check_challenge(response)

        headers = {
            'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8',
            'Accept-Language': 'en-US,en;q=0.5',
            'Referer': 'https://vk.com/',
            'Content-Type': 'application/x-www-form-urlencoded',
            'Origin': 'https://vk.com',
        }

        values = {
            'act': 'login',
            'role': 'al_frame',
            'expire': '',
            'to': search_re(RE_LOGIN_TO, response.text),
            'recaptcha': '',
            'captcha_sid': '',
            'captcha_key': '',
            '_origin': 'https://vk.com',
            'utf8': '1',
            'ip_h': search_re(RE_LOGIN_IP_H, response.text),
            'lg_h': search_re(RE_LOGIN_LG_H, response.text),
            'lg_domain_h': search_re(RE_LOGIN_LG_DOMAIN_H, response.text),
            'ul': '',
            'email': self.login,
            'pass': self.password
        }

        if captcha_sid and captcha_key:
            self.logger.info(f'Using captcha code: {captcha_sid}: {captcha_key}')
            values['captcha_sid'] = captcha_sid
            values['captcha_key'] = captcha_key

        response = self.http.post(
```

--------------------------------

### POST /docs.save

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/upload.html

Uploads a document to the VK platform, supporting wall posts and private messages.

```APIDOC
## POST /docs.save

### Description
Uploads a document to the VK platform. Supports uploading to walls, private messages, or general storage.

### Method
POST

### Parameters
#### Request Body
- **doc** (file) - Required - Path to the document or file-like object.
- **title** (str) - Optional - Title of the document.
- **tags** (str) - Optional - Tags for searching.
- **group_id** (int) - Optional - ID of the community.
- **to_wall** (bool) - Optional - Whether to upload for a wall post.
- **message_peer_id** (int) - Optional - Peer ID for private message upload.
- **doc_type** (str) - Optional - Type of the document.
```

--------------------------------

### Core API Modules

Source: https://vk-api.readthedocs.io/en/latest/keyboard.html

Overview of the primary classes used for interacting with the VK API.

```APIDOC
## Core Modules

### Description
Essential classes for interacting with the VK platform.

### Classes
- **VkApi**: The main class for API interaction.
- **VkUpload**: Handles file uploads to VK servers.
- **VkTools**: Utility functions for API operations.
- **VkLongPoll**: Module for standard long polling.
- **VkBotLongPoll**: Module for bot-specific long polling.
```

--------------------------------

### POST /al_audio.php (Edit Audio)

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/audio.html

Updates the metadata of an existing audio track.

```APIDOC
## POST https://vk.com/al_audio.php

### Description
Edits the details of an audio track including performer, title, and genre.

### Method
POST

### Endpoint
https://vk.com/al_audio.php

### Parameters
#### Request Body
- **act** (string) - Required - Set to 'edit_audio'
- **aid** (int) - Required - Audio ID
- **oid** (int) - Required - Owner ID
- **hash** (string) - Required - Edit hash
- **performer** (string) - Required - Performer name
- **title** (string) - Required - Track title
- **text** (string) - Optional - Track lyrics
- **genre** (int) - Optional - Genre ID
```

--------------------------------

### Authentication Logic

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/vk_api.html

Handles authentication using either only an access token or a combination of cookies and tokens. Prioritizes token-only authentication if only the access token is needed.

```python
if not self.login:
            raise LoginRequired('Login is required to auth')

        self.logger.info(f'Auth with login: {self.login}')

        set_cookies_from_list(
            self.http.cookies,
            self.storage.setdefault('cookies', [])
        )

        self.token = (
            self.storage.setdefault('token', {})
            .setdefault(f'app{str(self.app_id)}', {})
            .get(f'scope_{str(self.scope)}')
        )

        if token_only:
            self._auth_token(reauth=reauth)
        else:
            self._auth_cookies(reauth=reauth)
```

--------------------------------

### get_all Method

Source: https://vk-api.readthedocs.io/en/latest/tools.html

Retrieves all elements and loads them into memory. Use this only if you need all objects in memory. For processing objects in parts, prefer `get_all_iter`.

```APIDOC
## Method get_all

### Description
Use only if you need to load all objects into memory. If you can process objects in parts, it is better to use `get_all_iter`. For example, if you are writing objects to a database, there is no point in loading all the data into memory.

### Parameters
- **method** (str) - The name of the method.
- **max_count** (int) - The maximum number of elements that can be obtained per request.
- **values** (dict) - Parameters for the API call.
- **key** (str) - The key for the elements to retrieve (default: 'items').
- **limit** (int) - A limit on the number of elements to retrieve, though more may be returned.
- **stop_fn** (func) - A function that determines when to stop the iteration.
- **negative_offset** (bool) - If True, the offset should be negative (default: False).
```

--------------------------------

### POST /document

Source: https://vk-api.readthedocs.io/en/latest/upload.html

Uploads a document to VK.

```APIDOC
## POST /document

### Description
Uploads a document to the VK platform.

### Parameters
#### Request Body
- **doc** (file/path) - Required - Path to the document or file-like object
- **title** (string) - Optional - Title of the document
- **tags** (string) - Optional - Tags for search
- **group_id** (int) - Optional - Community ID if uploading to a group
```

--------------------------------

### POST /story

Source: https://vk-api.readthedocs.io/en/latest/upload.html

Uploads a story to VK.

```APIDOC
## POST /story

### Description
Uploads a story to VK.

### Parameters
#### Request Body
- **file** (file/path) - Required - Path to the image, gif, or video file
- **file_type** (string) - Required - Type of story (photo or video)
- **add_to_news** (bool) - Optional - Whether to post to news
- **user_ids** (list) - Optional - User IDs who can see the story
- **reply_to_story** (int) - Optional - ID of the story being replied to
- **link_text** (string) - Optional - Text for the link
- **link_url** (string) - Optional - URL for the link
- **group_id** (int) - Optional - Community ID
```

--------------------------------

### BaseConfig Class

Source: https://vk-api.readthedocs.io/en/latest/jconfig.html

Abstract base class for configuration management. Inheriting classes must define __slots__ and implement load and save methods.

```APIDOC
## BaseConfig

### Description
Abstract base class for configuration. Inheriting classes must define __slots__.

### Parameters
- **section** (string) - Required - Name of the configuration subcategory.
- **kwargs** (dict) - Optional - Arguments passed to the load() method.

### Methods
- **load(**kwargs)**: Abstract method, must return a dict with the configuration.
- **save()**: Abstract method, must save the configuration.
```

--------------------------------

### Upload Market Photo

Source: https://vk-api.readthedocs.io/en/latest/_modules/vk_api/upload.html

Uploads images for products in a store.

```APIDOC
## POST /photos.getMarketUploadServer & photos.saveMarketPhoto

### Description
Uploads images for products in a store. Allows specifying crop coordinates and dimensions.

### Method
POST

### Endpoint
This method involves two VK API calls: first to get the upload server URL, and then to save the market photo.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **photo** (str or list) - Required - Path to the image(s) or file-like object(s).
- **group_id** (int) - Required - Identifier of the community for which the product photo is being uploaded.
- **main_photo** (bool) - Optional - Whether this photo is the main cover for the product. Defaults to false.
- **crop_x** (int) - Optional - X-coordinate for cropping the photo (top-left corner).
- **crop_y** (int) - Optional - Y-coordinate for cropping the photo (top-left corner).
- **crop_width** (int) - Optional - Width of the photo after cropping in pixels.

### Request Example
```json
{
  "photo": "/path/to/product_image.jpg",
  "group_id": -12345,
  "main_photo": true,
  "crop_x": 10,
  "crop_y": 10,
  "crop_width": 200
}
```

### Response
#### Success Response (200)
Details of the saved market photo.

#### Response Example
```json
{
  "response": {
    "photo_id": 123456789,
    "owner_id": -12345,
    "photo_hash": "some_hash"
  }
}
```
```