mtcli 3.6.1__tar.gz → 3.7.0.dev0__tar.gz

{mtcli-3.6.1 → mtcli-3.7.0.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mtcli
-Version: 3.6.1
+Version: 3.7.0.dev0
 Summary: Aplicativo CLI para exibir gráficos do MetaTrader 5 screen reader friendly
 License-Expression: MIT
 License-File: LICENSE

mtcli-3.7.0.dev0/mtcli/commands/conf.py

@@ -0,0 +1,44 @@
+"""
+Comando para exibir configurações disponíveis.
+"""
+
+import click
+
+from mtcli.config_registry import registry
+from mtcli.conf import conf
+
+
+@click.command()
+@click.argument("section", required=False)
+def conf_cmd(section):
+    """
+    Exibe configurações disponíveis.
+
+    Exemplos:
+
+        mt conf
+        mt conf renko
+    """
+
+    if section:
+        options = registry.get_section(section)
+    else:
+        options = registry.get_all()
+
+    if not options:
+        click.echo("Nenhuma configuração registrada.")
+        return
+
+    for opt in options:
+
+        value = conf.get(opt.name, section=opt.section, default=opt.default)
+
+        click.echo(
+            f"{opt.section}.{opt.name} = {value} "
+            f"(default={opt.default})"
+        )
+
+        if opt.description:
+            click.echo(f"  {opt.description}")
+
+        click.echo()

mtcli-3.7.0.dev0/mtcli/conf.py

@@ -0,0 +1,233 @@
+"""
+Sistema central de configuração do mtcli.
+
+Fornece leitura de configuração a partir de:
+
+1. Variáveis de ambiente
+2. Arquivo mtcli.ini
+3. Valores default
+
+Também oferece utilidades usadas por plugins como:
+
+- descoberta do diretório MQL5/Files
+- seleção da fonte de dados (CSV ou MT5)
+
+Plugins devem acessar a configuração através do objeto global `conf`.
+"""
+
+import os
+import configparser
+
+import MetaTrader5 as mt5
+
+from mtcli.mt5_context import mt5_conexao
+
+
+class Config:
+    """
+    Gerenciador central de configurações do mtcli.
+    """
+
+    def __init__(self, filename="mtcli.ini"):
+        self.config = configparser.ConfigParser()
+        self.config.read(filename)
+
+    # ---------------------------------------------------------
+    # leitura de valores
+    # ---------------------------------------------------------
+
+    def get(self, key, section="DEFAULT", cast=None, default=None):
+        """
+        Retorna um valor de configuração.
+
+        Prioridade:
+
+        1. Variável de ambiente SECTION_KEY
+        2. Variável de ambiente KEY
+        3. mtcli.ini [section]
+        4. mtcli.ini [DEFAULT]
+        5. default
+
+        Args:
+            key (str)
+            section (str)
+            cast (type | None)
+            default (Any)
+
+        Returns:
+            Any
+        """
+
+        env_key = f"{section.upper()}_{key.upper()}"
+
+        value = os.getenv(env_key) or os.getenv(key.upper())
+
+        if value is None:
+
+            if self.config.has_option(section, key):
+                value = self.config.get(section, key)
+
+            elif self.config.has_option("DEFAULT", key):
+                value = self.config.get("DEFAULT", key)
+
+            else:
+                value = default
+
+        if cast and value is not None:
+
+            try:
+
+                if cast is bool:
+                    value = str(value).lower() in ("1", "true", "yes")
+
+                else:
+                    value = cast(value)
+
+            except ValueError:
+                value = default
+
+        return value
+
+    # ---------------------------------------------------------
+    # seção helper
+    # ---------------------------------------------------------
+
+    def section(self, section):
+        """
+        Retorna um helper para acessar uma seção específica.
+        """
+
+        class Section:
+
+            def __init__(self, parent, section):
+                self.parent = parent
+                self.section = section
+
+            def get(self, key, cast=None, default=None):
+                return self.parent.get(key, self.section, cast, default)
+
+        return Section(self, section)
+
+    # ---------------------------------------------------------
+    # caminho MT5
+    # ---------------------------------------------------------
+
+    def get_csv_path(self):
+        """
+        Retorna o caminho da pasta MQL5/Files.
+        """
+
+        path = self.get("mt5_pasta")
+
+        if path:
+            return os.path.normpath(path) + os.sep
+
+        with mt5_conexao():
+
+            info = mt5.terminal_info()
+
+            if info is None:
+                raise RuntimeError(
+                    "Não foi possível obter informações do terminal MT5."
+                )
+
+        path = os.path.join(info.data_path, "MQL5", "Files")
+
+        return os.path.normpath(path) + os.sep
+
+    # ---------------------------------------------------------
+    # data source
+    # ---------------------------------------------------------
+
+    def get_data_source(self, source=None):
+        """
+        Retorna a fonte de dados configurada.
+        """
+
+        from mtcli.data import CsvDataSource, MT5DataSource
+
+        src = (source or self.get("dados", default="mt5")).lower()
+
+        if src == "csv":
+            return CsvDataSource()
+
+        if src == "mt5":
+            return MT5DataSource()
+
+        raise ValueError(f"Fonte de dados desconhecida: {src}")
+
+
+# instância global usada por todo o sistema
+conf = Config()
+
+
+# ---------------------------------------------------------
+# timeframes suportados
+# ---------------------------------------------------------
+
+_HOURS = [12, 8, 6, 4, 3, 2, 1]
+_MINUTES = [30, 20, 15, 12, 10, 6, 5, 4, 3, 2, 1]
+
+TIMEFRAMES = (
+    ["mn1", "w1", "d1"]
+    + [f"h{i}" for i in _HOURS]
+    + [f"m{i}" for i in _MINUTES]
+)
+
+
+# ---------------------------------------------------------
+# Configurações gerais
+# ---------------------------------------------------------
+
+SYMBOL = conf.get("symbol", default="WIN$N")
+DIGITOS = conf.get("digitos", cast=int, default=2)
+PERIOD = conf.get("period", default="D1")
+BARS = conf.get("count", cast=int, default=999)
+
+VIEW = conf.get("view", default="ch")
+VOLUME = conf.get("volume", default="tick")
+DATE = conf.get("date", default="")
+
+# ---------------------------------------------------------
+# Configurações de leitura de candles
+# ---------------------------------------------------------
+
+LATERAL = conf.get("lateral", default="doji")
+ALTA = conf.get("alta", default="verde")
+BAIXA = conf.get("baixa", default="vermelho")
+
+ROMPIMENTO_ALTA = conf.get("rompimento_alta", default="c")
+ROMPIMENTO_BAIXA = conf.get("rompimento_baixa", default="v")
+
+PERCENTUAL_ROMPIMENTO = conf.get(
+    "percentual_rompimento", cast=int, default=50
+)
+
+PERCENTUAL_DOJI = conf.get(
+    "percentual_doji", cast=int, default=10
+)
+
+# ---------------------------------------------------------
+# Configurações de padrões de barra
+# ---------------------------------------------------------
+
+UP_BAR = conf.get("up_bar", default="asc")
+DOWN_BAR = conf.get("down_bar", default="desc")
+
+INSIDE_BAR = conf.get("inside_bar", default="ib")
+OUTSIDE_BAR = conf.get("outside_bar", default="ob")
+
+SOMBRA_SUPERIOR = conf.get("sombra_superior", default="top")
+SOMBRA_INFERIOR = conf.get("sombra_inferior", default="bottom")
+
+# ---------------------------------------------------------
+# Fonte de dados
+# ---------------------------------------------------------
+
+DATA_SOURCE = conf.get_data_source()
+
+# ---------------------------------------------------------
+# caminho inicial do CSV (pode vir do ini/env)
+# ---------------------------------------------------------
+
+_INITIAL_CSV_PATH = conf.get_csv_path()

mtcli-3.7.0.dev0/mtcli/config_registre.py

@@ -0,0 +1,41 @@
+"""
+Registry de configurações do mtcli.
+
+Plugins podem registrar suas opções de configuração aqui
+para permitir descoberta automática via CLI.
+"""
+
+
+class ConfigOption:
+    """
+    Representa uma opção de configuração registrada.
+    """
+
+    def __init__(self, section, name, type=str, default=None, description=""):
+        self.section = section
+        self.name = name
+        self.type = type
+        self.default = default
+        self.description = description
+
+
+class ConfigRegistry:
+    """
+    Registro central de opções de configuração.
+    """
+
+    def __init__(self):
+        self._options = []
+
+    def register(self, section, name, type=str, default=None, description=""):
+        option = ConfigOption(section, name, type, default, description)
+        self._options.append(option)
+
+    def get_all(self):
+        return self._options
+
+    def get_section(self, section):
+        return [o for o in self._options if o.section == section]
+
+
+registry = ConfigRegistry()

{mtcli-3.6.1 → mtcli-3.7.0.dev0}/mtcli/logger.py

@@ -1,136 +1,136 @@
-"""
-Sistema central de logging do mtcli.
-
-Este módulo fornece uma função única `setup_logger()` utilizada por todo
-o ecossistema de plugins do mtcli para configurar logging consistente.
-
-Características principais
---------------------------
-
-✔ Arquivo de log rotativo em:
-  %APPDATA%/mtcli/logs/mtcli.log
-
-✔ Rotação automática:
-  - tamanho máximo: 2 MB
-  - até 3 arquivos de backup
-
-✔ Proteção contra duplicação de handlers quando plugins
-  inicializam o logger múltiplas vezes.
-
-✔ Encoding UTF-8 garantido (evita problemas de acentuação
-  no Windows).
-
-✔ Compatível com pytest (caplog).
-
-Observação
-----------
-
-Os logs **não são exibidos no console**.
-Toda saída é direcionada exclusivamente para o arquivo de log.
-"""
-
-import logging
-from logging.handlers import RotatingFileHandler
-import os
-
-
-# ==========================================================
-# DIRETÓRIO DE LOG
-# ==========================================================
-
-base_dir = os.getenv("APPDATA", os.path.expanduser("~"))
-
-LOG_DIR = os.path.join(base_dir, "mtcli", "logs")
-
-os.makedirs(LOG_DIR, exist_ok=True)
-
-LOG_FILE = os.path.join(LOG_DIR, "mtcli.log")
-
-
-# ==========================================================
-# LOGGER SETUP
-# ==========================================================
-
-def setup_logger(name: str = "mtcli") -> logging.Logger:
-    """
-    Cria ou retorna um logger configurado para o mtcli.
-
-    O logger utiliza **apenas um handler de arquivo rotativo**.
-    Nenhuma saída é enviada ao console.
-
-    A função é **idempotente**, ou seja, pode ser chamada
-    múltiplas vezes sem duplicar handlers.
-
-    Parameters
-    ----------
-    name : str
-        Nome do logger (normalmente `__name__`).
-
-    Returns
-    -------
-    logging.Logger
-        Instância configurada do logger.
-    """
-
-    logger = logging.getLogger(name)
-
-    logger.setLevel(logging.DEBUG)
-
-    formatter = logging.Formatter(
-        "%(asctime)s | %(levelname)-8s | %(name)s | %(message)s",
-        datefmt="%Y-%m-%d %H:%M:%S",
-    )
-
-    # ======================================================
-    # REMOVE STREAM HANDLERS (garante silêncio no console)
-    # ======================================================
-
-    for handler in list(logger.handlers):
-        if isinstance(handler, logging.StreamHandler) and not isinstance(handler, RotatingFileHandler):
-            logger.removeHandler(handler)
-
-    # ======================================================
-    # FILE HANDLER ROTATIVO
-    # ======================================================
-
-    file_handler_exists = any(
-        isinstance(h, RotatingFileHandler) for h in logger.handlers
-    )
-
-    if not file_handler_exists:
-
-        file_handler = RotatingFileHandler(
-            LOG_FILE,
-            maxBytes=2_000_000,
-            backupCount=3,
-            encoding="utf-8",
-            delay=True,
-        )
-
-        file_handler.setFormatter(formatter)
-
-        logger.addHandler(file_handler)
-
-    # ======================================================
-    # PROPAGATION
-    # ======================================================
-
-    # Permite que pytest caplog capture logs
-    logger.propagate = True
-
-    return logger
-
-
-# ==========================================================
-# LOGGER PADRÃO DO MTCLI
-# ==========================================================
-
-"""
-Logger padrão utilizado por módulos internos do mtcli.
-
-Plugins geralmente criam seu próprio logger usando:
-
-    setup_logger(__name__)
-"""
-
-log = setup_logger()
+"""
+Sistema central de logging do mtcli.
+
+Este módulo fornece uma função única `setup_logger()` utilizada por todo
+o ecossistema de plugins do mtcli para configurar logging consistente.
+
+Características principais
+--------------------------
+
+✔ Arquivo de log rotativo em:
+  %APPDATA%/mtcli/logs/mtcli.log
+
+✔ Rotação automática:
+  - tamanho máximo: 2 MB
+  - até 3 arquivos de backup
+
+✔ Proteção contra duplicação de handlers quando plugins
+  inicializam o logger múltiplas vezes.
+
+✔ Encoding UTF-8 garantido (evita problemas de acentuação
+  no Windows).
+
+✔ Compatível com pytest (caplog).
+
+Observação
+----------
+
+Os logs **não são exibidos no console**.
+Toda saída é direcionada exclusivamente para o arquivo de log.
+"""
+
+import logging
+from logging.handlers import RotatingFileHandler
+import os
+
+
+# ==========================================================
+# DIRETÓRIO DE LOG
+# ==========================================================
+
+base_dir = os.getenv("APPDATA", os.path.expanduser("~"))
+
+LOG_DIR = os.path.join(base_dir, "mtcli", "logs")
+
+os.makedirs(LOG_DIR, exist_ok=True)
+
+LOG_FILE = os.path.join(LOG_DIR, "mtcli.log")
+
+
+# ==========================================================
+# LOGGER SETUP
+# ==========================================================
+
+def setup_logger(name: str = "mtcli") -> logging.Logger:
+    """
+    Cria ou retorna um logger configurado para o mtcli.
+
+    O logger utiliza **apenas um handler de arquivo rotativo**.
+    Nenhuma saída é enviada ao console.
+
+    A função é **idempotente**, ou seja, pode ser chamada
+    múltiplas vezes sem duplicar handlers.
+
+    Parameters
+    ----------
+    name : str
+        Nome do logger (normalmente `__name__`).
+
+    Returns
+    -------
+    logging.Logger
+        Instância configurada do logger.
+    """
+
+    logger = logging.getLogger(name)
+
+    logger.setLevel(logging.DEBUG)
+
+    formatter = logging.Formatter(
+        "%(asctime)s | %(levelname)-8s | %(name)s | %(message)s",
+        datefmt="%Y-%m-%d %H:%M:%S",
+    )
+
+    # ======================================================
+    # REMOVE STREAM HANDLERS (garante silêncio no console)
+    # ======================================================
+
+    for handler in list(logger.handlers):
+        if isinstance(handler, logging.StreamHandler) and not isinstance(handler, RotatingFileHandler):
+            logger.removeHandler(handler)
+
+    # ======================================================
+    # FILE HANDLER ROTATIVO
+    # ======================================================
+
+    file_handler_exists = any(
+        isinstance(h, RotatingFileHandler) for h in logger.handlers
+    )
+
+    if not file_handler_exists:
+
+        file_handler = RotatingFileHandler(
+            LOG_FILE,
+            maxBytes=2_000_000,
+            backupCount=3,
+            encoding="utf-8",
+            delay=True,
+        )
+
+        file_handler.setFormatter(formatter)
+
+        logger.addHandler(file_handler)
+
+    # ======================================================
+    # PROPAGATION
+    # ======================================================
+
+    # Permite que pytest caplog capture logs
+    logger.propagate = True
+
+    return logger
+
+
+# ==========================================================
+# LOGGER PADRÃO DO MTCLI
+# ==========================================================
+
+"""
+Logger padrão utilizado por módulos internos do mtcli.
+
+Plugins geralmente criam seu próprio logger usando:
+
+    setup_logger(__name__)
+"""
+
+log = setup_logger()

{mtcli-3.6.1 → mtcli-3.7.0.dev0}/mtcli/models/rates_model.py

@@ -1,41 +1,41 @@
-"""Módulo do model para obtenção das cotações."""
-
-from datetime import datetime
-
-from mtcli import conf
-
-
-class RatesModel:
-    """Classe do model para obtenção das cotações."""
-
-    def __init__(self, symbol, period, count=999, start=None, end=None, limit=None):
-        """Construtor da classe model rates."""
-        self.symbol = symbol
-        self.period = period
-        self.count = count
-        self.start = start
-        self.end = end
-        self.limit = limit
-        self.source = conf.get_data_source()
-
-    def get_data(self):
-        """Obtém a lista das cotações com filtros opcionais."""
-        data = self.source.get_data(self.symbol, self.period, self.count)
-
-        # Filtro por data
-        if self.start or self.end:
-
-            def filtrar(linha):
-                datahora = datetime.strptime(linha[0], "%Y.%m.%d %H:%M:%S")
-                if self.start and datahora < self.start:
-                    return False
-                if self.end and datahora > self.end:
-                    return False
-                return True
-
-            data = list(filter(filtrar, data))
-        # Limite de linhas
-        if self.limit:
-            data = data[-self.limit :]
-
-        return data
+"""Módulo do model para obtenção das cotações."""
+
+from datetime import datetime
+
+from mtcli.conf import conf
+
+
+class RatesModel:
+    """Classe do model para obtenção das cotações."""
+
+    def __init__(self, symbol, period, count=999, start=None, end=None, limit=None):
+        """Construtor da classe model rates."""
+        self.symbol = symbol
+        self.period = period
+        self.count = count
+        self.start = start
+        self.end = end
+        self.limit = limit
+        self.source = conf.get_data_source()
+
+    def get_data(self):
+        """Obtém a lista das cotações com filtros opcionais."""
+        data = self.source.get_data(self.symbol, self.period, self.count)
+
+        # Filtro por data
+        if self.start or self.end:
+
+            def filtrar(linha):
+                datahora = datetime.strptime(linha[0], "%Y.%m.%d %H:%M:%S")
+                if self.start and datahora < self.start:
+                    return False
+                if self.end and datahora > self.end:
+                    return False
+                return True
+
+            data = list(filter(filtrar, data))
+        # Limite de linhas
+        if self.limit:
+            data = data[-self.limit :]
+
+        return data