Python commandline-config簡潔命令行配置工具： 一個供用戶以Python Dict或JSON格式編寫（科研中實驗）配置的庫，同時可以從命令行中讀取參數

本文介紹了一個可以直接用pip安裝的python工具包commandline-config，適合經常寫python代碼跑實驗的研究生們，工具可以通過Python原生字典dict（支持嵌套）的形式來寫實驗的參數配置，同時可以通過命令行傳參的方式以及代碼直接賦值的方式來修改參數值。同時，工具還有配置拷貝，保存到本地或資料庫，傳參給函數等功能，以及參數完整性檢查，參數值類型檢查功能以保證代碼或命令行參數不會寫錯，歡迎有需要的朋友使用。

工具可通過pip install commandline_config直接安裝使用。

Github 網址

請您Star

如果您覺得此工具不錯，請輕輕點擊github頁面右上角Star按鈕增加項目曝光度，謝謝！

簡單使用示例圖

example.py

則在命令行中，可通過--dataset cifar10來給dataset參數賦值為字元串cifar10：

python example.py --dataset cifar10 --lr 0.001 --normalization --multi-information [1,[],[2,[3]]]

原來需要用argparse寫的很多行的代碼，現在使用此工具之後只需兩行即可，並且代碼結果更加清晰，易於理解：

配置文件支持嵌套，並可通過.的方式訪問和修改屬性值：

嵌套配置設置

配置文件支持以直接通過print列印，並以表格或json形式呈現：

開發原因

對於經常跑科研實驗的朋友們，大家是不是經常需要在python文件開頭設置大量的命令行參數，併在下方代碼中以args.*的方式調用：

比如下麵的這段示例：

parser = argparse.ArgumentParser(description='index')
parser.add_argument('--index', default=0, type=int, help='party index')
parser.add_argument('--party_num', default=100, type=int)
args = parser.parse_args()

print(args.index)

每多一個參數，代碼中就會多一行parser.add_argument，手寫每個參數的配置時會很繁瑣，如名稱需要加--，還有修改預設值，類型以及描述的時候很麻煩，最後也會導致自己的代碼很冗長，維護不便。

就算用了更高級一點的Click，也需要不停的寫option, 而且有幾個option對應函數就要寫幾個輸入參數與之匹配，寫代碼實在是繁瑣，比如以下Click代碼：

import click

from caesar_encryption import encrypt

@click.command()
@click.argument('text', nargs=-1)
@click.option('--decrypt/--encrypt', '-d/-e')
@click.option('--key', '-k', default=1)
def caesar(text, decrypt, key):
    text_string = ' '.join(text)
    if decrypt:
        key = -key
    cyphertext = encrypt(text_string, key)
    click.echo(cyphertext)

if __name__ == '__main__':
    caesar()

我並不想在寫代碼的時候反覆指定option選項，併在函數名參數欄寫一大堆對應參數，麻煩的很。

因此，如果可以在代碼中通過Python對象/JSON的形式寫參數配置，會不會就讓代碼看得更加結構化，更清晰呢？

同時，能不能直接將命令行參數當做Python對象進行讀寫，深拷貝等操作，就如同沒有配置過命令行參數一樣？

能不能很方便的將一次實驗的配置保存到本地文件或者插入如mongodb這樣的資料庫中？

另一個問題，能不能保證自己在傳遞命令行參數或者在python代碼中修改鍵值的時候不會出現如參數名稱寫錯，或者賦值的參數值的類型與初始設置類型不匹配的問題？

最重要的是，能不能讓寫代碼的速度變的很快，而不需要一行一行的添加一點一點的配置呢？

為瞭解決以上痛點，因此開發了此工具。

我的目標是讓大家用更加簡單的寫出和繁瑣的argparse或click這類命令行解析包一樣的效果的代碼，同時讓配置看起來結構化簡潔化，選擇json格式是因為Python字典類型dict原生就是json格式，所以可以做到和Python代碼格式保持一致，從而使我們可以將配置信息直接嵌入到Python代碼文件中（任意位置），而不需要建立類似toml這樣單獨的配置文件，同時，此庫也可以在代碼文件的任意位置寫配置以讀取命令行參數以及隨時修改配置各欄位值的功能等。

簡潔命令行配置工具

一個供用戶以Python Dict或JSON格式編寫（科研中實驗）配置的庫，同時可以從命令行中讀取參數。

文檔目錄
- [請您Star](#請您star)
- [簡潔命令行配置工具](#簡潔命令行配置工具)
- [目錄](#目錄)
- [使用方式](#使用方式)
- [請提出issue](#請提出issue)
- [安裝方法](#安裝方法)
- [配置方式](#配置方式)
- [配置參數讀寫方式](#配置參數讀寫方式)
- [寫入方式](#寫入方式)
- [讀取方式](#讀取方式)
- [傳遞配置給函數](#傳遞配置給函數)
- [拷貝配置](#拷貝配置)
- [配置參數存儲至本地或資料庫](#配置參數存儲至本地或資料庫)
- [註意事項](#註意事項)
- [與Argparse衝突](#與argparse衝突)
- [輸入值會自動強制轉換為預設值對應類型](#輸入值會自動強制轉換為預設值對應類型)
- [list參數賦值時字元串元素引號前需加反斜線](#list參數賦值時字元串元素引號前需加反斜線)
- [參數命名規範](#參數命名規範)
- [嵌套對象目前只支持一層](#嵌套對象目前只支持一層)
- [參數完整性檢查，所有要修改的參數必須預定義](#參數完整性檢查所有要修改的參數必須預定義)
- [ZSH環境特殊配置](#zsh環境特殊配置)
- [完整轉換示例](#完整轉換示例)

具體安裝和使用方式，請參考github中文文檔：