nautilus_common/python/
logging.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
16use ahash::AHashMap;
17use log::LevelFilter;
18use nautilus_core::{UUID4, python::to_pyvalue_err};
19use nautilus_model::identifiers::TraderId;
20use pyo3::prelude::*;
21use ustr::Ustr;
22
23use crate::{
24    enums::{LogColor, LogLevel},
25    logging::{
26        self, headers,
27        logger::{self, LogGuard, LoggerConfig},
28        logging_clock_set_realtime_mode, logging_clock_set_static_mode,
29        logging_clock_set_static_time, logging_set_bypass, map_log_level_to_filter,
30        parse_level_filter_str,
31        writer::FileWriterConfig,
32    },
33};
34
35#[pymethods]
36impl LoggerConfig {
37    /// Creates a [`LoggerConfig`] from a spec string.
38    ///
39    /// # Errors
40    ///
41    /// Returns a Python exception if the spec string is invalid.
42    #[staticmethod]
43    #[pyo3(name = "from_spec")]
44    pub fn py_from_spec(spec: String) -> PyResult<Self> {
45        Self::from_spec(&spec).map_err(to_pyvalue_err)
46    }
47}
48
49#[pymethods]
50impl FileWriterConfig {
51    #[new]
52    #[pyo3(signature = (directory=None, file_name=None, file_format=None, file_rotate=None))]
53    #[must_use]
54    pub fn py_new(
55        directory: Option<String>,
56        file_name: Option<String>,
57        file_format: Option<String>,
58        file_rotate: Option<(u64, u32)>,
59    ) -> Self {
60        Self::new(directory, file_name, file_format, file_rotate)
61    }
62}
63
64/// Initialize logging.
65///
66/// Logging should be used for Python and sync Rust logic which is most of
67/// the components in the [nautilus_trader](https://pypi.org/project/nautilus_trader) package.
68/// Logging can be configured to filter components and write up to a specific level only
69/// by passing a configuration using the `NAUTILUS_LOG` environment variable.
70///
71/// # Safety
72///
73/// Should only be called once during an applications run, ideally at the
74/// beginning of the run.
75/// Initializes logging via Python interface.
76///
77/// # Errors
78///
79/// Returns a Python exception if logger initialization fails.
80#[pyfunction]
81#[pyo3(name = "init_logging")]
82#[allow(clippy::too_many_arguments)]
83#[pyo3(signature = (trader_id, instance_id, level_stdout, level_file=None, component_levels=None, directory=None, file_name=None, file_format=None, file_rotate=None, is_colored=None, is_bypassed=None, print_config=None, log_components_only=None))]
84pub fn py_init_logging(
85    trader_id: TraderId,
86    instance_id: UUID4,
87    level_stdout: LogLevel,
88    level_file: Option<LogLevel>,
89    component_levels: Option<std::collections::HashMap<String, String>>,
90    directory: Option<String>,
91    file_name: Option<String>,
92    file_format: Option<String>,
93    file_rotate: Option<(u64, u32)>,
94    is_colored: Option<bool>,
95    is_bypassed: Option<bool>,
96    print_config: Option<bool>,
97    log_components_only: Option<bool>,
98) -> PyResult<LogGuard> {
99    let level_file = level_file.map_or(LevelFilter::Off, map_log_level_to_filter);
100
101    let component_levels = parse_component_levels(component_levels).map_err(to_pyvalue_err)?;
102
103    let config = LoggerConfig::new(
104        map_log_level_to_filter(level_stdout),
105        level_file,
106        component_levels,
107        AHashMap::new(), // module_level - not exposed to Python
108        log_components_only.unwrap_or(false),
109        is_colored.unwrap_or(true),
110        print_config.unwrap_or(false),
111    );
112
113    let file_config = FileWriterConfig::new(directory, file_name, file_format, file_rotate);
114
115    if is_bypassed.unwrap_or(false) {
116        logging_set_bypass();
117    }
118
119    logging::init_logging(trader_id, instance_id, config, file_config).map_err(to_pyvalue_err)
120}
121
122#[pyfunction()]
123#[pyo3(name = "logger_flush")]
124pub fn py_logger_flush() {
125    log::logger().flush();
126}
127
128fn parse_component_levels(
129    original_map: Option<std::collections::HashMap<String, String>>,
130) -> anyhow::Result<AHashMap<Ustr, LevelFilter>> {
131    match original_map {
132        Some(map) => {
133            let mut new_map = AHashMap::new();
134            for (key, value) in map {
135                let ustr_key = Ustr::from(&key);
136                let level = parse_level_filter_str(&value)?;
137                new_map.insert(ustr_key, level);
138            }
139            Ok(new_map)
140        }
141        None => Ok(AHashMap::new()),
142    }
143}
144
145/// Create a new log event.
146#[pyfunction]
147#[pyo3(name = "logger_log")]
148pub fn py_logger_log(level: LogLevel, color: LogColor, component: &str, message: &str) {
149    logger::log(level, color, Ustr::from(component), message);
150}
151
152/// Logs the standard Nautilus system header.
153#[pyfunction]
154#[pyo3(name = "log_header")]
155pub fn py_log_header(trader_id: TraderId, machine_id: &str, instance_id: UUID4, component: &str) {
156    headers::log_header(trader_id, machine_id, instance_id, Ustr::from(component));
157}
158
159/// Logs system information.
160#[pyfunction]
161#[pyo3(name = "log_sysinfo")]
162pub fn py_log_sysinfo(component: &str) {
163    headers::log_sysinfo(Ustr::from(component));
164}
165
166#[pyfunction]
167#[pyo3(name = "logging_clock_set_static_mode")]
168pub fn py_logging_clock_set_static_mode() {
169    logging_clock_set_static_mode();
170}
171
172#[pyfunction]
173#[pyo3(name = "logging_clock_set_realtime_mode")]
174pub fn py_logging_clock_set_realtime_mode() {
175    logging_clock_set_realtime_mode();
176}
177
178#[pyfunction]
179#[pyo3(name = "logging_clock_set_static_time")]
180pub fn py_logging_clock_set_static_time(time_ns: u64) {
181    logging_clock_set_static_time(time_ns);
182}
183
184/// A thin wrapper around the global Rust logger which exposes ergonomic
185/// logging helpers for Python code.
186///
187/// It mirrors the familiar Python `logging` interface while forwarding
188/// all records through the Nautilus logging infrastructure so that log levels
189/// and formatting remain consistent across Rust and Python.
190#[pyclass(
191    module = "nautilus_trader.core.nautilus_pyo3.common",
192    name = "Logger",
193    unsendable
194)]
195#[derive(Debug, Clone)]
196pub struct PyLogger {
197    name: Ustr,
198}
199
200impl PyLogger {
201    pub fn new(name: &str) -> Self {
202        Self {
203            name: Ustr::from(name),
204        }
205    }
206}
207
208#[pymethods]
209impl PyLogger {
210    /// Create a new `Logger` instance.
211    #[new]
212    #[pyo3(signature = (name="Python"))]
213    fn py_new(name: &str) -> Self {
214        Self::new(name)
215    }
216
217    /// The component identifier carried by this logger.
218    #[getter]
219    fn name(&self) -> &str {
220        &self.name
221    }
222
223    /// Emit a TRACE level record.
224    #[pyo3(name = "trace")]
225    fn py_trace(&self, message: &str, color: Option<LogColor>) {
226        self._log(LogLevel::Trace, color, message);
227    }
228
229    /// Emit a DEBUG level record.
230    #[pyo3(name = "debug")]
231    fn py_debug(&self, message: &str, color: Option<LogColor>) {
232        self._log(LogLevel::Debug, color, message);
233    }
234
235    /// Emit an INFO level record.
236    #[pyo3(name = "info")]
237    fn py_info(&self, message: &str, color: Option<LogColor>) {
238        self._log(LogLevel::Info, color, message);
239    }
240
241    /// Emit a WARNING level record.
242    #[pyo3(name = "warning")]
243    fn py_warning(&self, message: &str, color: Option<LogColor>) {
244        self._log(LogLevel::Warning, color, message);
245    }
246
247    /// Emit an ERROR level record.
248    #[pyo3(name = "error")]
249    fn py_error(&self, message: &str, color: Option<LogColor>) {
250        self._log(LogLevel::Error, color, message);
251    }
252
253    /// Emit an ERROR level record with the active Python exception info.
254    #[pyo3(name = "exception")]
255    #[pyo3(signature = (message="", color=None))]
256    fn py_exception(&self, py: Python, message: &str, color: Option<LogColor>) {
257        let mut full_msg = message.to_owned();
258
259        if pyo3::PyErr::occurred(py) {
260            let err = PyErr::fetch(py);
261            let err_str = err.to_string();
262            if full_msg.is_empty() {
263                full_msg = err_str;
264            } else {
265                full_msg = format!("{full_msg}: {err_str}");
266            }
267        }
268
269        self._log(LogLevel::Error, color, &full_msg);
270    }
271
272    /// Flush buffered log records.
273    #[pyo3(name = "flush")]
274    fn py_flush(&self) {
275        log::logger().flush();
276    }
277
278    fn _log(&self, level: LogLevel, color: Option<LogColor>, message: &str) {
279        let color = color.unwrap_or(LogColor::Normal);
280        logger::log(level, color, self.name, message);
281    }
282}
nautilus_common/python/logging.rs

nautilus_common/python/
logging.rs
