mtcli-volume 1.6.2__tar.gz → 2.0.0.dev0__tar.gz

{mtcli_volume-1.6.2 → mtcli_volume-2.0.0.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mtcli-volume
-Version: 1.6.2
+Version: 2.0.0.dev0
 Summary: Plugin mtcli para exibir o volume profile
 Author: Valmir França da Silva
 Author-email: vfranca3@gmail.com
@@ -10,7 +10,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: mtcli (>=1.18.1)
+Requires-Dist: mtcli (>=3.2.0)
 Project-URL: Documentation, https://mtcli-volume.readthedocs.io
 Project-URL: Homepage, https://github.com/vfranca/mtcli-volume
 Project-URL: Repository, https://github.com/vfranca/mtcli-volume

mtcli_volume-2.0.0.dev0/mtcli_volume/commands/volume_cli.py

@@ -0,0 +1,35 @@
+import click
+from mtcli_volume.controllers.volume_controller import calcular_volume_profile
+from mtcli_volume.views.volume_view import exibir_volume_profile
+from mtcli_volume.conf import SYMBOL, PERIOD, BARS, STEP, VOLUME
+
+
+@click.command(
+    "volume",
+    help="Exibe o Volume Profile, agrupando volumes por faixa de preço no histórico recente."
+)
+@click.version_option(package_name="mtcli-volume")
+@click.option("--symbol", "-s", default=SYMBOL, help="Símbolo do ativo (default WIN$N).")
+@click.option("--period", "-p", default=PERIOD, help="Timeframe (ex: M1, M5, H1).")
+@click.option("--bars", "-b", default=BARS, help="Número de barras (default 566).")
+@click.option(
+    "--step", "-e", type=float, default=STEP,
+    help="Tamanho do agrupamento de preços (default 100)."
+)
+@click.option(
+    "--volume", "-v", default=VOLUME,
+    help="Tipo de volume (tick ou real), default tick."
+)
+@click.option("--exporta-csv", "-csv", is_flag=True, help="Exportar resultados para CSV.")
+@click.option(
+    "--sem-histograma", "-sh", is_flag=True,
+    help="Oculta o histograma textual de volume."
+)
+def volume(symbol, period, bars, step, volume, exporta_csv, sem_histograma):
+    """Exibe o Volume Profile agrupando volumes por faixa de preço."""
+    profile, stats = calcular_volume_profile(symbol, period, bars, step, volume)
+    exibir_volume_profile(profile, stats, symbol, exporta_csv, sem_histograma)
+
+
+if __name__ == "__main__":
+    volume()

{mtcli_volume-1.6.2 → mtcli_volume-2.0.0.dev0}/mtcli_volume/conf.py

@@ -1,9 +1,10 @@
-import os
-from mtcli.conf import config
-
-
-SYMBOL = os.getenv("SYMBOL", config["DEFAULT"].get("symbol", fallback="WIN$N"))
-DIGITOS = int(os.getenv("DIGITOS", config["DEFAULT"].getint("digitos", fallback=0)))
-PERIODS = int(os.getenv("PERIODS", config["DEFAULT"].getint("periods", fallback=566)))
-STEP = float(os.getenv("STEP", config["DEFAULT"].getfloat("step", fallback=100)))
-VOLUME = os.getenv("VOLUME", config["DEFAULT"].get("volume", fallback="tick"))
+import os
+from mtcli.conf import config
+
+
+SYMBOL = os.getenv("SYMBOL", config["DEFAULT"].get("symbol", fallback="WIN$N"))
+DIGITOS = int(os.getenv("DIGITOS", config["DEFAULT"].getint("digitos", fallback=0)))
+PERIOD = os.getenv("PERIOD", config["DEFAULT"].get("period", fallback="M1"))
+BARS = int(os.getenv("BARS", config["DEFAULT"].getint("bars", fallback=566)))
+STEP = float(os.getenv("STEP", config["DEFAULT"].getfloat("step", fallback=100)))
+VOLUME = os.getenv("VOLUME", config["DEFAULT"].get("volume", fallback="tick"))

mtcli_volume-2.0.0.dev0/mtcli_volume/controllers/volume_controller.py

@@ -0,0 +1,22 @@
+from mtcli.logger import setup_logger
+from mtcli_volume.models.volume_model import obter_rates, calcular_profile, calcular_estatisticas
+
+log = setup_logger()
+
+
+def calcular_volume_profile(symbol, period, bars, step, volume):
+    """Controla o fluxo de cálculo do volume profile."""
+    volume = volume.lower().strip()
+    if volume not in ["tick", "real"]:
+        log.error(f"Tipo de volume inválido: {volume}. Use 'tick' ou 'real'.")
+        raise ValueError(f"Tipo de volume inválido: {volume}. Use 'tick' ou 'real'.")
+
+    rates = obter_rates(symbol, period, bars)
+    if not rates:
+        log.error("Falha ao obter dados de preços para cálculo do volume profile.")
+        return {}, {}
+
+    profile = calcular_profile(rates, step, volume)
+    stats = calcular_estatisticas(profile)
+
+    return profile, stats

mtcli_volume-2.0.0.dev0/mtcli_volume/models/volume_model.py

@@ -0,0 +1,96 @@
+from collections import defaultdict
+import MetaTrader5 as mt5
+from mtcli.mt5_context import mt5_conexao
+from mtcli.logger import setup_logger
+from mtcli.models.rates_model import RatesModel
+from mtcli_volume.conf import DIGITOS
+
+log = setup_logger()
+
+
+def obter_rates(symbol, period, bars):
+    """Obtém os dados históricos de preços via MetaTrader 5."""
+    with mt5_conexao():
+        tf = getattr(mt5, f"TIMEFRAME_{period.upper()}", None)
+        if tf is None:
+            log.error(f"Timeframe inválido: {period}")
+            return
+
+        if not mt5.symbol_select(symbol, True):
+            log.error(f"Erro ao selecionar símbolo {symbol}")
+            return
+
+        rates = RatesModel(symbol, period, bars).get_data()
+
+        if not rates:
+            log.error("Erro: não foi possível obter os dados históricos.")
+            return
+
+    return rates
+
+
+def calcular_profile(rates, step, volume="tick"):
+    """Calcula o volume total por faixa de preço, suportando dicionários, objetos ou tuplas."""
+    from collections.abc import Mapping
+
+    profile = defaultdict(int)
+
+    for r in rates:
+        # Detecta se r é dict, objeto com atributos ou tupla
+        if isinstance(r, Mapping):  # dict
+            preco = r["close"]
+            tick_volume = r["tick_volume"]
+            real_volume = r.get("real_volume", tick_volume)
+        elif hasattr(r, "close"):  # objeto com atributos
+            preco = r.close
+            tick_volume = r.tick_volume
+            real_volume = getattr(r, "real_volume", tick_volume)
+        elif isinstance(r, (tuple, list)) and len(r) >= 6:  # tupla com campos esperados
+            preco = r[4]  # índice típico de 'close' em rates do MT5
+            tick_volume = r[5]
+            real_volume = r[6] if len(r) > 6 else tick_volume
+        else:
+            raise TypeError(f"Formato de rate desconhecido: {type(r)}")
+
+        faixa = round(round(preco / step) * step, DIGITOS)
+        profile[faixa] += tick_volume if volume == "tick" else real_volume
+
+    return dict(profile)
+
+def calcular_estatisticas(profile):
+    """Calcula POC, área de valor (70%), HVNs e LVNs."""
+    if profile is None or len(profile) == 0:
+        return {
+            "poc": None,
+            "area_valor": (None, None),
+            "hvns": [],
+            "lvns": [],
+        }
+
+    # Ordena faixas de preço pelo volume em ordem decrescente
+    volumes_ordenados = sorted(profile.items(), key=lambda x: x[1], reverse=True)
+    poc = volumes_ordenados[0][0]
+
+    # Área de valor (70% do volume)
+    total_volume = sum(profile.values())
+    acumulado = 0
+    faixas_area_valor = []
+    for faixa, vol in volumes_ordenados:
+        acumulado += vol
+        faixas_area_valor.append(faixa)
+        if acumulado >= total_volume * 0.7:
+            break
+    area_valor = (min(faixas_area_valor), max(faixas_area_valor))
+
+    # HVNs (High Volume Nodes) e LVNs (Low Volume Nodes)
+    media = total_volume / len(profile)
+    hvns = sorted([faixa for faixa, vol in profile.items() if vol >= media * 1.5])
+    lvns = sorted([faixa for faixa, vol in profile.items() if vol <= media * 0.5])
+
+    return {
+        "poc": poc,
+        "area_valor": area_valor,
+        "hvns": hvns,
+        "lvns": lvns,
+    }
+

mtcli_volume-2.0.0.dev0/mtcli_volume/plugin.py

@@ -0,0 +1,5 @@
+from mtcli_volume.commands.volume_cli import volume
+
+
+def register(cli):
+    cli.add_command(volume, name="volume")

mtcli_volume-2.0.0.dev0/mtcli_volume/views/volume_view.py

@@ -0,0 +1,50 @@
+import click
+import csv
+from datetime import datetime
+from mtcli.logger import setup_logger
+from mtcli_volume.conf import DIGITOS
+
+log = setup_logger()
+BARRA_CHAR = "#"  # Pode mudar para "■" ou "=" se UTF-8 for garantido
+
+
+def exibir_volume_profile(profile, stats, symbol, exporta_csv=False, sem_histograma=False):
+    """Exibe o volume profile no terminal ou exporta para CSV."""
+    if not profile:
+        click.echo(f"Nenhum dado disponível para {symbol}.")
+        return
+
+    dados_ordenados = sorted(profile.items(), reverse=True)
+
+    if exporta_csv:
+        try:
+            data_str = datetime.now().strftime("%Y%m%d_%H%M")
+            nome_arquivo = f"volume_profile_{symbol}_{data_str}.csv"
+            with open(nome_arquivo, mode="w", newline="", encoding="utf-8") as f:
+                writer = csv.writer(f)
+                writer.writerow(["Faixa de Preço", "Volume"])
+                writer.writerows(dados_ordenados)
+            click.echo(f"Exportado para {nome_arquivo}")
+            log.info(f"Exportado para {nome_arquivo}")
+        except Exception as e:
+            log.error(f"Erro ao exportar CSV: {e}")
+            click.echo(f"Erro ao exportar CSV: {e}")
+        return
+
+    # Exibição textual
+    click.echo(f"\nVolume Profile {symbol}\n")
+    max_vol = max(profile.values())
+    for preco, vol in dados_ordenados:
+        barra = "" if sem_histograma else BARRA_CHAR * (vol // max(1, max_vol // 50))
+        click.echo(f"{preco:>8.{DIGITOS}f} {vol:>6} {barra}")
+
+    # Estatísticas
+    if stats.get("poc") is not None:
+        click.echo(f"\nPOC (Preço de Maior Volume): {stats['poc']:.{DIGITOS}f}")
+        click.echo(
+            f"Área de Valor: {stats['area_valor'][0]:.{DIGITOS}f} a {stats['area_valor'][1]:.{DIGITOS}f}"
+        )
+        click.echo(f"HVNs: {stats['hvns']}")
+        click.echo(f"LVNs: {stats['lvns']}")
+    else:
+        click.echo("\nEstatísticas indisponíveis (dados insuficientes).")

{mtcli_volume-1.6.2 → mtcli_volume-2.0.0.dev0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mtcli-volume"
-version = "1.6.2"
+version = "2.0.0.dev0"
 description = "Plugin mtcli para exibir o volume profile"
 authors = [
     {name = "Valmir França da Silva",email = "vfranca3@gmail.com"}
@@ -8,7 +8,7 @@ authors = [
 readme = "README.md"
 requires-python = ">=3.10,<3.14.0"
 dependencies = [
-    "mtcli>=1.18.1"
+    "mtcli>=3.2.0"
 ]
 
 [project.urls]
@@ -18,7 +18,7 @@ repository = "https://github.com/vfranca/mtcli-volume"
 issues = "https://github.com/vfranca/mtcli-volume/issues"
 
 [project.entry-points."mtcli.plugins"]
-mtcli-volume = "mtcli_volume.plugin:volume"
+mtcli_volume = "mtcli_volume.plugin:register"
 
 [build-system]
 requires = ["poetry-core>=2.0.0,<3.0.0"]
@@ -28,6 +28,7 @@ build-backend = "poetry.core.masonry.api"
 pytest = "^8.4.2"
 pytest-cov = "^6.2.1"
 black = "^25.1.0"
+pytest-mock = "^3.15.1"
 
 [tool.poetry.group.docs.dependencies]
 mkdocs = "^1.6.1"

mtcli_volume-1.6.2/mtcli_volume/plugin.py

@@ -1,96 +0,0 @@
-"""Plugin para exibir o Volume Profile do ativo."""
-
-import click
-import MetaTrader5 as mt5
-import csv
-from datetime import datetime
-from mtcli.conecta import conectar, shutdown
-from mtcli.logger import setup_logger
-from .conf import DIGITOS, SYMBOL, STEP, PERIODS, VOLUME
-from .volume import calcular_volume_profile, calcular_estatisticas
-
-log = setup_logger()
-BARRA_CHAR = "#"  # Pode mudar para "|", "=" ou "■" se UTF-8 estiver garantido
-
-
-@click.command("volume", help="Exibe o Volume Profile, agrupando volumes por faixa de preço no histórico recente.")
-@click.version_option(package_name="mtcli-volume")
-@click.option(
-    "--symbol", "-s", default=SYMBOL, help="Símbolo do ativo (default WIN$N)."
-)
-@click.option(
-    "--periods",
-    "-p",
-    default=PERIODS,
-    help="Número de candles de 1 minuto (default 566).",
-)
-@click.option(
-    "--step",
-    "-e",
-    type=float,
-    default=STEP,
-    help="Tamanho do agrupamento de preços (default 100).",
-)
-@click.option(
-    "--volume",
-    "-v",
-    default=VOLUME,
-    help="Tipo de volume (tick ou real), default tick.",
-)
-@click.option("--exporta-csv", "-csv", is_flag=True, help="Exportar para CSV.")
-@click.option(
-    "--sem-histograma",
-    "-sh",
-    is_flag=True,
-    help="Oculta o histograma textual de volume.",
-)
-def volume(symbol, periods, step, volume, exporta_csv, sem_histograma):
-    """Exibe o Volume Profile agrupando volumes por faixa de preço."""
-
-    if volume not in ["tick", "real"]:
-        msg = f"Tipo de volume inválido: {volume}. Use 'tick' ou 'real'."
-        click.echo(msg)
-        log.error(msg)
-        return
-
-    conectar()
-    rates = mt5.copy_rates_from_pos(symbol, mt5.TIMEFRAME_M1, 0, periods)
-
-    if rates is None or len(rates) == 0:
-        msg = "Não foi possível obter os dados"
-        click.echo(msg)
-        log.error(msg)
-        shutdown()
-        return
-
-    profile = calcular_volume_profile(rates, step, volume)
-    stats = calcular_estatisticas(profile)
-
-    dados_ordenados = sorted(profile.items(), reverse=True)
-
-    if exporta_csv:
-        data_str = datetime.now().strftime("%Y%m%d_%H%M")
-        nome_arquivo = f"volume_profile_{symbol}_{data_str}.csv"
-        with open(nome_arquivo, mode="w", newline="", encoding="utf-8") as f:
-            writer = csv.writer(f)
-            writer.writerow(["Faixa de Preço", "Volume"])
-            writer.writerows(dados_ordenados)
-        click.echo(f"Exportado para {nome_arquivo}")
-        log.info(f"Exportado para {nome_arquivo}")
-    else:
-        click.echo(f"\nVolume Profile {symbol}\n")
-        max_vol = max(profile.values())
-        for preco, vol in dados_ordenados:
-            barra = (
-                "" if sem_histograma else BARRA_CHAR * (vol // max(1, max_vol // 50))
-            )
-            click.echo(f"{preco:>8.{DIGITOS}f} | {vol:>6} {barra}")
-            # Estatísticas
-        click.echo(f"\nPOC (Preço de Maior Volume): {stats['poc']:.{DIGITOS}f}")
-        click.echo(
-            f"Área de Valor: {stats['area_valor'][0]:.{DIGITOS}f} a {stats['area_valor'][1]:.{DIGITOS}f}"
-        )
-        click.echo(f"HVNs: {stats['hvns']}")
-        click.echo(f"LVNs: {stats['lvns']}")
-
-    shutdown()

mtcli_volume-1.6.2/mtcli_volume/volume.py

@@ -1,55 +0,0 @@
-"""Modelo do volume profile."""
-
-from collections import defaultdict
-from .conf import DIGITOS
-
-
-def calcular_volume_profile(rates, step, volume="tick"):
-    """Calcula o volume por faixa de preço."""
-    profile = defaultdict(int)
-    for r in rates:
-        preco = r["close"]
-        faixa = round(round(preco / step) * step, DIGITOS)
-        profile[faixa] += r["tick_volume"] if volume == "tick" else r["real_volume"]
-    return dict(profile)
-
-
-def calcular_estatisticas(profile):
-    """Calcula POC, área de valor, HVNs e LVNs."""
-    if not profile:
-        return {
-            "poc": None,
-            "area_valor": (None, None),
-            "hvns": [],
-            "lvns": [],
-        }
-
-    total_volume = sum(profile.values())
-    dados = sorted(profile.items())
-    volumes_ordenados = sorted(dados, key=lambda x: x[1], reverse=True)
-
-    # POC: faixa com maior volume
-    poc = volumes_ordenados[0][0]
-
-    # Área de valor (70% do volume total)
-    acumulado = 0
-    area_valor = []
-    for faixa, vol in volumes_ordenados:
-        acumulado += vol
-        area_valor.append(faixa)
-        if acumulado / total_volume >= 0.7:
-            break
-    area_valor_min = min(area_valor)
-    area_valor_max = max(area_valor)
-
-    # HVNs e LVNs
-    media = total_volume / len(profile)
-    hvns = [faixa for faixa, vol in profile.items() if vol >= media * 1.5]
-    lvns = [faixa for faixa, vol in profile.items() if vol <= media * 0.5]
-
-    return {
-        "poc": poc,
-        "area_valor": (area_valor_min, area_valor_max),
-        "hvns": sorted(hvns),
-        "lvns": sorted(lvns),
-    }