答案1
简介
注意:这是脚本的新版本和更新版本,对于旧版本,请参阅此答案的编辑历史
下面提供的脚本允许设置 GitHub 存储库图标或徽标(但不能同时设置),以及将元数据重置为默认值。使用方法非常简单,如选项所示-h
:
$ ./set_folder_icon.py -h
usage: set_folder_icon.py [-h] [-i ICON] [-e EMBLEM] [-r ROOT] [-u]
Finds and sets github repository icons.Choose either --icon or --emblem.
Without either the script exists with 0 exit status.For --icons, use absolute
or relative path.For --emblem use single string of text.Emblem pathnames are
in the format emblem-name.extension.The script then can becalled with -e
<name>.Use ~/.local/share/icons folder for custom emblems (if it does not
exist - create it. Store filenames in specified format
optional arguments:
-h, --help show this help message and exit
-i ICON, --icon ICON path to image to set
-e EMBLEM, --emblem EMBLEM
single-string emblem name
-r ROOT, --root ROOT where search starts,default - current working
directory
-u, --unset unset both emblem and icon. Cannot be used with -e or
-i options
因此,如果我们想递归搜索主文件夹中的所有github
存储库并设置它们的徽标,我们可以这样做,set_folder_icon.py -e myemblemname -r $HOME
或者只是cd; set_folder_icon.py -e myemblemname
为了获得最佳性能,请创建~/bin
目录并将脚本存储为set_folder_icon.py
。如果您想立即使用它,请运行source ~/.bashrc
。如果您使用的是其他 shell,请确保您的~/bin
已添加到$PATH
变量中。
笔记:脚本可以使用--icon
选项获取任意文件,但--emblem
要求您有一个要存储的特定文件,~/.local/share/icons
文件名类似于emblem-github
。请参阅脚本实际运行部分的示例
脚本实际运行
我碰巧将所有 GitHub 存储库保存在~/GIT
文件夹下。在下面的屏幕截图中,您可以看到所有 GitHub 存储库的徽标如何设置为自定义徽标。
前:
后:
脚本
该脚本也可以在我的个人 GitHub 仓库,更有可能获得更新的变化和修复。
#!/usr/bin/env python3
"""
Author: Sergiy Kolodyazhnyy
Date: 7/12/2017
Purpose: Script to find github repository folders
and set their icons for Ubuntu.
Written for: https://askubuntu.com/q/935003/295286
"""
import argparse
import os
import sys
import subprocess
import urllib.parse
def puke(message, status_code):
""" Print to stderr and exit with given code """
sys.stderr.write('>>> OOOPS. Something is wrong:\n')
sys.stderr.write(message + '\n')
sys.exit(status_code)
def run_cmd(cmdlist):
""" Reusable function for running external commands """
try:
stdout = subprocess.check_output(cmdlist)
except subprocess.CalledProcessError as cpe:
puke('Called command failed with ' + str(cpe.returncode) +
' exit status\n' + repr(cpe), 4)
else:
if stdout:
return stdout
def set_icon(directory, icon_type, image):
""" Wrapper function that specifies command and calls run_cmd()"""
key = 'metadata::' + icon_type
meta = {'metadata::custom-icon': 'string',
'metadata::emblems': 'stringv'}
# Because custom-icons and emblems type are mutually
# exclusive, we need to unset custom-icon to enable emblems
if icon_type == 'emblems':
cmd = ['gvfs-set-attribute', '-t', 'unset',
directory, 'metadata::custom-icon']
run_cmd(cmd)
cmd = ['gvfs-set-attribute', '-t', meta[key],
directory, key, image]
return run_cmd(cmd)
def unset_all(directory):
for key in ['metadata::custom-icon', 'metadata::emblems']:
run_cmd(['gvfs-set-attribute', '-t', 'unset', directory, key])
def find_directories(tree_root):
""" Does the job of recursive traversal of given directory tree,
starting at the specified tree root directory. If condition for
given subdirectory is met, calls set_icon() function"""
for current_dir, subdirs, files in os.walk(tree_root):
# This check can be adapted to other cases
if '.git' in subdirs:
print('Found', current_dir)
yield current_dir
def parse_args():
""" Parses command-line arguments """
text = ['Finds and sets github repository icons.',
'Choose either --icon or --emblem. Without either'
' the script exists with 0 exit status.',
'For --icons, use absolute or relative path.',
'For --emblem use single string of text.',
'Emblem pathnames are in the format',
' emblem-name.extension.', 'The script then can be',
'called with -e <name>.Use ~/.local/share/icons folder',
' for custom emblems (if it does not ',
'exist - create it. Store filenames in specified format']
arg_parser = argparse.ArgumentParser(description="".join(text))
arg_parser.add_argument('-i', '--icon', help='path to image to set',
type=str, required=False)
arg_parser.add_argument('-e', '--emblem', help='single-string emblem name',
type=str, required=False)
arg_parser.add_argument('-r', '--root', help='where search starts,' +
'default - current working directory',
default='.', type=str, required=False)
arg_parser.add_argument('-u', '--unset', help='unset both emblem ' +
'and icon. Cannot be used with -e or -i options',
action='store_true', required=False)
return arg_parser.parse_args()
def main():
""" Script entry point """
# Parse command-line arguments and check their correctness
args = parse_args()
status_code = {'icon_missing': 1, 'root_missing': 2,
'root_isnt_dir': 3, 'exclusion': 4,
'not_string': 5, 'conflict': 6}
if args.unset and (args.icon or args.emblem):
puke('Conflicting options', status_code['conflict'])
if not args.unset:
# both or none are given
if not args.icon and not args.emblem:
sys.exit(0)
if args.icon and args.emblem:
puke('Can only use either --icon or --emblem',
status_code['exclusion'])
# Verify correctness of either one
if args.icon and not os.path.exists(args.icon):
puke('Icon pathname does not exist',
status_code['icon_missing'])
if args.emblem:
if '/' in args.emblem:
puke('Emblem must be a single string of text,no paths',
status_code['not_string'])
if not isinstance(args.emblem, str):
puke('Given argument for emblem is not a string',
stats_code['not_string'])
# Verify correctness of the path
if not os.path.exists(args.root):
puke('Root pathname does not exist',
status_code['root_missing'])
if not os.path.isdir(args.root):
puke('Root pathname is not a directory',
status_code['root_isnt_dir'])
if args.unset:
for directory in find_directories(args.root):
print('Unsetting', directory)
unset_all(directory)
sys.exit(0)
# Everything should be OK past this point
if args.icon:
meta_type = 'custom-icon'
icon = 'file://' + urllib.parse.quote(os.path.abspath(args.icon))
if args.emblem:
meta_type = 'emblems'
icon = args.emblem
# Now do the actual traversal and icon-setting
for directory in find_directories(args.root):
set_icon(directory, meta_type, icon)
if __name__ == '__main__':
main()
自动化脚本
当然,我们可以每次手动运行该脚本(事实上我可能会制作一个可以组合git clone
并运行该脚本的函数),尽管我建议您每次登录 GUI 会话时都运行该脚本。为此,请打开“启动应用程序”菜单,并将脚本(建议使用完整路径和完整文件名)添加为条目。
下次您登录时,您的图标将被设置。
至于手动想法,你可以git clone
用操作员一个接一个地运行脚本,或者更好的是,像这样&&
创建一个函数:~/.bashrc
$ tree
.
0 directories, 0 files
$ typeset -f my_gitclone
my_gitclone ()
{
git clone "$1" && ~/GIT/sergrep/set_folder_icon.py -e github
}
$ my_gitclone https://github.com/SergKolo/sergrep
Cloning into 'sergrep'...
remote: Counting objects: 387, done.
remote: Compressing objects: 100% (17/17), done.
remote: Total 387 (delta 10), reused 17 (delta 5), pack-reused 365
Receiving objects: 100% (387/387), 115.65 KiB | 0 bytes/s, done.
Resolving deltas: 100% (203/203), done.
Checking connectivity... done.
Found ./sergrep