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 # nn [options...] [filepaths/URIs...]
  27 #
  28 # Nice Numbers restyles all runs of 4+ digits by alternating ANSI-styles
  29 # every 3-digit group, so long numbers become easier to read at a glance.
  30 #
  31 # All (optional) leading options start with either single or double-dash,
  32 # and most of them change the style/color used. Some of the options are,
  33 # shown in their single-dash form:
  34 #
  35 #     -h          show this help message
  36 #     -help       show this help message
  37 #
  38 #     -b          use a blue color
  39 #     -blue       use a blue color
  40 #     -bold       bold-style digits
  41 #     -g          use a green color
  42 #     -gray       use a gray color (default)
  43 #     -green      use a green color
  44 #     -hi         use a highlighting/inverse style
  45 #     -m          use a magenta color
  46 #     -magenta    use a magenta color
  47 #     -o          use an orange color
  48 #     -orange     use an orange color
  49 #     -r          use a red color
  50 #     -red        use a red color
  51 #     -u          underline digits
  52 #     -underline  underline digits
  53 
  54 
  55 # Note: string slicing is a major source of inefficiencies in this script,
  56 # making it viable only for small inputs; it's not clear what the stdlib
  57 # offers to loop over sub-strings without copying data, which is really
  58 # needed in this case.
  59 #
  60 # In the end the code has become much uglier by using explicit index-pairs,
  61 # which are used/updated all over to avoid copying sub-strings. Standard
  62 # output seems already line-buffered by default, which means explicit
  63 # output-buffering is unlikely to bring any noticeable speed-ups.
  64 
  65 
  66 from io import TextIOWrapper
  67 from sys import argv, exit, stderr, stdin, stdout
  68 from urllib.request import urlopen
  69 
  70 
  71 # info is the help message shown when asked to
  72 info = '''
  73 nn [options...] [filepaths/URIs...]
  74 
  75 Nice Numbers restyles all runs of 4+ digits by alternating ANSI-styles
  76 every 3-digit group, so long numbers become easier to read at a glance.
  77 
  78 All (optional) leading options start with either single or double-dash,
  79 and most of them change the style/color used. Some of the options are,
  80 shown in their single-dash form:
  81 
  82     -h          show this help message
  83     -help       show this help message
  84 
  85     -b          use a blue color
  86     -blue       use a blue color
  87     -bold       bold-style digits
  88     -g          use a green color
  89     -gray       use a gray color (default)
  90     -green      use a green color
  91     -hi         use a highlighting/inverse style
  92     -m          use a magenta color
  93     -magenta    use a magenta color
  94     -o          use an orange color
  95     -orange     use an orange color
  96     -r          use a red color
  97     -red        use a red color
  98     -u          underline digits
  99     -underline  underline digits
 100 '''.strip()
 101 
 102 # handle standard help cmd-line options, quitting right away in that case
 103 if len(argv) == 2 and argv[1] in ('-h', '--h', '-help', '--help'):
 104     print(info, file=stderr)
 105     exit(0)
 106 
 107 # names_aliases normalizes lookup keys for table names2styles
 108 names_aliases = {
 109     'b': 'blue',
 110     'g': 'green',
 111     'm': 'magenta',
 112     'o': 'orange',
 113     'r': 'red',
 114     'u': 'underline',
 115 
 116     'hi': 'inverse',
 117     'inv': 'inverse',
 118     'mag': 'magenta',
 119 
 120     'flip': 'inverse',
 121     'swap': 'inverse',
 122 
 123     'reset': 'plain',
 124     'highlight': 'inverse',
 125     'hilite': 'inverse',
 126     'invert': 'inverse',
 127     'inverted': 'inverse',
 128     'swapped': 'inverse',
 129 }
 130 
 131 # names2styles matches color/style names to their ANSI-style strings
 132 names2styles = {
 133     'blue': '\x1b[38;5;26m',
 134     'bold': '\x1b[1m',
 135     'gray': '\x1b[38;5;249m',
 136     'green': '\x1b[38;5;29m',
 137     'inverse': '\x1b[7m',
 138     'magenta': '\x1b[38;5;99m',
 139     'orange': '\x1b[38;5;166m',
 140     'plain': '\x1b[0m',
 141     'red': '\x1b[31m',
 142     'underline': '\x1b[4m',
 143 }
 144 
 145 
 146 def restyle_line(w, line: str, style: str) -> None:
 147     '''Alternate styles for runs of digits in the string given'''
 148 
 149     start = 0
 150     end = len(line)
 151 
 152     if end > 1 and line[end - 2] == '\r' and line[end - 1] == '\n':
 153         end -= 2
 154     elif end > 0 and line[end - 1] == '\n':
 155         end -= 1
 156 
 157     while True:
 158         # see if line is over
 159         if start >= end:
 160             w.write('\n')
 161             return
 162 
 163         # find where the next run of digits starts; a negative index means
 164         # none were found
 165         i = -1
 166         for j in range(start, end):
 167             if line[j].isdigit():
 168                 i = j
 169                 break
 170 
 171         # check if rest of the line has no more digits
 172         if i < 0:
 173             w.write(line[start:end])
 174             w.write('\n')
 175             return
 176 
 177         # emit line up to right before the next run of digits starts
 178         w.write(line[start:i])
 179         start = i
 180 
 181         # find where/if the current run of digits ends; a negative index
 182         # means the run reaches the end of the line
 183         i = -1
 184         for j in range(start, end):
 185             if not line[j].isdigit():
 186                 i = j
 187                 break
 188 
 189         # check if rest of the line has only digits in it
 190         if i < 0:
 191             restyle_digits(w, line, start, end, style)
 192             w.write('\n')
 193             return
 194 
 195         # emit digits using alternate styling, and advance past them
 196         restyle_digits(w, line, start, i, style)
 197         start = i
 198 
 199 
 200 def restyle_digits(w, digits: str, start: int, end: int, style: str) -> None:
 201     '''Alternate styles on 3-item chunks from the string given'''
 202     diff = end - start
 203 
 204     # it's overall quicker to just emit short-enough digit-runs verbatim
 205     if diff < 4:
 206         w.write(digits[start:end])
 207         return
 208 
 209     # emit leading chunk of digits, which is the only one which
 210     # can have fewer than 3 items
 211     lead = diff % 3
 212     w.write(digits[start:start + lead])
 213 
 214     # the rest of the sub-string now has a multiple of 3 items left
 215     start += lead
 216 
 217     # start by styling the next digit-group only if there was a
 218     # non-empty leading group at the start of the full digit-run
 219     use_style = lead > 0
 220 
 221     # alternate styles until the string is over
 222     while start < end:
 223         # the digits left are always a multiple of 3
 224         stop = start + 3
 225 
 226         if use_style:
 227             w.write(style)
 228             w.write(digits[start:stop])
 229             w.write('\x1b[0m')
 230         else:
 231             w.write(digits[start:stop])
 232 
 233         # switch style and advance to the next 3-digit chunk
 234         use_style = not use_style
 235         start = stop
 236 
 237 
 238 def seems_url(s: str) -> bool:
 239     for prot in ('https://', 'http://', 'file://', 'ftp://', 'data:'):
 240         if s.startswith(prot):
 241             return True
 242     return False
 243 
 244 
 245 def handle_lines(w, src, style: str) -> None:
 246     for line in src:
 247         restyle_line(w, line, style)
 248 
 249 
 250 args = argv[1:]
 251 # default (alternate) style is a light-gray color
 252 style = names2styles['gray']
 253 
 254 # handle leading style/color option, if present
 255 if len(args) > 0 and args[0].startswith('-'):
 256     s = args[0].lstrip('-')
 257     if s in names_aliases:
 258         s = names_aliases[s]
 259     if s in names2styles:
 260         style = names2styles[s]
 261         # skip leading arg, since it's clearly not a filepath
 262         args = args[1:]
 263 
 264 try:
 265     if args.count('-') > 1:
 266         msg = 'reading from `-` (standard input) more than once not allowed'
 267         raise ValueError(msg)
 268 
 269     stdout.reconfigure(newline='\n', encoding='utf-8')
 270 
 271     # handle all named inputs given
 272     for path in args:
 273         if path == '-':
 274             handle_lines(stdout, stdin, style)
 275             continue
 276 
 277         if seems_url(path):
 278             with urlopen(path) as inp:
 279                 with TextIOWrapper(inp, encoding='utf-8') as txt:
 280                     handle_lines(stdout, txt, style)
 281             continue
 282 
 283         with open(path) as inp:
 284             handle_lines(stdout, inp, style)
 285 
 286     # when no filenames are given, handle lines from stdin
 287     if len(args) == 0:
 288         handle_lines(stdout, stdin, style)
 289 except (BrokenPipeError, KeyboardInterrupt):
 290     # quit quietly, instead of showing a confusing error message
 291     stderr.flush()
 292     stderr.close()
 293 except Exception as e:
 294     print(f'\x1b[31m{e}\x1b[0m', file=stderr)
 295     exit(1)