Merge pull request #55 from aguzererler/fix/refactor-alpha-vantage-indicator-4324081028548110342
🧹 Refactor long `get_indicator` function to improve maintainability
This commit is contained in:
ahmet guzererler
GitHub
commit
ae83ce74fa
|
|
@ -1,5 +1,167 @@
|
||||||
|
from datetime import datetime
|
||||||
|
from typing import Dict, Any
|
||||||
|
from dateutil.relativedelta import relativedelta
|
||||||
from .alpha_vantage_common import _make_api_request
|
from .alpha_vantage_common import _make_api_request
|
||||||
|
|
||||||
|
|
||||||
|
SUPPORTED_INDICATORS = {
|
||||||
|
"close_50_sma": ("50 SMA", "close"),
|
||||||
|
"close_200_sma": ("200 SMA", "close"),
|
||||||
|
"close_10_ema": ("10 EMA", "close"),
|
||||||
|
"macd": ("MACD", "close"),
|
||||||
|
"macds": ("MACD Signal", "close"),
|
||||||
|
"macdh": ("MACD Histogram", "close"),
|
||||||
|
"rsi": ("RSI", "close"),
|
||||||
|
"boll": ("Bollinger Middle", "close"),
|
||||||
|
"boll_ub": ("Bollinger Upper Band", "close"),
|
||||||
|
"boll_lb": ("Bollinger Lower Band", "close"),
|
||||||
|
"atr": ("ATR", None),
|
||||||
|
"vwma": ("VWMA", "close")
|
||||||
|
}
|
||||||
|
|
||||||
|
INDICATOR_DESCRIPTIONS = {
|
||||||
|
"close_50_sma": "50 SMA: A medium-term trend indicator. Usage: Identify trend direction and serve as dynamic support/resistance. Tips: It lags price; combine with faster indicators for timely signals.",
|
||||||
|
"close_200_sma": "200 SMA: A long-term trend benchmark. Usage: Confirm overall market trend and identify golden/death cross setups. Tips: It reacts slowly; best for strategic trend confirmation rather than frequent trading entries.",
|
||||||
|
"close_10_ema": "10 EMA: A responsive short-term average. Usage: Capture quick shifts in momentum and potential entry points. Tips: Prone to noise in choppy markets; use alongside longer averages for filtering false signals.",
|
||||||
|
"macd": "MACD: Computes momentum via differences of EMAs. Usage: Look for crossovers and divergence as signals of trend changes. Tips: Confirm with other indicators in low-volatility or sideways markets.",
|
||||||
|
"macds": "MACD Signal: An EMA smoothing of the MACD line. Usage: Use crossovers with the MACD line to trigger trades. Tips: Should be part of a broader strategy to avoid false positives.",
|
||||||
|
"macdh": "MACD Histogram: Shows the gap between the MACD line and its signal. Usage: Visualize momentum strength and spot divergence early. Tips: Can be volatile; complement with additional filters in fast-moving markets.",
|
||||||
|
"rsi": "RSI: Measures momentum to flag overbought/oversold conditions. Usage: Apply 70/30 thresholds and watch for divergence to signal reversals. Tips: In strong trends, RSI may remain extreme; always cross-check with trend analysis.",
|
||||||
|
"boll": "Bollinger Middle: A 20 SMA serving as the basis for Bollinger Bands. Usage: Acts as a dynamic benchmark for price movement. Tips: Combine with the upper and lower bands to effectively spot breakouts or reversals.",
|
||||||
|
"boll_ub": "Bollinger Upper Band: Typically 2 standard deviations above the middle line. Usage: Signals potential overbought conditions and breakout zones. Tips: Confirm signals with other tools; prices may ride the band in strong trends.",
|
||||||
|
"boll_lb": "Bollinger Lower Band: Typically 2 standard deviations below the middle line. Usage: Indicates potential oversold conditions. Tips: Use additional analysis to avoid false reversal signals.",
|
||||||
|
"atr": "ATR: Averages true range to measure volatility. Usage: Set stop-loss levels and adjust position sizes based on current market volatility. Tips: It's a reactive measure, so use it as part of a broader risk management strategy.",
|
||||||
|
"vwma": "VWMA: A moving average weighted by volume. Usage: Confirm trends by integrating price action with volume data. Tips: Watch for skewed results from volume spikes; use in combination with other volume analyses."
|
||||||
|
}
|
||||||
|
|
||||||
|
COL_NAME_MAP = {
|
||||||
|
"macd": "MACD", "macds": "MACD_Signal", "macdh": "MACD_Hist",
|
||||||
|
"boll": "Real Middle Band", "boll_ub": "Real Upper Band", "boll_lb": "Real Lower Band",
|
||||||
|
"rsi": "RSI", "atr": "ATR", "close_10_ema": "EMA",
|
||||||
|
"close_50_sma": "SMA", "close_200_sma": "SMA"
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def _parse_indicator_data(
|
||||||
|
data: str,
|
||||||
|
indicator: str,
|
||||||
|
before: datetime,
|
||||||
|
curr_date_dt: datetime
|
||||||
|
) -> tuple[str, list[tuple[datetime, str]]]:
|
||||||
|
"""Helper function to parse the CSV string from Alpha Vantage."""
|
||||||
|
lines = data.strip().split('\n')
|
||||||
|
if len(lines) < 2:
|
||||||
|
return f"Error: No data returned for {indicator}", []
|
||||||
|
|
||||||
|
# Parse header and data
|
||||||
|
header = [col.strip() for col in lines[0].split(',')]
|
||||||
|
try:
|
||||||
|
date_col_idx = header.index('time')
|
||||||
|
except ValueError:
|
||||||
|
return f"Error: 'time' column not found in data for {indicator}. Available columns: {header}", []
|
||||||
|
|
||||||
|
target_col_name = COL_NAME_MAP.get(indicator)
|
||||||
|
|
||||||
|
if not target_col_name:
|
||||||
|
# Default to the second column if no specific mapping exists
|
||||||
|
value_col_idx = 1
|
||||||
|
else:
|
||||||
|
try:
|
||||||
|
value_col_idx = header.index(target_col_name)
|
||||||
|
except ValueError:
|
||||||
|
return f"Error: Column '{target_col_name}' not found for indicator '{indicator}'. Available columns: {header}", []
|
||||||
|
|
||||||
|
result_data = []
|
||||||
|
for line in lines[1:]:
|
||||||
|
if not line.strip():
|
||||||
|
continue
|
||||||
|
values = line.split(',')
|
||||||
|
if len(values) > value_col_idx:
|
||||||
|
try:
|
||||||
|
date_str = values[date_col_idx].strip()
|
||||||
|
# Parse the date
|
||||||
|
date_dt = datetime.strptime(date_str, "%Y-%m-%d")
|
||||||
|
|
||||||
|
# Check if date is in our range
|
||||||
|
if before <= date_dt <= curr_date_dt:
|
||||||
|
value = values[value_col_idx].strip()
|
||||||
|
result_data.append((date_dt, value))
|
||||||
|
except (ValueError, IndexError):
|
||||||
|
continue
|
||||||
|
|
||||||
|
return "", result_data
|
||||||
|
|
||||||
|
|
||||||
|
def _fetch_indicator_data(
|
||||||
|
symbol: str,
|
||||||
|
indicator: str,
|
||||||
|
interval: str,
|
||||||
|
time_period: int,
|
||||||
|
series_type: str
|
||||||
|
) -> str:
|
||||||
|
"""Helper function to fetch indicator data from Alpha Vantage."""
|
||||||
|
if indicator == "close_50_sma":
|
||||||
|
return _make_api_request("SMA", {
|
||||||
|
"symbol": symbol,
|
||||||
|
"interval": interval,
|
||||||
|
"time_period": "50",
|
||||||
|
"series_type": series_type,
|
||||||
|
"datatype": "csv"
|
||||||
|
})
|
||||||
|
elif indicator == "close_200_sma":
|
||||||
|
return _make_api_request("SMA", {
|
||||||
|
"symbol": symbol,
|
||||||
|
"interval": interval,
|
||||||
|
"time_period": "200",
|
||||||
|
"series_type": series_type,
|
||||||
|
"datatype": "csv"
|
||||||
|
})
|
||||||
|
elif indicator == "close_10_ema":
|
||||||
|
return _make_api_request("EMA", {
|
||||||
|
"symbol": symbol,
|
||||||
|
"interval": interval,
|
||||||
|
"time_period": "10",
|
||||||
|
"series_type": series_type,
|
||||||
|
"datatype": "csv"
|
||||||
|
})
|
||||||
|
elif indicator in ("macd", "macds", "macdh"):
|
||||||
|
return _make_api_request("MACD", {
|
||||||
|
"symbol": symbol,
|
||||||
|
"interval": interval,
|
||||||
|
"series_type": series_type,
|
||||||
|
"datatype": "csv"
|
||||||
|
})
|
||||||
|
elif indicator == "rsi":
|
||||||
|
return _make_api_request("RSI", {
|
||||||
|
"symbol": symbol,
|
||||||
|
"interval": interval,
|
||||||
|
"time_period": str(time_period),
|
||||||
|
"series_type": series_type,
|
||||||
|
"datatype": "csv"
|
||||||
|
})
|
||||||
|
elif indicator in ["boll", "boll_ub", "boll_lb"]:
|
||||||
|
return _make_api_request("BBANDS", {
|
||||||
|
"symbol": symbol,
|
||||||
|
"interval": interval,
|
||||||
|
"time_period": "20",
|
||||||
|
"series_type": series_type,
|
||||||
|
"datatype": "csv"
|
||||||
|
})
|
||||||
|
elif indicator == "atr":
|
||||||
|
return _make_api_request("ATR", {
|
||||||
|
"symbol": symbol,
|
||||||
|
"interval": interval,
|
||||||
|
"time_period": str(time_period),
|
||||||
|
"datatype": "csv"
|
||||||
|
})
|
||||||
|
elif indicator == "vwma":
|
||||||
|
# Alpha Vantage doesn't have direct VWMA, so we'll return an informative message
|
||||||
|
# In a real implementation, this would need to be calculated from OHLCV data
|
||||||
|
return f"## VWMA (Volume Weighted Moving Average) for {symbol}:\n\nVWMA calculation requires OHLCV data and is not directly available from Alpha Vantage API.\nThis indicator would need to be calculated from the raw stock data using volume-weighted price averaging.\n\n{INDICATOR_DESCRIPTIONS.get('vwma', 'No description available.')}"
|
||||||
|
else:
|
||||||
|
return f"Error: Indicator {indicator} not implemented yet."
|
||||||
|
|
||||||
|
|
||||||
def get_indicator(
|
def get_indicator(
|
||||||
symbol: str,
|
symbol: str,
|
||||||
indicator: str,
|
indicator: str,
|
||||||
|
|
@ -24,199 +186,41 @@ def get_indicator(
|
||||||
Returns:
|
Returns:
|
||||||
String containing indicator values and description
|
String containing indicator values and description
|
||||||
"""
|
"""
|
||||||
from datetime import datetime
|
if indicator not in SUPPORTED_INDICATORS:
|
||||||
from dateutil.relativedelta import relativedelta
|
|
||||||
|
|
||||||
supported_indicators = {
|
|
||||||
"close_50_sma": ("50 SMA", "close"),
|
|
||||||
"close_200_sma": ("200 SMA", "close"),
|
|
||||||
"close_10_ema": ("10 EMA", "close"),
|
|
||||||
"macd": ("MACD", "close"),
|
|
||||||
"macds": ("MACD Signal", "close"),
|
|
||||||
"macdh": ("MACD Histogram", "close"),
|
|
||||||
"rsi": ("RSI", "close"),
|
|
||||||
"boll": ("Bollinger Middle", "close"),
|
|
||||||
"boll_ub": ("Bollinger Upper Band", "close"),
|
|
||||||
"boll_lb": ("Bollinger Lower Band", "close"),
|
|
||||||
"atr": ("ATR", None),
|
|
||||||
"vwma": ("VWMA", "close")
|
|
||||||
}
|
|
||||||
|
|
||||||
indicator_descriptions = {
|
|
||||||
"close_50_sma": "50 SMA: A medium-term trend indicator. Usage: Identify trend direction and serve as dynamic support/resistance. Tips: It lags price; combine with faster indicators for timely signals.",
|
|
||||||
"close_200_sma": "200 SMA: A long-term trend benchmark. Usage: Confirm overall market trend and identify golden/death cross setups. Tips: It reacts slowly; best for strategic trend confirmation rather than frequent trading entries.",
|
|
||||||
"close_10_ema": "10 EMA: A responsive short-term average. Usage: Capture quick shifts in momentum and potential entry points. Tips: Prone to noise in choppy markets; use alongside longer averages for filtering false signals.",
|
|
||||||
"macd": "MACD: Computes momentum via differences of EMAs. Usage: Look for crossovers and divergence as signals of trend changes. Tips: Confirm with other indicators in low-volatility or sideways markets.",
|
|
||||||
"macds": "MACD Signal: An EMA smoothing of the MACD line. Usage: Use crossovers with the MACD line to trigger trades. Tips: Should be part of a broader strategy to avoid false positives.",
|
|
||||||
"macdh": "MACD Histogram: Shows the gap between the MACD line and its signal. Usage: Visualize momentum strength and spot divergence early. Tips: Can be volatile; complement with additional filters in fast-moving markets.",
|
|
||||||
"rsi": "RSI: Measures momentum to flag overbought/oversold conditions. Usage: Apply 70/30 thresholds and watch for divergence to signal reversals. Tips: In strong trends, RSI may remain extreme; always cross-check with trend analysis.",
|
|
||||||
"boll": "Bollinger Middle: A 20 SMA serving as the basis for Bollinger Bands. Usage: Acts as a dynamic benchmark for price movement. Tips: Combine with the upper and lower bands to effectively spot breakouts or reversals.",
|
|
||||||
"boll_ub": "Bollinger Upper Band: Typically 2 standard deviations above the middle line. Usage: Signals potential overbought conditions and breakout zones. Tips: Confirm signals with other tools; prices may ride the band in strong trends.",
|
|
||||||
"boll_lb": "Bollinger Lower Band: Typically 2 standard deviations below the middle line. Usage: Indicates potential oversold conditions. Tips: Use additional analysis to avoid false reversal signals.",
|
|
||||||
"atr": "ATR: Averages true range to measure volatility. Usage: Set stop-loss levels and adjust position sizes based on current market volatility. Tips: It's a reactive measure, so use it as part of a broader risk management strategy.",
|
|
||||||
"vwma": "VWMA: A moving average weighted by volume. Usage: Confirm trends by integrating price action with volume data. Tips: Watch for skewed results from volume spikes; use in combination with other volume analyses."
|
|
||||||
}
|
|
||||||
|
|
||||||
if indicator not in supported_indicators:
|
|
||||||
raise ValueError(
|
raise ValueError(
|
||||||
f"Indicator {indicator} is not supported. Please choose from: {list(supported_indicators.keys())}"
|
f"Indicator {indicator} is not supported. Please choose from: {list(SUPPORTED_INDICATORS.keys())}"
|
||||||
)
|
)
|
||||||
|
|
||||||
curr_date_dt = datetime.strptime(curr_date, "%Y-%m-%d")
|
curr_date_dt = datetime.strptime(curr_date, "%Y-%m-%d")
|
||||||
before = curr_date_dt - relativedelta(days=look_back_days)
|
before = curr_date_dt - relativedelta(days=look_back_days)
|
||||||
|
|
||||||
# Get the full data for the period instead of making individual calls
|
_, required_series_type = SUPPORTED_INDICATORS[indicator]
|
||||||
_, required_series_type = supported_indicators[indicator]
|
|
||||||
|
|
||||||
# Use the provided series_type or fall back to the required one
|
|
||||||
if required_series_type:
|
if required_series_type:
|
||||||
series_type = required_series_type
|
series_type = required_series_type
|
||||||
|
|
||||||
try:
|
try:
|
||||||
# Get indicator data for the period
|
data = _fetch_indicator_data(symbol, indicator, interval, time_period, series_type)
|
||||||
if indicator == "close_50_sma":
|
if data.startswith("Error:") or data.startswith("## VWMA"):
|
||||||
data = _make_api_request("SMA", {
|
return data
|
||||||
"symbol": symbol,
|
|
||||||
"interval": interval,
|
|
||||||
"time_period": "50",
|
|
||||||
"series_type": series_type,
|
|
||||||
"datatype": "csv"
|
|
||||||
})
|
|
||||||
elif indicator == "close_200_sma":
|
|
||||||
data = _make_api_request("SMA", {
|
|
||||||
"symbol": symbol,
|
|
||||||
"interval": interval,
|
|
||||||
"time_period": "200",
|
|
||||||
"series_type": series_type,
|
|
||||||
"datatype": "csv"
|
|
||||||
})
|
|
||||||
elif indicator == "close_10_ema":
|
|
||||||
data = _make_api_request("EMA", {
|
|
||||||
"symbol": symbol,
|
|
||||||
"interval": interval,
|
|
||||||
"time_period": "10",
|
|
||||||
"series_type": series_type,
|
|
||||||
"datatype": "csv"
|
|
||||||
})
|
|
||||||
elif indicator == "macd":
|
|
||||||
data = _make_api_request("MACD", {
|
|
||||||
"symbol": symbol,
|
|
||||||
"interval": interval,
|
|
||||||
"series_type": series_type,
|
|
||||||
"datatype": "csv"
|
|
||||||
})
|
|
||||||
elif indicator == "macds":
|
|
||||||
data = _make_api_request("MACD", {
|
|
||||||
"symbol": symbol,
|
|
||||||
"interval": interval,
|
|
||||||
"series_type": series_type,
|
|
||||||
"datatype": "csv"
|
|
||||||
})
|
|
||||||
elif indicator == "macdh":
|
|
||||||
data = _make_api_request("MACD", {
|
|
||||||
"symbol": symbol,
|
|
||||||
"interval": interval,
|
|
||||||
"series_type": series_type,
|
|
||||||
"datatype": "csv"
|
|
||||||
})
|
|
||||||
elif indicator == "rsi":
|
|
||||||
data = _make_api_request("RSI", {
|
|
||||||
"symbol": symbol,
|
|
||||||
"interval": interval,
|
|
||||||
"time_period": str(time_period),
|
|
||||||
"series_type": series_type,
|
|
||||||
"datatype": "csv"
|
|
||||||
})
|
|
||||||
elif indicator in ["boll", "boll_ub", "boll_lb"]:
|
|
||||||
data = _make_api_request("BBANDS", {
|
|
||||||
"symbol": symbol,
|
|
||||||
"interval": interval,
|
|
||||||
"time_period": "20",
|
|
||||||
"series_type": series_type,
|
|
||||||
"datatype": "csv"
|
|
||||||
})
|
|
||||||
elif indicator == "atr":
|
|
||||||
data = _make_api_request("ATR", {
|
|
||||||
"symbol": symbol,
|
|
||||||
"interval": interval,
|
|
||||||
"time_period": str(time_period),
|
|
||||||
"datatype": "csv"
|
|
||||||
})
|
|
||||||
elif indicator == "vwma":
|
|
||||||
# Alpha Vantage doesn't have direct VWMA, so we'll return an informative message
|
|
||||||
# In a real implementation, this would need to be calculated from OHLCV data
|
|
||||||
return f"## VWMA (Volume Weighted Moving Average) for {symbol}:\n\nVWMA calculation requires OHLCV data and is not directly available from Alpha Vantage API.\nThis indicator would need to be calculated from the raw stock data using volume-weighted price averaging.\n\n{indicator_descriptions.get('vwma', 'No description available.')}"
|
|
||||||
else:
|
|
||||||
return f"Error: Indicator {indicator} not implemented yet."
|
|
||||||
|
|
||||||
# Parse CSV data and extract values for the date range
|
err_msg, result_data = _parse_indicator_data(data, indicator, before, curr_date_dt)
|
||||||
lines = data.strip().split('\n')
|
if err_msg:
|
||||||
if len(lines) < 2:
|
return err_msg
|
||||||
return f"Error: No data returned for {indicator}"
|
|
||||||
|
|
||||||
# Parse header and data
|
|
||||||
header = [col.strip() for col in lines[0].split(',')]
|
|
||||||
try:
|
|
||||||
date_col_idx = header.index('time')
|
|
||||||
except ValueError:
|
|
||||||
return f"Error: 'time' column not found in data for {indicator}. Available columns: {header}"
|
|
||||||
|
|
||||||
# Map internal indicator names to expected CSV column names from Alpha Vantage
|
|
||||||
col_name_map = {
|
|
||||||
"macd": "MACD", "macds": "MACD_Signal", "macdh": "MACD_Hist",
|
|
||||||
"boll": "Real Middle Band", "boll_ub": "Real Upper Band", "boll_lb": "Real Lower Band",
|
|
||||||
"rsi": "RSI", "atr": "ATR", "close_10_ema": "EMA",
|
|
||||||
"close_50_sma": "SMA", "close_200_sma": "SMA"
|
|
||||||
}
|
|
||||||
|
|
||||||
target_col_name = col_name_map.get(indicator)
|
|
||||||
|
|
||||||
if not target_col_name:
|
|
||||||
# Default to the second column if no specific mapping exists
|
|
||||||
value_col_idx = 1
|
|
||||||
else:
|
|
||||||
try:
|
|
||||||
value_col_idx = header.index(target_col_name)
|
|
||||||
except ValueError:
|
|
||||||
return f"Error: Column '{target_col_name}' not found for indicator '{indicator}'. Available columns: {header}"
|
|
||||||
|
|
||||||
result_data = []
|
|
||||||
for line in lines[1:]:
|
|
||||||
if not line.strip():
|
|
||||||
continue
|
|
||||||
values = line.split(',')
|
|
||||||
if len(values) > value_col_idx:
|
|
||||||
try:
|
|
||||||
date_str = values[date_col_idx].strip()
|
|
||||||
# Parse the date
|
|
||||||
date_dt = datetime.strptime(date_str, "%Y-%m-%d")
|
|
||||||
|
|
||||||
# Check if date is in our range
|
|
||||||
if before <= date_dt <= curr_date_dt:
|
|
||||||
value = values[value_col_idx].strip()
|
|
||||||
result_data.append((date_dt, value))
|
|
||||||
except (ValueError, IndexError):
|
|
||||||
continue
|
|
||||||
|
|
||||||
# Sort by date and format output
|
|
||||||
result_data.sort(key=lambda x: x[0])
|
result_data.sort(key=lambda x: x[0])
|
||||||
|
|
||||||
ind_string = ""
|
ind_string = "\n".join([f"{date_dt.strftime('%Y-%m-%d')}: {value}" for date_dt, value in result_data])
|
||||||
for date_dt, value in result_data:
|
if ind_string:
|
||||||
ind_string += f"{date_dt.strftime('%Y-%m-%d')}: {value}\n"
|
ind_string += "\n"
|
||||||
|
else:
|
||||||
if not ind_string:
|
|
||||||
ind_string = "No data available for the specified date range.\n"
|
ind_string = "No data available for the specified date range.\n"
|
||||||
|
|
||||||
result_str = (
|
return (
|
||||||
f"## {indicator.upper()} values from {before.strftime('%Y-%m-%d')} to {curr_date}:\n\n"
|
f"## {indicator.upper()} values from {before.strftime('%Y-%m-%d')} to {curr_date}:\n\n"
|
||||||
+ ind_string
|
f"{ind_string}\n\n"
|
||||||
+ "\n\n"
|
f"{INDICATOR_DESCRIPTIONS.get(indicator, 'No description available.')}"
|
||||||
+ indicator_descriptions.get(indicator, "No description available.")
|
|
||||||
)
|
)
|
||||||
|
|
||||||
return result_str
|
|
||||||
|
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
print(f"Error getting Alpha Vantage indicator data for {indicator}: {e}")
|
print(f"Error getting Alpha Vantage indicator data for {indicator}: {e}")
|
||||||
return f"Error retrieving {indicator} data: {str(e)}"
|
return f"Error retrieving {indicator} data: {str(e)}"
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue