powerliners 0.2.14

1:1 Rust port of powerline/powerline. The ultimate statusline/prompt utility
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

// vim:fileencoding=utf-8:noet
//! Port of `powerline/segments/__init__.py`.
//!
//! Exports the `Segment` base class + `with_docstring` decorator used
//! by class-based segments (`segments/common/vcs.py`,
//! `segments/common/players.py`, etc.). Function-based segments don't
//! inherit from `Segment` — they're plain `def`s decorated with
//! `@requires_segment_info` / `@requires_filesystem_watcher`.

// from __future__ import (unicode_literals, division, absolute_import, print_function)  // py:2
// import sys                                       // py:4
// from pkgutil import extend_path                  // py:6
// from types import MethodType                     // py:7

// py:10  __path__ = extend_path(__path__, __name__)
// (Namespace-package mechanism — handled statically in Rust via
// the `pub mod` declarations at the bottom of this file.)

pub mod common;
pub mod i3wm;
pub mod ipython;
pub mod pdb;
pub mod shell;
pub mod tmux;
pub mod vim;

/// Port of `class Segment` from `powerline/segments/__init__.py:13`.
///
/// Base class for any segment that is not a function.
///
/// Required for `powerline.lint.inspect` to work properly: it defines
/// methods for omitting existing or adding new arguments.
///
/// The Python implementation has three methods:
/// - `argspecobjs()` — yields `('__call__', self.__call__)`
/// - `omitted_args(name, method)` — list args to drop from inspection
/// - `additional_args()` (static) — extra args to inject
///
/// All three are introspection helpers used by the linter to figure
/// out what arguments a class-based segment accepts. powerliners's
/// linter is unported (Phase 5), so the Rust port carries the trait
/// shape with default no-op implementations; class-based segments
/// override as needed.
pub trait Segment {
    // py:13  class Segment(object):
    // py:14-24  docstring
    // py:25  if sys.version_info < (3, 4):
    // py:26  def argspecobjs(self):
    // py:27  yield '__call__', self.__call__
    // py:28  else:
    // py:29  def argspecobjs(self):
    // py:30  yield '__call__', self

    /// Port of `Segment.omitted_args()` from
    /// `powerline/segments/__init__.py:40`.
    ///
    /// Returns a tuple with indexes of omitted arguments.
    fn omitted_args(&self, _name: &str) -> Vec<usize> {
        // py:39  def omitted_args(self, name, method):
        // py:40-48  docstring
        // py:49  if isinstance(self.__call__, MethodType):
        // py:50  return (0,)
        // py:51  else:
        // py:52  return ()
        Vec::new()
    }

    /// Port of `Segment.additional_args()` from
    /// `powerline/segments/__init__.py:53`.
    ///
    /// Returns a list of `(additional argument name[, default value])` tuples.
    fn additional_args(&self) -> Vec<(String, Option<serde_json::Value>)> {
        // py:54  @staticmethod
        // py:55  def additional_args():
        // py:56-57  docstring
        // py:58  return ()
        Vec::new()
    }
}

/// Port of `with_docstring()` from `powerline/segments/__init__.py:60`.
///
/// Python: `instance.__doc__ = doc; return instance`
///
/// Used by `segments/common/env.py` etc. to replace the docstring of a
/// class-based segment instance (since the class docstring would
/// otherwise apply to every instance). Rust has no runtime
/// `__doc__` attribute; doc-strings are baked into the binary at
/// compile time. The Rust port is therefore an identity passthrough
/// preserved for upstream call-site shape.
pub fn with_docstring<T>(instance: T, _doc: &str) -> T {
    // py:61  instance.__doc__ = doc
    // py:62  return instance
    instance
}

/// Port of `Segment.argspecobjs()` from
/// `powerline/segments/__init__.py:25-30`.
///
/// Python defines it twice (Py < 3.4 / Py 3.4+). Both yield a
/// single `('__call__', target)` pair. Rust port returns the
/// (name, identifier) tuple list shape upstream's `getargspec`
/// dispatch expects.
pub fn argspecobjs() -> Vec<(&'static str, &'static str)> {
    // py:25-27  (Py < 3.4)  yield '__call__', self.__call__
    // py:28-30  (Py 3.4+)   yield '__call__', self
    vec![("__call__", "__call__")]
}

#[cfg(test)]
mod tests {
    use super::*;

    /// Default `Segment` impl returns empty omitted_args + additional_args.
    #[test]
    fn segment_defaults_are_empty() {
        struct DummySegment;
        impl Segment for DummySegment {}

        let s = DummySegment;
        assert!(s.omitted_args("__call__").is_empty());
        assert!(s.additional_args().is_empty());
    }

    /// `with_docstring` is an identity passthrough.
    #[test]
    fn with_docstring_passes_through() {
        let x = 42;
        let y = with_docstring(x, "any docstring");
        assert_eq!(x, y);
    }
}