Merge pull request #2410 from ranaroussi/dev

sync dev -> main

Author: ValueRaider

doc/source/advanced/config.rst

@@ -0,0 +1,15 @@
+******
+Config
+******
+
+`yfinance` has a new global config for sharing common values.
+
+Proxy
+-----
+
+Set proxy once in config, affects all yfinance data fetches.
+
+.. code-block:: python
+
+   import yfinance as yf
+   yf.set_config(proxy="PROXY_SERVER")

doc/source/advanced/index.rst

@@ -6,6 +6,6 @@ Advanced
    :maxdepth: 2
 
    logging
-   proxy
+   config
    caching
    multi_level_columns

doc/source/advanced/proxy.rst

@@ -0,0 +1,33 @@
+import yfinance as yf
+
+# Get All
+all = yf.Lookup("AAPL").all
+all = yf.Lookup("AAPL").get_all(count=100)
+
+# Get Stocks
+stock = yf.Lookup("AAPL").stock
+stock = yf.Lookup("AAPL").get_stock(count=100)
+
+# Get Mutual Funds
+mutualfund = yf.Lookup("AAPL").mutualfund
+mutualfund = yf.Lookup("AAPL").get_mutualfund(count=100)
+
+# Get ETFs
+etf = yf.Lookup("AAPL").etf
+etf = yf.Lookup("AAPL").get_etf(count=100)
+
+# Get Indices
+index = yf.Lookup("AAPL").index
+index = yf.Lookup("AAPL").get_index(count=100)
+
+# Get Futures
+future = yf.Lookup("AAPL").future
+future = yf.Lookup("AAPL").get_future(count=100)
+
+# Get Currencies
+currency = yf.Lookup("AAPL").currency
+currency = yf.Lookup("AAPL").get_currency(count=100)
+
+# Get Cryptocurrencies
+cryptocurrency = yf.Lookup("AAPL").cryptocurrency
+cryptocurrency = yf.Lookup("AAPL").get_cryptocurrency(count=100)

doc/source/reference/examples/lookup.py

@@ -18,6 +18,7 @@ The following are the publicly available classes, and functions exposed by the `
 - :attr:`Market <yfinance.Market>`: Class for accessing market summary.
 - :attr:`download <yfinance.download>`: Function to download market data for multiple tickers.
 - :attr:`Search <yfinance.Search>`: Class for accessing search results.
+- :attr:`Lookup <yfinance.Lookup>`: Class for looking up tickers.
 - :attr:`Sector <yfinance.Sector>`: Domain class for accessing sector information.
 - :attr:`Industry <yfinance.Industry>`: Domain class for accessing industry information.
 - :attr:`Market <yfinance.Market>`: Class for accessing market status & summary.
@@ -39,6 +40,7 @@ The following are the publicly available classes, and functions exposed by the `
    yfinance.analysis
    yfinance.market
    yfinance.search
+   yfinance.lookup
    yfinance.sector_industry
    yfinance.screener
    yfinance.functions

doc/source/reference/index.rst

@@ -1,5 +1,5 @@
 =====================
-Search & News
+Search & Lookup
 =====================
 
 .. currentmodule:: yfinance
@@ -14,9 +14,21 @@ The `Search` module, allows you to access search data in a Pythonic way.
 
    Search
 
-Search Sample Code
+The `Lookup` module, allows you to look up tickers in a Pythonic way.
+
+.. autosummary::
+   :toctree: api/
+
+   Lookup
+
+Sample Code
 ------------------
 The `Search` module, allows you to access search data in a Pythonic way.
 
 .. literalinclude:: examples/search.py
    :language: python
+
+The `Lookup` module, allows you to look up tickers in a Pythonic way.
+
+.. literalinclude:: examples/lookup.py
+   :language: python

doc/source/reference/yfinance.search.rst

@@ -8,8 +8,6 @@
    python -m unittest tests.cache.TestCache
 
 """
-from unittest import TestSuite
-
 from tests.context import yfinance as yf
 
 import unittest
@@ -48,46 +46,5 @@ def test_setTzCacheLocation(self):
         self.assertTrue(os.path.exists(os.path.join(self.tempCacheDir.name, "tkr-tz.db")))
 
 
-class TestCacheNoPermission(unittest.TestCase):
-    @classmethod
-    def setUpClass(cls):
-        if os.name == "nt":  # Windows
-            cls.cache_path = "C:\\Windows\\System32\\yf-cache"
-        else:  # Unix/Linux/MacOS
-            # Use a writable directory
-            cls.cache_path = "/yf-cache"
-        yf.set_tz_cache_location(cls.cache_path)
-
-    def test_tzCacheRootStore(self):
-        # Test that if cache path in read-only filesystem, no exception.
-        tkr = 'AMZN'
-        tz1 = "America/New_York"
-
-        # During attempt to store, will discover cannot write
-        yf.cache.get_tz_cache().store(tkr, tz1)
-
-        # Handling the store failure replaces cache with a dummy
-        cache = yf.cache.get_tz_cache()
-        self.assertTrue(cache.dummy)
-        cache.store(tkr, tz1)
-
-    def test_tzCacheRootLookup(self):
-        # Test that if cache path in read-only filesystem, no exception.
-        tkr = 'AMZN'
-        # During attempt to lookup, will discover cannot write
-        yf.cache.get_tz_cache().lookup(tkr)
-
-        # Handling the lookup failure replaces cache with a dummy
-        cache = yf.cache.get_tz_cache()
-        self.assertTrue(cache.dummy)
-        cache.lookup(tkr)
-
-def suite():
-    ts: TestSuite = unittest.TestSuite()
-    ts.addTest(TestCache('Test cache'))
-    ts.addTest(TestCacheNoPermission('Test cache no permission'))
-    return ts
-
-
 if __name__ == '__main__':
     unittest.main()

tests/test_cache.py

@@ -0,0 +1,52 @@
+"""
+Tests for cache
+
+To run all tests in suite from commandline:
+   python -m unittest tests.cache
+
+Specific test class:
+   python -m unittest tests.cache.TestCache
+
+"""
+from tests.context import yfinance as yf
+
+import unittest
+import os
+
+
+class TestCacheNoPermission(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        if os.name == "nt":  # Windows
+            cls.cache_path = "C:\\Windows\\System32\\yf-cache"
+        else:  # Unix/Linux/MacOS
+            # Use a writable directory
+            cls.cache_path = "/yf-cache"
+        yf.set_tz_cache_location(cls.cache_path)
+
+    def test_tzCacheRootStore(self):
+        # Test that if cache path in read-only filesystem, no exception.
+        tkr = 'AMZN'
+        tz1 = "America/New_York"
+
+        # During attempt to store, will discover cannot write
+        yf.cache.get_tz_cache().store(tkr, tz1)
+
+        # Handling the store failure replaces cache with a dummy
+        cache = yf.cache.get_tz_cache()
+        self.assertTrue(cache.dummy)
+        cache.store(tkr, tz1)
+
+    def test_tzCacheRootLookup(self):
+        # Test that if cache path in read-only filesystem, no exception.
+        tkr = 'AMZN'
+        # During attempt to lookup, will discover cannot write
+        yf.cache.get_tz_cache().lookup(tkr)
+
+        # Handling the lookup failure replaces cache with a dummy
+        cache = yf.cache.get_tz_cache()
+        self.assertTrue(cache.dummy)
+        cache.lookup(tkr)
+
+if __name__ == '__main__':
+    unittest.main()

tests/test_cache_noperms.py

@@ -0,0 +1,69 @@
+import unittest
+
+import pandas as pd
+
+from tests.context import yfinance as yf, session_gbl
+
+
+class TestLookup(unittest.TestCase):
+    def setUp(self):
+        self.query = "A"  # Generic query to make sure all lookup types are returned
+        self.lookup = yf.Lookup(query=self.query, session=session_gbl)
+
+    def test_get_all(self):
+        result = self.lookup.get_all(count=5)
+
+        self.assertIsInstance(result, pd.DataFrame)
+        self.assertEqual(len(result), 5)
+
+    def test_get_stock(self):
+        result = self.lookup.get_stock(count=5)
+
+        self.assertIsInstance(result, pd.DataFrame)
+        self.assertEqual(len(result), 5)
+
+    def test_get_mutualfund(self):
+        result = self.lookup.get_mutualfund(count=5)
+
+        self.assertIsInstance(result, pd.DataFrame)
+        self.assertEqual(len(result), 5)
+
+    def test_get_etf(self):
+        result = self.lookup.get_etf(count=5)
+
+        self.assertIsInstance(result, pd.DataFrame)
+        self.assertEqual(len(result), 5)
+
+    def test_get_index(self):
+        result = self.lookup.get_index(count=5)
+
+        self.assertIsInstance(result, pd.DataFrame)
+        self.assertEqual(len(result), 5)
+
+    def test_get_future(self):
+        result = self.lookup.get_future(count=5)
+
+        self.assertIsInstance(result, pd.DataFrame)
+        self.assertEqual(len(result), 5)
+
+    def test_get_currency(self):
+        result = self.lookup.get_currency(count=5)
+
+        self.assertIsInstance(result, pd.DataFrame)
+        self.assertEqual(len(result), 5)
+
+    def test_get_cryptocurrency(self):
+        result = self.lookup.get_cryptocurrency(count=5)
+
+        self.assertIsInstance(result, pd.DataFrame)
+        self.assertEqual(len(result), 5)
+
+    def test_large_all(self):
+        result = self.lookup.get_all(count=1000)
+
+        self.assertIsInstance(result, pd.DataFrame)
+        self.assertEqual(len(result), 1000)
+
+
+if __name__ == "__main__":
+    unittest.main()

tests/test_lookup.py

@@ -66,7 +66,7 @@ def test_duplicatingHourly(self):
         tkrs = ["IMP.JO", "BHG.JO", "SSW.JO", "BP.L", "INTC"]
         for tkr in tkrs:
             dat = yf.Ticker(tkr, session=self.session)
-            tz = dat._get_ticker_tz(proxy=None, timeout=None)
+            tz = dat._get_ticker_tz(timeout=None)
 
             dt_utc = _pd.Timestamp.utcnow()
             dt = dt_utc.astimezone(_tz.timezone(tz))
@@ -86,7 +86,7 @@ def test_duplicatingDaily(self):
         test_run = False
         for tkr in tkrs:
             dat = yf.Ticker(tkr, session=self.session)
-            tz = dat._get_ticker_tz(proxy=None, timeout=None)
+            tz = dat._get_ticker_tz(timeout=None)
 
             dt_utc = _pd.Timestamp.utcnow()
             dt = dt_utc.astimezone(_tz.timezone(tz))
@@ -112,7 +112,7 @@ def test_duplicatingWeekly(self):
         test_run = False
         for tkr in tkrs:
             dat = yf.Ticker(tkr, session=self.session)
-            tz = dat._get_ticker_tz(proxy=None, timeout=None)
+            tz = dat._get_ticker_tz(timeout=None)
 
             dt = _tz.timezone(tz).localize(_dt.datetime.now())
             if dt.date().weekday() not in [1, 2, 3, 4]: