Source code for PyPoE.poe.file.stat_filters

"""
Parser for skillpopup_stat_filters.txt

Overview
===============================================================================

+----------+------------------------------------------------------------------+
| Path     | PyPoE/poe/file/stat_filters.py                                   |
+----------+------------------------------------------------------------------+
| Version  | 1.0.0a0                                                          |
+----------+------------------------------------------------------------------+
| Revision | $Id: 8c0f2a25e79bc2ed8def2092c3857fd2b946684a $                  |
+----------+------------------------------------------------------------------+
| Author   | Omega_K2                                                         |
+----------+------------------------------------------------------------------+

Description
===============================================================================

Parser for Metadata/StatDescriptions/skillpopup_stat_filters.txt

Agreement
===============================================================================

See PyPoE/LICENSE

Documentation
===============================================================================

Public API
-------------------------------------------------------------------------------

.. autoclass:: StatFilterFile

.. autoclass:: SkillEntry
"""

# =============================================================================
# Imports
# =============================================================================

# Python
import re

# 3rd-party

# self
from PyPoE.shared.mixins import ReprMixin
from PyPoE.poe.file.shared import AbstractFileReadOnly

# =============================================================================
# Globals
# =============================================================================

__all__ = []

# =============================================================================
# Classes
# =============================================================================


class SkillEntry(ReprMixin):
    """

    Attributes
    ----------
    skill_id : str
        Id from ActiveSkills.dat
    translation_file_path : str
        Path to the translation file that should be used for this skill id.
        Path is relative to content.ggpk
    stats : list[str]
        Order in which to display stats
    """

    __slots__ = ['skill_id', 'translation_file_path', 'stats']

    def __init__(self, skill_id, translation_file_path, stats):
        self.skill_id = skill_id
        self.translation_file_path = translation_file_path
        self.stats = stats


class StatFilterFile(AbstractFileReadOnly):
    """
    Parser for Metadata/skillpopup_stat_filters.txt

    Attributes
    ----------
    groups : dict[str, list[str]]
        Dictionary containing stat groups with the id as key, and the list of
        stats as value
    skills : dict[str, SkillEntry]
        Dictionary mapping the active skill id (as key) to a the respective
        :class:`SkillEntry` instance as value.
    """
    _re_find_sections = re.compile(
        # header
        r'^(?:'
            r'group (?P<group>[\w]+)|'
            r'(?P<skill_id>[\w]+) "(?P<file>[\w/\.]+)"'
        r')[\r\n]+'
        # contents
        r'^{'
        r'(?P<contents>[^}]*)'
        r'^}',
        re.UNICODE | re.MULTILINE,
    )

    _re_find_contents = re.compile(
        r'[\w$]+',
        re.UNICODE | re.MULTILINE,
    )

    groups = None
    skills = None

    def _read(self, buffer, *args, **kwargs):
        data = buffer.read().decode('utf-16')

        self.groups = {}
        self.skills = {}

        for match in self._re_find_sections.finditer(data):
            contents = self._re_find_contents.findall(match.group('contents'))
            if match.group('group'):
                self.groups[match.group('group')] = contents
            elif match.group('skill_id'):
                stats = []
                for stat in contents:
                    if stat.startswith('$'):
                        stats.extend(self.groups[stat[1:]])
                    else:
                        stats.append(stat)
                self.skills[match.group('skill_id')] = SkillEntry(
                    skill_id=match.group('skill_id'),
                    translation_file_path=match.group('file'),
                    stats=stats,
                )