主页 / ubuntu / 问题 / 1146269
Accepted
jarno
Asked: 2019-05-27 01:23:56 +0800 CST

如何找到某些 bash 函数的定义位置？

  • 772

Bash shell 中可以使用许多功能。它们的定义可以通过 列出set，但是如何找到在哪些文件中定义了某些用户定义的函数？

bash functions

3 个回答

  1. Best Answer

    打开调试。来自Bash 手册：

    扩展调试

    如果在 shell 调用或 shell 启动文件中设置，安排在 shell 启动之前执行调试器配置文件，与 --debugger选项相同。如果在调用后设置，则启用调试器使用的行为：

    • -F内置选项declare（请参阅Bash Builtins）显示与作为参数提供的每个函数名称相对应的源文件名和行号。

    例子：

    $ bash --debugger
$ declare -Ff quote
quote 143 /usr/share/bash-completion/bash_completion

    事实上：

    $ nl -ba /usr/share/bash-completion/bash_completion | sed -n 143,150p
   143  quote()
   144  {
   145      local quoted=${1//\'/\'\\\'\'}
   146      printf "'%s'" "$quoted"
   147  }
   148
   149  # @see _quote_readline_by_ref()
   150  quote_readline()
    • 36

  2. 这实际上比最初看起来要复杂得多。您的 shell 读取哪些文件取决于您当前运行的 shell 类型。不管是交互还是非交互，是登录还是非登录shell以及以上的什么组合。要搜索不同 shell 可以读取的所有默认文件，您可以执行以下操作（更改$functionName为您要查找的函数的实际名称）：

    grep "$functionName" ~/.bashrc ~/.profile ~/.bash_profile ~/.bash.login \
                     ~/.bash_aliases /etc/bash.bashrc /etc/profile \
                     /etc/profile.d/* /etc/environment 2> /dev/null

    如果这不起作用，您可能正在使用.或其别名调用非默认文件source。要查找此类情况，请运行：

    grep -P '(^|\s)(\.|source)\s+' ~/.bashrc ~/.profile ~/.bash_profile \
                               ~/.bash.login ~/.bash_aliases /etc/bash.bashrc \
                               /etc/profile /etc/profile.d/* /etc/environment 2> /dev/null

    这可能需要一些解释。启用 Perl 兼容正-P则表达式 (PCRE)，这让我们可以使用一些更高级的正则表达式语法。具体来说：

    • (^|\s): 匹配行首 ( ^) 或空格 ( \s)。
    • (\.|source)\s+: 匹配文字.字符 ( \.) 或单词source，但前提是它们后跟一个或多个空白字符。

    这是我的系统上给我的东西：

    $ grep -P '(^|\s)(\.|source)\s+' ~/.bashrc ~/.profile ~/.bash_profile \
>                                ~/.bash.login ~/.bash_aliases /etc/bash.bashrc \
>                                /etc/profile /etc/profile.d/* /etc/environment 2> /dev/null
/home/terdon/.bashrc:   . /etc/bashrc
/home/terdon/.bashrc:   . /etc/bash_completion
/home/terdon/.bashrc:. $HOME/scripts/git-prompt.sh
/home/terdon/.bashrc:#  echo -n "$n : "; grep "^CA"  $n |perl -e 'my ($a,$c)=0; while(<>){$c++;next if /cellular_component_unknown/; next if /biological_process/; $a++} print "$a Classes of $c annotated (" . $a*100/$c . ")\n"' 
/etc/bash.bashrc:[ -r /usr/share/bash-completion/bash_completion   ] && . /usr/share/bash-completion/bash_completion
/etc/profile:       test -r "$profile" && . "$profile"
/etc/profile:   . /etc/bash.bashrc
/etc/profile.d/locale.sh:    . "$XDG_CONFIG_HOME/locale.conf"
/etc/profile.d/locale.sh:    . "$HOME/.config/locale.conf"
/etc/profile.d/locale.sh:    . /etc/locale.conf
/etc/profile.d/Z97-byobu.sh:        . /usr/bin/byobu-launch
/etc/profile.d/Z97-byobu.sh:        . /usr/bin/byobu-launch
/etc/profile.d/Z97-byobu.sh:        . /usr/bin/byobu-launch
/etc/profile.d/Z97-byobu.sh:        . /usr/bin/byobu-launch
/etc/profile.d/Z97-byobu.sh:        . /usr/bin/byobu-launch

    但是，如您所见，这将打印整个匹配的行。我们真正感兴趣的是调用的文件名列表，而不是调用它们的行。你可以用这个更复杂的正则表达式来获得那些：

    grep -hPo '(^|\s)(\.|source)\s+\K\S+' ~/.bashrc ~/.profile ~/.bash_profile \
                                      ~/.bash.login ~/.bash_aliases \
                                      /etc/bash.bashrc /etc/profile \
                                      /etc/profile.d/* /etc/environment 2> /dev/null

    该-h标志禁止打印找到匹配项的文件名，grep默认情况下，当被告知搜索多个文件时。意思是“只打印该-o行的匹配部分”。添加到正则表达式的额外内容是：

    • \K: 忽略任何匹配到这一点的东西。-o这是一个 PCRE 技巧，可让您使用复杂的正则表达式来查找匹配项，但在使用 grep 的标志时不包括匹配的部分。

    在我的系统上，上述命令将返回：

    $ grep -hPo '(^|\s)(\.|source)\s+\K\S+' ~/.bashrc ~/.profile ~/.bash_profile \
>                                       ~/.bash.login ~/.bash_aliases \
>                                       /etc/bash.bashrc /etc/profile \
>                                       /etc/profile.d/* /etc/environment 2> /dev/null
/etc/bashrc
/etc/bash_completion
$HOME/scripts/git-prompt.sh
$a*100/$c
")\n"'
/usr/share/bash-completion/bash_completion
"$profile"
/etc/bash.bashrc
"$XDG_CONFIG_HOME/locale.conf"
"$HOME/.config/locale.conf"
/etc/locale.conf
/usr/bin/byobu-launch
/usr/bin/byobu-launch
/usr/bin/byobu-launch
/usr/bin/byobu-launch
/usr/bin/byobu-launch

    请注意，我碰巧使用了一个不.用于采购的空格，但那是因为我有一个别名调用另一种语言，而不是 bash。这就是在上面的输出中给出奇怪和的原因。但这可以忽略。$a*100/$c")\n"'

    最后，这里是如何将所有这些放在一起并在所有默认文件和您的默认文件来源的所有文件中搜索函数名称：

    grep_function(){
  target="$@"
  files=( ~/.bashrc ~/.profile ~/.bash_profile ~/.bash.login 
         ~/.bash_aliases /etc/bash.bashrc /etc/profile 
         /etc/profile.d/* /etc/environment)
    while IFS= read -r file; do
      files+=( "$file" )
    done < <(grep -hPo '(^|\s)(\.|source)\s+\K\S+'  "${files[@]}" 2>/dev/null)
    for file in "${files[@]}"; do
      ## The tilde of ~/ can break this
      file=$(sed 's|~/|'"$HOME"'/|g' <<<"$file")
      if [[ -e $file ]]; then
        grep -H "$target" -- "$file"
      fi
    done
}

    将这些行添加到您的~/.bashrc，然后您可以运行（我使用fooBar作为示例函数名称）：

    grep_function fooBar

    例如，如果我的 中有这一行~/.bashrc：

    . ~/a

    文件~/a是：

    $ cat ~/a
fooBar(){
  echo foo
}

    我应该找到它：

    $ grep_function fooBar
/home/terdon/a:fooBar(){
    • 18

  3. 通常每个用户bash读取的点文件是~/.bashrc. 但是，它可能很好地获取其他文件，例如我喜欢将别名和函数保存在名为~/.bash_aliasesand的单独文件中~/.bash_functions，这使得查找它们变得更加容易。您可以使用以下命令搜索.bashrcforsource命令：

    grep -E '(^\s*|\s)(\.|source)\s' /home/USERNAME/.bashrc

    获得用户创建的文件列表后，您可以.bashrc通过一次grep调用搜索它们和用户，例如foo我的设置的功能：

    grep foo /home/USERNAME/.bash{rc,_aliases,_functions}
    • 2

相关问题