5086546951

Build Type

github

Committed by GitHub

Commit Message

Merge f8da34855 into 4cad7f0d0

Pull Request Pull Request #78: Add f-score

Run Details

94 of 127 branches covered (74.02%)

Branch coverage included in aggregate %.

92 of 140 new or added lines in 7 files covered. (65.71%)

38 existing lines in 4 files now uncovered.

397 of 487 relevant lines covered (81.52%)

1.63 hits per line

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

60.71

/src/stocktracer/analysis/annual_reports.py

"""Download and retrieves annual reports for the specified stock tickers."""
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
from stocktracer.interface import Options

logger = logging.getLogger(__name__)


def create_normalized_sec_table(
    sec_filter: SecFilter, options: Options, normalize: bool = True
) -> SecFilter.Results:
    """Create a normalized SEC table with all NA values removed.

    Args:
        sec_filter (SecFilter): filter to use for grabbing results
        options (Options): user provided CLI options
        normalize (bool): Remove all columns that contain at least one NA value

    Returns:
        SecFilter.Results: An SEC table with normalized results
    """
    sec = SecDataSource(storage_path=options.cache_path)
    sec.filter_data(tickers=options.tickers, sec_filter=sec_filter)

    table = sec_filter.select()
    # If you prefer to see columns that are not universal across all stocks, comment this out
    if normalize:
        table.normalize()
    return table


@beartype
class Analysis(AnalysisInterface):
    """Class for collecting and processing annual report data."""

    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
        table = create_normalized_sec_table(sec_filter, self.options, False)

        return table.data

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

1	"""Download and retrieves annual reports for the specified stock tickers."""
2	import logging	2✔
3	from typing import Optional	2✔
4
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	from stocktracer.interface import Options	2✔
12
13	logger = logging.getLogger(__name__)	2✔
14
15
16	def create_normalized_sec_table(	2✔
17	sec_filter: SecFilter, options: Options, normalize: bool = True
18	) -> SecFilter.Results:
19	"""Create a normalized SEC table with all NA values removed.
20
21	Args:
22	sec_filter (SecFilter): filter to use for grabbing results
23	options (Options): user provided CLI options
24	normalize (bool): Remove all columns that contain at least one NA value
25
26	Returns:
27	SecFilter.Results: An SEC table with normalized results
28	"""
NEW 29	sec = SecDataSource(storage_path=options.cache_path)	×
NEW 30	sec.filter_data(tickers=options.tickers, sec_filter=sec_filter)	×
31
NEW 32	table = sec_filter.select()	×
33	# If you prefer to see columns that are not universal across all stocks, comment this out
NEW 34	if normalize:	×
NEW 35	table.normalize()	×
NEW 36	return table	×
37
38
39	@beartype	2✔
40	class Analysis(AnalysisInterface):	2✔
41	"""Class for collecting and processing annual report data."""
42
43	under_development = True	2✔
44
45	def analyze(self) -> Optional[pd.DataFrame]:	2✔
46	# By omitting the tags, we'll collect all tags for securities
UNCOV 47	sec_filter = SecFilter(	×
48	# tags=["EarningsPerShareDiluted"],
49	years=1, # Over the past 1 years
50	last_report=self.options.last_report,
51	only_annual=True, # We only want the 10-K
52	)
53
54	# Create an SEC Data Source
NEW 55	table = create_normalized_sec_table(sec_filter, self.options, False)	×
56
UNCOV 57	return table.data	×
58
59	# Reuse documentation from parent
60	analyze.__doc__ = AnalysisInterface.analyze.__doc__	2✔

gyund / fundamental-analysis / 5086546951

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