skilleter-modules 0.0.1__py3-none-any.whl

skilleter_modules/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_modules/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)

skilleter_modules/dircolors.py

@@ -0,0 +1,310 @@
+# Dircolors, a Python library for colorizing and formatting filenames like GNU Coreutils'
+# ls and dircolors programs.
+# Requires python 3.3 or later
+#
+# Copyright 2019 Allen Wild <allenwild93@gmail.com>
+# Modifications copyright 2020 John Skilleter <john@skilleter.org.uk>
+# SPDX-License-Identifier: Apache-2.0
+
+""" dircolors, a Python library to colorize filenames based on their type
+for terminal use, like GNU ls and dircolors. """
+
+from collections import OrderedDict
+from io import StringIO, TextIOBase
+import os
+import stat
+
+import dc_defaults
+import dc_util
+
+__all__ = ['Dircolors']
+
+_CODE_MAP = OrderedDict()
+
+def _init_code_map():
+    """ mapping between the key name in the .dircolors file and the two letter
+    code found in the LS_COLORS environment variable.
+    Used for parsing .dircolors files. """
+    # This code is wrapped in a function so we can disable pylint's whitespace check
+    # on a limited scope.
+    # pylint: disable=bad-whitespace
+    _CODE_MAP['RESET']                  = 'rs'
+    _CODE_MAP['DIR']                    = 'di'
+    _CODE_MAP['LINK']                   = 'ln'
+    _CODE_MAP['MULTIHARDLINK']          = 'mh'
+    _CODE_MAP['FIFO']                   = 'pi'
+    _CODE_MAP['SOCK']                   = 'so'
+    _CODE_MAP['DOOR']                   = 'do'
+    _CODE_MAP['BLK']                    = 'bd'
+    _CODE_MAP['CHR']                    = 'cd'
+    _CODE_MAP['ORPHAN']                 = 'or'
+    _CODE_MAP['MISSING']                = 'mi'
+    _CODE_MAP['SETUID']                 = 'su'
+    _CODE_MAP['SETGID']                 = 'sg'
+    _CODE_MAP['CAPABILITY']             = 'ca'
+    _CODE_MAP['STICKY_OTHER_WRITABLE']  = 'tw'
+    _CODE_MAP['OTHER_WRITABLE']         = 'ow'
+    _CODE_MAP['STICKY']                 = 'st'
+    _CODE_MAP['EXEC']                   = 'ex'
+
+_init_code_map()
+del _init_code_map
+
+class Dircolors:
+    """ Main dircolors class. Contains a database of formats corresponding to file types,
+    modes, and extensions. Use the format() method to check a file and color it appropriately.
+    """
+
+    def __init__(self, load=True):
+        """ Initialize a Dircolors object. If load=True (the default), then try
+        to load dircolors info from the LS_COLORS environment variable.
+        If no data is obtained from LS_COLORS, load the defaults.
+        If load=False, don't even load defaults. """
+        self._loaded = False
+        self._codes = OrderedDict()
+        self._extensions = OrderedDict()
+        if load:
+            if not self.load_from_environ():
+                self.load_defaults()
+
+    def __bool__(self):
+        """ convenience method for checking whether this Dircolors object has loaded a database.
+        Can be used like
+            d = Dircolors()
+            if d:
+                d.format(somefile)
+        """
+        return self._loaded
+
+    @property
+    def loaded(self):
+        """ return a boolean indicating whether some valid dircolors data has been loaded """
+        return self._loaded
+
+    def clear(self):
+        """ Clear the loaded data """
+        self._loaded = False
+        self._codes.clear()
+        self._extensions.clear()
+
+    def load_from_lscolors(self, lscolors):
+        """ Load the dircolors database from a string in the same format as the LS_COLORS
+        environment variable.
+        Returns True if data was successfully loaded, False otherwise (e.g. if
+        envvar is unset). Regardless, the current database will be cleared """
+        self.clear()
+        if not lscolors:
+            return False
+
+        for item in lscolors.split(':'):
+            try:
+                code, color = item.split('=', 1)
+            except ValueError:
+                continue  # no key=value, just ignore
+            if code.startswith('*.'):
+                self._extensions[code[1:]] = color
+            else:
+                self._codes[code] = color
+
+        if self._codes or self._extensions:
+            self._loaded = True
+        return self._loaded
+
+    def load_from_environ(self, envvar='LS_COLORS'):
+        """ Load the dircolors database from an environment variable. By default,
+        use LS_COLORS like the GNU Coreutils `ls` program.
+        Returns True if data was successfully loaded, False otherwise (e.g. if
+        envvar is unset). Regardless, the current database will be cleared. """
+        return self.load_from_lscolors(os.environ.get(envvar))
+
+    def load_from_dircolors(self, database, strict=False):
+        """ Load the dircolors database from a GNU-compatible .dircolors file.
+        May raise any of the usual OSError exceptions if filename doesn't exist
+        or otherwise can't be read.
+
+        database can be a string representing a filename, or a file-like object
+        opened in text mode (i.e. a subclass of io.TextIOBase). To load from the
+        contents of a .dircolors file, wrap it in an io.StringIO object.
+
+        If strict is True, raise ValueError on the first unparsed line
+
+        Returns a boolean indicating whether any data was loaded.
+        The current database will always be cleared. """
+        self.clear()
+        if isinstance(database, str):
+            file = open(database, 'r')
+        elif isinstance(database, TextIOBase):
+            file = database
+        else:
+            raise ValueError('database must be str or io.TextIOBase, not %s' % type(database))
+
+        try:
+            for line in file:
+                # remove comments and skip empty lines
+                line = line.split('#')[0].strip()
+                if not line:
+                    continue
+
+                # make sure there's two space-separated fields
+                split = line.split()
+                if len(split) != 2:
+                    if strict:
+                        raise ValueError('Warning: unable to parse dircolors line "%s"' % line)
+                    continue
+
+                key, val = split
+                if key == 'TERM':
+                    continue  # ignore TERM directives
+                elif key in _CODE_MAP:
+                    self._codes[_CODE_MAP[key]] = val
+                elif key.startswith('.'):
+                    self._extensions[key] = val
+                elif strict:
+                    raise ValueError('Warning: unable to parse dircolors line "%s"' % line)
+                # elif not strict, skip
+
+            if self._codes or self._extensions:
+                self._loaded = True
+            return self._loaded
+        finally:
+            file.close()
+
+    def load_defaults(self):
+        """ Load the default database. """
+        self.clear()
+        return self.load_from_dircolors(StringIO(dc_defaults.DEFAULT_DIRCOLORS), True)
+
+    def generate_lscolors(self):
+        """ Output the database in the format used by the LS_COLORS environment variable. """
+        if not self._loaded:
+            return ''
+
+        def gen_pairs():
+            for pair in self._codes.items():
+                yield pair
+            for pair in self._extensions.items():
+                # change .xyz to *.xyz
+                yield '*' + pair[0], pair[1]
+
+        return ':'.join('%s=%s' % pair for pair in gen_pairs())
+
+    def _format_code(self, text, code):
+        """ format text with an lscolors code. Return text unmodified if code
+        isn't found in the database """
+        val = self._codes.get(code, None)
+        if val:
+            return '\033[%sm%s\033[%sm' % (val, text, self._codes.get('rs', '0'))
+        return text
+
+    def _format_ext(self, text, ext):
+        """ Format text according to the given file extension.
+        ext must have a leading '.'
+        text need not actually end in '.ext' """
+        val = self._extensions.get(ext, '0')
+        if val:
+            return '\033[%sm%s\033[%sm' % (val, text, self._codes.get('rs', '0'))
+        return text
+
+    def format_mode(self, text, mode):
+        """ Format and color the given text based on the given file mode.
+
+        `mode` can be an integer, usually the st_mode field of an os.stat_result
+        object obtained from os.stat() or similar function. It can also be an os.stat_result
+        object, and the st_mode field will be extracted automatically.
+
+        If mode is zero then the formatting is performed only according to the filename.
+
+        `text` is an arbitrary string which will be colored according to the bits
+        set in `mode` and the colors database loaded in this Dircolors object.
+
+        If `mode` represents a symlink, it will be formatted as such with no dereferencing
+        (since this function doesn't know the file name) """
+        if not self._loaded:
+            return text
+
+        if isinstance(mode, int):
+            pass
+        elif isinstance(mode, os.stat_result):
+            mode = mode.st_mode
+        else:
+            raise ValueError('mode must be int or os.stat_result, not %s' % type(mode))
+
+        if mode:
+            if stat.S_ISDIR(mode):
+                if (mode & (stat.S_ISVTX | stat.S_IWOTH)) == (stat.S_ISVTX | stat.S_IWOTH):
+                    # sticky and world-writable
+                    return self._format_code(text, 'tw')
+                if mode & stat.S_ISVTX:
+                    # sticky but not world-writable
+                    return self._format_code(text, 'st')
+                if mode & stat.S_IWOTH:
+                    # world-writable but not sticky
+                    return self._format_code(text, 'ow')
+                # normal directory
+                return self._format_code(text, 'di')
+
+            # special file?
+            # pylint: disable=bad-whitespace
+            special_types = (
+                (stat.S_IFLNK,  'ln'),  # symlink
+                (stat.S_IFIFO,  'pi'),  # pipe (FIFO)
+                (stat.S_IFSOCK, 'so'),  # socket
+                (stat.S_IFBLK,  'bd'),  # block device
+                (stat.S_IFCHR,  'cd'),  # character device
+                (stat.S_ISUID,  'su'),  # setuid
+                (stat.S_ISGID,  'sg'),  # setgid
+            )
+
+            for mask, code in special_types:
+                if (mode & mask) == mask:
+                    return self._format_code(text, code)
+
+            # executable file?
+            if mode & (stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH):
+                return self._format_code(text, 'ex')
+
+        # regular file, format according to its extension
+        _, ext = os.path.splitext(text)
+        if ext:
+            return self._format_ext(text, ext)
+        return text
+
+    def format(self, file, cwd=None, follow_symlinks=False, show_target=False):
+        """ Format and color the file given by the name `file`.
+
+        If `cwd` is not None, it should be a string for the directory relative
+        to which `file` is looked up, or an integer representing a directory
+        descriptor (usually from `os.open()`).
+
+        If the file does not exist, it is formatted according to the filename only.
+
+        Use follow_symlinks to dereference symlinks entirely.
+        Use show_target=True with follow_symlinks=False to format both the link name
+        and its target in the format:
+            linkname -> target
+        With linkname formatted as a link color, and the link target formatted as its respective
+        type. If the link target is another link, it will not be recursively dereferenced. """
+
+        if not self.loaded:
+            return file
+
+        if os.path.exists(file):
+            try:
+                statbuf = dc_util.stat_at(file, cwd, follow_symlinks)
+            except OSError as e:
+                return '%s [Error stat-ing: %s]' % (file, e.strerror)
+
+            mode = statbuf.st_mode
+            if (not follow_symlinks) and show_target and stat.S_ISLNK(mode):
+                target_path = dc_util.readlink_at(file, cwd)
+                try:
+                    dc_util.stat_at(target_path, cwd)  # check for broken link
+                    target = self.format(target_path, cwd, False, False)
+                except OSError:
+                    # format as "orphan"
+                    target = self._format_code(target_path, 'or') + ' [broken link]'
+                return self._format_code(file, 'ln') + ' -> ' + target
+        else:
+            mode = 0
+
+        return self.format_mode(file, mode)