Files
yfinance-fork/tests/test_sector_region.py
Alessandro Colace ac1a7f65ca Allow region scoping for Sector and Industry
Yahoo's `/v1/finance/sectors/{key}` and `/industries/{key}` endpoints accept
an ISO 3166-1 alpha-2 `region` query parameter and return regional top
companies/ETFs/funds accordingly. The Domain base class hard-coded `region=US`,
so `Sector("technology").top_companies` always returned U.S. names regardless
of the user's interest.

- Add `region: str = "US"` to `Domain.__init__` and propagate through
  `Sector` and `Industry`.
- Normalize input via `.strip().upper()` so "us", " GB ", and "Fr" all work.
- Use `self._region` in the request params.
- Document and test the behavior.

Closes #2601
2026-05-09 17:55:05 +02:00

32 lines
1.1 KiB
Python

import unittest
from tests.context import yfinance as yf
class TestSectorRegion(unittest.TestCase):
def test_default_region_is_us(self):
s = yf.Sector("technology")
self.assertEqual(s._region, "US")
def test_region_is_normalized(self):
for raw, expected in [("us", "US"), (" GB ", "GB"), ("Fr", "FR")]:
s = yf.Sector("technology", region=raw)
self.assertEqual(s._region, expected)
def test_us_and_gb_top_companies_differ(self):
us = yf.Sector("technology").top_companies
gb = yf.Sector("technology", region="GB").top_companies
self.assertIsNotNone(us)
self.assertIsNotNone(gb)
# UK-listed symbols carry the .L suffix, U.S. symbols do not.
self.assertTrue(any(sym.endswith(".L") for sym in gb.index))
self.assertFalse(any(sym.endswith(".L") for sym in us.index))
def test_industry_region_propagates(self):
ind = yf.Industry("software-infrastructure", region="DE")
self.assertEqual(ind._region, "DE")
if __name__ == "__main__":
unittest.main()