[Python] 関数の引数へ複数のDataFrameを渡して変数名を表示する方法

Question

関数の引数へ複数(その時々によって変わる)のDataFrameを渡してshapeをprintしたいです。
どのようにするれば良いのか教えて頂けると幸いです。

print_shape(**args):
   for i in args:
      print(i.shape)

print_shape(df_tokyo, df_osaka, df_gunma)
print_shape(df_hello, df_amerika, df_hakone, df_tochigi)

上3行を変更して、以下のような結果を得たいです。

df_tokyo shape: (100, 1), df_osaka shape: (100, 1), df_gunma shape: (100, 1)
df_hello shape: (100, 1), df_amerika shape: (100, 1), df_hakone shape: (100, 1), df_tochigi shape: (100, 1)

なるべく簡潔にしたいことから、print_shapeに新たに変数名のリストなどを渡すということはしたくないです。
そのようなことは可能でしょうか。よろしくお願いいたします。

Answer 1

こんな感じでどうでしょうか！　この記事を参考にしました。

関数部分

from inspect import currentframe
def print_shape(* args):
    names = {id(v):k for k,v in currentframe().f_back.f_locals.items()}
    print(
        "\n".join(
            names.get(id(arg),'???') + ": " + repr(arg.shape)  for arg in args
        )
    )

全体（test.py）

import pandas as pd
import numpy as np
from inspect import currentframe


def print_shape(* args):
    names = {id(v):k for k,v in currentframe().f_back.f_locals.items()}
    print(
        "\n".join(
            names.get(id(arg),'???') + ": " + repr(arg.shape)  for arg in args
        )
    )


def main():
    df_tokyo = pd.DataFrame(np.random.randint(0,100,size=(100, 4)), columns=list('ABCD' ))
    df_osaka = pd.DataFrame(np.random.randint(0,100,size=(100, 5)), columns=list('ABCDE'))
    df_gumna = pd.DataFrame(np.random.randint(0,100,size=( 10, 4)), columns=list('ABCD' ))

    print_shape(df_tokyo, df_osaka, df_gumna)


if __name__ == "__main__":
    main()

出力

$ python test.py
df_tokyo: (100, 4)
df_osaka: (100, 5)
df_gumna: (10, 4)

追加、

すみません、投稿者さまのように横一列に表示したければ、

from inspect import currentframe


def print_shape(* args):
names = {id(v):k for k,v in currentframe().f_back.f_locals.items()}
print(
    ", ".join(
        names.get(id(arg),'???') + " shape: " + repr(arg.shape) for arg in args
        )
    )

としてください！

Comments

[ppaul]

方法としてはこの方法しかないのですが、以下の問題は解決できないのですね。
df_tokyo2 = df_tokyo
とした後に、
print_shape(df_tokyo, df_osaka, df_gumna)
print_shape(df_tokyo2, df_osaka, df_gumna)
を実行すると、どちらも同じ結果を出力する。

これはそういうものなのでしかたがないとあきらめましょう。

Answer 2

しかたがないのであきらめましょう、とコメントしたように、この問題には完全な答えはないと思います。
同じオブジェクトを二つ以上の変数に入れるのを避ければ、BOLTEさんの回答で十分です。

一方、ユーザが書いたソースファイルの中身を読めば、引数の文字列を調べて表示することも不可能ではないなと思って作ってみました。
現在のフレームの一つ前のフレーム、つまり呼び出し元のフレームからファイル名と行番号を取り出し、ソースファイルを見て正規表現で引数の文字列に分解しています。
ソースがファイルに格納されていないと使えないので、これも完全な答えではありません。

ご参考まで

import pandas as pd
import inspect
import re

def get_line(file, no):
    with open(file, "r") as f:
        for i in range(no):
            line = f.readline()
    return line

def find_argnames(fname, line):
    m = re.search(fname + '[^(]*(([^)]*))', line)
    return [v.strip() for v in m.groups()[0].split(',')]

def print_shape(*dfs):
    fname = "print_shape"
    f = inspect.currentframe().f_back
    names = find_argnames(fname, get_line(f.f_code.co_filename, f.f_lineno))
    print(', '.join(f'{name} shape: {df.shape}' for name, df in zip(names, dfs)))

if __name__ == '__main__':
    df_hello  = pd.DataFrame({'John': list(range(100))})
    df_amerika  = pd.DataFrame({'Eric': list(range(100))})
    df_hakone  = pd.DataFrame({'Graham': list(range(100))})
    df_tochigi = pd.DataFrame({'Terry': list(range(100))})

    print_shape(df_hello, df_amerika, df_hakone, df_tochigi)

実行結果は以下です。

> python test.py
df_hello shape: (100, 1), df_amerika shape: (100, 1), df_hakone shape: (100, 1), df_tochigi shape: (100, 1)