Add __str__ method to models

Author: codeofandrin

apininjas/finance.py

@@ -55,6 +55,10 @@ class Stock(apininjas.abc.FinancialInstrument):
 
     .. container:: operations
 
+        .. describe:: str(x)
+
+            Returns the stock's name.
+
         .. describe:: x == y
 
             Checks if two stocks are equal.
@@ -114,6 +118,9 @@ def __repr__(self) -> str:
         joined = " ".join([f"{a}={v!r}" for a, v in attrs])
         return f"<Stock {joined}>"
 
+    def __str__(self) -> str:
+        return self.name
+
     def __eq__(self, other: Stock) -> bool:
         return self.ticker == other.ticker
 
@@ -137,6 +144,10 @@ class Commodity(apininjas.abc.FinancialInstrument):
 
     .. container:: operations
 
+        .. describe:: str(x)
+
+            Returns the name of the commodity future.
+
         .. describe:: x == y
 
             Checks if two commodity futures are equal.
@@ -199,6 +210,9 @@ def __repr__(self) -> str:
         joined = " ".join([f"{a}={v!r}" for a, v in attrs])
         return f"<Commodity {joined}>"
 
+    def __str__(self) -> str:
+        return self.name
+
     def __eq__(self, other: Commodity) -> bool:
         return self.type == other.type
 
@@ -222,6 +236,10 @@ class Crypto(apininjas.abc.FinancialInstrument):
 
     .. container:: operations
 
+        .. describe:: str(x)
+
+            Returns the cryptocurrency's symbol.
+
         .. describe:: x == y
 
             Checks if two cryptocurrencies are equal.
@@ -264,6 +282,9 @@ def __init__(self, *, http: HTTPClient, data: CryptoPayload):
     def __repr__(self) -> str:
         return f"<Crypto symbol={self.symbol}>"
 
+    def __str__(self) -> str:
+        return self.symbol
+
     def __eq__(self, other: Crypto) -> bool:
         return self.symbol == other.symbol
 
@@ -287,6 +308,10 @@ class Currency:
 
     .. container:: operations
 
+        .. describe:: str(x)
+
+            Returns the currency's name.
+
         .. describe:: x == y
 
             Checks if two currencies are equal.
@@ -321,6 +346,9 @@ def __repr__(self) -> str:
         joined = " ".join([f"{a}={v!r}" for a, v in attrs])
         return f"<Currency {joined}>"
 
+    def __str__(self) -> str:
+        return self.name
+
     def __eq__(self, other: Currency) -> bool:
         return self.name == other.name and self.reference == other.reference