4965660921

Build Type

github

Committed by GitHub

Commit Message

Merge c57507bf8 into b165bae82

Pull Request Pull Request #45: Add support for transforming collected data into something useful

Run Details

114 of 147 branches covered (77.55%)

Branch coverage included in aggregate %.

94 of 118 new or added lines in 7 files covered. (79.66%)

24 existing lines in 2 files now uncovered.

349 of 402 relevant lines covered (86.82%)

1.74 hits per line

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

65.22

/src/stocktracer/analysis/annual_reports.py

import logging
from typing import Optional

import pandas as pd
from beartype import beartype

from stocktracer.data.sec import Filter as SecFilter
from stocktracer.data.sec import Sec as SecDataSource
from stocktracer.interface import Analysis as AnalysisInterface

logger = logging.getLogger(__name__)


@beartype
class Analysis(AnalysisInterface):
    """Perform an analysis on the earnings per share over time."""

    under_development = True

    def analyze(self) -> Optional[pd.DataFrame]:
        # By omitting the tags, we'll collect all tags for securities
        sec_filter = SecFilter(
            # tags=["EarningsPerShareDiluted"],
            years=1,  # Over the past 1 years
            last_report=self.options.last_report,
            only_annual=True,  # We only want the 10-K
        )

        # Create an SEC Data Source
        assert self.options is not None
        assert self.options.cache_path is not None
        sec = SecDataSource(storage_path=self.options.cache_path)
        sec.select_data(tickers=self.options.tickers, filter=sec_filter)

        table = sec_filter.select()
        logger.debug(f"tags:\n{table.tags}")

        return table.data

    # Reuse documentation from parent
    analyze.__doc__ = AnalysisInterface.analyze.__doc__

1	import logging	2✔
2	from typing import Optional	2✔
3
4	import pandas as pd	2✔
5	from beartype import beartype	2✔
6
7	from stocktracer.data.sec import Filter as SecFilter	2✔
8	from stocktracer.data.sec import Sec as SecDataSource	2✔
9	from stocktracer.interface import Analysis as AnalysisInterface	2✔
10
11	logger = logging.getLogger(__name__)	2✔
12
13
14	@beartype	2✔
15	class Analysis(AnalysisInterface):	2✔
16	"""Perform an analysis on the earnings per share over time."""
17
18	under_development = True	2✔
19
20	def analyze(self) -> Optional[pd.DataFrame]:	2✔
21	# By omitting the tags, we'll collect all tags for securities
NEW 22	sec_filter = SecFilter(	×
23	# tags=["EarningsPerShareDiluted"],
24	years=1, # Over the past 1 years
25	last_report=self.options.last_report,
26	only_annual=True, # We only want the 10-K
27	)
28
29	# Create an SEC Data Source
NEW 30	assert self.options is not None	×
NEW 31	assert self.options.cache_path is not None	×
NEW 32	sec = SecDataSource(storage_path=self.options.cache_path)	×
NEW 33	sec.select_data(tickers=self.options.tickers, filter=sec_filter)	×
34
NEW 35	table = sec_filter.select()	×
NEW 36	logger.debug(f"tags:\n{table.tags}")	×
37
NEW 38	return table.data	×
39
40	# Reuse documentation from parent
41	analyze.__doc__ = AnalysisInterface.analyze.__doc__	2✔

gyund / fundamental-analysis / 4965660921

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