przypisuj i sprawdzaj metadane funkcji bash

Często generuję i rejestruję wiele funkcji bash, które automatyzują wiele zadań, które zwykle wykonuję w swoich projektach programistycznych. To generowanie zależy od metadanych projektu, nad którym pracuję.

Chcę opisać funkcje informacjami o projekcie, który zostały wygenerowane, w ten sposób:

func1() {
# This function was generated for project: PROJECT1
echo "do my automation"
}

Idealnie byłoby zobaczyć komentarz, gdy sprawdzę definicję:

$ type func1

func1 is a function
func1 () 
{
    # This function was generated for project: PROJECT1
    echo "do my automation"
}

Ale bash wydaje się ignorować komentarze w momencie ładowania funkcji, a nie podczas jej wykonywania. Komentarze są zgubione i otrzymuję ten wynik:

func1 is a function
func1 () 
{
    echo "do my automation"
}

Czy jest jakiś sposób przypisania metadanych do funkcji i sprawdzenia ich później? Czy można je odzyskać podczas sprawdzania definicji typu?

function func_name()
{
  : '
  Invocation:   func_name $1 $2 ... $n
  Function:     Display the values of the supplied arguments, in double quotes.
  Exit status:  func_name always returns with exit status 0.
  ' :
  local i
  echo "func_name: $# arguments"
  for ((i = 1; i <= $#; ++i)); do
    echo "func_name [$i] \"$1\""
    shift
  done
  return 0
}

Tak, typewydaje się , że drukuje tylko te części funkcji, które zostaną uruchomione. Wydaje mi się to rozsądne, ponieważ zazwyczaj to wszystko, czym jesteś zainteresowany, kiedy pytasz type.

Aby obejść ten problem, zamiast używać komentarzy, dodaj swoje metadane w następujący sposób:

func1() {
    meta="This function was generated for project: PROJECT1"
    echo "do my automation"
}

Nie ma potrzeby używania tej zmiennej, ale pojawi się ona podczas zapytania funkcji za pomocą type:

$ type func1
func1 is a function
func1 () 
{ 
    meta="This function was generated for project: PROJECT1";
    echo "do my automation"
}

Możesz użyć wbudowanego nop: . Poza tym nie musisz przechowywać go jako zmiennej:

function f() {
  : your metadata here
  : "or here"
  # do yours
}

EDYCJA : Uważaj na znaki specjalne w swoich metadanych. Do czystego tekstu możesz użyć:

: <<EOT
Your metadata text here.
EOT

EDYCJA : Zamiast tego możesz użyć globalnej tablicy asocjacyjnej do przechowywania metadanych wszystkich funkcji:

declare -A METADATA=()
METADATA[fun1]='foo bar'
function fun1() {
  echo I have some metadata: "${METADATA[$FUNCNAME]}"
}
METADATA[fun2]='baz you'
function fun2() {
  echo I have some other metadata: "${METADATA[$FUNCNAME]}"
}

W ten sposób nie musisz analizować declareani typegenerować danych wyjściowych, a jedynie zapytać o klucz tablicy.

Możesz to zrobić.

$ f() { This function does nothing. 2> /dev/null; }
$ f
$ type f
f is a function
f () 
{ 
    This function does nothing. 2> /dev/null
}