แปลง kebab-case เป็น snake_case!

ข้อความตัวอักษร
ผลลัพธ์

แปลง kebab-case เป็น snake_case!

การตั้งชื่อตัวแปรในโค้ดที่คัดลอกจากที่อื่นไม่ตรงกับโค้ดของคุณใช่ไหม? ไม่ต้องกังวล! แปลงตัวแปรให้เป็นรูปแบบที่ต้องการ!

สลับขีดกลางเป็นขีดล่างในชื่อแบบ kebab-case: order-history → order_history path ของ URL, query parameter, แฟล็ก CLI และชื่อไฟล์มักมีขีดกลาง ขณะที่ตัวแปร Python คอลัมน์ SQL และ schema ของงานวิเคราะห์หรือ logging จำนวนมากยอมรับแค่ขีดล่าง

วาง route คีย์ของ query หรือชื่อแฟล็ก แล้วจะได้ identifier ที่ใช้ในโค้ด Python คอลัมน์ฐานข้อมูล หรือพร็อพเพอร์ตีของ event ได้

วิธีใช้

  1. เลือก kebab-case เป็นต้นทางและ snake_case เป็นปลายทาง
  2. วาง URL, query string หรือชื่อ option ลงใน ข้อความตัวอักษร
  3. คัดลอกข้อความที่เปลี่ยนชื่อแล้วจาก ผลลัพธ์

ตัวอย่าง

อินพุต (kebab-case)
GET /api/order-history?page-size=20
GET /api/gift-cards/balance-check
เอาต์พุต (snake_case)
GET /api/order_history?page_size=20
GET /api/gift_cards/balance_check

ช่วงของ path และคีย์ query page-size ถูกแปลง ส่วน GET, /api และตัวเลข 20 ไม่ถูกแตะต้อง

ฟีเจอร์ที่รองรับ

  • แทนขีดกลางแต่ละตัวภายในชื่อด้วยขีดล่าง: balance-check → balance_check
  • เก็บเครื่องหมายทับ ?, = และตัวอักษรอื่นของ URL ที่อยู่รอบชื่อไว้
  • ปล่อยวันที่และหมายเลขเวอร์ชันอย่าง 2024-01-01 ไว้ตามเดิม

กรณีการใช้งาน

จากชื่อ route ไปเป็น handler ของ Python

path ของ Flask และ FastAPI อย่าง /gift-cards/balance-check มักจับคู่กับฟังก์ชันชื่อ balance_check การแปลงรายการ route จะได้ชื่อฟังก์ชันที่ต้องเขียน

จาก parameter สำหรับ tracking ไปเป็นคอลัมน์ใน warehouse

query parameter อย่าง utm-source หรือ ref-code ที่ไปลงใน BigQuery หรือ Snowflake มักถูกเก็บเป็นคอลัมน์ utm_source, ref_code

ข้อควรระวังและข้อจำกัด

  • ช่วงที่เป็นตัวเลขก็ถูกแปลง: item-2 กลายเป็น item_2 ซึ่งยังเป็น identifier ที่ถูกต้องของ Python
  • ชื่อโดเมนที่มีขีดกลางก็ถูกแปลงด้วย (my-shop.com → my_shop.com) อย่าใส่ host ในอินพุต

คำถามที่พบบ่อย

ผลลัพธ์ใช้เป็น identifier ของ Python ได้อย่างปลอดภัยไหม?

สำหรับชื่อที่ประกอบด้วยตัวอักษรและขีดกลาง ได้ แต่ถ้าชื่อขึ้นต้นด้วยตัวเลข Python ก็ยังไม่รับเป็น identifier

argparse ของ Python ต้องใช้สิ่งนี้ไหม?

ไม่ต้อง argparse เปลี่ยน --dry-run เป็น args.dry_run ให้อยู่แล้ว หน้านี้สำหรับเมื่อต้องการเขียนชื่อเหล่านั้นที่อื่น เช่น คีย์คอนฟิกหรือเอกสาร