Skip to content

talib ¤

cdl_3blackcrows ¤

cdl_3blackcrows(
    dataframe: DataFrame,
    name: str | None = None,
    prefix: str = "cdl_",
    inplace: bool = False,
    plot: bool | list[str] = False,
    plot_type: Literal[
        "candlestick", "mark"
    ] = "candlestick",
    plot_kwargs: dict | None = None,
    **kwargs
) -> Series | DataFrame

summary

Parameters:

  • dataframe (DataFrame) –

    description

  • name (str | None, default: None ) –

    description. Defaults to None.

  • prefix (str, default: 'cdl_' ) –

    description. Defaults to "cdl_".

  • inplace (bool, default: False ) –

    description. Defaults to False.

Returns:

  • Series | DataFrame –

    pd.Series | pd.DataFrame: description

Source code in lettrade/indicator/candlestick/talib.py 
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
def cdl_3blackcrows(
    dataframe: pd.DataFrame,
    name: str | None = None,
    prefix: str = "cdl_",
    inplace: bool = False,
    plot: bool | list[str] = False,
    plot_type: Literal["candlestick", "mark"] = "candlestick",
    plot_kwargs: dict | None = None,
    **kwargs,
) -> pd.Series | pd.DataFrame:
    """_summary_

    Args:
        dataframe (pd.DataFrame): _description_
        name (str | None, optional): _description_. Defaults to None.
        prefix (str, optional): _description_. Defaults to "cdl_".
        inplace (bool, optional): _description_. Defaults to False.

    Returns:
        pd.Series | pd.DataFrame: _description_
    """
    return cdl_pattern(
        dataframe=dataframe,
        pattern="3blackcrows",
        name=name,
        prefix=prefix,
        inplace=inplace,
        plot=plot,
        plot_type=plot_type,
        plot_kwargs=plot_kwargs,
        **kwargs,
    )

cdl_3inside ¤

cdl_3inside(
    dataframe: DataFrame,
    name: str | None = None,
    prefix: str = "cdl_",
    inplace: bool = False,
    plot: bool | list[str] = False,
    plot_type: Literal[
        "candlestick", "mark"
    ] = "candlestick",
    plot_kwargs: dict | None = None,
    **kwargs
) -> Series | DataFrame

summary

Parameters:

  • dataframe (DataFrame) –

    description

  • name (str | None, default: None ) –

    description. Defaults to None.

  • prefix (str, default: 'cdl_' ) –

    description. Defaults to "cdl_".

  • inplace (bool, default: False ) –

    description. Defaults to False.

Returns:

  • Series | DataFrame –

    pd.Series | pd.DataFrame: description

Source code in lettrade/indicator/candlestick/talib.py 
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
def cdl_3inside(
    dataframe: pd.DataFrame,
    name: str | None = None,
    prefix: str = "cdl_",
    inplace: bool = False,
    plot: bool | list[str] = False,
    plot_type: Literal["candlestick", "mark"] = "candlestick",
    plot_kwargs: dict | None = None,
    **kwargs,
) -> pd.Series | pd.DataFrame:
    """_summary_

    Args:
        dataframe (pd.DataFrame): _description_
        name (str | None, optional): _description_. Defaults to None.
        prefix (str, optional): _description_. Defaults to "cdl_".
        inplace (bool, optional): _description_. Defaults to False.

    Returns:
        pd.Series | pd.DataFrame: _description_
    """
    return cdl_pattern(
        dataframe=dataframe,
        pattern="3inside",
        name=name,
        prefix=prefix,
        inplace=inplace,
        plot=plot,
        plot_type=plot_type,
        plot_kwargs=plot_kwargs,
        **kwargs,
    )

cdl_3whitesoldiers ¤

cdl_3whitesoldiers(
    dataframe: DataFrame,
    name: str | None = None,
    prefix: str = "cdl_",
    inplace: bool = False,
    plot: bool | list[str] = False,
    plot_type: Literal[
        "candlestick", "mark"
    ] = "candlestick",
    plot_kwargs: dict | None = None,
    **kwargs
) -> Series | DataFrame

summary

Parameters:

  • dataframe (DataFrame) –

    description

  • name (str | None, default: None ) –

    description. Defaults to None.

  • prefix (str, default: 'cdl_' ) –

    description. Defaults to "cdl_".

  • inplace (bool, default: False ) –

    description. Defaults to False.

Returns:

  • Series | DataFrame –

    pd.Series | pd.DataFrame: description

Source code in lettrade/indicator/candlestick/talib.py 
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
def cdl_3whitesoldiers(
    dataframe: pd.DataFrame,
    name: str | None = None,
    prefix: str = "cdl_",
    inplace: bool = False,
    plot: bool | list[str] = False,
    plot_type: Literal["candlestick", "mark"] = "candlestick",
    plot_kwargs: dict | None = None,
    **kwargs,
) -> pd.Series | pd.DataFrame:
    """_summary_

    Args:
        dataframe (pd.DataFrame): _description_
        name (str | None, optional): _description_. Defaults to None.
        prefix (str, optional): _description_. Defaults to "cdl_".
        inplace (bool, optional): _description_. Defaults to False.

    Returns:
        pd.Series | pd.DataFrame: _description_
    """
    return cdl_pattern(
        dataframe=dataframe,
        pattern="3whitesoldiers",
        name=name,
        prefix=prefix,
        inplace=inplace,
        plot=plot,
        plot_type=plot_type,
        plot_kwargs=plot_kwargs,
        **kwargs,
    )

cdl_doji ¤

cdl_doji(
    dataframe: DataFrame,
    name: str | None = None,
    prefix: str = "cdl_",
    inplace: bool = False,
    plot: bool | list[str] = False,
    plot_type: Literal[
        "candlestick", "mark"
    ] = "candlestick",
    plot_kwargs: dict | None = None,
    **kwargs
) -> Series | DataFrame

summary

Parameters:

  • dataframe (DataFrame) –

    description

  • name (str | None, default: None ) –

    description. Defaults to None.

  • prefix (str, default: 'cdl_' ) –

    description. Defaults to "cdl_".

  • inplace (bool, default: False ) –

    description. Defaults to False.

Returns:

  • Series | DataFrame –

    pd.Series | pd.DataFrame: description

Source code in lettrade/indicator/candlestick/talib.py 
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
def cdl_doji(
    dataframe: pd.DataFrame,
    name: str | None = None,
    prefix: str = "cdl_",
    inplace: bool = False,
    plot: bool | list[str] = False,
    plot_type: Literal["candlestick", "mark"] = "candlestick",
    plot_kwargs: dict | None = None,
    **kwargs,
) -> pd.Series | pd.DataFrame:
    """_summary_

    Args:
        dataframe (pd.DataFrame): _description_
        name (str | None, optional): _description_. Defaults to None.
        prefix (str, optional): _description_. Defaults to "cdl_".
        inplace (bool, optional): _description_. Defaults to False.

    Returns:
        pd.Series | pd.DataFrame: _description_
    """
    return cdl_pattern(
        dataframe=dataframe,
        pattern="doji",
        name=name,
        prefix=prefix,
        inplace=inplace,
        plot=plot,
        plot_type=plot_type,
        plot_kwargs=plot_kwargs,
        **kwargs,
    )

cdl_engulfing ¤

cdl_engulfing(
    dataframe: DataFrame,
    name: str | None = None,
    prefix: str = "cdl_",
    inplace: bool = False,
    plot: bool | list[str] = False,
    plot_type: Literal[
        "candlestick", "mark"
    ] = "candlestick",
    plot_kwargs: dict | None = None,
    **kwargs
) -> Series | DataFrame

summary

Parameters:

  • dataframe (DataFrame) –

    description

  • name (str | None, default: None ) –

    description. Defaults to None.

  • prefix (str, default: 'cdl_' ) –

    description. Defaults to "cdl_".

  • inplace (bool, default: False ) –

    description. Defaults to False.

Returns:

  • Series | DataFrame –

    pd.Series | pd.DataFrame: description

Source code in lettrade/indicator/candlestick/talib.py 
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
def cdl_engulfing(
    dataframe: pd.DataFrame,
    name: str | None = None,
    prefix: str = "cdl_",
    inplace: bool = False,
    plot: bool | list[str] = False,
    plot_type: Literal["candlestick", "mark"] = "candlestick",
    plot_kwargs: dict | None = None,
    **kwargs,
) -> pd.Series | pd.DataFrame:
    """_summary_

    Args:
        dataframe (pd.DataFrame): _description_
        name (str | None, optional): _description_. Defaults to None.
        prefix (str, optional): _description_. Defaults to "cdl_".
        inplace (bool, optional): _description_. Defaults to False.

    Returns:
        pd.Series | pd.DataFrame: _description_
    """
    return cdl_pattern(
        dataframe=dataframe,
        pattern="engulfing",
        name=name,
        prefix=prefix,
        inplace=inplace,
        plot=plot,
        plot_type=plot_type,
        plot_kwargs=plot_kwargs,
        **kwargs,
    )

cdl_eveningstar ¤

cdl_eveningstar(
    dataframe: DataFrame,
    name: str | None = None,
    prefix: str = "cdl_",
    inplace: bool = False,
    plot: bool | list[str] = False,
    plot_type: Literal[
        "candlestick", "mark"
    ] = "candlestick",
    plot_kwargs: dict | None = None,
    **kwargs
) -> Series | DataFrame

summary

Parameters:

  • dataframe (DataFrame) –

    description

  • name (str | None, default: None ) –

    description. Defaults to None.

  • prefix (str, default: 'cdl_' ) –

    description. Defaults to "cdl_".

  • inplace (bool, default: False ) –

    description. Defaults to False.

Returns:

  • Series | DataFrame –

    pd.Series | pd.DataFrame: description

Source code in lettrade/indicator/candlestick/talib.py 
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
def cdl_eveningstar(
    dataframe: pd.DataFrame,
    name: str | None = None,
    prefix: str = "cdl_",
    inplace: bool = False,
    plot: bool | list[str] = False,
    plot_type: Literal["candlestick", "mark"] = "candlestick",
    plot_kwargs: dict | None = None,
    **kwargs,
) -> pd.Series | pd.DataFrame:
    """_summary_

    Args:
        dataframe (pd.DataFrame): _description_
        name (str | None, optional): _description_. Defaults to None.
        prefix (str, optional): _description_. Defaults to "cdl_".
        inplace (bool, optional): _description_. Defaults to False.

    Returns:
        pd.Series | pd.DataFrame: _description_
    """
    return cdl_pattern(
        dataframe=dataframe,
        pattern="eveningstar",
        name=name,
        prefix=prefix,
        inplace=inplace,
        plot=plot,
        plot_type=plot_type,
        plot_kwargs=plot_kwargs,
        **kwargs,
    )

cdl_morningstar ¤

cdl_morningstar(
    dataframe: DataFrame,
    name: str | None = None,
    prefix: str = "cdl_",
    inplace: bool = False,
    plot: bool | list[str] = False,
    plot_type: Literal[
        "candlestick", "mark"
    ] = "candlestick",
    plot_kwargs: dict | None = None,
    **kwargs
) -> Series | DataFrame

summary

Parameters:

  • dataframe (DataFrame) –

    description

  • name (str | None, default: None ) –

    description. Defaults to None.

  • prefix (str, default: 'cdl_' ) –

    description. Defaults to "cdl_".

  • inplace (bool, default: False ) –

    description. Defaults to False.

Returns:

  • Series | DataFrame –

    pd.Series | pd.DataFrame: description

Source code in lettrade/indicator/candlestick/talib.py 
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
def cdl_morningstar(
    dataframe: pd.DataFrame,
    name: str | None = None,
    prefix: str = "cdl_",
    inplace: bool = False,
    plot: bool | list[str] = False,
    plot_type: Literal["candlestick", "mark"] = "candlestick",
    plot_kwargs: dict | None = None,
    **kwargs,
) -> pd.Series | pd.DataFrame:
    """_summary_

    Args:
        dataframe (pd.DataFrame): _description_
        name (str | None, optional): _description_. Defaults to None.
        prefix (str, optional): _description_. Defaults to "cdl_".
        inplace (bool, optional): _description_. Defaults to False.

    Returns:
        pd.Series | pd.DataFrame: _description_
    """
    return cdl_pattern(
        dataframe=dataframe,
        pattern="morningstar",
        name=name,
        prefix=prefix,
        inplace=inplace,
        plot=plot,
        plot_type=plot_type,
        plot_kwargs=plot_kwargs,
        **kwargs,
    )

cdl_pattern ¤

cdl_pattern(
    dataframe: DataFrame,
    pattern: str,
    name: str | None = None,
    prefix: str = "cdl_",
    inplace: bool = False,
    plot: bool | list[str] = False,
    plot_type: Literal[
        "candlestick", "mark"
    ] = "candlestick",
    plot_kwargs: dict | None = None,
    **kwargs
) -> Series | DataFrame

summary

Parameters:

  • dataframe (DataFrame) –

    pandas.DataFrame with ohlcv

  • pattern (str) –

    TA-Lib candle pattern name. Ex: 3whitesoldiers, 3blackcrows

  • name (str | None, default: None ) –

    description. Defaults to None.

  • prefix (str, default: 'cdl_' ) –

    description. Defaults to "cdl_".

  • inplace (bool, default: False ) –

    description. Defaults to False.

Raises:

Returns:

  • Series | DataFrame –

    pd.Series | pd.DataFrame: description

Source code in lettrade/indicator/candlestick/talib.py 
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
def cdl_pattern(
    dataframe: pd.DataFrame,
    pattern: str,
    name: str | None = None,
    prefix: str = "cdl_",
    inplace: bool = False,
    plot: bool | list[str] = False,
    plot_type: Literal["candlestick", "mark"] = "candlestick",
    plot_kwargs: dict | None = None,
    **kwargs,
) -> pd.Series | pd.DataFrame:
    """_summary_

    Args:
        dataframe (pd.DataFrame): pandas.DataFrame with ohlcv
        pattern (str): TA-Lib candle pattern name. Ex: `3whitesoldiers`, `3blackcrows`
        name (str | None, optional): _description_. Defaults to None.
        prefix (str, optional): _description_. Defaults to "cdl_".
        inplace (bool, optional): _description_. Defaults to False.

    Raises:
        RuntimeError: _description_

    Returns:
        pd.Series | pd.DataFrame: _description_
    """
    if __debug__:
        if not isinstance(dataframe, pd.DataFrame):
            raise RuntimeError(
                f"dataframe type '{type(dataframe)}' "
                "is not instance of pandas.DataFrame"
            )
        if plot and not inplace:
            raise RuntimeError("Cannot plot when inplace=False")

    i = getattr(ta, f"CDL{pattern.upper()}")(dataframe, **kwargs)

    if inplace:
        name = name or f"{prefix}{pattern.lower()}"
        dataframe[name] = i

        # Plot
        if plot:
            _plot_pattern(
                dataframe=dataframe,
                indicator=i,
                name=name,
                plot_type=plot_type,
                plot_kwargs=plot_kwargs,
            )

        return dataframe

    return i