Skip to content

Commit

Permalink
move read_config out of init for easier mocking
Browse files Browse the repository at this point in the history
  • Loading branch information
@chadsr
chadsr committed May 27, 2024
1 parent e1e44f6 commit 79ce3af
Showing 1 changed file with 112 additions and 93 deletions.
205 changes: 112 additions & 93 deletions waybar_crypto.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,10 @@ def __init__(self, message: str) -> None:
self.message = message


class NoApiKeyException(WaybarCryptoException):
pass


class CoinmarketcapApiException(WaybarCryptoException):
def __init__(self, message: str, error_code: int | None) -> None:
super().__init__(message)
Expand All @@ -131,103 +135,117 @@ def __str__(self) -> str:
return f"{self.message} ({self.error_code})"


class WaybarCrypto(object):
def __init__(self, config_path: str):
self.config: Config = self.__parse_config_path(config_path)
def read_config(config_path: str) -> Config:
"""Read a configuration file
def __parse_config_path(self, config_path: str) -> Config:
# Attempt to load crypto.ini configuration file
cfp = configparser.ConfigParser(allow_no_value=True, interpolation=None)
Args:
config_path (str): Path to a .ini configuration file
try:
with open(config_path, "r", encoding="utf-8") as f:
cfp.read_file(f)
except Exception as e:
raise WaybarCryptoException(f"failed to open config file: {e}")

# Assume any section that isn't 'general', is a coin
coin_names = [section for section in cfp.sections() if section != "general"]

# Construct the coin configuration dict
coins: dict[str, ConfigCoin] = {}
for coin_name in coin_names:
if coin_name in coins:
# duplicate entry, skip
continue

display_in_tooltip = DEFAULT_COIN_CONFIG_TOOLTIP
if "in_tooltip" in cfp[coin_name]:
display_in_tooltip = cfp.getboolean(coin_name, "in_tooltip")

coins[coin_name] = {
"icon": cfp.get(coin_name, "icon"),
"in_tooltip": display_in_tooltip,
"price_precision": DEFAULT_PRECISION,
"change_precision": DEFAULT_PRECISION,
"volume_precision": DEFAULT_PRECISION,
}

for coin_precision_option in COIN_PRECISION_OPTIONS:
if coin_precision_option in cfp[coin_name]:
if not cfp[coin_name][coin_precision_option].isdigit():
raise WaybarCryptoException(
f"configured option '{coin_precision_option}' for cryptocurrency '{coin_name}' must be an integer"
)

precision_value = cfp.getint(coin_name, coin_precision_option)
if precision_value < MIN_PRECISION:
raise WaybarCryptoException(
f"value of option '{coin_precision_option}' for cryptocurrency '{coin_name}' must be greater than {MIN_PRECISION}",
)

coins[coin_name][coin_precision_option] = precision_value

# The fiat currency used in the trading pair
currency = cfp.get("general", "currency").upper()
currency_symbol = cfp.get("general", "currency_symbol")

spacer_symbol = ""
if "spacer_symbol" in cfp["general"]:
spacer_symbol = cfp.get("general", "spacer_symbol")

# Get a list of the chosen display options
display_options: list[str] = cfp.get("general", "display").split(",")

if len(display_options) == 0:
display_options = DEFAULT_DISPLAY_OPTIONS

for display_option in display_options:
if display_option not in DEFAULT_DISPLAY_OPTIONS_FORMAT:
raise WaybarCryptoException(f"invalid display option '{display_option}")

display_options_format = DEFAULT_DISPLAY_OPTIONS_FORMAT
display_format_price = display_options_format["price"]
display_options_format["price"] = f"{currency_symbol}{display_format_price}"

api_key: str | None = None
if "api_key" in cfp["general"]:
api_key = cfp.get("general", "api_key")

# If API_KEY_ENV exists, take precedence over the config file value
api_key = os.getenv(key=API_KEY_ENV, default=api_key)
if api_key is None:
raise WaybarCryptoException(
f"no API key provided in configuration file or with environment variable '{API_KEY_ENV}'"
)
Returns:
Config: Configuration dict object
"""

cfp = configparser.ConfigParser(allow_no_value=True, interpolation=None)

try:
with open(config_path, "r", encoding="utf-8") as f:
cfp.read_file(f)
except Exception as e:
raise WaybarCryptoException(f"failed to open config file: {e}")

config: Config = {
"general": {
"currency": currency,
"currency_symbol": currency_symbol,
"spacer_symbol": spacer_symbol,
"display_options": display_options,
"display_options_format": display_options_format,
"api_key": api_key,
},
"coins": coins,
# Assume any section that isn't 'general', is a coin
coin_names = [section for section in cfp.sections() if section != "general"]

# Construct the coin configuration dict
coins: dict[str, ConfigCoin] = {}
for coin_name in coin_names:
if coin_name in coins:
# duplicate entry, skip
continue

display_in_tooltip = DEFAULT_COIN_CONFIG_TOOLTIP
if "in_tooltip" in cfp[coin_name]:
display_in_tooltip = cfp.getboolean(coin_name, "in_tooltip")

coins[coin_name] = {
"icon": cfp.get(coin_name, "icon"),
"in_tooltip": display_in_tooltip,
"price_precision": DEFAULT_PRECISION,
"change_precision": DEFAULT_PRECISION,
"volume_precision": DEFAULT_PRECISION,
}

return config
for coin_precision_option in COIN_PRECISION_OPTIONS:
if coin_precision_option in cfp[coin_name]:
if not cfp[coin_name][coin_precision_option].isdigit():
raise WaybarCryptoException(
f"configured option '{coin_precision_option}' for cryptocurrency '{coin_name}' must be an integer"
)

precision_value = cfp.getint(coin_name, coin_precision_option)
if precision_value < MIN_PRECISION:
raise WaybarCryptoException(
f"value of option '{coin_precision_option}' for cryptocurrency '{coin_name}' must be greater than {MIN_PRECISION}",
)

coins[coin_name][coin_precision_option] = precision_value

# The fiat currency used in the trading pair
currency = cfp.get("general", "currency").upper()
currency_symbol = cfp.get("general", "currency_symbol")

spacer_symbol = ""
if "spacer_symbol" in cfp["general"]:
spacer_symbol = cfp.get("general", "spacer_symbol")

# Get a list of the chosen display options
display_options: list[str] = cfp.get("general", "display").split(",")

if len(display_options) == 0:
display_options = DEFAULT_DISPLAY_OPTIONS

for display_option in display_options:
if display_option not in DEFAULT_DISPLAY_OPTIONS_FORMAT:
raise WaybarCryptoException(f"invalid display option '{display_option}")

display_options_format = DEFAULT_DISPLAY_OPTIONS_FORMAT
display_format_price = display_options_format["price"]
display_options_format["price"] = f"{currency_symbol}{display_format_price}"

api_key: str | None = None
if "api_key" in cfp["general"]:
api_key = cfp.get("general", "api_key")
if api_key == "":
api_key = None

# If API_KEY_ENV exists, take precedence over the config file value
api_key = os.getenv(key=API_KEY_ENV, default=api_key)
if api_key is None:
raise NoApiKeyException(
f"no API key provided in configuration file or with environment variable '{API_KEY_ENV}'"
)

config: Config = {
"general": {
"currency": currency,
"currency_symbol": currency_symbol,
"spacer_symbol": spacer_symbol,
"display_options": display_options,
"display_options_format": display_options_format,
"api_key": api_key,
},
"coins": coins,
}

return config


class WaybarCrypto(object):
def __init__(self, config: Config):
if config["general"]["api_key"] == "":
raise NoApiKeyException("No API key provided")

self.config: Config = config

def coinmarketcap_latest(self) -> ResponseQuotesLatest:
# Construct API query parameters
Expand Down Expand Up @@ -350,7 +368,8 @@ def main():
if not os.path.isfile(config_path):
raise WaybarCryptoException(f"configuration file not found at '{config_path}'")

waybar_crypto = WaybarCrypto(args["config_path"])
config = read_config(args["config_path"])
waybar_crypto = WaybarCrypto(config)
quotes_latest = waybar_crypto.coinmarketcap_latest()
output = waybar_crypto.waybar_output(quotes_latest)

Expand Down

0 comments on commit 79ce3af

Please sign in to comment.