4908036935

Build Type

github

Committed by GitHub

Commit Message

Merge 7a2501e40 into 4b6424b61

Pull Request Pull Request #36: Add support to generate reports in different formats supported by pandas

Run Details

71 of 103 branches covered (68.93%)

Branch coverage included in aggregate %.

113 of 140 new or added lines in 7 files covered. (80.71%)

32 existing lines in 1 file now uncovered.

272 of 335 relevant lines covered (81.19%)

0.81 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

93.55

/src/stocktracer/interface.py

""" Interfaces for the StockTracer Module."""
import abc
from pathlib import Path
from typing import Optional

from beartype import beartype
from pandas import DataFrame


@beartype
class Options:
    """Command Line Options"""

    def __init__(self, tickers: frozenset[str], cache_path: Path):
        """Options

        Args:
            tickers (frozenset[str]): tickers to scrape from data sets
            cache_path (Path): path to cache processed or downloaded information
        """
        self.tickers = tickers
        self.cache_path = cache_path


@beartype
class Analysis(metaclass=abc.ABCMeta):
    @abc.abstractmethod
    def analyze(self) -> Optional[DataFrame]:
        """Perform financial analysis."""
        pass

    @property
    def options(self) -> Optional[Options]:
        """Get current analysis options.

        Returns:
            Optional[Options]: configured options or None.
        """
        return self._options

    @options.setter
    def options(self, options: Options):
        """Set analysis options.

        Args:
            options (Options): options
        """
        self._options = options

1	""" Interfaces for the StockTracer Module."""
2	import abc	1✔
3	from pathlib import Path	1✔
4	from typing import Optional	1✔
5
6	from beartype import beartype	1✔
7	from pandas import DataFrame	1✔
8
9
10	@beartype	1✔
11	class Options:	1✔
12	"""Command Line Options"""
13
14	def __init__(self, tickers: frozenset[str], cache_path: Path):	1✔
15	"""Options
16
17	Args:
18	tickers (frozenset[str]): tickers to scrape from data sets
19	cache_path (Path): path to cache processed or downloaded information
20	"""
21	self.tickers = tickers	1✔
22	self.cache_path = cache_path	1✔
23
24
25	@beartype	1✔
26	class Analysis(metaclass=abc.ABCMeta):	1✔
27	@abc.abstractmethod	1✔
28	def analyze(self) -> Optional[DataFrame]:	1✔
29	"""Perform financial analysis."""
NEW 30	pass	×
31
32	@property	1✔
33	def options(self) -> Optional[Options]:	1✔
34	"""Get current analysis options.
35
36	Returns:
37	Optional[Options]: configured options or None.
38	"""
NEW 39	return self._options	×
40
41	@options.setter	1✔
42	def options(self, options: Options):	1✔
43	"""Set analysis options.
44
45	Args:
46	options (Options): options
47	"""
48	self._options = options	1✔

gyund / fundamental-analysis / 4908036935

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous