skilleter-thingy 0.0.22__py3-none-any.whl

skilleter_thingy/dc_curses.py

@@ -0,0 +1,278 @@
+#! /usr/bin/env python3
+
+""" Convert colour highlighting codes from the LS_COLORS environment variable
+    used by ls to curses
+"""
+
+################################################################################
+
+import sys
+import os
+import glob
+import fnmatch
+import curses
+import stat
+
+################################################################################
+
+class CursesDircolors:
+    """ Convert dircolors codes to curses colours """
+
+    # Convert standard foreground and background codes to curses equivalents
+
+    ANSI_CONVERT_FORE = {
+        30: curses.COLOR_BLACK,
+        31: curses.COLOR_RED,
+        32: curses.COLOR_GREEN,
+        33: curses.COLOR_YELLOW,
+        34: curses.COLOR_BLUE,
+        35: curses.COLOR_MAGENTA,
+        36: curses.COLOR_CYAN,
+        37: curses.COLOR_WHITE,
+    }
+
+    ANSI_CONVERT_BACK = {
+        40: curses.COLOR_BLACK,
+        41: curses.COLOR_RED,
+        42: curses.COLOR_GREEN,
+        43: curses.COLOR_YELLOW,
+        44: curses.COLOR_BLUE,
+        45: curses.COLOR_MAGENTA,
+        46: curses.COLOR_CYAN,
+        47: curses.COLOR_WHITE,
+    }
+
+    # Convert attribute codes to their meanings
+    # TODO: Attributes not handled yet
+
+    ANSI_CONVERT_ATTR = {
+        0: 0,
+        1: curses.A_BOLD,
+        4: curses.A_UNDERLINE,
+        5: curses.A_BLINK,
+        7: curses.A_BLINK,
+        8: curses.A_INVIS,
+    }
+
+    # Default colour
+
+    DEFAULT_ATTR = {'attr': [], 'fore': -1, 'back': -1}
+
+    ################################################################################
+
+    def __init__(self, reserved=0):
+        # Create the lookup tables associating special type codes or wildcards
+        # with colour pairs.
+
+        self.colour_pairs = [[-1, -1]]
+
+        self.wildcard_highlight = {}
+        self.special_highlight = {}
+
+        self.reserved = reserved
+
+        self.init_ls_colours()
+
+    ################################################################################
+
+    def curses_alloc_pair(self, attr):
+        """ Given a set of attributes return the equivalent curses colour pair,
+            creating a new one if a matching one doesn't already exsit """
+
+        # TODO: Take account of attributes as well as colours
+
+        colours = [attr['fore'], attr['back']]
+
+        # Get an existing colour pair that uses the same colours or create
+        # a new one if one doesn't exist
+
+        if colours in self.colour_pairs:
+            pair_index = self.colour_pairs.index(colours) + self.reserved
+        else:
+            pair_index = len(self.colour_pairs) + self.reserved
+            self.colour_pairs.append(colours)
+            curses.init_pair(pair_index, attr['fore'], attr['back'])
+
+        return pair_index
+
+    ################################################################################
+
+    def curses_colour(self, code):
+        """ Return a cursors colour pair index for the specified dircolor colour
+            code string. """
+
+        # Default attribute
+
+        attr = {'attr': [], 'fore': -1, 'back': -1}
+
+        # Non-zero if processing multi-value colour code
+
+        special = 0
+        special_item = None
+
+        # We trigger a ValueError and fail on anything that's wrong in the code
+
+        try:
+            # Split into fields and convert to integer values
+
+            codes = [int(c) for c in code.split(';')]
+
+            for entry in codes:
+                # Process 2nd entry in a special colour sequence - must have value of 5
+
+                if special == 1:
+                    if entry != 5:
+                        raise ValueError
+                    special = 2
+
+                # Process 3rd entry in a special colour sequence - must be the colour
+                # code between 0 and 255
+
+                elif special == 2:
+                    if entry < 0 or entry > 255:
+                        raise ValueError
+
+                    attr[special_item] = entry
+                    special = 0
+
+                # Normal foreground colour
+
+                elif entry in self.ANSI_CONVERT_FORE:
+                    attr['fore'] = self.ANSI_CONVERT_FORE[entry]
+
+                # Normal background colour
+
+                elif entry in self.ANSI_CONVERT_BACK:
+                    attr['back'] = self.ANSI_CONVERT_BACK[entry]
+
+                # Special foreground colour in the form 38;5;VALUE
+
+                elif entry == 38:
+                    special = 1
+                    special_item = 'fore'
+
+                # Special background colour in the form 48;5;VALUE
+
+                elif entry == 48:
+                    special = 1
+                    special_item = 'back'
+
+                # Attribute (underline, bold, etc.)
+
+                elif entry in self.ANSI_CONVERT_ATTR:
+                    attr['attr'].append(self.ANSI_CONVERT_ATTR[entry])
+
+                # Anything else is an error
+
+                else:
+                    raise ValueError
+
+        except ValueError:
+            print(f'Invalid colour specification: "{code}"')
+            sys.exit(1)
+
+        # Allocate a colour pair for the colour combination and return it
+
+        return self.curses_alloc_pair(attr)
+
+    ################################################################################
+
+    def init_ls_colours(self):
+        """ Generate tables matching special file types (fifos, sockets, etc.) and
+            wildcards to curses colour pairs """
+
+        colour_data = os.environ.get('LS_COLORS', '').split(':')
+
+        # Iterate through the highlighters, create/get a colour pair corresponding
+        # to the colour codes and save one of the tables.
+
+        for item in colour_data:
+            item = item.strip()
+            if '=' in item:
+                code, colour = item.split('=')
+
+                colour_pair = self.curses_colour(colour)
+
+                if len(code) == 2 and '*' not in code and '.' not in code:
+                    self.special_highlight[code] = colour_pair
+                else:
+                    self.wildcard_highlight[code] = colour_pair
+
+    ################################################################################
+
+    def get_colour(self, filename, filemode=None):
+        """ Get the curses colour for a filename, returns 0 if no highlighting
+            is needed """
+
+        if filemode:
+            if stat.S_ISDIR(filemode):
+                if 'di' in self.special_highlight:
+                    return self.special_highlight['di']
+            elif stat.S_ISLNK(filemode):
+                destfile = os.readlink(filename)
+
+                if os.path.exists(destfile):
+                    if 'ln' in self.special_highlight:
+                        return self.special_highlight['ln']
+                elif 'or' in self.special_highlight:
+                    return self.special_highlight['or']
+
+            elif stat.S_ISBLK(filemode):
+                if 'bd' in self.special_highlight:
+                    return self.special_highlight['bd']
+            elif stat.S_ISCHR(filemode):
+                if 'cd' in self.special_highlight:
+                    return self.special_highlight['cd']
+
+            if filemode & stat.S_IXUSR:
+                if 'ex' in self.special_highlight:
+                    return self.special_highlight['ex']
+
+        for entry in self.wildcard_highlight:
+            if fnmatch.fnmatch(filename, entry):
+                colour = self.wildcard_highlight[entry]
+                break
+        else:
+            colour = 0
+
+        return colour
+
+    ################################################################################
+
+    def get_colour_pair(self, filename, filemode=None):
+        """ Get the curses colour pair for a filename, optionally specifying the
+            file mode (as per os.stat()) """
+
+        return curses.color_pair(self.get_colour(filename, filemode))
+
+################################################################################
+
+def _test_code(stdscr):
+    """ Entry point """
+
+    curses.start_color()
+    curses.use_default_colors()
+
+    # Initialise colours
+
+    dc = CursesDircolors()
+
+    # Demo code to list files specified by the first command line argument
+    # highlighted appropriately
+
+    y = 0
+    for filename in glob.glob(sys.argv[1]):
+        colour = dc.get_colour(filename)
+
+        stdscr.addstr(y, 0, filename, curses.color_pair(colour))
+
+        y += 1
+        if y > 30:
+            break
+
+    stdscr.getch()
+
+################################################################################
+
+if __name__ == "__main__":
+    curses.wrapper(_test_code)

skilleter_thingy/dc_defaults.py

@@ -0,0 +1,221 @@
+""" Default dircolors data, and the reference .dircolors file.
+Generated from dircolors in GNU coreutils version 8.31 """
+
+__all__ = ['DEFAULT_DIRCOLORS', 'DEFAULT_LS_COLORS']
+
+# the output of `dircolors -p`
+DEFAULT_DIRCOLORS = r"""
+# Configuration file for dircolors, a utility to help you set the
+# LS_COLORS environment variable used by GNU ls with the --color option.
+# Copyright (C) 1996-2019 Free Software Foundation, Inc.
+# Copying and distribution of this file, with or without modification,
+# are permitted provided the copyright notice and this notice are preserved.
+# The keywords COLOR, OPTIONS, and EIGHTBIT (honored by the
+# slackware version of dircolors) are recognized but ignored.
+# Below are TERM entries, which can be a glob patterns, to match
+# against the TERM environment variable to determine if it is colorizable.
+TERM Eterm
+TERM ansi
+TERM *color*
+TERM con[0-9]*x[0-9]*
+TERM cons25
+TERM console
+TERM cygwin
+TERM dtterm
+TERM gnome
+TERM hurd
+TERM jfbterm
+TERM konsole
+TERM kterm
+TERM linux
+TERM linux-c
+TERM mlterm
+TERM putty
+TERM rxvt*
+TERM screen*
+TERM st
+TERM terminator
+TERM tmux*
+TERM vt100
+TERM xterm*
+# Below are the color init strings for the basic file types.
+# One can use codes for 256 or more colors supported by modern terminals.
+# The default color codes use the capabilities of an 8 color terminal
+# with some additional attributes as per the following codes:
+# Attribute codes:
+# 00=none 01=bold 04=underscore 05=blink 07=reverse 08=concealed
+# Text color codes:
+# 30=black 31=red 32=green 33=yellow 34=blue 35=magenta 36=cyan 37=white
+# Background color codes:
+# 40=black 41=red 42=green 43=yellow 44=blue 45=magenta 46=cyan 47=white
+#NORMAL 00 # no color code at all
+#FILE 00 # regular file: use no color at all
+RESET 0 # reset to "normal" color
+DIR 01;34 # directory
+LINK 01;36 # symbolic link. (If you set this to 'target' instead of a
+ # numerical value, the color is as for the file pointed to.)
+MULTIHARDLINK 00 # regular file with more than one link
+FIFO 40;33 # pipe
+SOCK 01;35 # socket
+DOOR 01;35 # door
+BLK 40;33;01 # block device driver
+CHR 40;33;01 # character device driver
+ORPHAN 40;31;01 # symlink to nonexistent file, or non-stat'able file ...
+MISSING 00 # ... and the files they point to
+SETUID 37;41 # file that is setuid (u+s)
+SETGID 30;43 # file that is setgid (g+s)
+CAPABILITY 30;41 # file with capability
+STICKY_OTHER_WRITABLE 30;42 # dir that is sticky and other-writable (+t,o+w)
+OTHER_WRITABLE 34;42 # dir that is other-writable (o+w) and not sticky
+STICKY 37;44 # dir with the sticky bit set (+t) and not other-writable
+# This is for files with execute permission:
+EXEC 01;32
+# List any file extensions like '.gz' or '.tar' that you would like ls
+# to colorize below. Put the extension, a space, and the color init string.
+# (and any comments you want to add after a '#')
+# If you use DOS-style suffixes, you may want to uncomment the following:
+#.cmd 01;32 # executables (bright green)
+#.exe 01;32
+#.com 01;32
+#.btm 01;32
+#.bat 01;32
+# Or if you want to colorize scripts even if they do not have the
+# executable bit actually set.
+#.sh 01;32
+#.csh 01;32
+ # archives or compressed (bright red)
+.tar 01;31
+.tgz 01;31
+.arc 01;31
+.arj 01;31
+.taz 01;31
+.lha 01;31
+.lz4 01;31
+.lzh 01;31
+.lzma 01;31
+.tlz 01;31
+.txz 01;31
+.tzo 01;31
+.t7z 01;31
+.zip 01;31
+.z 01;31
+.dz 01;31
+.gz 01;31
+.lrz 01;31
+.lz 01;31
+.lzo 01;31
+.xz 01;31
+.zst 01;31
+.tzst 01;31
+.bz2 01;31
+.bz 01;31
+.tbz 01;31
+.tbz2 01;31
+.tz 01;31
+.deb 01;31
+.rpm 01;31
+.jar 01;31
+.war 01;31
+.ear 01;31
+.sar 01;31
+.rar 01;31
+.alz 01;31
+.ace 01;31
+.zoo 01;31
+.cpio 01;31
+.7z 01;31
+.rz 01;31
+.cab 01;31
+.wim 01;31
+.swm 01;31
+.dwm 01;31
+.esd 01;31
+# image formats
+.jpg 01;35
+.jpeg 01;35
+.mjpg 01;35
+.mjpeg 01;35
+.gif 01;35
+.bmp 01;35
+.pbm 01;35
+.pgm 01;35
+.ppm 01;35
+.tga 01;35
+.xbm 01;35
+.xpm 01;35
+.tif 01;35
+.tiff 01;35
+.png 01;35
+.svg 01;35
+.svgz 01;35
+.mng 01;35
+.pcx 01;35
+.mov 01;35
+.mpg 01;35
+.mpeg 01;35
+.m2v 01;35
+.mkv 01;35
+.webm 01;35
+.ogm 01;35
+.mp4 01;35
+.m4v 01;35
+.mp4v 01;35
+.vob 01;35
+.qt 01;35
+.nuv 01;35
+.wmv 01;35
+.asf 01;35
+.rm 01;35
+.rmvb 01;35
+.flc 01;35
+.avi 01;35
+.fli 01;35
+.flv 01;35
+.gl 01;35
+.dl 01;35
+.xcf 01;35
+.xwd 01;35
+.yuv 01;35
+.cgm 01;35
+.emf 01;35
+# https://wiki.xiph.org/MIME_Types_and_File_Extensions
+.ogv 01;35
+.ogx 01;35
+# audio formats
+.aac 00;36
+.au 00;36
+.flac 00;36
+.m4a 00;36
+.mid 00;36
+.midi 00;36
+.mka 00;36
+.mp3 00;36
+.mpc 00;36
+.ogg 00;36
+.ra 00;36
+.wav 00;36
+# https://wiki.xiph.org/MIME_Types_and_File_Extensions
+.oga 00;36
+.opus 00;36
+.spx 00;36
+.xspf 00;36
+"""
+
+# the above converted to LS_COLORS by dircolors, but with the trailing ':' stripped
+DEFAULT_LS_COLORS = r"""
+rs=0:di=01;34:ln=01;36:mh=00:pi=40;33:so=01;35:do=01;35:bd=40;33;01:cd=40;33;01:or=40;31;01:
+mi=00:su=37;41:sg=30;43:ca=30;41:tw=30;42:ow=34;42:st=37;44:ex=01;32:*.tar=01;31:*.tgz=01;31:
+*.arc=01;31:*.arj=01;31:*.taz=01;31:*.lha=01;31:*.lz4=01;31:*.lzh=01;31:*.lzma=01;31:*.tlz=01;31:
+*.txz=01;31:*.tzo=01;31:*.t7z=01;31:*.zip=01;31:*.z=01;31:*.dz=01;31:*.gz=01;31:*.lrz=01;31:
+*.lz=01;31:*.lzo=01;31:*.xz=01;31:*.zst=01;31:*.tzst=01;31:*.bz2=01;31:*.bz=01;31:*.tbz=01;31:
+*.tbz2=01;31:*.tz=01;31:*.deb=01;31:*.rpm=01;31:*.jar=01;31:*.war=01;31:*.ear=01;31:*.sar=01;31:
+*.rar=01;31:*.alz=01;31:*.ace=01;31:*.zoo=01;31:*.cpio=01;31:*.7z=01;31:*.rz=01;31:*.cab=01;31:
+*.wim=01;31:*.swm=01;31:*.dwm=01;31:*.esd=01;31:*.jpg=01;35:*.jpeg=01;35:*.mjpg=01;35:
+*.mjpeg=01;35:*.gif=01;35:*.bmp=01;35:*.pbm=01;35:*.pgm=01;35:*.ppm=01;35:*.tga=01;35:*.xbm=01;35:
+*.xpm=01;35:*.tif=01;35:*.tiff=01;35:*.png=01;35:*.svg=01;35:*.svgz=01;35:*.mng=01;35:*.pcx=01;35:
+*.mov=01;35:*.mpg=01;35:*.mpeg=01;35:*.m2v=01;35:*.mkv=01;35:*.webm=01;35:*.ogm=01;35:*.mp4=01;35:
+*.m4v=01;35:*.mp4v=01;35:*.vob=01;35:*.qt=01;35:*.nuv=01;35:*.wmv=01;35:*.asf=01;35:*.rm=01;35:
+*.rmvb=01;35:*.flc=01;35:*.avi=01;35:*.fli=01;35:*.flv=01;35:*.gl=01;35:*.dl=01;35:*.xcf=01;35:
+*.xwd=01;35:*.yuv=01;35:*.cgm=01;35:*.emf=01;35:*.ogv=01;35:*.ogx=01;35:*.aac=00;36:*.au=00;36:
+*.flac=00;36:*.m4a=00;36:*.mid=00;36:*.midi=00;36:*.mka=00;36:*.mp3=00;36:*.mpc=00;36:*.ogg=00;36:
+*.ra=00;36:*.wav=00;36:*.oga=00;36:*.opus=00;36:*.spx=00;36:*.xspf=00;36""".replace('\n', '')

skilleter_thingy/dc_util.py

@@ -0,0 +1,50 @@
+# private utility functions for pydircolors
+#
+# Copyright 2019 Allen Wild <allenwild93@gmail.com>
+# SPDX-License-Identifier: Apache-2.0
+
+""" private/internal utility functions for pydircolors """
+
+import os
+
+__all__ = ['stat_at', 'readlink_at']
+
+def stat_at(file, cwd=None, follow_symlinks=False):
+    """ helper function to call os.stat on a file relative to a given directory.
+    cwd should be a string, and will be opened as read-only (then closed), or an integer
+    for an already-open directory file descriptor (which won't be closed).
+    os.open or os.stat may raise various errors, which are passed on. """
+    if isinstance(cwd, str):
+        dirfd = os.open(cwd, os.O_RDONLY)
+        need_to_close = True
+    elif cwd is None or isinstance(cwd, int):
+        dirfd = cwd
+        need_to_close = False
+    else:
+        raise ValueError('cwd must be str, int, or None')
+
+    try:
+        return os.stat(file, dir_fd=dirfd, follow_symlinks=follow_symlinks)
+    finally:
+        if need_to_close:
+            os.close(dirfd)
+
+def readlink_at(file, cwd=None):
+    """ helper function to call os.readlink on a file relative to a given directory.
+    cwd should be a string, and will be opened as read-only (then closed), or an integer
+    for an already-open directory file descriptor (which won't be closed).
+    os.open or os.readlink may raise various errors, which are passed on. """
+    if isinstance(cwd, str):
+        dirfd = os.open(cwd, os.O_RDONLY)
+        need_to_close = True
+    elif cwd is None or isinstance(cwd, int):
+        dirfd = cwd
+        need_to_close = False
+    else:
+        raise ValueError('cwd must be str, int, or None')
+
+    try:
+        return os.readlink(file, dir_fd=dirfd)
+    finally:
+        if need_to_close:
+            os.close(dirfd)