nautilus_core/python/casing.rs
1// -------------------------------------------------------------------------------------------------
2// Copyright (C) 2015-2025 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//! String-case conversion helpers (`CamelCase` ⇄ `snake_case`).
17
18use heck::ToSnakeCase;
19use pyo3::prelude::*;
20use pyo3_stub_gen::derive::gen_stub_pyfunction;
21
22/// Convert the given string from any common case (PascalCase, camelCase, kebab-case, etc.)
23/// to *lower* `snake_case`.
24///
25/// This function uses the `heck` Rust crate under the hood.
26///
27/// Parameters
28/// ----------
29/// input : str
30/// The input string to convert.
31///
32/// Returns
33/// -------
34/// str
35#[must_use]
36#[gen_stub_pyfunction(module = "nautilus_trader.core")]
37#[pyfunction(name = "convert_to_snake_case")]
38pub fn py_convert_to_snake_case(input: &str) -> String {
39 input.to_snake_case()
40}