Skip to content

Commit

Permalink
made see() easier to see
Browse files Browse the repository at this point in the history
  • Loading branch information
Tetsu HARUYAMA authored and Tetsu HARUYAMA committed Jan 8, 2024
1 parent 4beaaaa commit 117b651
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 17 deletions.
29 changes: 26 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
* Hodrick-Prescottフィルターを使い時系列データのトレンドを返す`trend()`関数
* DataFrameを全て表示する`show()`関数
* `n`個の浮動小数点数から構成されるリストを返す`xvalues()`関数
* オブジェクトの属性を表示する`see()`関数
* オブジェクトの属性(`_`もしくは`__`が付いた属性以外)を表示する`see()`関数
* 後退期間にグレーの塗りつぶしを追加する`fukyo()`関数
* 後退期間にグレーの塗りつぶしを追加する`recessions()`デコレーター
* データ・セット
Expand Down Expand Up @@ -71,8 +71,7 @@ py4macro.xvalues(l, h, n)
* `n`:要素数

**戻り値**

`n`個の浮動小数点数のリスト
* `n`個の浮動小数点数のリスト

****:

Expand All @@ -82,6 +81,30 @@ py4macro.xvalues(l, h, n)
>>> [-1.0, -0.5, 0.0, 0.5, 1.0]
```

## オブジェクトの属性(`_`もしくは`__`が付いた属性以外)を表示する

py4macro.see(obj, col=4, width=70)

引数:
* obj: 属性を調べるオブジェクト
* col: 表示する際の列の数(デフォルトは4)
* width: 表示の幅(デフォルトは70)
  (列の幅は width/col 以上である最小整数となる)

戻り値:
* None (表示のみ)


例:整数型である100の属性を調べる。

see(100)

```
>>> .as_integer_ratio .bit_count .bit_length .conjugate
>>> .denominator .from_bytes .imag .numerator
>>> .real .to_bytes
```


## 横軸に`DatetimeIndex`を使うプロットに対して後退期間にグレーの塗りつぶしを追加する関数
* `fukyo()`関数は後退期間の塗りつぶしを追加する
Expand Down
2 changes: 1 addition & 1 deletion py4macro/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* HPフィルターを使いトレンドを抽出する`trend()`関数
* `DataFrame`を全て表示する`show()`関数
* `n`個の浮動小数点数から構成されるリストを返す`xvalues()`関数
* オブジェクトの属性を表示する`see()`関数
* オブジェクトの属性(`_`もしくは`__`が付いた属性以外)を表示する`see()`関数
* 後退期間にグレーの塗りつぶしを追加する`fukyo()`関数
* 後退期間にグレーの塗りつぶしを追加する`recessions()`デコレーター
* データ・セット
Expand Down
25 changes: 12 additions & 13 deletions py4macro/py4macro.py
Original file line number Diff line number Diff line change
Expand Up @@ -427,28 +427,27 @@ def _create_template(obj, col, width):
return template_dic


def see(obj, col=5, width=70):
def see(obj, col=4, width=70):
"""
オブジェクトの属性を表示する
オブジェクトの属性(`_`もしくは`__`が付いた属性以外)を表示する
引数:
obj: 属性を調べるオブジェクト
col: 表示する際の列の数(デフォルトは5
col: 表示する際の列の数(デフォルトは4
width: 表示の幅(デフォルトは70)
     (列の幅は width/col 以上である最小整数となる)
戻り値:
None (表示のみ)
例:整数型である100の属性を調べる。列は4と指定する。
例:整数型である100の属性を調べる。
see(100, col=4)
see(100)
<実行結果>
as_integer_ratio bit_count bit_length conjugate
denominator from_bytes imag numerator
real to_bytes
<実行結果>
.as_integer_ratio .bit_count .bit_length .conjugate
.denominator .from_bytes .imag .numerator
.real .to_bytes
"""

lst = [i for i in dir(obj) if i[0] != "_"]
Expand All @@ -469,14 +468,14 @@ def see(obj, col=5, width=70):
# create a new inner list with inserted text
inner_lst_new = []
for idx, j in enumerate(template[num]):
inner_lst_new.append(j.format(inner_lst[idx]))
inner_lst_new.append(j.format("."+inner_lst[idx]))

# create concatenated strings for a line to print
line_str = ""
for e in inner_lst_new:
line_str += e
line_str += e+" "

print(line_str)
print(line_str.strip())


# ===== Data-related function =================================================
Expand Down

0 comments on commit 117b651

Please sign in to comment.