mtcli 3.7.0.dev7__tar.gz → 3.7.0.dev9__tar.gz

{mtcli-3.7.0.dev7 → mtcli-3.7.0.dev9}/PKG-INFO

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

{mtcli-3.7.0.dev7 → mtcli-3.7.0.dev9}/mtcli/cli.py

@@ -11,7 +11,7 @@ from mtcli.plugin_loader import load_plugins
 from mtcli.logger import setup_logger
 
 from .commands.bars import bars
-
+from .commands.doctor import doctor
 
 logger = setup_logger(__name__)
 
@@ -33,6 +33,7 @@ def mt():
 # ---------------------------------------------------------
 
 mt.add_command(bars, name="bars")
+mt.add_command(doctor, name="dr")
 
 
 # ---------------------------------------------------------

mtcli-3.7.0.dev9/mtcli/commands/doctor.py

@@ -0,0 +1,194 @@
+"""
+Comando de diagnóstico do mtcli.
+
+Este comando executa uma série de verificações básicas para ajudar
+a identificar problemas de instalação, configuração ou carregamento
+de plugins no ambiente do mtcli.
+
+As verificações incluem:
+
+- Versão do Python
+- Instalação do mtcli
+- Fonte de dados configurada
+- Caminho de dados CSV
+- Conexão com MetaTrader5
+- Descoberta e carregamento de plugins
+
+Caso algum plugin falhe ao carregar, o erro é exibido e registrado
+no sistema de logs.
+"""
+
+import sys
+import click
+import traceback
+
+from importlib.metadata import version, PackageNotFoundError
+
+import MetaTrader5 as mt5
+
+from mtcli.logger import setup_logger
+from mtcli.conf import conf, DATA_SOURCE_NAME
+from mtcli.mt5_context import mt5_conexao
+from mtcli.plugin_loader import discover_plugins
+
+
+logger = setup_logger(__name__)
+
+
+def status(ok: bool) -> str:
+    """
+    Retorna um marcador visual simples de status.
+
+    Parameters
+    ----------
+    ok : bool
+        Indica se o teste foi bem sucedido.
+
+    Returns
+    -------
+    str
+        Texto representando o status.
+    """
+    return "OK " if ok else "ERRO"
+
+
+@click.command()
+def doctor():
+    """
+    Executa diagnóstico do ambiente mtcli.
+
+    O comando verifica se os componentes essenciais do ambiente
+    estão funcionando corretamente e apresenta um relatório simples
+    no terminal.
+    """
+
+    click.echo("Diagnóstico do ambiente mtcli\n")
+
+    # ---------------------------------------------------------
+    # Python
+    # ---------------------------------------------------------
+
+    python_ok = sys.version_info >= (3, 10)
+
+    click.echo(f"{status(python_ok)} Python: {sys.version.split()[0]}")
+
+    if not python_ok:
+        click.echo("   Versão mínima recomendada: Python 3.10")
+
+    # ---------------------------------------------------------
+    # mtcli
+    # ---------------------------------------------------------
+
+    try:
+
+        mtcli_version = version("mtcli")
+
+        click.echo(f"{status(True)} mtcli: {mtcli_version}")
+
+    except PackageNotFoundError:
+
+        click.echo(f"{status(False)} mtcli não encontrado")
+
+        logger.error("Pacote mtcli não encontrado no ambiente.")
+
+    # ---------------------------------------------------------
+    # Fonte de dados
+    # ---------------------------------------------------------
+
+    click.echo(f"{status(True)} Data source: {DATA_SOURCE_NAME}")
+
+    # ---------------------------------------------------------
+    # CSV path
+    # ---------------------------------------------------------
+
+    try:
+
+        path = conf.get_csv_path()
+
+        click.echo(f"{status(True)} CSV path: {path}")
+
+    except Exception as exc:
+
+        click.echo(f"{status(False)} CSV path inválido")
+
+        logger.exception("Erro ao obter CSV path: %s", exc)
+
+    # ---------------------------------------------------------
+    # MT5 conexão
+    # ---------------------------------------------------------
+
+    try:
+
+        with mt5_conexao():
+
+            info = mt5.terminal_info()
+
+            if info:
+
+                click.echo(f"{status(True)} MetaTrader5 conectado")
+
+            else:
+
+                click.echo(f"{status(False)} MetaTrader5 não respondeu")
+
+    except Exception as exc:
+
+        click.echo(f"{status(False)} Falha na conexão MT5")
+
+        logger.exception("Erro ao conectar MT5: %s", exc)
+
+    # ---------------------------------------------------------
+    # Plugins
+    # ---------------------------------------------------------
+
+    click.echo("\nPlugins:")
+
+    try:
+
+        entry_points = list(discover_plugins())
+
+        if not entry_points:
+
+            click.echo("   Nenhum plugin encontrado.")
+            return
+
+        ok_count = 0
+        fail_count = 0
+
+        for ep in entry_points:
+
+            plugin_name = ep.name
+
+            try:
+
+                ep.load()
+
+                click.echo(f"   OK  {plugin_name}")
+
+                ok_count += 1
+
+            except Exception as exc:
+
+                click.echo(f"   ERRO {plugin_name}")
+
+                click.echo(f"       {exc}")
+
+                logger.error(
+                    "Erro ao carregar plugin %s\n%s",
+                    plugin_name,
+                    traceback.format_exc(),
+                )
+
+                fail_count += 1
+
+        click.echo(
+            f"\nResumo: {ok_count} plugins OK | {fail_count} com erro"
+        )
+
+    except Exception as exc:
+
+        click.echo(f"{status(False)} Falha ao descobrir plugins")
+
+        logger.exception("Erro ao descobrir plugins: %s", exc)
+
+    click.echo("\nDiagnóstico concluído.")

{mtcli-3.7.0.dev7 → mtcli-3.7.0.dev9}/mtcli/conf.py

@@ -12,7 +12,21 @@ 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`.
+Plugins novos devem acessar a configuração através do objeto global `conf`.
+
+Compatibilidade retroativa:
+---------------------------
+Plugins antigos utilizavam:
+
+    from mtcli.conf import config
+
+onde `config` era um objeto `configparser.ConfigParser`.
+
+Para manter compatibilidade com plugins já publicados,
+o objeto `config` continua sendo exposto.
+
+Essa API é considerada **deprecated** e poderá ser removida
+em versões futuras do mtcli.
 """
 
 import os
@@ -26,6 +40,17 @@ from mtcli.mt5_context import mt5_conexao
 class Config:
     """
     Gerenciador central de configurações do mtcli.
+
+    Permite acessar valores a partir de:
+
+    - variáveis de ambiente
+    - arquivo mtcli.ini
+    - valores default
+
+    Plugins devem preferencialmente usar:
+
+        from mtcli.conf import conf
+        conf.get(...)
     """
 
     def __init__(self, filename="mtcli.ini"):
@@ -49,10 +74,17 @@ class Config:
         5. default
 
         Args:
-            key (str)
-            section (str)
-            cast (type | None)
-            default (Any)
+            key (str):
+                Nome da configuração.
+
+            section (str):
+                Seção do arquivo mtcli.ini.
+
+            cast (type | None):
+                Tipo para conversão do valor.
+
+            default (Any):
+                Valor padrão.
 
         Returns:
             Any
@@ -95,10 +127,14 @@ class Config:
     def section(self, section):
         """
         Retorna um helper para acessar uma seção específica.
+
+        Example:
+
+            renko = conf.section("renko")
+            brick = renko.get("brick", cast=int, default=10)
         """
 
         class Section:
-
             def __init__(self, parent, section):
                 self.parent = parent
                 self.section = section
@@ -114,7 +150,15 @@ class Config:
 
     def get_csv_path(self):
         """
-        Retorna o caminho da pasta MQL5/Files.
+        Retorna o caminho da pasta MQL5/Files do MetaTrader 5.
+
+        A prioridade é:
+
+        1. mtcli.ini -> mt5_pasta
+        2. descoberta automática via MT5
+
+        Returns:
+            str: caminho normalizado da pasta Files.
         """
 
         path = self.get("mt5_pasta")
@@ -142,6 +186,13 @@ class Config:
     def get_data_source(self, source=None):
         """
         Retorna a fonte de dados configurada.
+
+        Args:
+            source (str | None):
+                Fonte explícita ("csv" ou "mt5").
+
+        Returns:
+            DataSource
         """
 
         from mtcli.data import CsvDataSource, MT5DataSource
@@ -157,9 +208,30 @@ class Config:
         raise ValueError(f"Fonte de dados desconhecida: {src}")
 
 
+# ---------------------------------------------------------
 # instância global usada por todo o sistema
+# ---------------------------------------------------------
+
 conf = Config()
 
+# ---------------------------------------------------------
+# compatibilidade com plugins antigos
+# ---------------------------------------------------------
+#
+# Plugins antigos utilizam:
+#
+#     from mtcli.conf import config
+#
+# onde `config` era um ConfigParser.
+#
+# Mantemos esse objeto apontando para o ConfigParser interno
+# para evitar quebra de compatibilidade.
+#
+# API DEPRECATED – usar `conf.get()` em novos plugins.
+#
+
+config = conf.config
+
 
 # ---------------------------------------------------------
 # timeframes suportados
@@ -174,7 +246,6 @@ TIMEFRAMES = (
     + [f"m{i}" for i in _MINUTES]
 )
 
-
 # ---------------------------------------------------------
 # Configurações gerais
 # ---------------------------------------------------------
@@ -200,11 +271,15 @@ 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_rompimento",
+    cast=int,
+    default=50,
 )
 
 PERCENTUAL_DOJI = conf.get(
-    "percentual_doji", cast=int, default=10
+    "percentual_doji",
+    cast=int,
+    default=10,
 )
 
 # ---------------------------------------------------------
@@ -224,6 +299,7 @@ SOMBRA_INFERIOR = conf.get("sombra_inferior", default="bottom")
 # Fonte de dados
 # ---------------------------------------------------------
 
+DATA_SOURCE_NAME = conf.get("dados", default="mt5").lower()
 DATA_SOURCE = conf.get_data_source()
 
 # ---------------------------------------------------------

{mtcli-3.7.0.dev7 → mtcli-3.7.0.dev9}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mtcli"
-version = "3.7.0.dev7"
+version = "3.7.0.dev9"
 description = "Aplicativo CLI para exibir gráficos do MetaTrader 5 screen reader friendly"
 authors = [
     {name = "Valmir França da Silva",email = "vfranca3@gmail.com"}
@@ -47,7 +47,7 @@ mtcli = "mtcli.cli:mt"
 mt = "mtcli.cli:mt"
 
 [project.entry-points."mtcli.plugins"]
-mtcli = "mtcli.plugin:register"
+internos = "mtcli.plugin:register"
 
 [build-system]
 requires = ["poetry-core>=2.0.0,<3.0.0"]