mtcli 3.6.0.dev1__py3-none-any.whl → 3.7.0.dev0__py3-none-any.whl

mtcli/cli.py

@@ -1,34 +1,34 @@
-"""
-CLI principal do mtcli.
-
-Este módulo define o grupo principal `mt`
-e inicializa o carregamento de plugins.
-"""
-
-import click
-
-from mtcli.plugin_loader import load_plugins
-from .commands.bars import bars
-
-
-@click.group(context_settings={"max_content_width": 120})
-@click.version_option(package_name="mtcli")
-def mt():
-    """
-    CLI principal do mtcli.
-
-    Exibe gráficos e informações de mercado
-    em formato textual compatível com leitores de tela.
-    """
-    pass
-
-
-mt.add_command(bars, name="bars")
-
-
-# Carrega plugins automaticamente
-load_plugins(mt)
-
-
-if __name__ == "__main__":
-    mt()
+"""
+CLI principal do mtcli.
+
+Este módulo define o grupo principal `mt`
+e inicializa o carregamento de plugins.
+"""
+
+import click
+
+from mtcli.plugin_loader import load_plugins
+from .commands.bars import bars
+
+
+@click.group(context_settings={"max_content_width": 120})
+@click.version_option(package_name="mtcli")
+def mt():
+    """
+    CLI principal do mtcli.
+
+    Exibe gráficos e informações de mercado
+    em formato textual compatível com leitores de tela.
+    """
+    pass
+
+
+mt.add_command(bars, name="bars")
+
+
+# Carrega plugins automaticamente
+load_plugins(mt)
+
+
+if __name__ == "__main__":
+    mt()

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/conf.py

@@ -1,19 +1,18 @@
 """
-Configurações principais do mtcli.
+Sistema central de configuração do mtcli.
 
-Este módulo centraliza a leitura de configurações provenientes de:
+Fornece leitura de configuração a partir de:
 
 1. Variáveis de ambiente
 2. Arquivo mtcli.ini
+3. Valores default
 
-As variáveis de ambiente sempre têm prioridade sobre o arquivo INI.
+Também oferece utilidades usadas por plugins como:
 
-Também fornece utilidades para obter o caminho de arquivos do
-terminal MetaTrader5 e selecionar a fonte de dados (CSV ou MT5).
+- descoberta do diretório MQL5/Files
+- seleção da fonte de dados (CSV ou MT5)
 
-O acesso ao terminal MT5 é realizado apenas sob demanda para evitar
-efeitos colaterais durante a importação do módulo (import side effects),
-facilitando testes automatizados e execução em ambientes CI/CD.
+Plugins devem acessar a configuração através do objeto global `conf`.
 """
 
 import os
@@ -23,170 +22,147 @@ import MetaTrader5 as mt5
 
 from mtcli.mt5_context import mt5_conexao
 
-# ---------------------------------------------------------
-# Carregamento do arquivo de configuração
-# ---------------------------------------------------------
 
-CONFIG_FILE = "mtcli.ini"
-SECTION = "DEFAULT"
+class Config:
+    """
+    Gerenciador central de configurações do mtcli.
+    """
 
-config = configparser.ConfigParser()
-config.read(CONFIG_FILE)
+    def __init__(self, filename="mtcli.ini"):
+        self.config = configparser.ConfigParser()
+        self.config.read(filename)
 
+    # ---------------------------------------------------------
+    # leitura de valores
+    # ---------------------------------------------------------
 
-def get_config_value(key: str, cast=None, fallback=None):
-    """
-    Retorna um valor de configuração.
+    def get(self, key, section="DEFAULT", cast=None, default=None):
+        """
+        Retorna um valor de configuração.
 
-    A prioridade de leitura é:
-    1. Variável de ambiente
-    2. Arquivo mtcli.ini
-    3. Valor fallback
+        Prioridade:
 
-    Args:
-        key (str): Nome da chave de configuração.
-        cast (type | None): Tipo de conversão (ex: int, float).
-        fallback (Any): Valor padrão caso não encontrado.
+        1. Variável de ambiente SECTION_KEY
+        2. Variável de ambiente KEY
+        3. mtcli.ini [section]
+        4. mtcli.ini [DEFAULT]
+        5. default
 
-    Returns:
-        Any: valor convertido ou fallback.
-    """
-    value = os.getenv(key)
-
-    if value is None:
-        try:
-            if cast == int:
-                value = config.getint(SECTION, key, fallback=fallback)
-            elif cast == float:
-                value = config.getfloat(SECTION, key, fallback=fallback)
-            else:
-                value = config.get(SECTION, key, fallback=fallback)
-        except (configparser.NoOptionError, ValueError):
-            value = fallback
-    else:
-        if cast:
-            try:
-                value = cast(value)
-            except ValueError:
-                value = fallback
+        Args:
+            key (str)
+            section (str)
+            cast (type | None)
+            default (Any)
 
-    return value
+        Returns:
+            Any
+        """
 
+        env_key = f"{section.upper()}_{key.upper()}"
 
-# ---------------------------------------------------------
-# Configurações gerais
-# ---------------------------------------------------------
+        value = os.getenv(env_key) or os.getenv(key.upper())
 
-SYMBOL = get_config_value("symbol", fallback="WIN$N")
-DIGITOS = get_config_value("digitos", cast=int, fallback=2)
-PERIOD = get_config_value("period", fallback="D1")
-BARS = get_config_value("count", cast=int, fallback=999)
+        if value is None:
 
-VIEW = get_config_value("view", fallback="ch")
-VOLUME = get_config_value("volume", fallback="tick")
-DATE = get_config_value("date", fallback="")
+            if self.config.has_option(section, key):
+                value = self.config.get(section, key)
 
-# ---------------------------------------------------------
-# Configurações de leitura de candles
-# ---------------------------------------------------------
+            elif self.config.has_option("DEFAULT", key):
+                value = self.config.get("DEFAULT", key)
 
-LATERAL = get_config_value("lateral", fallback="doji")
-ALTA = get_config_value("alta", fallback="verde")
-BAIXA = get_config_value("baixa", fallback="vermelho")
+            else:
+                value = default
 
-ROMPIMENTO_ALTA = get_config_value("rompimento_alta", fallback="c")
-ROMPIMENTO_BAIXA = get_config_value("rompimento_baixa", fallback="v")
+        if cast and value is not None:
 
-PERCENTUAL_ROMPIMENTO = get_config_value(
-    "percentual_rompimento", cast=int, fallback=50
-)
+            try:
 
-PERCENTUAL_DOJI = get_config_value(
-    "percentual_doji", cast=int, fallback=10
-)
+                if cast is bool:
+                    value = str(value).lower() in ("1", "true", "yes")
 
-# ---------------------------------------------------------
-# Configurações de padrões de barra
-# ---------------------------------------------------------
+                else:
+                    value = cast(value)
 
-UP_BAR = get_config_value("up_bar", fallback="asc")
-DOWN_BAR = get_config_value("down_bar", fallback="desc")
+            except ValueError:
+                value = default
 
-INSIDE_BAR = get_config_value("inside_bar", fallback="ib")
-OUTSIDE_BAR = get_config_value("outside_bar", fallback="ob")
+        return value
 
-SOMBRA_SUPERIOR = get_config_value("sombra_superior", fallback="top")
-SOMBRA_INFERIOR = get_config_value("sombra_inferior", fallback="bottom")
+    # ---------------------------------------------------------
+    # seção helper
+    # ---------------------------------------------------------
 
-# ---------------------------------------------------------
-# Fonte de dados
-# ---------------------------------------------------------
+    def section(self, section):
+        """
+        Retorna um helper para acessar uma seção específica.
+        """
 
-DATA_SOURCE = get_config_value("dados", fallback="mt5").lower()
+        class Section:
 
-# caminho inicial (pode vir do ini/env)
-_INITIAL_CSV_PATH = get_config_value("mt5_pasta", fallback="")
+            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)
 
-def get_csv_path():
-    """
-    Retorna o caminho da pasta de arquivos do MT5 ou CSV.
+        return Section(self, section)
 
-    Se o caminho não estiver definido no mtcli.ini ou nas
-    variáveis de ambiente, o terminal MT5 é consultado para
-    descobrir automaticamente a pasta MQL5/Files.
+    # ---------------------------------------------------------
+    # 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
 
-    Returns:
-        str: caminho normalizado da pasta de arquivos.
-    """
-    if _INITIAL_CSV_PATH:
-        path = _INITIAL_CSV_PATH
-    else:
         with mt5_conexao():
-            terminal_info = mt5.terminal_info()
 
-            if terminal_info is None:
+            info = mt5.terminal_info()
+
+            if info is None:
                 raise RuntimeError(
-                    "Não foi possível obter as informações do terminal MT5."
+                    "Não foi possível obter informações do terminal MT5."
                 )
 
-        path = os.path.join(terminal_info.data_path, "MQL5", "Files")
-
-    return os.path.normpath(path) + os.sep
+        path = os.path.join(info.data_path, "MQL5", "Files")
 
+        return os.path.normpath(path) + os.sep
 
-# ---------------------------------------------------------
-# Factory de DataSource
-# ---------------------------------------------------------
+    # ---------------------------------------------------------
+    # data source
+    # ---------------------------------------------------------
 
-def get_data_source(source=None):
-    """
-    Retorna a fonte de dados configurada.
+    def get_data_source(self, source=None):
+        """
+        Retorna a fonte de dados configurada.
+        """
 
-    Args:
-        source (str | None): sobrescreve DATA_SOURCE se fornecido.
+        from mtcli.data import CsvDataSource, MT5DataSource
 
-    Returns:
-        CsvDataSource | MT5DataSource
+        src = (source or self.get("dados", default="mt5")).lower()
 
-    Raises:
-        ValueError: se a fonte de dados não for reconhecida.
-    """
-    from mtcli.data import CsvDataSource, MT5DataSource
+        if src == "csv":
+            return CsvDataSource()
 
-    src = source.lower() if source else DATA_SOURCE
+        if src == "mt5":
+            return MT5DataSource()
 
-    if src == "csv":
-        return CsvDataSource()
+        raise ValueError(f"Fonte de dados desconhecida: {src}")
 
-    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
+# timeframes suportados
 # ---------------------------------------------------------
 
 _HOURS = [12, 8, 6, 4, 3, 2, 1]
@@ -197,3 +173,61 @@ TIMEFRAMES = (
     + [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/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/data/csv.py

@@ -1,31 +1,31 @@
-"""Módulo fonte de dados via CSV."""
-
-import csv
-import os
-
-from mtcli import conf
-from mtcli.logger import setup_logger
-
-from .base import DataSourceBase
-
-logger = setup_logger()
-
-
-class CsvDataSource(DataSourceBase):
-    """Fonte de dados via CSV."""
-
-    def get_data(self, symbol, period, count=100):
-        """Retorna dados CSV em uma lista de lista."""
-        file_path = os.path.join(conf._INITIAL_CSV_PATH, f"{symbol}{period}.csv")
-        logger.info(f"Iniciando coleta de dados via CSV: {file_path}.")
-        csv_data = []
-        try:
-            with open(file_path, encoding="utf-16", newline="") as f:
-                lines = csv.reader(f, delimiter=",", quotechar="'")
-                for line in lines:
-                    csv_data.append(line)
-        except:
-            logger.warning(f"Arquivo {file_path} não encontrado.")
-            print("Arquivo %s nao encontrado! Tente novamente" % file_path)
-        logger.info("Coleta de dados via CSV finalizada.")
-        return csv_data
+"""Módulo fonte de dados via CSV."""
+
+import csv
+import os
+
+from mtcli import conf
+from mtcli.logger import setup_logger
+
+from .base import DataSourceBase
+
+logger = setup_logger()
+
+
+class CsvDataSource(DataSourceBase):
+    """Fonte de dados via CSV."""
+
+    def get_data(self, symbol, period, count=100):
+        """Retorna dados CSV em uma lista de lista."""
+        file_path = os.path.join(conf._INITIAL_CSV_PATH, f"{symbol}{period}.csv")
+        logger.info(f"Iniciando coleta de dados via CSV: {file_path}.")
+        csv_data = []
+        try:
+            with open(file_path, encoding="utf-16", newline="") as f:
+                lines = csv.reader(f, delimiter=",", quotechar="'")
+                for line in lines:
+                    csv_data.append(line)
+        except:
+            logger.warning(f"Arquivo {file_path} não encontrado.")
+            print("Arquivo %s nao encontrado! Tente novamente" % file_path)
+        logger.info("Coleta de dados via CSV finalizada.")
+        return csv_data