### EsportsLookupCache Methods

Source: https://mwrogue.readthedocs.io/en/latest/genindex

Provides methods for interacting with a cache for esports lookups, including retrieving cached data, disambiguating players, and getting target information.

```python
cache.clear()
cache.get()
cache.get_disambiguated_player_from_event()
cache.get_target()
cache.get_team_from_event_tricode()
cache.unescape()
```

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

### EsportsLookupCache: Get Lookup Value by Key

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Returns the lookup value for a given key from a specified file. Assumes the file structure mirrors Leaguepedia's -names modules. Supports optional fallback to the key itself if the value is missing.

```python
get(_filename_ , _key_ , _length_ , _allow_fallback =False_)
```

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

### Get Wiki Function

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

A static method to retrieve a wiki object, likely for internal use or validation.

```python
_static _get_wiki(_wiki_)
```

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

### EsportsLookupCache: Get Wiki Page Target

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Caches and returns the redirect target of a wiki page title. If the title has been queried before, the cached result is returned.

```python
get_target(_title_)
```

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

### EsportsLookupCache: Get Team Name from Tricode

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Determines the full team name using its tricode within a specific event. Assumes the tricode matches the team's short name on the wiki and that tricodes are unique within the event.

```python
get_team_from_event_tricode(_event_ , _tricode_)
```

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

### EsportsLookupCache: Get Disambiguated Player ID

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Retrieves the disambiguated ID of a player based on their team and event. It caches results for performance, making a single network call per event/team combination to fetch all player names. Handles players renaming mid-event by storing all their lifetime IDs.

```python
get_disambiguated_player_from_event(_event_ , _team_ , _player_)
```

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

### setup_tables

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Sets up tables.

```APIDOC
## setup_tables

### Description
Sets up the specified tables.

### Parameters
*   **tables** (list) - A list of tables to set up.
```

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

### EsportsClient Class Initialization

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Initializes the EsportsClient for connecting to Gamepedia esports wikis. Allows specifying wiki name, an optional WikiClient, credentials for logged-in sessions, and cache/language settings. It inherits from FandomClient.

```python
class EsportsClient(_wiki : str_, _client : Optional[Site] = None_, _credentials : Optional[AuthCredentials] = None_, _cache : Optional[EsportsLookupCache] = None_, _lang : Optional[str] = None_, _** kwargs_):
    """Bases: `FandomClient`

    Functions for connecting to and editing specifically to Gamepedia esports wikis.
    If not using an esports wiki, please use GamepediaSite instead.
    Create a site object.

    Parameters:
        wiki – Name of a wiki
        client – WikiClient object. If this is provided, SessionManager will not be used.
        credentials – Optional. Provide if you want a logged-in session.
        stg – if it’s a staging wiki or not
    """
```

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

### WikiTime Class Initialization

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Initializes a `WikiTime` object, simplifying timestamps to a model used by esports wikis. It handles timezone conversions for PST, CET, and KST, and manages DST metadata.

```python
class WikiTime:
    """Creates a wiki date-time object

    Parameters
    ----------
    timestamp : datetime object
    tz : optional, timezone. if not provided, utc will be assumed.
    """
    def __init__(self, _timestamp: datetime.datetime, _tz: pytz.timezone = UTC):
        # ... implementation details ...
        pass
```

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

### AuthCredentials Class

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Wrapper class for authentication credentials, simplifying imports for WikiClient. Supports username/password or user file configuration.

```APIDOC
## Class: AuthCredentials

### Description
Wrapper class for authentication credentials, simplifying imports for WikiClient. Supports username/password or user file configuration. Specify either `user_file` or both `username` and `password`.

If using a file, files can be either located in the same directory as the code, or in the config directory of the user. If files in both locations exist, files in the former location will trump those in the latter.

### Parameters
* **username** (str) - Optional - Username, this must include an "@" if using a bot password.
* **password** (str) - Optional - Password, this is the actual value of the password, not the "name" of a "bot password".
* **user_file** (str) - Optional - Either a file or a system variable as a nicknamed account to look for.
* **start_over** (bool) - Optional - Flag to start over.
```

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

### recreate_tables

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Recreates tables.

```APIDOC
## recreate_tables

### Description
Recreates specified tables.

### Parameters
*   **tables** (list) - A list of tables to recreate.
*   **replacement** (bool, optional) - Flag to indicate if replacement should occur. Defaults to True.
```

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

### Table Management Functions

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Provides functions for creating, recreating, and setting up tables. The `recreate_tables` function allows for replacements.

```python
create_tables(_tables_)

recreate_tables(_tables_ , _replacement =True_)

setup_tables(_tables_)
```

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

### Backup and Restore Template Functionality

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Provides methods to back up a template to the Backup namespace and restore it later. The backup process uses a key to identify the template parameters for restoration. Restoration retrieves the backed-up template if found.

```python
backup_template(_template : Template_, _page : Union[str, Page]_, _key : Union[str, List[str]]_)
    """Backs up a template in the Backup namespace. The template can later be restored with get_restored_template.

    Parameters:
        template – Template object
        page – Page or title where the template is located on
        key – Identifying set of params that we can use to locate the template when we restore it
    """

get_restored_template(_template : Template_, _page : Union[str, Page]_, _key : Union[str, List[str]]_) → Optional[Template]
    """Looks for the backed-up version of the specified template on the backup page & returns it
    The template should have been backed up using the backup_template method earlier.

    Parameters:
        template – Template object that we want to restore from backup page
        page – Page or title where the template is located on
        key – Identifying set of params to use to restore the template from

    Returns:
        Template object, if found, else None
    """
```

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

### EsportsClient Methods for Wiki Operations

Source: https://mwrogue.readthedocs.io/en/latest/genindex

Contains methods for interacting with wikis, such as retrieving specific wiki information, creating and recreating database tables, and reporting errors.

```python
client.get_wiki()
client.create_tables()
client.recreate_tables()
client.report_all_errors()
client.log_error_content()
client.log_error_script()
```

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

### get_data_and_timeline

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Queries Leaguepedia to return two JSONs: the data and timeline from a single game.

```APIDOC
## get_data_and_timeline

### Description
Queries Leaguepedia to retrieve the data and timeline for a single game. This function is specific to Leaguepedia.

### Parameters
*   **rpgid** (str) - A single Riot Platform Game ID.
*   **version** (Literal[4, 5], optional) - The API version of the JSON to download. Defaults to 4.

### Returns
*   A tuple containing two JSON objects: the data and the timeline for the game. Returns None for the timeline if it's not found (e.g., for chronobreaks).

### Raises
*   KeyError - If data is not found.
```

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

### AuthCredentials Class for WikiClient Authentication

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

The AuthCredentials class simplifies authentication for the WikiClient by storing username and password. It supports credentials from a file or directly provided username/password. Specify user_file, or both username and password. Files can be in the code directory or user's config directory, with local files taking precedence.

```python
class AuthCredentials(_username =None_, _password =None_, _user_file =None_, _start_over =False_):
    """Wrapper class just to make imports nicer to work with
    Stores username and password for future use with a WikiClient. Specify either user_file or both username and password.
    If using a file, files can be either located in the same directory as the code, or in the config directory of the user. If files in both locations exist, files in the former location will trump those in the latter.

    Parameters:
        username – Username, this must include an @ if using a bot password
        password – Password, this is the actual value of the password, not the “name” of a “bot password”
        user_file – Either a file or a system variable as a nicknamed account to look for
    """
    pass
```

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

### List of Esports Wikis

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

A constant list containing the names of various esports wikis supported by the module.

```python
ALL_ESPORTS_WIKIS _ = ['lol', 'halo', 'smite', 'vg', 'rl', 'pubg', 'fortnite', 'apexlegends', 'fifa', 'gears', 'nba2k', 'paladins', 'siege', 'splatoon2', 'legendsofruneterra', 'default-loadout', 'commons', 'teamfighttactics', 'valorant']_
```

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

### TemplateModifierBase: Backup Template

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Creates a backup of a template using a specified key.

```python
backup(_key_)
```

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

### Wiki and Client Attributes

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Attributes representing the wiki name and the client object.

```python
wiki : str_ = None_

client : Site = None_

cargo_client : CargoClient = None_
```

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

### EsportsClient

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Functions for connecting to and editing specifically to Gamepedia esports wikis. If not using an esports wiki, please use GamepediaSite instead.

```APIDOC
## EsportsClient Class

### Description
Provides functions for connecting to and editing Gamepedia esports wikis.

### Initialization
```python
EsportsClient(wiki: str, client: Optional[Site] = None, credentials: Optional[AuthCredentials] = None, cache: Optional[EsportsLookupCache] = None, lang: Optional[str] = None, **kwargs)
```

### Parameters
*   **wiki** (str) - Name of a wiki.
*   **client** (Optional[Site]) - WikiClient object. If provided, SessionManager will not be used.
*   **credentials** (Optional[AuthCredentials]) - Provide if you want a logged-in session.
*   **cache** (Optional[EsportsLookupCache]) - Cache object.
*   **lang** (Optional[str]) - Language code for the wiki.
*   **kwargs** - Additional keyword arguments.
```

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

### mwrogue Core Classes

Source: https://mwrogue.readthedocs.io/en/latest/genindex

Highlights core classes within the mwrogue library, including client for esports data, cache for lookups, and template modifiers.

```python
from mwrogue.esports_client import EsportsClient
from mwrogue.lookup_cache import EsportsLookupCache
from mwrogue.template_modifier import TemplateModifierBase
from mwrogue.wiki_time import WikiTime
```

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

### get_data_and_timeline_from_gameid

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Queries Leaguepedia to return two JSONs: the data and timeline from a single game.

```APIDOC
## get_data_and_timeline_from_gameid

### Description
Queries Leaguepedia to retrieve the data and timeline for a single game using its Leaguepedia game ID.

### Parameters
*   **game_id** (str) - The Leaguepedia game ID.

### Returns
*   A tuple containing two JSON objects: the data and the timeline for the game.
```

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

### mwrogue Module Structure

Source: https://mwrogue.readthedocs.io/en/latest/genindex

Illustrates the modular structure of the mwrogue library, listing various submodules.

```python
import mwrogue.auth_credentials
import mwrogue.error_reporting
import mwrogue.esports_client
import mwrogue.lookup_cache
import mwrogue.template_modifier
import mwrogue.wiki_time
import mwrogue.wiki_time_parser
```

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

### TemplateModifierBase Methods for Backup and Restore

Source: https://mwrogue.readthedocs.io/en/latest/genindex

Methods for managing wiki templates, specifically for backing up templates and restoring them.

```python
modifier.backup()
modifier.restore()
```

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

### EsportsClient Methods for Querying Match History

Source: https://mwrogue.readthedocs.io/en/latest/genindex

Methods for querying match history data from different sources, including Riot Games API and potentially Wikipedia.

```python
client.query_bayes_id()
client.query_qq_mh()
client.query_riot_mh()
client.query_wp_mh()
```

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

### backup_template

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Backs up a template in the Backup namespace. The template can later be restored with get_restored_template.

```APIDOC
## backup_template

### Description
Backs up a template in the Backup namespace. The template can later be restored using `get_restored_template`.

### Parameters
*   **template** (Template) - The template object to back up.
*   **page** (Union[str, Page]) - The page or title where the template is located.
*   **key** (Union[str, List[str]]) - Identifying set of parameters used to locate the template for restoration.

### Returns
*   null
```

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

### data_pages

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Find all the data pages for an event.

```APIDOC
## data_pages

### Description
Finds all data pages associated with a given event.

### Parameters
*   **event** (str) - The overview page of the event.

### Returns
*   A generator yielding data pages.
```

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

### query_riot_mh

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Queries using a Riot ID.

```APIDOC
## query_riot_mh

### Description
Performs a query using a Riot ID.

### Parameters
*   **riot_mh** (str) - The Riot ID to query.
```

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

### query_qq_mh

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Queries using a QQ ID.

```APIDOC
## query_qq_mh

### Description
Performs a query using a QQ ID.

### Parameters
*   **qq_id** (str) - The QQ ID to query.
```

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

### EsportsClient Methods for Data Retrieval

Source: https://mwrogue.readthedocs.io/en/latest/genindex

Provides methods for fetching esports data, including game data, timelines, and specific data pages. Some methods are designed to retrieve data based on game IDs.

```python
client.get_data_and_timeline()
client.get_data_and_timeline_from_gameid()
client.get_one_data_page()
```

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

### query_wp_mh

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Queries using a WP ID.

```APIDOC
## query_wp_mh

### Description
Performs a query using a WP ID.

### Parameters
*   **wp_id** (str) - The WP ID to query.
```

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

### Query Game Data and Timeline

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Queries Leaguepedia for game data and timeline information using a Riot Platform Game ID (RPGID). It returns two JSON objects, one for data and one for the timeline. This function is specific to Leaguepedia and has limitations on querying multiple games or excluding data fields. It raises a KeyError if data is not found and returns None for the timeline if it's unavailable (e.g., for chronobreaks).

```python
get_data_and_timeline(_rpgid : str_, _version : Literal[4, 5] = 4_)
    """Queries Leaguepedia to return two jsons: The data & timeline from a single game.
    This function is limited in scope: It will not allow you to query multiple games in a single query; however, the MediaWiki API does support this. It also will not allow you to drop one of the jsons for a smaller response package if you don’t require all of the data. You also must know the ID in advance. You can find IDs by querying the MatchScheduleGame Cargo table and looking up the RiotPlatformGameId field.
    Raises a KeyError in the case that data is not found. If Timeline is not found, None will be returned for that json (this happens for chronobreaks).
    This function is unavailable on wikis other than Leaguepedia.

    Parameters:
        rpgid – A single riot_platform_game_id
        version – The API version of the json to download. Defaults to 4.

    Returns:
        Two jsons, the data & timeline for the game
    """

get_data_and_timeline_from_gameid(_game_id : str_)
    """Queries Leaguepedia to return two jsons: The data & timeline from a single game.

    Parameters:
        game_id – The Leaguepedia game_id

    Returns:
        Two jsons, the data & timeline for the game
    """
```

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

### Query Utility Functions

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Utility functions for querying specific identifiers such as bayes ID, QQ ID, Riot MH, and WP ID.

```python
query_bayes_id(_idx_)

query_qq_mh(_qq_id_)

query_riot_mh(_riot_mh_)

query_wp_mh(_wp_id_)
```

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

### TemplateModifierBase: Restore Template

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Restores a template from a backup using a specified key.

```python
restore(_key_)
```

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

### tournaments_to_skip

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Identifies tournaments to skip based on a script.

```APIDOC
## tournaments_to_skip

### Description
Determines which tournaments should be skipped based on script criteria.

### Parameters
*   **script** (str) - The script used for determining skipped tournaments.
```

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

### get_restored_template

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Looks for the backed-up version of the specified template on the backup page & returns it.

```APIDOC
## get_restored_template

### Description
Retrieves the backed-up version of a template from a backup page. The template must have been previously backed up using `backup_template`.

### Parameters
*   **template** (Template) - The template object to restore.
*   **page** (Union[str, Page]) - The page or title where the template is located.
*   **key** (Union[str, List[str]]) - Identifying set of parameters used to restore the template.

### Returns
*   Optional[Template] - The restored Template object if found, otherwise None.
```

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

### Error Reporting Modules

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Details on error reporting classes within the mwrogue package.

```APIDOC
## Module: mwrogue.error_reporting.wiki_content_error

### Class: WikiContentError

### Description
Represents an error related to wiki content.

## Module: mwrogue.error_reporting.wiki_error

### Class: WikiError

### Description
Base class for wiki-related errors.

#### Attributes
* **error** (any) - The error details.
* **error_type** (str) - The type of the error.
* **title** (str) - The title of the error.

#### Methods
* **format_for_print()** - Formats the error for printing.
```

```APIDOC
## Module: mwrogue.error_reporting.wiki_script_error

### Class: WikiScriptError

### Description
Represents an error related to wiki scripts.
```

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

### mwrogue.wiki_time_parser.time_from_template

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Extracts date-time information from a template and returns a WikiTime object.

```APIDOC
## POST /api/parse/time_from_template

### Description
Pulls date-time information encoded by a template and returns a WikiTime object. Returns None if information is missing or incomplete.

### Method
POST

### Endpoint
/api/parse/time_from_template

### Parameters

#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **template** (Template) - Required - A mwparserfromhell Template object with date, time, and timezone parameters.

### Request Example
```json
{
  "template": "{{Start date|2023|10|27}}"
}
```

### Response
#### Success Response (200)
* **wikiTime** (WikiTime or None) - A WikiTime object representing the date-time information, or None if data is insufficient.

#### Response Example
```json
{
  "wikiTime": {
    "timestamp": "2023-10-27T00:00:00+00:00",
    "timezone": "UTC"
  }
}
```
```

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

### WikiTime Class

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Represents a timestamp within the simplified timezone model used by esports wikis. It handles PST, CET, and KST timezones and user-supplied DST metadata.

```APIDOC
## WikiTime Class

### Description
Manages timestamps for esports wikis with a simplified timezone model (PST, CET, KST) and handles Daylight Saving Time metadata.

### Parameters

#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

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

### get_one_data_page

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Find one data page for an event.

```APIDOC
## get_one_data_page

### Description
Retrieves a single data page for a specified event.

### Parameters
*   **event** (str) - The overview page of the event.
*   **i** (int) - The index of the data page to retrieve.

### Returns
*   A Page object representing the requested data page.
```

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

### Custom Exception: EsportsCacheKeyError

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Defines a custom exception `EsportsCacheKeyError` inheriting from `KeyError`. This exception is used for errors related to cache keys in an esports context, providing details about the file, value, length, and value table involved.

```python
class EsportsCacheKeyError(_file_ , _value_ , _length_ , _value_table_):
    pass
```

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

### EsportsClient Methods for Tournament Filtering

Source: https://mwrogue.readthedocs.io/en/latest/genindex

Methods to retrieve lists of tournaments that should be skipped, either all or based on specific criteria.

```python
client.tournaments_to_skip()
client.tournaments_to_skip_where()
```

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

### tournaments_to_skip_where

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Identifies tournaments to skip based on a script and a specific field.

```APIDOC
## tournaments_to_skip_where

### Description
Determines which tournaments should be skipped based on script criteria and a specific field.

### Parameters
*   **script** (str) - The script used for determining skipped tournaments.
*   **field** (str) - The field to check for skipping criteria.
```

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

### Error Logging and Reporting

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Functions for logging errors, either as content with a title or as script errors with an exception object. It also includes a function to report all errors associated with a given title.

```python
log_error_content(_title : Optional[str] = None_, _text : Optional[str] = None_)

log_error_script(_title : Optional[str] = None_, _error : Optional[Exception] = None_)

report_all_errors(_error_title_)
```

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

### Find Event Data Pages

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Retrieves data pages associated with a specific event. It can find all data pages for an event or a single, specific data page based on an index.

```python
data_pages(_event_)
    """Find all the data pages for an event.

    Parameters:
        event – Overview Page of event

    Returns:
        generator of data pages
    """

get_one_data_page(_event_ , _i_)
    """Find one data page for an event

    Parameters:
        event – Overview Page of an event
        i – the ith page to return

    Returns:
        a Page object of a single data page
    """
```

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

### Tournament Skipping Logic

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Functions to manage and check which tournaments should be skipped based on script and field criteria.

```python
tournaments_to_skip(_script_)

tournaments_to_skip_where(_script_ , _field_)
```

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

### mwrogue.wiki_time_parser.time_from_str

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Parses a timestamp string and converts it into a WikiTime object.

```APIDOC
## POST /api/parse/time_from_str

### Description
Parses a timestamp string and returns a WikiTime object, optionally with a specified timezone.

### Method
POST

### Endpoint
/api/parse/time_from_str

### Parameters

#### Path Parameters
None

#### Query Parameters
* **tz** (Optional[timezone]) - Optional - The timezone to use for parsing.

#### Request Body
* **timestamp** (str) - Required - The timestamp string to parse.

### Request Example
```json
{
  "timestamp": "2023-10-27 10:00:00 PST"
}
```

### Response
#### Success Response (200)
* **wikiTime** (WikiTime) - A WikiTime object representing the parsed timestamp.

#### Response Example
```json
{
  "wikiTime": {
    "timestamp": "2023-10-27T18:00:00+00:00",
    "timezone": "UTC"
  }
}
```
```

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

### Time Parsing from Template

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Extracts date-time information from a `mwparserfromhell` Template object and returns a `WikiTime` object. Returns `None` if date-time information is missing or incomplete.

```python
def time_from_template(_template : Template):
    """Pulls date-time information encoded by a template and returns a WikiTime object.

    If date-time information is missing or incomplete, None is returned instead.

    Parameters
    ----------
    template : A mwparserfromhell Template object with date, time, and timezone parameters

    Returns
    -------
    a WikiTime object representing the date-time information encoded by this template
    """
    # ... implementation details ...
    pass
```

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

### log_error_script

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Logs a script error.

```APIDOC
## log_error_script

### Description
Logs a script execution error.

### Parameters
*   **title** (Optional[str]) - The title of the script or error.
*   **error** (Optional[Exception]) - The exception object representing the error.
```

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

### query_bayes_id

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Queries using a Bayes ID.

```APIDOC
## query_bayes_id

### Description
Performs a query using a Bayes ID.

### Parameters
*   **idx** (str) - The Bayes ID to query.
```

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

### WikiTime Parsing Functions

Source: https://mwrogue.readthedocs.io/en/latest/genindex

Functions for parsing time information from strings or wiki templates.

```python
mwrogue.wiki_time_parser.time_from_str()
mwrogue.wiki_time_parser.time_from_template()
```

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

### Custom Exceptions

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Custom exception classes defined in the mwrogue.errors module.

```APIDOC
## Exception: CantFindMatchHistory

### Description
Raised when match history cannot be found.

Bases: `KeyError`

## Exception: EsportsCacheKeyError

### Description
Raised when there is an issue with the esports cache key.

### Parameters
* **file_** (str) - The file associated with the error.
* **value** (any) - The problematic value.
* **length** (int) - The length of the value.
* **value_table** (str) - The table containing the value.

Bases: `KeyError`

## Exception: InvalidEventError

### Description
Raised when an event is invalid.

Bases: `KeyError`
```

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

### Custom Exception: CantFindMatchHistory

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Defines a custom exception class `CantFindMatchHistory` that inherits from `KeyError`. This exception is used to indicate when a match history cannot be found, likely due to a missing key or data.

```python
class CantFindMatchHistory(KeyError):
    pass
```

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

### report_all_errors

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Reports all errors associated with a given title.

```APIDOC
## report_all_errors

### Description
Reports all errors pertaining to a specific error title.

### Parameters
*   **error_title** (str) - The title used to identify the errors to report.
```

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

### WikiContentError Class

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Represents an error specifically related to wiki content. This class is part of the error reporting submodules within the mwrogue package.

```python
class WikiContentError:
    pass
```

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

### log_error_content

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Logs an error with associated content.

```APIDOC
## log_error_content

### Description
Logs an error message along with optional content.

### Parameters
*   **title** (Optional[str]) - The title of the error.
*   **text** (Optional[str]) - The content associated with the error.
```

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

### WikiError Class and its Properties

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

The `WikiError` class is designed to encapsulate errors encountered during wiki operations. It provides attributes for the error itself (`error`), the type of error (`error_type`), and a formatted representation for printing (`format_for_print`), along with a title (`title`).

```python
class WikiError:
    error: any
    error_type: any

    def format_for_print(self):
        pass

    title: any
```

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

### EsportsLookupCache: Clear Cache

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Clears all cached lookup data within the EsportsLookupCache instance.

```python
clear()
```

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

### Time Parsing from String

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Parses a timestamp string into a `WikiTime` object. Optionally accepts a timezone to aid in parsing.

```python
def time_from_str(_timestamp : str, _tz : Optional[timezone] = None):
    # ... implementation details ...
    pass
```

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

### EsportsLookupCache: Unescape String (Static Method)

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

A static method to unescape a given string.

```python
_static _unescape(_string_)
```

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

### mwrogue Error Classes

Source: https://mwrogue.readthedocs.io/en/latest/genindex

Defines custom error classes used within the mwrogue library for handling specific error conditions.

```python
from mwrogue.errors import InvalidEventError
from mwrogue.error_reporting.wiki_error import WikiError
from mwrogue.error_reporting.wiki_content_error import WikiContentError
from mwrogue.error_reporting.wiki_script_error import WikiScriptError
from mwrogue.esports_client import EsportsCacheKeyError
```

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

### WikiScriptError Class

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Represents an error associated with a wiki script execution. This class is part of the error reporting utilities within the mwrogue package.

```python
class WikiScriptError:
    pass
```

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

### Custom Exception: InvalidEventError

Source: https://mwrogue.readthedocs.io/en/latest/mwrogue

Defines a custom exception `InvalidEventError` that inherits from `KeyError`. This exception is raised when an event data or identifier is considered invalid, typically indicating a data integrity issue.

```python
class InvalidEventError(KeyError):
    pass
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.