File: nn.py 1 #!/usr/bin/python3 2 3 # The MIT License (MIT) 4 # 5 # Copyright © 2024 pacman64 6 # 7 # Permission is hereby granted, free of charge, to any person obtaining a copy 8 # of this software and associated documentation files (the “Software”), to deal 9 # in the Software without restriction, including without limitation the rights 10 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 11 # copies of the Software, and to permit persons to whom the Software is 12 # furnished to do so, subject to the following conditions: 13 # 14 # The above copyright notice and this permission notice shall be included in 15 # all copies or substantial portions of the Software. 16 # 17 # THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 18 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 19 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 20 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 21 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 22 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 23 # SOFTWARE. 24 25 26 # Note: string slicing is a major source of inefficiencies in this script, 27 # making it viable only for small inputs; it's not clear what the stdlib 28 # offers to loop over sub-strings without copying data, which is really 29 # needed in this case. 30 # 31 # In the end the code has become much uglier by using explicit index-pairs, 32 # which are used/updated all over to avoid copying sub-strings. Standard 33 # output is already line-buffered by default, which is makes writing to it 34 # already fairly fast. 35 36 37 from sys import argv, exit, stderr, stdin, stdout 38 39 40 info = ''' 41 nn [option...] [filepaths/URIs...] 42 43 44 Nice Numbers restyles all runs of 4+ digits by alternating ANSI-styles 45 every 3-digit group, so long numbers become easier to read at a glance. 46 47 All (optional) leading options start with either single or double-dash, 48 and most of them change the style/color used. Some of the options are, 49 shown in their single-dash form: 50 51 -h show this help message 52 -help show this help message 53 54 -b use a blue color 55 -blue use a blue color 56 -bold bold-style digits 57 -g use a green color 58 -gray use a gray color (default) 59 -green use a green color 60 -hi use a highlighting/inverse style 61 -highlight use a highlighting/inverse style 62 -hilite use a highlighting/inverse style 63 -inverse use a highlighting/inverse style 64 -m use a magenta color 65 -magenta use a magenta color 66 -o use an orange color 67 -orange use an orange color 68 -p use a purple color 69 -purple use a purple color 70 -r use a red color 71 -red use a red color 72 -u underline digits 73 -underline underline digits 74 ''' 75 76 # handle standard help cmd-line options, quitting right away in that case 77 if len(argv) == 2 and argv[1] in ('-h', '--h', '-help', '--help'): 78 print(info.strip()) 79 exit(0) 80 81 82 # names_aliases normalizes lookup keys for table names2styles 83 names_aliases = { 84 'b': 'blue', 85 'g': 'green', 86 'm': 'magenta', 87 'o': 'orange', 88 'p': 'purple', 89 'r': 'red', 90 'u': 'underline', 91 92 'bb': 'blueback', 93 'bg': 'greenback', 94 'bm': 'magentaback', 95 'bo': 'orangeback', 96 'bp': 'purpleback', 97 'br': 'redback', 98 99 'gb': 'greenback', 100 'mb': 'magentaback', 101 'ob': 'orangeback', 102 'pb': 'purpleback', 103 'rb': 'redback', 104 105 'hi': 'inverse', 106 'inv': 'inverse', 107 'mag': 'magenta', 108 109 'flip': 'inverse', 110 'swap': 'inverse', 111 112 'reset': 'plain', 113 'highlight': 'inverse', 114 'hilite': 'inverse', 115 'invert': 'inverse', 116 'inverted': 'inverse', 117 'swapped': 'inverse', 118 119 'bblue': 'blueback', 120 'bgray': 'grayback', 121 'bgreen': 'greenback', 122 'bmagenta': 'magback', 123 'bmagenta': 'magentaback', 124 'borange': 'orangeback', 125 'bpurple': 'purpleback', 126 'bred': 'redback', 127 128 'bgblue': 'blueback', 129 'bggray': 'grayback', 130 'bggreen': 'greenback', 131 'bgmag': 'magentaback', 132 'bgmagenta': 'magentaback', 133 'bgorange': 'orangeback', 134 'bgpurple': 'purpleback', 135 'bgred': 'redback', 136 137 'bluebg': 'blueback', 138 'graybg': 'grayback', 139 'greenbg': 'greenback', 140 'magbg': 'magentaback', 141 'magentabg': 'magentaback', 142 'orangebg': 'orangeback', 143 'purplebg': 'purpleback', 144 'redbg': 'redback', 145 146 'backblue': 'blueback', 147 'backgray': 'grayback', 148 'backgreen': 'greenback', 149 'backmag': 'magentaback', 150 'backmagenta': 'magentaback', 151 'backorange': 'orangeback', 152 'backpurple': 'purpleback', 153 'backred': 'redback', 154 } 155 156 # names2styles matches color/style names to their ANSI-style strings 157 names2styles = { 158 'blue': '\x1b[38;2;0;95;215m', 159 'bold': '\x1b[1m', 160 'gray': '\x1b[38;2;168;168;168m', 161 'green': '\x1b[38;2;0;135;95m', 162 'inverse': '\x1b[7m', 163 'magenta': '\x1b[38;2;215;0;255m', 164 'orange': '\x1b[38;2;215;95;0m', 165 'plain': '\x1b[0m', 166 'purple': '\x1b[38;2;135;95;255m', 167 'red': '\x1b[38;2;204;0;0m', 168 'underline': '\x1b[4m', 169 170 'blueback': '\x1b[48;2;0;95;215m\x1b[38;2;238;238;238m', 171 'grayback': '\x1b[48;2;168;168;168m\x1b[38;2;238;238;238m', 172 'greenback': '\x1b[48;2;0;135;95m\x1b[38;2;238;238;238m', 173 'magentaback': '\x1b[48;2;215;0;255m\x1b[38;2;238;238;238m', 174 'orangeback': '\x1b[48;2;215;95;0m\x1b[38;2;238;238;238m', 175 'purpleback': '\x1b[48;2;135;95;255m\x1b[38;2;238;238;238m', 176 'redback': '\x1b[48;2;204;0;0m\x1b[38;2;238;238;238m', 177 } 178 179 180 def restyle_line(w, line: str, style: str) -> None: 181 'Alternate styles for runs of digits in the string given.' 182 183 start = 0 184 end = len(line) 185 if end > 1 and line[end - 2] == '\r' and line[end - 1] == '\n': 186 end -= 2 187 elif end > 0 and line[end - 1] == '\n': 188 end -= 1 189 190 while True: 191 # see if line is over 192 if start >= end: 193 w.write('\n') 194 return 195 196 # find where the next run of digits starts; a negative index means 197 # none were found 198 i = -1 199 for j in range(start, end): 200 if line[j].isdigit(): 201 i = j 202 break 203 204 # check if rest of the line has no more digits 205 if i < 0: 206 w.write(line[start:end]) 207 w.write('\n') 208 return 209 210 # some ANSI-style sequences use 4-digit numbers, which are long 211 # enough for this script to mangle 212 is_ansi = i >= 2 and line[i-2] == '\x1b' and line[i-1] == '[' 213 214 # emit line up to right before the next run of digits starts 215 w.write(line[start:i]) 216 start = i 217 218 # find where/if the current run of digits ends; a negative index 219 # means the run reaches the end of the line 220 i = -1 221 for j in range(start, end): 222 if not line[j].isdigit(): 223 i = j 224 break 225 226 # check if rest of the line has only digits in it 227 if i < 0: 228 if not is_ansi: 229 restyle_digits(w, line, start, end, style) 230 else: 231 w.write(line[start:end]) 232 w.write('\n') 233 return 234 235 # emit digits using alternate styling, and advance past them 236 if not is_ansi: 237 restyle_digits(w, line, start, i, style) 238 else: 239 w.write(line[start:i]) 240 start = i 241 242 243 def restyle_digits(w, digits: str, start: int, end: int, style: str) -> None: 244 'Alternate styles on 3-item chunks from the string given.' 245 246 diff = end - start 247 248 # it's overall quicker to just emit short-enough digit-runs verbatim 249 if diff < 4: 250 w.write(digits[start:end]) 251 return 252 253 # emit leading chunk of digits, which is the only one which 254 # can have fewer than 3 items 255 lead = diff % 3 256 w.write(digits[start:start + lead]) 257 258 # the rest of the sub-string now has a multiple of 3 items left 259 start += lead 260 261 # start by styling the next digit-group only if there was a 262 # non-empty leading group at the start of the full digit-run 263 use_style = lead > 0 264 265 # alternate styles until the string is over 266 while start < end: 267 # the digits left are always a multiple of 3 268 stop = start + 3 269 270 if use_style: 271 w.write(style) 272 w.write(digits[start:stop]) 273 w.write('\x1b[0m') 274 else: 275 w.write(digits[start:stop]) 276 277 # switch style and advance to the next 3-digit chunk 278 use_style = not use_style 279 start = stop 280 281 282 def seems_url(s: str) -> bool: 283 protocols = ('https://', 'http://', 'file://', 'ftp://', 'data:') 284 return any(s.startswith(p) for p in protocols) 285 286 287 def handle_lines(w, src, style: str) -> None: 288 for line in src: 289 restyle_line(w, line, style) 290 291 292 args = argv[1:] 293 style = names2styles['gray'] 294 295 # handle leading style/color option, if present 296 if len(args) > 0 and args[0].startswith('-'): 297 s = args[0].lstrip('-') 298 if s in names_aliases: 299 s = names_aliases[s] 300 301 if s in names2styles: 302 style = names2styles[s] 303 # skip leading arg, since it's clearly not a filepath 304 args = args[1:] 305 306 if any(seems_url(e) for e in args): 307 from io import TextIOWrapper 308 from urllib.request import urlopen 309 310 try: 311 if args.count('-') > 1: 312 msg = 'reading from `-` (standard input) more than once not allowed' 313 raise ValueError(msg) 314 315 for path in args: 316 if path == '-': 317 handle_lines(stdout, stdin, style) 318 continue 319 320 if seems_url(path): 321 with urlopen(path) as inp: 322 with TextIOWrapper(inp, encoding='utf-8') as txt: 323 handle_lines(stdout, txt, style) 324 continue 325 326 with open(path, encoding='utf-8') as inp: 327 handle_lines(stdout, inp, style) 328 329 if len(args) == 0: 330 handle_lines(stdout, stdin, style) 331 except BrokenPipeError: 332 # quit quietly, instead of showing a confusing error message 333 stderr.close() 334 exit(0) 335 except KeyboardInterrupt: 336 # quit quietly, instead of showing a confusing error message 337 stderr.close() 338 exit(2) 339 except Exception as e: 340 print(f'\x1b[31m{e}\x1b[0m', file=stderr) 341 exit(1)