cleanup python env var checks examples (#1362)

* cleanup env var checks * cleanup env var checks
iotaledger · Oct 2, 2023 · fa366bc · fa366bc
1 parent 9a860db
commit fa366bc
Show file tree

Hide file tree

Showing 13 changed files with 39 additions and 76 deletions.
diff --git a/bindings/python/examples/exchange/1_create_account.py b/bindings/python/examples/exchange/1_create_account.py
@@ -14,17 +14,9 @@
 # should not be done in production.
 load_dotenv()
 
-if 'WALLET_DB_PATH' not in os.environ:
-    raise Exception(".env WALLET_DB_PATH is undefined, see .env.example")
-if 'NODE_URL' not in os.environ:
-    raise Exception(".env NODE_URL is undefined, see .env.example")
-if 'STRONGHOLD_SNAPSHOT_PATH' not in os.environ:
-    raise Exception(
-        ".env STRONGHOLD_SNAPSHOT_PATH is undefined, see .env.example")
-if 'STRONGHOLD_PASSWORD' not in os.environ:
-    raise Exception(".env STRONGHOLD_PASSWORD is undefined, see .env.example")
-if 'MNEMONIC' not in os.environ:
-    raise Exception(".env MNEMONIC is undefined, see .env.example")
+for env_var in ['WALLET_DB_PATH', 'NODE_URL', 'STRONGHOLD_SNAPSHOT_PATH', 'STRONGHOLD_PASSWORD', 'MNEMONIC']:
+    if env_var not in os.environ:
+        raise Exception(f'.env {env_var} is undefined, see .env.example')
 
 client_options = ClientOptions(nodes=[os.environ.get('NODE_URL')])
 

diff --git a/bindings/python/examples/exchange/2_generate_address.py b/bindings/python/examples/exchange/2_generate_address.py
@@ -13,10 +13,9 @@
 # should not be done in production.
 load_dotenv()
 
-if 'WALLET_DB_PATH' not in os.environ:
-    raise Exception(".env WALLET_DB_PATH is undefined, see .env.example")
-if 'STRONGHOLD_PASSWORD' not in os.environ:
-    raise Exception(".env STRONGHOLD_PASSWORD is undefined, see .env.example")
+for env_var in ['WALLET_DB_PATH', 'STRONGHOLD_PASSWORD']:
+    if env_var not in os.environ:
+        raise Exception(f'.env {env_var} is undefined, see .env.example')
 
 wallet = Wallet(os.environ.get('WALLET_DB_PATH'))
 

diff --git a/bindings/python/examples/exchange/5_send_amount.py b/bindings/python/examples/exchange/5_send_amount.py
@@ -13,12 +13,9 @@
 # should not be done in production.
 load_dotenv()
 
-if 'WALLET_DB_PATH' not in os.environ:
-    raise Exception(".env WALLET_DB_PATH is undefined, see .env.example")
-if 'STRONGHOLD_PASSWORD' not in os.environ:
-    raise Exception(".env STRONGHOLD_PASSWORD is undefined, see .env.example")
-if 'EXPLORER_URL' not in os.environ:
-    raise Exception(".env EXPLORER_URL is undefined, see .env.example")
+for env_var in ['WALLET_DB_PATH', 'STRONGHOLD_PASSWORD', 'EXPLORER_URL']:
+    if env_var not in os.environ:
+        raise Exception(f'.env {env_var} is undefined, see .env.example')
 
 wallet = Wallet(os.environ.get('WALLET_DB_PATH'))
 

diff --git a/bindings/python/examples/how_tos/accounts_and_addresses/create_account.py b/bindings/python/examples/how_tos/accounts_and_addresses/create_account.py
@@ -14,8 +14,9 @@
 # Shimmer coin type
 coin_type = CoinType.SHIMMER
 
-if 'STRONGHOLD_PASSWORD' not in os.environ:
-    raise Exception(".env STRONGHOLD_PASSWORD is undefined, see .env.example")
+for env_var in ['STRONGHOLD_PASSWORD', 'MNEMONIC']:
+    if env_var not in os.environ:
+        raise Exception(f".env {env_var} is undefined, see .env.example")
 
 secret_manager = StrongholdSecretManager(
     os.environ['STRONGHOLD_SNAPSHOT_PATH'], os.environ['STRONGHOLD_PASSWORD'])
@@ -26,9 +27,6 @@
     coin_type,
     secret_manager)
 
-if 'MNEMONIC' not in os.environ:
-    raise Exception(".env MNEMONIC is undefined, see .env.example")
-
 # Store the mnemonic in the Stronghold snapshot, this only needs to be
 # done once.
 wallet.store_mnemonic(os.environ['MNEMONIC'])

diff --git a/bindings/python/examples/how_tos/alias/governance_transition.py b/bindings/python/examples/how_tos/alias/governance_transition.py
@@ -8,14 +8,9 @@
 
 # In this example we will update the state controller of an alias output.
 
-if 'WALLET_DB_PATH' not in os.environ:
-    raise Exception(".env WALLET_DB_PATH is undefined, see .env.example")
-
-if 'STRONGHOLD_PASSWORD' not in os.environ:
-    raise Exception(".env STRONGHOLD_PASSWORD is undefined, see .env.example")
-
-if 'EXPLORER_URL' not in os.environ:
-    raise Exception(".env EXPLORER_URL is undefined, see .env.example")
+for env_var in ['WALLET_DB_PATH', 'STRONGHOLD_PASSWORD', 'EXPLORER_URL']:
+    if env_var not in os.environ:
+        raise Exception(f".env {env_var} is undefined, see .env.example")
 
 wallet = Wallet(os.environ['WALLET_DB_PATH'])
 

diff --git a/bindings/python/examples/how_tos/alias/state_transition.py b/bindings/python/examples/how_tos/alias/state_transition.py
@@ -10,14 +10,9 @@
 
 NEW_STATE_METADATA = 'updated state metadata 1'
 
-if 'WALLET_DB_PATH' not in os.environ:
-    raise Exception(".env WALLET_DB_PATH is undefined, see .env.example")
-
-if 'STRONGHOLD_PASSWORD' not in os.environ:
-    raise Exception(".env STRONGHOLD_PASSWORD is undefined, see .env.example")
-
-if 'EXPLORER_URL' not in os.environ:
-    raise Exception(".env EXPLORER_URL is undefined, see .env.example")
+for env_var in ['WALLET_DB_PATH', 'STRONGHOLD_PASSWORD', 'EXPLORER_URL']:
+    if env_var not in os.environ:
+        raise Exception(f".env {env_var} is undefined, see .env.example")
 
 wallet = Wallet(os.environ['WALLET_DB_PATH'])
 

diff --git a/bindings/python/examples/how_tos/sign_and_verify_ed25519/sign_ed25519.py b/bindings/python/examples/how_tos/sign_and_verify_ed25519/sign_ed25519.py
@@ -14,11 +14,9 @@
 INTERNAL_ADDRESS = False
 ADDRESS_INDEX = 0
 
-if 'MNEMONIC' not in os.environ:
-    raise Exception(".env MNEMONIC is undefined, see .env.example")
-
-if 'STRONGHOLD_PASSWORD' not in os.environ:
-    raise Exception(".env STRONGHOLD_PASSWORD is undefined, see .env.example")
+for env_var in ['MNEMONIC', 'STRONGHOLD_PASSWORD']:
+    if env_var not in os.environ:
+        raise Exception(f'.env {env_var} is undefined, see .env.example')
 
 secret_manager = SecretManager(StrongholdSecretManager(
     "sign_ed25519.stronghold", os.environ['STRONGHOLD_PASSWORD']))

diff --git a/bindings/python/examples/how_tos/sign_evm/sign_evm.py b/bindings/python/examples/how_tos/sign_evm/sign_evm.py
@@ -14,11 +14,9 @@
 INTERNAL_ADDRESS = False
 ADDRESS_INDEX = 0
 
-if 'MNEMONIC' not in os.environ:
-    raise Exception(".env MNEMONIC is undefined, see .env.example")
-
-if 'STRONGHOLD_PASSWORD' not in os.environ:
-    raise Exception(".env STRONGHOLD_PASSWORD is undefined, see .env.example")
+for env_var in ['MNEMONIC', 'STRONGHOLD_PASSWORD']:
+    if env_var not in os.environ:
+        raise Exception(f'.env {env_var} is undefined, see .env.example')
 
 secret_manager = SecretManager(StrongholdSecretManager(
     "sign_secp256k1_ecdsa.stronghold", os.environ['STRONGHOLD_PASSWORD']))

diff --git a/bindings/python/examples/secret_manager/stronghold.py b/bindings/python/examples/secret_manager/stronghold.py
@@ -6,11 +6,10 @@
 
 load_dotenv()
 
-if 'MNEMONIC' not in os.environ:
-    raise Exception(".env MNEMONIC is undefined, see .env.example")
+for env_var in ['MNEMONIC', 'STRONGHOLD_PASSWORD']:
+    if env_var not in os.environ:
+        raise Exception(f'.env {env_var} is undefined, see .env.example')
 
-if 'STRONGHOLD_PASSWORD' not in os.environ:
-    raise Exception(".env STRONGHOLD_PASSWORD is undefined, see .env.example")
 
 secret_manager = SecretManager(StrongholdSecretManager(
     "example.stronghold", os.environ['STRONGHOLD_PASSWORD']))

diff --git a/bindings/python/examples/wallet/backup.py b/bindings/python/examples/wallet/backup.py
@@ -14,18 +14,16 @@
 # Shimmer coin type
 coin_type = CoinType.SHIMMER
 
-if 'STRONGHOLD_PASSWORD' not in os.environ:
-    raise Exception(".env STRONGHOLD_PASSWORD is undefined, see .env.example")
+for env_var in ['STRONGHOLD_PASSWORD', 'MNEMONIC']:
+    if env_var not in os.environ:
+        raise Exception(f'.env {env_var} is undefined, see .env.example')
 
 secret_manager = StrongholdSecretManager(
     os.environ['STRONGHOLD_SNAPSHOT_PATH'], os.environ['STRONGHOLD_PASSWORD'])
 
 wallet = Wallet('./backup-database', client_options,
                 coin_type, secret_manager)
 
-if 'MNEMONIC' not in os.environ:
-    raise Exception(".env MNEMONIC is undefined, see .env.example")
-
 # Store the mnemonic in the Stronghold snapshot, this only needs to be
 # done once.
 account = wallet.store_mnemonic(os.environ['MNEMONIC'])

diff --git a/bindings/python/examples/wallet/logger.py b/bindings/python/examples/wallet/logger.py
@@ -27,8 +27,9 @@
 # Shimmer coin type
 coin_type = CoinType.SHIMMER
 
-if 'STRONGHOLD_PASSWORD' not in os.environ:
-    raise Exception(".env STRONGHOLD_PASSWORD is undefined, see .env.example")
+for env_var in ['STRONGHOLD_PASSWORD', 'MNEMONIC']:
+    if env_var not in os.environ:
+        raise Exception(f'.env {env_var} is undefined, see .env.example')
 
 secret_manager = StrongholdSecretManager(
     "wallet.stronghold",
@@ -37,9 +38,6 @@
 wallet = Wallet(os.environ['WALLET_DB_PATH'], client_options,
                 coin_type, secret_manager)
 
-if 'MNEMONIC' not in os.environ:
-    raise Exception(".env MNEMONIC is undefined, see .env.example")
-
 # Store the mnemonic in the Stronghold snapshot, this only needs to be
 # done once.
 account = wallet.store_mnemonic(os.environ["MNEMONIC"])

diff --git a/bindings/python/examples/wallet/offline_signing/0_generate_addresses.py b/bindings/python/examples/wallet/offline_signing/0_generate_addresses.py
@@ -21,18 +21,16 @@
 node_url = os.environ.get('NODE_URL', 'https://api.testnet.shimmer.network')
 offline_client_options = ClientOptions()
 
-if 'STRONGHOLD_PASSWORD' not in os.environ:
-    raise Exception(".env STRONGHOLD_PASSWORD is undefined, see .env.example")
+for env_var in ['STRONGHOLD_PASSWORD', 'MNEMONIC']:
+    if env_var not in os.environ:
+        raise Exception(f'.env {env_var} is undefined, see .env.example')
 
 secret_manager = StrongholdSecretManager(
     STRONGHOLD_SNAPSHOT_PATH, os.environ['STRONGHOLD_PASSWORD'])
 
 wallet = Wallet(OFFLINE_WALLET_DB_PATH, offline_client_options,
                 CoinType.IOTA, secret_manager)
 
-if 'MNEMONIC' not in os.environ:
-    raise Exception(".env MNEMONIC is undefined, see .env.example")
-
 # Store the mnemonic in the Stronghold snapshot, this only needs to be
 # done once
 wallet.store_mnemonic(os.environ['MNEMONIC'])

diff --git a/bindings/python/examples/wallet/recover_accounts.py b/bindings/python/examples/wallet/recover_accounts.py
@@ -15,8 +15,9 @@
 # Shimmer coin type
 coin_type = CoinType.SHIMMER
 
-if 'STRONGHOLD_PASSWORD' not in os.environ:
-    raise Exception(".env STRONGHOLD_PASSWORD is undefined, see .env.example")
+for env_var in ['STRONGHOLD_PASSWORD', 'MNEMONIC']:
+    if env_var not in os.environ:
+        raise Exception(f'.env {env_var} is undefined, see .env.example')
 
 secret_manager = StrongholdSecretManager(
     os.environ['STRONGHOLD_SNAPSHOT_PATH'], os.environ['STRONGHOLD_PASSWORD'])
@@ -27,9 +28,6 @@
     coin_type,
     secret_manager)
 
-if 'MNEMONIC' not in os.environ:
-    raise Exception(".env MNEMONIC is undefined, see .env.example")
-
 # Store the mnemonic in the Stronghold snapshot, this only needs to be
 # done once.
 account = wallet.store_mnemonic(os.environ['MNEMONIC'])