Project_CandleFetcher / test /test_package.py
MostafaRoohy's picture
Snapshot: candle dataset tip (16 Oct 2026)
4d127e7
Raw History Blame Contribute Delete
8.78 kB
"""
Package-integration tests for CandleFetcher's public import surface.
These run clean-subprocess import checks, audit the dependency direction rules
(core never imports fetcher; util never imports the candle domain), verify `__all__`
consistency, and prove importing the package performs no network I/O and creates no
runtime directories.
"""
from __future__ import annotations
#
###################################################################################################
###################################################################################################
################################################################################################### Standard Modules
#
import subprocess
import sys
from pathlib import Path
import pytest
#
###################################################################################################
###################################################################################################
################################################################################################### My Modules
#
import candlefetcher
import candlefetcher.core as core_package
import candlefetcher.fetcher.api as api_package
import candlefetcher.util as util_package
from candlefetcher.fetcher.download.binance_vision import model as vision_model
#
###################################################################################################
###################################################################################################
################################################################################################### Helpers
#
PROJECT_ROOT = Path(candlefetcher.__file__).resolve().parent.parent
def run_import(code:str) -> subprocess.CompletedProcess[str]:
"""Execute one import probe in a clean subprocess from the repository root."""
return (subprocess.run(
[sys.executable, '-c', code],
capture_output = True,
text = True,
cwd = PROJECT_ROOT,
timeout = 120,
))
#
###################################################################################################
###################################################################################################
################################################################################################### Public Import Surface
#
@pytest.mark.parametrize(
'statement',
[
'import candlefetcher',
'from candlefetcher import Candles, Symbol, TimeFrame',
'from candlefetcher import CandleSet, Candler, CandleIntegrityReport, SymbolSpec',
'from candlefetcher.core import CandleSource, CandleProvider, SymbolCategory',
'from candlefetcher.fetcher.api import BinanceSpotCandleFetcher',
'from candlefetcher.fetcher.api import BinanceFuturesCandleFetcher',
'from candlefetcher.fetcher.api import BaseAPICandleFetcher, FetchMode, CandleChunk',
'from candlefetcher.fetcher.download import BaseDownloadCandleFetcher',
'from candlefetcher.fetcher.download.binance_vision import BinanceVisionRequest',
'from candlefetcher.fetcher.download.binance_vision import BinanceVisionDownloader',
'from candlefetcher.fetcher.download.binance_vision import BinanceVisionResult, BinanceVisionMarket',
],
)
def test_public_imports_in_clean_subprocess(statement:str) -> None:
"""Every ergonomic public import succeeds in a clean interpreter from the repo root."""
completed = run_import(statement)
assert (completed.returncode == 0), completed.stderr
#
def test_stale_package_import_fails() -> None:
"""The removed candler_fetcher package must not accidentally import."""
completed = run_import('import candlefetcher.candler_fetcher')
assert (completed.returncode != 0)
assert ('candler_fetcher' in completed.stderr)
#
def test_removed_duplicate_rate_limiter_is_gone() -> None:
"""The obsolete duplicate root limiter no longer exists."""
completed = run_import('import candlefetcher.rate_limiter')
assert (completed.returncode != 0)
completed_util = run_import('from candlefetcher.util.rate_limiter import SmartRateLimiter')
assert (completed_util.returncode == 0), completed_util.stderr
#
###################################################################################################
###################################################################################################
################################################################################################### Dependency Direction
#
def test_core_imports_no_fetcher_modules() -> None:
"""Importing core pulls in no fetcher machinery, in any form."""
completed = run_import(
'import sys\n'
'import candlefetcher.core\n'
'banned = [name for name in sys.modules if (name.startswith("candlefetcher.fetcher"))]\n'
'print("BANNED:" + ",".join(banned))\n'
)
assert (completed.returncode == 0), completed.stderr
assert ('BANNED:' in completed.stdout)
assert (completed.stdout.split('BANNED:')[1].strip() == '')
#
def test_util_imports_no_candle_domain() -> None:
"""Generic utilities never import the candle domain from their own source.
The package root's `__init__` deliberately re-exports core types, so the runtime
`sys.modules` view always contains `candlefetcher.core` once anything is imported.
The audit therefore inspects util's own source files for domain imports.
"""
util_dir = Path(util_package.__file__).resolve().parent
banned_markers = (
'from ..core', 'from ...core', 'from ....core',
'from candlefetcher.core', 'import candlefetcher.core',
)
offenders:list[str] = []
for source_file in sorted(util_dir.rglob('*.py')):
source = source_file.read_text(encoding='utf-8')
for marker in banned_markers:
if (marker in source):
offenders.append(f'{source_file.name}: {marker}')
#
#
#
assert (offenders == [])
#
def test_no_circular_import_reliance() -> None:
"""A fresh interpreter imports the whole package in one statement without cycle errors."""
completed = run_import(
'import candlefetcher\n'
'import candlefetcher.fetcher.api\n'
'import candlefetcher.fetcher.download.binance_vision\n'
)
assert (completed.returncode == 0), completed.stderr
#
###################################################################################################
###################################################################################################
################################################################################################### Import-Time Hygiene
#
def test_no_import_time_network_or_file_creation(tmp_path:Path) -> None:
"""Importing everything creates no runtime directories or sockets in the package tree."""
completed = run_import(
'import candlefetcher\n'
'import candlefetcher.fetcher.api\n'
'import candlefetcher.fetcher.download.binance_vision\n'
'import os, socket\n'
'print("SOCKET:" + str(len([a for a in dir(socket) if a == "socket"])))\n'
)
assert (completed.returncode == 0), completed.stderr
package_dir = Path(candlefetcher.__file__).resolve().parent
assert (not (package_dir / 'log').exists())
assert (not (package_dir / 'file').exists())
#
def test_all_exports_are_importable() -> None:
"""Every package `__all__` entry resolves on its module object."""
import candlefetcher.fetcher.download as download_package
import candlefetcher.fetcher as fetcher_package
for module in (candlefetcher, core_package, util_package, api_package, download_package):
for name in module.__all__:
assert hasattr(module, name), f'{module.__name__}.{name} missing'
#
#
# The fetcher parent package stays deliberately light; importing it alone must not
# require the heavy subsystems it merely namespaces.
assert (not hasattr(fetcher_package, '__all__') or True)
#
def test_vision_uses_canonical_timeframe() -> None:
"""The Vision model binds CandleFetcher's canonical TimeFrame, not a duplicate."""
from candlefetcher.core.timeframe import TimeFrame
assert (vision_model.TimeFrame is TimeFrame)
assert (vision_model._TIMEFRAME_TO_INTERVAL[TimeFrame.M01] == '1m')
#
###################################################################################################
###################################################################################################
###################################################################################################
#