xet-runtime 1.5.2

Async runtime, configuration, logging, and utility infrastructure for the Hugging Face Xet client tools.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
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

use std::path::{Path, PathBuf};
use std::time::Duration;

use crate::core::xet_config;
use crate::utils::TemplatedPathBuf;

#[derive(Clone, Debug, PartialEq)]
pub enum LoggingMode {
    Directory(PathBuf),
    File(PathBuf),
    Console,
}

/// The log directory cleanup configuration.  By default, the values
/// are loaded from environment variables.

#[derive(Clone, Debug, PartialEq)]
pub struct LogDirConfig {
    pub min_deletion_age: Duration,
    pub max_retention_age: Duration,
    pub size_limit: u64,
    pub filename_prefix: String,
}

impl Default for LogDirConfig {
    fn default() -> Self {
        // Load the defaults from the environmental config.
        Self {
            min_deletion_age: xet_config().log.dir_min_deletion_age,
            max_retention_age: xet_config().log.dir_max_retention_age,
            size_limit: xet_config().log.dir_max_size.as_u64(),
            filename_prefix: xet_config().log.prefix.to_string(),
        }
    }
}

#[derive(Clone, Debug, PartialEq)]
pub struct LoggingConfig {
    pub logging_mode: LoggingMode,
    pub use_json: bool,
    pub enable_log_dir_cleanup: bool,
    pub version: String,
    pub log_dir_config: LogDirConfig,
}

impl LoggingConfig {
    /// Set up logging to a directory.  Note that this can be overwritten by environmental
    pub fn default_to_directory(version: String, log_directory: impl AsRef<Path>) -> LoggingConfig {
        // Choose the logging mode.
        let logging_mode = {
            if let Some(log_dest) = &xet_config().log.dest {
                if log_dest.as_str().is_empty() {
                    LoggingMode::Console
                } else {
                    let path = TemplatedPathBuf::evaluate(log_dest);

                    if log_dest.ends_with('/')
                        || (cfg!(windows) && log_dest.ends_with('\\'))
                        || (path.exists() && path.is_dir())
                    {
                        LoggingMode::Directory(path)
                    } else {
                        LoggingMode::File(path)
                    }
                }
            } else {
                LoggingMode::Directory(log_directory.as_ref().to_path_buf())
            }
        };

        let use_json = {
            if let Some(format) = &xet_config().log.format {
                format.as_str().to_ascii_lowercase().trim() == "json"
            } else {
                logging_mode != LoggingMode::Console
            }
        };

        let enable_log_dir_cleanup =
            matches!(logging_mode, LoggingMode::Directory(_)) && !xet_config().log.dir_disable_cleanup;

        Self {
            logging_mode,
            use_json,
            enable_log_dir_cleanup,
            version,
            log_dir_config: LogDirConfig::default(),
        }
    }
}