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
16use heck::ToSnakeCase;
17use pyo3::prelude::*;
18
19/// Convert the given string from any common case (PascalCase, camelCase, kebab-case, etc.)
20/// to *lower* snake_case.
21///
22/// This function uses the `heck` Rust crate under the hood.
23///
24/// Parameters
25/// ----------
26/// input : str
27/// The input string to convert.
28///
29/// Returns
30/// -------
31/// str
32#[must_use]
33#[pyfunction(name = "convert_to_snake_case")]
34pub fn py_convert_to_snake_case(input: &str) -> String {
35 input.to_snake_case()
36}