Skip to content

Indicators Util

Dashboard-specific utilities for indicator discovery and registration lookup.

get_registered_indicators()

Return all registered indicator classes.

Returns:

Type Description
dict[str, type]

Dictionary mapping indicator class names to their class objects.
Source code in src/onesecondtrader/dashboard/indicators_util.py 
11
12
13
14
15
16
17
18
19
20
def get_registered_indicators() -> dict[str, type]:
    """
    Return all registered indicator classes.

    Returns:
        Dictionary mapping indicator class names to their class objects.
    """
    from onesecondtrader.indicators.base import _indicator_registry

    return dict(_indicator_registry)

discover_indicators(directory='indicators')

Import all Python files from a directory to register indicators.

Any class inheriting from IndicatorBase in the imported files will be automatically registered via init_subclass.

Parameters:

Name Type Description Default
directory str | Path

Path to the directory containing indicator files. Defaults to "indicators" relative to the current working directory.

 'indicators'

Returns:

Type Description
list[str]

List of successfully imported module names.
Source code in src/onesecondtrader/dashboard/indicators_util.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
def discover_indicators(directory: str | Path = "indicators") -> list[str]:
    """
    Import all Python files from a directory to register indicators.

    Any class inheriting from IndicatorBase in the imported files will be
    automatically registered via __init_subclass__.

    Parameters:
        directory:
            Path to the directory containing indicator files.
            Defaults to "indicators" relative to the current working directory.

    Returns:
        List of successfully imported module names.
    """
    import sys
    import types

    path = Path(directory)
    if not path.is_dir():
        return []

    if "indicators" not in sys.modules:
        sys.modules["indicators"] = types.ModuleType("indicators")

    imported = []
    for file in path.glob("*.py"):
        if file.name.startswith("_"):
            continue

        module_name = f"indicators.{file.stem}"
        spec = importlib.util.spec_from_file_location(module_name, file)
        if spec is None or spec.loader is None:
            continue

        module = importlib.util.module_from_spec(spec)
        sys.modules[module_name] = module
        try:
            spec.loader.exec_module(module)
            imported.append(file.stem)
        except Exception:
            del sys.modules[module_name]

    return imported