Module `moex.data_classes`

Expand source code

# -*- coding: utf-8 -*-
from dataclasses import dataclass
from typing import FrozenSet, Dict
from xml.etree import ElementTree

from jinja2 import Template as JinjaTemplate
from pandas import DataFrame, read_html


@dataclass
class Template:
    """Data class for template
    """
    id: int
    path: str
    path_variables: FrozenSet
    content: JinjaTemplate


@dataclass
class JSON:
    """Data class wrapper for JSONHandler
    """
    raw: Dict

    def to_df(self, filter_key=None):
        """Convert dict to dataframe

        Parameters
        ----------
        filter_key : str, optional
            Key from dict for select, by default None

        Returns
        -------
        pandas.core.frame.DataFrame
            Converted dataframe
        """
        if self.raw is None:
            return
        if filter_key is None:
            raw_keys = [*self.raw.keys()]
            if raw_keys:
                filter_key = raw_keys[0]
        if filter_key is None or filter_key not in self.raw:
            return
        raw_filtered = self.raw[filter_key]
        raw_filtered_data = raw_filtered.get("data", None)
        raw_filtered_columns = raw_filtered.get("columns", None)
        if raw_filtered_data is None or raw_filtered_columns is None:
            return
        return DataFrame(raw_filtered_data, columns=raw_filtered_columns)


@dataclass
class XML:
    """Data class wrapper for XMLHandler
    """
    raw: str

    def to_tree(self):
        """Convert html text to xml tree

        Returns
        -------
        xml.etree.ElementTree.Element
            XML Tree
        """
        if self.raw:
            return ElementTree.fromstring(self.raw)


@dataclass
class CSV:
    """Data class wrapper for CSVHandler
    """
    raw: str


@dataclass
class HTML:
    """Data class wrapper for HTMLHandler
    """
    raw: str

    def to_df(self):
        """Convert html text to dataframe

        Returns
        -------
        pandas.core.frame.DataFrame
            Converted dataframe
        """
        if self.raw:
            df, = read_html(self.raw)
            return df

Classes

class CSV (raw: str)

Data class wrapper for CSVHandler

Expand source code

class CSV:
    """Data class wrapper for CSVHandler
    """
    raw: str

Class variables

var raw : str

class HTML (raw: str)

Data class wrapper for HTMLHandler

Expand source code

class HTML:
    """Data class wrapper for HTMLHandler
    """
    raw: str

    def to_df(self):
        """Convert html text to dataframe

        Returns
        -------
        pandas.core.frame.DataFrame
            Converted dataframe
        """
        if self.raw:
            df, = read_html(self.raw)
            return df

Class variables

var raw : str

Methods

def to_df(self)

Convert html text to dataframe

Returns

pandas.core.frame.DataFrame: Converted dataframe

Expand source code

def to_df(self):
    """Convert html text to dataframe

    Returns
    -------
    pandas.core.frame.DataFrame
        Converted dataframe
    """
    if self.raw:
        df, = read_html(self.raw)
        return df

class JSON (raw: Dict[~KT, ~VT])

Data class wrapper for JSONHandler

Expand source code

class JSON:
    """Data class wrapper for JSONHandler
    """
    raw: Dict

    def to_df(self, filter_key=None):
        """Convert dict to dataframe

        Parameters
        ----------
        filter_key : str, optional
            Key from dict for select, by default None

        Returns
        -------
        pandas.core.frame.DataFrame
            Converted dataframe
        """
        if self.raw is None:
            return
        if filter_key is None:
            raw_keys = [*self.raw.keys()]
            if raw_keys:
                filter_key = raw_keys[0]
        if filter_key is None or filter_key not in self.raw:
            return
        raw_filtered = self.raw[filter_key]
        raw_filtered_data = raw_filtered.get("data", None)
        raw_filtered_columns = raw_filtered.get("columns", None)
        if raw_filtered_data is None or raw_filtered_columns is None:
            return
        return DataFrame(raw_filtered_data, columns=raw_filtered_columns)

Class variables

var raw : Dict[~KT, ~VT]

Methods

def to_df(self, filter_key=None)

Convert dict to dataframe

Parameters

filter_key : str, optional: Key from dict for select, by default None

Returns

pandas.core.frame.DataFrame: Converted dataframe

Expand source code

def to_df(self, filter_key=None):
    """Convert dict to dataframe

    Parameters
    ----------
    filter_key : str, optional
        Key from dict for select, by default None

    Returns
    -------
    pandas.core.frame.DataFrame
        Converted dataframe
    """
    if self.raw is None:
        return
    if filter_key is None:
        raw_keys = [*self.raw.keys()]
        if raw_keys:
            filter_key = raw_keys[0]
    if filter_key is None or filter_key not in self.raw:
        return
    raw_filtered = self.raw[filter_key]
    raw_filtered_data = raw_filtered.get("data", None)
    raw_filtered_columns = raw_filtered.get("columns", None)
    if raw_filtered_data is None or raw_filtered_columns is None:
        return
    return DataFrame(raw_filtered_data, columns=raw_filtered_columns)

class Template (id: int, path: str, path_variables: FrozenSet[+T_co], content: jinja2.environment.Template)

Data class for template

Expand source code

class Template:
    """Data class for template
    """
    id: int
    path: str
    path_variables: FrozenSet
    content: JinjaTemplate

Class variables

var content : jinja2.environment.Template
var id : int
var path : str
var path_variables : FrozenSet[+T_co]

class XML (raw: str)

Data class wrapper for XMLHandler

Expand source code

class XML:
    """Data class wrapper for XMLHandler
    """
    raw: str

    def to_tree(self):
        """Convert html text to xml tree

        Returns
        -------
        xml.etree.ElementTree.Element
            XML Tree
        """
        if self.raw:
            return ElementTree.fromstring(self.raw)

Class variables

var raw : str

Methods

def to_tree(self)

Convert html text to xml tree

Returns

xml.etree.ElementTree.Element: XML Tree

Expand source code

def to_tree(self):
    """Convert html text to xml tree

    Returns
    -------
    xml.etree.ElementTree.Element
        XML Tree
    """
    if self.raw:
        return ElementTree.fromstring(self.raw)