Skip to content

stub

This stub serves an example for module developers.

Analysis

Bases: AnalysisInterface

Stub for analyzing the report.

Source code in src/stocktracer/analysis/stub.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
@beartype
class Analysis(AnalysisInterface):
    """Stub for analyzing the report."""

    def analyze(self) -> Optional[pd.DataFrame]:
        """

        As a stub, this does nothing

        Returns:
            Optional[pd.DataFrame]: Always None, since the stub doesn't analyze anything.
        """
        print(
            "This is where we would start to process information, but we're not right now"
        )

analyze()

As a stub, this does nothing

Returns:

Type Description
Optional[pd.DataFrame]

Optional[pd.DataFrame]: Always None, since the stub doesn't analyze anything.
Source code in src/stocktracer/analysis/stub.py 
17
18
19
20
21
22
23
24
25
26
27
def analyze(self) -> Optional[pd.DataFrame]:
    """

    As a stub, this does nothing

    Returns:
        Optional[pd.DataFrame]: Always None, since the stub doesn't analyze anything.
    """
    print(
        "This is where we would start to process information, but we're not right now"
    )
Last update: July 3, 2023