nautilus_core/python/
string.rs

1// -------------------------------------------------------------------------------------------------
2//  Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
3//  https://nautechsystems.io
4//
5//  Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
6//  You may not use this file except in compliance with the License.
7//  You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
8//
9//  Unless required by applicable law or agreed to in writing, software
10//  distributed under the License is distributed on an "AS IS" BASIS,
11//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12//  See the License for the specific language governing permissions and
13//  limitations under the License.
14// -------------------------------------------------------------------------------------------------
15
16#![allow(clippy::doc_markdown, reason = "Python docstrings")]
17
18use pyo3::prelude::*;
19use pyo3_stub_gen::derive::gen_stub_pyfunction;
20
21/// Masks an API key by showing only the first and last 4 characters.
22///
23/// For keys 8 characters or shorter, returns asterisks only.
24///
25/// Parameters
26/// ----------
27/// api_key : str
28///     The API key to mask.
29///
30/// Returns
31/// -------
32/// str
33///
34/// Examples
35/// --------
36/// >>> mask_api_key("abcdefghijklmnop")
37/// 'abcd...mnop'
38/// >>> mask_api_key("short")
39/// '*****'
40///
41#[gen_stub_pyfunction(module = "nautilus_trader.core")]
42#[pyfunction(name = "mask_api_key")]
43#[allow(
44    clippy::needless_pass_by_value,
45    reason = "Python FFI requires owned types"
46)]
47pub fn py_mask_api_key(api_key: String) -> String {
48    crate::string::mask_api_key(&api_key)
49}
nautilus_core/python/string.rs

nautilus_core/python/
string.rs
