4965412900

Build Type

github

Committed by GitHub

Commit Message

Merge 10d0bc423 into b165bae82

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

Run Details

113 of 143 branches covered (79.02%)

Branch coverage included in aggregate %.

80 of 96 new or added lines in 7 files covered. (83.33%)

30 existing lines in 2 files now uncovered.

350 of 401 relevant lines covered (87.28%)

1.75 hits per line

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

66.67

/src/stocktracer/analysis/annual_reports.py

import logging
from typing import Optional

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

gyund / fundamental-analysis / 4965412900

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