python click 如何避免參數中的通配符被展開

在這篇討論中有被提到
Expand globs in arguments on Windows? · Issue #1096 · pallets/click (github.com)

click預設會通過 glob 展開通配符這是為了確保在 Windows 或 Linux 上能獲得一致的效果
不過反過來說如果你就是要傳入通配符，其實沒有任何手段可以避免的，原作似乎就沒開放了

討論的最後有提到改進在這裡
expand patterns in Windows args by davidism · Pull Request #1830 · pallets/click (github.com)

那就沒辦法只能硬幹了，就把這代碼幹掉

import click

# 定義一個新的 _expand_args 函數，直接返回原始參數
def _no_expand_args(args):
    return args
# 猴子補丁覆蓋 Click 的 _expand_args 方法
from click import core
core._expand_args = _no_expand_args

@click.command()
@click.argument('path', type=str)
def process_path(path):
    click.echo(f"Received path: {path}")

if __name__ == '__main__':
    process_path()

這樣一來就不會被騷擾了，反過來說你也可以在這裡寫上屬於自己的條件

上面是簡寫完整一點的整個函式其實是長這樣的

# 定義一個新的 _expand_args 函數，直接返回原始參數
import typing as t
def _no_expand_args(
    args: t.Iterable[str],
    *,
    user: bool = True,
    env: bool = True,
    glob_recursive: bool = True,
) -> t.List[str]:
    return list(args)
# 猴子補丁覆蓋 Click 的 _expand_args 方法
from click import core
core._expand_args = _no_expand_args

原始代碼可以在這裡看，可以參考是如何用 glob 展開變數的
click/src/click/utils.py at 923d197b56caa9ffea21edeef5baf1816585b099 · pallets/click (github.com)

補充說明一下流程，我覺得 click 原作這個解不夠漂亮，但確實已經是沒有辦法中的一個還算可以的辦法了。

原作的做法是收到來自命令的參數時，就先進行展開，不管是 option 還是 augument 都會被展開，這個有個問題是

在 linux 上 bash 會直接展開後才輸入，所以實際 click 拿到的參數已經是展開後的，但是有個例外是在 bash 中如果輸入雙引號就不會被展開

問題就在這裡，click是拿到參數之後不管如何總之每個都過一輪 glob 就對了，所以最終還是會被展開，等於摁還是會被展開。

好處就是統一了 windwos 跟 linux 的結果，犧牲輸入*號的可能性，click這一層無法關閉沒機會輸入了。

不過其實有bug可以卡，但不在討論範圍的內先拉出來講，就別槓這個了。透過這個方式 `myapp -p"*.py"` 或是全寫也行，這樣過 glob 的時時候由於長的不是路徑樣就不會被展開了

繼續回來原本的話題，這個要比較合理的解決，估計還是只能開放 glob 的自由度吧，預設不要開，自己決定要不要展開，而且最好還是可以決定系統層級的 `glob_win=Ture`, `glob_unix=Ture`。

這樣至少 linux 上還可以保持透過雙引號控制要不要展開，而Windwos這沒辦法了終端機本來就不會展開了，不管雙不雙引號都一樣。

兩邊系統的統一性我覺得不是那個重要，對於 win 本來就要知道系統不會幫你展開，對於 unix 本來就要知道系統會擅自展開。

函式只需要提供一個快捷讓你自己決定要不要賭這個洞。

PowerShell 通配符 Get-Item 無法帶有方括號名稱的檔案

這算是 PowerShell 5.1 預設給的方便的，不過在不知情的情況下就造成bug了

假設有一個 [1]File.txt 的檔案，於是就這樣獲取

Get-Item [1]File.txt

居然什麼都沒有，於是乎聰明如你，用引號總能解吧?

Get-Item "[1]File.txt"
Get-Item '[1]File.txt'

想不到吧很遺憾還是沒有辦法

這東西叫做通配符，內建在 Get-Item 裡的所才沒法通過引號處理的
about Wildcards - PowerShell | Microsoft Learn

情況1

如果你只是單純想解決括號問題，沒有要搞通配符號組合，參考這個就能解了。

# 使用函式接口 LiteralPath (就是拒用萬用符拉)
Get-Item -LiteralPath 'Test[1]'.txt

# 連帶反轉意符號一起傳進去
Get-Item '.\Test`[1`].txt'

# 如果用雙引號圍住的話傳入前就會被解掉要多2個反引號
Get-Item ".\Test```[1```].txt"

情況2

另一個坑是當括號與星號一起出現時，又會導致另一個解析問題，括號被當作通佩服一起解釋了，就是你想匹配 Test[*].txt 多個檔案的時候。

這時候情況更複雜了一些，你得連反引號都一起傳進去才能，免得反引號在傳入的當下被解析了少了一次解析。

# 連帶反轉意符號一起傳進去
Get-Item '.\Test``[*``].txt'

# 雙引號的話更精彩一點，堪稱這在衝三小
Get-Item ".\Test`````[*`````].txt"

測試結果

情況3

2024-09-28 發現一個新問題 'Test``[*``].txt' 實際上匹配的並不是 Test[*].txt 而是 Test*.txt，說起來繞口，原因是那個方括號被當作萬用字解讀了。

如何更明白的理解問題可以看下面這個例子

# 匹配檔名為 Test[0].txt, Test[1].txt 的檔案
Get-Item '.\Test``[[0-1]``].txt'

這樣寫出來應該就很好理解了，因為萬用字的匹配是在 cmdlet 裡面做的，所以才導致這個反人類思維的解...

第一層反引號會在傳入的時候被解掉，此時算法實際吃到的是一個反引號的 `[ 所以她成功識別是一個引號，第二個由於就是引號沒什麼好說的吃到引號當作萬用字解讀。

也就是可以理解成 [0-1] 這東西會被當作一個特殊字串對待，剩下的保持原本模樣。

那為什麼 '.\Test`[1`].txt' 能夠被正確識別呢? 因為 [1] 沒有構成合法的萬用字元所以被當作字串解讀了 (這鬼邏輯...雖然是正確的但別這樣設計搞人啊)

情況4

以為這樣就結束了嗎? 不還有一個更鬼畜，記得先溫得好情況3的神奇邏輯，這是同一套邏輯的變態版，現在考慮到檔名含有雙引號的情況

# 匹配檔名為 Test`[0].txt, Test`[1].txt 的檔案
Get-Item '.\Test``````[[0-1]``].txt'

居然是要添加4個引號? 是的這個邏輯的是正確，因為傳入的時候會被吃掉一次只剩2個，真正在運算的時候又被吃掉一次只剩1個，所以正確的識別了

這個鬼邏輯來自於，不知道為啥路徑相關的cmdlet會對路徑做一次多餘的雙引號解析導致的，啥原因設計成這樣就不知道了。

下面是測試的方法，看了應該就秒懂上面的 情況4 發生什麼事情了
 (注意雙引號與單引號)

# 模擬 Get-Item 是如何處理萬用字元的
'.\Test`[1].txt' -like ".\Test``````[[0-1]``].txt"

對他們是相等的...也就是說對於所有路徑相關的 Get-Item, Test-Path 等等必須自己有自覺的認識到，即使我用了單引號避免被解釋，但實務上進去還會被解析一次。

這個真該打屁股了誰寫的反人類設計...

不過嘴砲歸嘴砲，八成是身處歷史當下的那群人，遇到某個無法解決的問題，提出的無可奈何的解吧...。現在好拉已經過這麼久了，想修估計也改不了了，成為萬世毒瘤了

對於這個局面的處置方法

對於這個局面要人性化的處置可以參考這下面這個解法

# 匹配的真實路徑 Test`[1].txt
Test-Path ('Test```[[0-1]`].txt' -replace('`','``'))
Test-Path ('Test```[*`].txt' -replace('`','``'))

這少這樣理解度就高一點了，為什麼會有三個是因為需要反轉意一個反引號跟方括號導致的，是可以讀懂的代碼。

參考

1. Wildcard matching when filename has square brackets · PowerShell/PowerShell · Discussion #18146 (github.com)
2. 
   

Linux 中仿 tree 輸出的 Shell 檔案

2024-05-29 一個比較完整的檔案寫完了放在gist上 Tree.sh (github.com)

某些環境基於某些原因實在是沒辦法，只能自己自幹一個這邊給一個 GPT 的作品，最基本基本的功能是有了

tree.sh

#!/bin/bash

# Function to print the folder name with color
function print_folder() {
    local folder_name=$1
    local COLOR_RESET="\033[0m"
    local COLOR_FOLDER="\033[1;34m" # Blue color for folders
    echo -e "${COLOR_FOLDER}${folder_name}/${COLOR_RESET}"
}

# Function to recursively print the directory tree structure
function print_tree() {
    local directory=$1
    local prefix=$2
    local files=("$directory"/*)
    local last_index=$((${#files[@]} - 1))

    # Check if the directory is empty
    if [ "$files" = "$directory/*" ]; then
        return
    fi

    for i in "${!files[@]}"; do
        local file="${files[$i]}"
        local basename=$(basename "$file")
        local new_prefix="$prefix"

        if [ $i -eq $last_index ]; then
            echo -n "${prefix}└── "
            new_prefix="$prefix    "
        else
            echo -n "${prefix}├── "
            new_prefix="$prefix│   "
        fi

        if [ -d "$file" ]; then
            print_folder "$basename"
            print_tree "$file" "$new_prefix"
        else
            echo "$basename"
        fi
    done
}

# Check if a directory is provided as an argument
if [ -z "$1" ]; then
    echo "Usage: $0 <directory>"
    exit 1
fi

# Remove trailing slash from the directory if it exists
directory=$(echo "$1" | sed 's:/*$::')

# Print the initial directory with color
print_folder "$(basename "$directory")"
print_tree "$directory" ""

使用的話跟 tree 差不多沒兩樣先給執行權限

chmod +x tree.sh

然後使用

./tree.sh testdir

輸出結果

testdir/
├── file1.txt
├── file2.txt
├── subdir1/
│   ├── file2.txt
│   ├── file3.txt
│   ├── subsubdir1/
│   │   └── file4.txt
│   └── subsubdir2/
│       └── file5.txt
└── subdir2/
    ├── file3.txt
    ├── file6.txt
    └── subsubdir1/
        └── file7.txt

精簡高壓版本

邏輯一樣的只是完全不管可讀性，能壓能壓版本

tree(){
    [ -z "$1" ] && { echo "Usage: $0 <directory>"; exit 1; }
    print_folder() { echo -e "\\033[1;34m${1}/\\033[0m"; }
    print_tree() { local dir=$1 prefix=$2; local files=("$dir"/*)
        print_tree_core() { [ $1 -ge ${#files[@]} ] && return
            local idx=$1; local file="${files[$idx]}"
            local base=$(basename "$file") new_prefix="$prefix"
            ([ $idx -eq $((${#files[@]} - 1)) ]) && {
                echo -n "${prefix}└── "; new_prefix="$prefix    "
            } || { echo -n "${prefix}├── "; new_prefix="$prefix│   "
            }; ([ -d "$file" ] && {
                print_folder "$base"; print_tree "$file" "$new_prefix"
            } || echo "$base"); print_tree_core $(($idx + 1))
        }; [ "$files" = "$dir/*" ] && return || print_tree_core 0
    }; dir=$(echo "$1" | sed 's:/*$::')
    print_folder "$(basename "$dir")"; print_tree "$dir" ""
}

貼上之後直接呼叫 tree 就可以用了 (要是原本就有會被覆蓋功能，被蓋了重啟終端就好)

tree testdir

增加顯示有多少個檔案

tree(){
    [ -z "$1" ] && { echo "Usage: $0 <directory>"; exit 1; }
    print_folder() { echo -e "\\033[1;34m${1}/\\033[0m"; }
    print_tree() { local dir=$1 prefix=$2; local files=("$dir"/*)
        print_tree_core() { [ $1 -ge ${#files[@]} ] && return
            local idx=$1; local file="${files[$idx]}"
            local base=$(basename "$file") new_prefix="$prefix"
            ([ $idx -eq $((${#files[@]} - 1)) ]) && {
                echo -n "${prefix}└── "; new_prefix="$prefix    "
            } || { echo -n "${prefix}├── "; new_prefix="$prefix│   "
            }; [ -d "$file" ] && { dir_cnt=$((dir_cnt + 1))
                print_folder "$base"; print_tree "$file" "$new_prefix"
            } || { echo "$base"; file_cnt=$((file_cnt + 1))
            }; print_tree_core $(($idx + 1))
        }; [ "$files" = "$dir/*" ] && return || print_tree_core 0
    }; dir=$(echo "$1" | sed 's:/*$::')
    print_folder "$(basename "$dir")"; dir_cnt=0; file_cnt=0
    print_tree "$dir"; echo -e "\n$dir_cnt directories, $file_cnt files"
}

增加顯示隱藏檔案

tree(){
    [ -z "$1" ] && { echo "Usage: $0 <directory>"; exit 1; }
    print_folder() { echo -e "\\033[1;34m${1}/\\033[0m"; }
    print_tree() { local dir=$1 prefix=$2; local files
        files=("${dir}"/.* "${dir}"/*); files=(${files[@]/*\*/})
        print_tree_core() { [ $1 -ge ${#files[@]} ] && return
            local idx=$1; local file="${files[$idx]}"
            local base=$(basename "$file") new_prefix="$prefix"
            ([ "$base" == "." ] || [ "$base" == ".." ]) && {
                print_tree_core $(($idx + 1)); return
            }; ([ $idx -eq $((${#files[@]} - 1)) ]) && {
                echo -n "${prefix}└── "; new_prefix="$prefix    "
            } || { echo -n "${prefix}├── "; new_prefix="$prefix│   "
            }; [ -d "$file" ] && { dir_cnt=$((dir_cnt + 1))
                print_folder "$base"; print_tree "$file" "$new_prefix"
            } || { echo "$base"; file_cnt=$((file_cnt + 1))
            }; print_tree_core $(($idx + 1))
        }; [ ${#files[@]} -eq 0 ] && return || print_tree_core 0
    }; dir=$(echo "$1" | sed 's:/*$::')
    print_folder "$(basename "$dir")"; dir_cnt=0; file_cnt=0
    print_tree "$dir"; echo -e "\n$dir_cnt directories, $file_cnt files"
}

魔法咒語

最後是魔法咒語，特地用函式包起來是要把路徑後置到後面，方便貼上直接些改

_(){ d=$(realpath "$1"); echo "$d"; find "$1" | sort | sed '1d;s|^'"$1"'| |;s/\/\([^/]*\)$/|-- \1/;s/\/[^/|]*/|   /g'; };_ .

為什麼要用醜醜的 |-- 而不是更漂亮的 └── 是因為，用 Ascii 以外的符號很容易就噴亂碼，自己根據情況斟酌使用吧

ASCII 顏色碼 綠色成功 與 紅色失敗

ASCII 顏色碼 綠色成功 Success 與 紅色失敗

偶爾用到每次都要查 gpt 查到煩了寫一份備用下來

# 綠色成功
echo -e "\033[42mSuccess\033[0m"
# 紅色失敗
echo -e "\e[41mFailure\e[0m"

​

WSL 安裝 ssh 並更改 port 設置自動啟動

預設狀態是不會自動啟動的而且 port 可能與主機端有衝突，視情況可以自行改成 2222 口這樣可以避開 Windows 本身如果也有 ssh 的話。

安裝並配置 OpenSSH

首先，確保已安裝 OpenSSH 伺服器：

sudo apt update
sudo apt install openssh-server

1. 設定 SSH 端口與密碼登入

編輯 SSH 設定檔：

sudo nano /etc/ssh/sshd_config

1. 找到 Port 行，並修改為你所要的或保持預設就 22
2. 找到 PasswordAuthentication  行，並修改為 yes

Port 22
PasswordAuthentication yes

儲存並退出 (Ctrl+S 然後 Ctrl+X)。

這裡預設值其實本來就是 22 ，只是為了示範如何修改而特地寫出來

2. 設定 SSH 伺服器開機自動啟動

設置 systemd 服務管理器：

sudo systemctl enable ssh

必須開著 WSL 視窗才會生效（這服務 systemctl 其實是由 wsl.conf 文件間接啟動的）

如果是舊版的 wsl 不支持 systemctl 請這裡編輯 /etc/wsl.conf 文件：

sudo nano /etc/wsl.conf

在文件末尾添加以下內容：

command="service ssh start"

保存文件（按 Ctrl + O），然後退出編輯器（按 Ctrl + X）。

4. 重啟 WSL

在 Windows 命令提示字元或 PowerShell 中執行：

wsl --shutdown

然後再次打開 WSL 後，SSH 伺服器應該會自動啟動並使用設定的端口。

在 WSL 中執行以下命令確認 SSH 伺服器是否正在運行：

sudo service ssh status

從主機端以 SSH 連接 WSL

打開主機端的 PowerShell 嘗試從主機端連接 WSL：

ssh -p 22 your_username@localhost

這裡 -p 的選項預設值就是 22，如果沒有改 port 可以省略不打

[番外篇] 在 WSL 中添加允許的公鑰

在 WSL 中創建 .ssh 目錄並設置適當的權限：

mkdir -p ~/.ssh
chmod 700 ~/.ssh

已經存在則無需建立

將你想要使用的公鑰添加到 authorized_keys 文件中：

nano ~/.ssh/authorized_keys

已經存在則無需建立

將公鑰貼上到此文件中，然後保存並退出。設置 authorized_keys 文件的權限：

chmod 600 ~/.ssh/authorized_keys

參考

1. 適用於 Windows 的 OpenSSH 中的金鑰型驗證 | Microsoft Learn
2. 開始使用適用於 Windows 的 OpenSSH | Microsoft Learn

Python 如何使用 boxsdk 獲取 Box Accese Token

繼上一篇
CHG: Python 如何使用 Json 通過 JWT 請求獲取 Box Accese Token (不使用boxsdk)

詳細介紹了如何手動請求，這裡介紹 boxsdk 的使用方法

安裝 boxsdk[jwt]

參考這裡官方安裝的教學
box/box-python-sdk: Box SDK for Python (github.com)

他有分兩個版本記得後面要括號 jwt 會多裝一些基本套件

pip install "boxsdk[jwt]"

單純的執行就可以安裝好了

方法1 直接直接導入 json 檔案

參考自官方的這篇文章
JWT with SDKs - Box Developer Documentation

以及這裡的教學
BOX API（JWT認証）をPythonで使ったときの備忘録 #Python - Qiita

from boxsdk import JWTAuth
from boxsdk import Client

# JSON 檔案的路徑
CONFIG_FILE = 'config.json'

# 準備使用 BOX API
auth = JWTAuth.from_settings_file(CONFIG_FILE)
client = Client(auth)

# 獲取並顯示用戶資訊（API 測試）
user = client.user().get()
print(f'用戶名稱: {user.name} (ID: {user.id}), 電子郵件: {user.login}')

如此就能輕鬆導入了

方法2 手動導入 JWT物件

這裡是手動從 json 中抽取出數據，並導入 JWT 物件的方法

import json
from boxsdk import Client, JWTAuth

# 加載官方 JSON 檔案
with open('config.json') as json_file:
    config = json.load(json_file)

# 創建 JWTAuth 認證對象
auth = JWTAuth(
    client_id=config['boxAppSettings']['clientID'],
    client_secret=config['boxAppSettings']['clientSecret'],
    enterprise_id=config['enterpriseID'],
    jwt_key_id=config['boxAppSettings']['appAuth']['publicKeyID'],
    rsa_private_key_data=config['boxAppSettings']['appAuth']['privateKey'].replace('\\n', '\n'),
    rsa_private_key_passphrase=config['boxAppSettings']['appAuth']['passphrase']
)

# 獲取訪問令牌
access_token = auth.authenticate_instance()
print(f"訪問令牌: {access_token}")

# 使用訪問令牌創建 Box 客戶端
client = Client(auth)

# 認證並獲取當前用戶資訊
user = client.user().get()
print(f'用戶名稱: {user.name} (ID: {user.id}), 電子郵件: {user.login}')

本質上跟 方法1 跑的是一樣的代碼只是拉出來手動做而已。