Merge pull request #243 from dpguthrie/refactor-init

Refactor Session Initialization
dpguthrie · Dec 6, 2023 · 1a8269b · 1a8269b
2 parents c87734c + 5a36d47
commit 1a8269b
Show file tree

Hide file tree

Showing 15 changed files with 4,125 additions and 2,739 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -2,25 +2,24 @@ name: Build
 
 on:
   pull_request_target:
-    branches: [ master ]
+    branches: [master]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python 3.9
-      uses: actions/setup-python@v2
-      with:
-        python-version: "3.9"
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install poetry
-        make install_dev
-    - name: Run tests and coverage
-      run: make test_cov
-    - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v2
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.9"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install poetry
+          make install_dev
+      - name: Run tests and coverage
+        run: make test_cov
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v2
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,6 +1,18 @@
 Change Log
 ==========
 
+2.3.4
+-----
+## Update
+- Use a different url to try and obtain cookies (fc.yahoo.com no longer works)
+- Refactor how a session is initialized
+- Use the country as a way to make the request to obtain cookies be more location specific
+
+2.3.3
+-----
+## Update
+- Try and obtain cookies and a crumb during `Ticker` initialization so they can be used in further requests.
+
 2.3.2
 -----
 ## Update

diff --git a/docs/docs/guide/advanced.md b/docs/docs/guide/advanced.md
@@ -34,7 +34,7 @@ for i, row in df.iterrows():
 
 # Or, pass all tickers to the Ticker instance
 ticker_list = df['Tickers'].tolist()
-ticker_list = list(set(_flatten_list(ticker_list)))
+ticker_list = list(set(flatten_list(ticker_list)))
 tickers = Ticker(ticker_list, session=r.session, crumb=r.crumb)
 data = tickers.p_company_360
 # Do something with data

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "yahooquery"
-version = "2.3.3"
+version = "2.3.4"
 description = "Python wrapper for an unofficial Yahoo Finance API"
 authors = ["Doug Guthrie <douglas.p.guthrie@gmail.com>"]
 documentation = "https://yahooquery.dpguthrie.com"
@@ -9,7 +9,7 @@ license = "MIT"
 readme = "README.md"
 
 [tool.poetry.dependencies]
-python = "^3.9"
+python = ">=3.8.1,<4.0"
 requests = "^2.31.0"
 pandas = "^2.0.3"
 requests-futures = "^1.0.1"
@@ -20,13 +20,13 @@ webdriver-manager = {version = "^3.8.6", optional = true}
 
 [tool.poetry.dev-dependencies]
 pytest = "^7.4.0"
-isort = "^5.12.0"
+isort = "^5.0.0"
 flake8 = "^6.0.0"
 mypy = "^1.4.1"
 pytest-cov = "^4.1.0"
 black = "^23.7.0"
 pre-commit = "^3.3.3"
-ipython = "^8.14.0"
+ipython = "^8.0.0"
 mkdocs-material = "^9.1.18"
 
 [build-system]

diff --git a/tests/test_ticker.py b/tests/test_ticker.py
@@ -184,7 +184,7 @@ def test_adj_ohlc(ticker):
     assert ticker.history(period="max", adj_ohlc=True) is not None
 
 
-class TestHistoryDataframe():
+class TestHistoryDataframe:
     """Tests for `utils.__init__._history_dataframe` and dependencies."""
 
     @pytest.fixture
@@ -250,13 +250,20 @@ def timestamps_daily(self, utc, tz_oz, tz_us, tz_hk):
 
         expected_utc = pd.DatetimeIndex(
             [
-                '2022-11-04 13:30:00', '2022-11-07 14:30:00',
-                '2022-11-08 14:30:00', '2022-11-09 14:30:00',
-                '2022-11-10 14:30:00', '2022-11-11 14:30:00',
-                '2022-11-14 14:30:00', '2022-11-15 14:30:00',
-                '2022-11-16 14:30:00', '2022-11-17 14:30:00',
-                '2022-11-18 14:30:00', '2022-11-21 14:30:00',
-                '2022-11-22 14:30:00', '2022-11-23 14:30:00',
+                '2022-11-04 13:30:00',
+                '2022-11-07 14:30:00',
+                '2022-11-08 14:30:00',
+                '2022-11-09 14:30:00',
+                '2022-11-10 14:30:00',
+                '2022-11-11 14:30:00',
+                '2022-11-14 14:30:00',
+                '2022-11-15 14:30:00',
+                '2022-11-16 14:30:00',
+                '2022-11-17 14:30:00',
+                '2022-11-18 14:30:00',
+                '2022-11-21 14:30:00',
+                '2022-11-22 14:30:00',
+                '2022-11-23 14:30:00',
             ],
             tz=utc,
         )
@@ -284,13 +291,20 @@ def timestamps_daily(self, utc, tz_oz, tz_us, tz_hk):
 
         expected_oz = pd.DatetimeIndex(
             [
-                '2022-11-05 00:30:00', '2022-11-08 01:30:00',
-                '2022-11-09 01:30:00', '2022-11-10 01:30:00',
-                '2022-11-11 01:30:00', '2022-11-12 01:30:00',
-                '2022-11-15 01:30:00', '2022-11-16 01:30:00',
-                '2022-11-17 01:30:00', '2022-11-18 01:30:00',
-                '2022-11-19 01:30:00', '2022-11-22 01:30:00',
-                '2022-11-23 01:30:00', '2022-11-24 01:30:00',
+                '2022-11-05 00:30:00',
+                '2022-11-08 01:30:00',
+                '2022-11-09 01:30:00',
+                '2022-11-10 01:30:00',
+                '2022-11-11 01:30:00',
+                '2022-11-12 01:30:00',
+                '2022-11-15 01:30:00',
+                '2022-11-16 01:30:00',
+                '2022-11-17 01:30:00',
+                '2022-11-18 01:30:00',
+                '2022-11-19 01:30:00',
+                '2022-11-22 01:30:00',
+                '2022-11-23 01:30:00',
+                '2022-11-24 01:30:00',
             ],
             tz=tz_oz,
         )
@@ -318,13 +332,20 @@ def timestamps_daily(self, utc, tz_oz, tz_us, tz_hk):
 
         expected_us = pd.DatetimeIndex(
             [
-                '2022-11-04 09:30:00', '2022-11-07 09:30:00',
-                '2022-11-08 09:30:00', '2022-11-09 09:30:00',
-                '2022-11-10 09:30:00', '2022-11-11 09:30:00',
-                '2022-11-14 09:30:00', '2022-11-15 09:30:00',
-                '2022-11-16 09:30:00', '2022-11-17 09:30:00',
-                '2022-11-18 09:30:00', '2022-11-21 09:30:00',
-                '2022-11-22 09:30:00', '2022-11-23 09:30:00',
+                '2022-11-04 09:30:00',
+                '2022-11-07 09:30:00',
+                '2022-11-08 09:30:00',
+                '2022-11-09 09:30:00',
+                '2022-11-10 09:30:00',
+                '2022-11-11 09:30:00',
+                '2022-11-14 09:30:00',
+                '2022-11-15 09:30:00',
+                '2022-11-16 09:30:00',
+                '2022-11-17 09:30:00',
+                '2022-11-18 09:30:00',
+                '2022-11-21 09:30:00',
+                '2022-11-22 09:30:00',
+                '2022-11-23 09:30:00',
             ],
             tz=tz_us,
         )
@@ -352,13 +373,20 @@ def timestamps_daily(self, utc, tz_oz, tz_us, tz_hk):
 
         expected_hk = pd.DatetimeIndex(
             [
-                '2022-11-04 21:30', '2022-11-07 22:30',
-                '2022-11-08 22:30', '2022-11-09 22:30',
-                '2022-11-10 22:30', '2022-11-11 22:30',
-                '2022-11-14 22:30', '2022-11-15 22:30',
-                '2022-11-16 22:30', '2022-11-17 22:30',
-                '2022-11-18 22:30', '2022-11-21 22:30',
-                '2022-11-22 22:30', '2022-11-23 22:30',
+                '2022-11-04 21:30',
+                '2022-11-07 22:30',
+                '2022-11-08 22:30',
+                '2022-11-09 22:30',
+                '2022-11-10 22:30',
+                '2022-11-11 22:30',
+                '2022-11-14 22:30',
+                '2022-11-15 22:30',
+                '2022-11-16 22:30',
+                '2022-11-17 22:30',
+                '2022-11-18 22:30',
+                '2022-11-21 22:30',
+                '2022-11-22 22:30',
+                '2022-11-23 22:30',
             ],
             tz=tz_hk,
         )
@@ -370,7 +398,11 @@ def timestamps_daily(self, utc, tz_oz, tz_us, tz_hk):
         )
 
         yield (
-            tss, expected_us_days, expected_oz_days, expected_hk_days, expected_utc_days
+            tss,
+            expected_us_days,
+            expected_oz_days,
+            expected_hk_days,
+            expected_utc_days,
         )
 
     @pytest.fixture
@@ -451,12 +483,7 @@ def get_splits(tss):
         indice = 11
         ts = tss[indice]
         d = {
-            str(ts): {
-                'data': ts,
-                'numerator': 3,
-                'denominator': 1,
-                'splitRatio': '3:1'
-            }
+            str(ts): {'data': ts, 'numerator': 3, 'denominator': 1, 'splitRatio': '3:1'}
         }
         expected = [3 if i == indice else float('nan') for i in range(14)]
         return d, expected
@@ -606,7 +633,10 @@ def f(data, adj_timezone):
         dividends, _ = dividends_daily
 
         expecteds = (
-            expected_daily_utc, expected_daily_us, expected_daily_oz, expected_daily_hk
+            expected_daily_utc,
+            expected_daily_us,
+            expected_daily_oz,
+            expected_daily_hk,
         )
         tzs = (utc, tz_us, tz_oz, tz_hk)
         for expected, tz in zip(expecteds, tzs):
@@ -663,7 +693,9 @@ def test_live_indice(
         # verify live indice has local timezone when adj_timezone True
         rtrn = _history_dataframe(data, daily=True, adj_timezone=True)
         expected_li = pd.Timestamp("2022-11-23 14:31", tz=tz_us).to_pydatetime()
-        expected_index = expected_index[:-1].insert(len(expected_index)-1, expected_li)
+        expected_index = expected_index[:-1].insert(
+            len(expected_index) - 1, expected_li
+        )
         expected_df.index = expected_index
         assert_frame_equal(rtrn, expected_df)
 
@@ -728,13 +760,20 @@ def timestamps_intraday(self, utc):
 
         expected_index_utc = pd.DatetimeIndex(
             [
-                '2022-11-04 13:30:00', '2022-11-04 14:30:00',
-                '2022-11-04 15:30:00', '2022-11-04 16:30:00',
-                '2022-11-04 17:30:00', '2022-11-04 18:30:00',
-                '2022-11-04 19:30:00', '2022-11-07 14:30:00',
-                '2022-11-07 15:30:00', '2022-11-07 16:30:00',
-                '2022-11-07 17:30:00', '2022-11-07 18:30:00',
-                '2022-11-07 19:30:00', '2022-11-07 20:30:00'
+                '2022-11-04 13:30:00',
+                '2022-11-04 14:30:00',
+                '2022-11-04 15:30:00',
+                '2022-11-04 16:30:00',
+                '2022-11-04 17:30:00',
+                '2022-11-04 18:30:00',
+                '2022-11-04 19:30:00',
+                '2022-11-07 14:30:00',
+                '2022-11-07 15:30:00',
+                '2022-11-07 16:30:00',
+                '2022-11-07 17:30:00',
+                '2022-11-07 18:30:00',
+                '2022-11-07 19:30:00',
+                '2022-11-07 20:30:00',
             ],
             tz=utc,
         )

diff --git a/yahooquery/__init__.py b/yahooquery/__init__.py
@@ -1,7 +1,7 @@
 """Python interface to unofficial Yahoo Finance API endpoints"""
 
 name = "yahooquery"
-__version__ = "2.3.2"
+__version__ = "2.3.4"
 
 from .research import Research  # noqa
 from .ticker import Ticker  # noqa