identify

แยกแยะ

ไลบรารีการระบุไฟล์สำหรับ Python

เมื่อได้รับไฟล์ (หรือข้อมูลบางอย่างเกี่ยวกับไฟล์) ให้ส่งคืนชุดแท็กมาตรฐานเพื่อระบุว่าไฟล์นั้นคืออะไร

การติดตั้ง

pip install identify

การใช้งาน

ด้วยไฟล์บนดิสก์

หากคุณมีไฟล์จริงบนดิสก์ คุณสามารถรับข้อมูลได้มากที่สุดเท่าที่จะเป็นไปได้ (เหนือกว่าวิธีการอื่นทั้งหมด):

 >> > from identify import identify
>> > identify . tags_from_path ( '/path/to/file.py' )
{ 'file' , 'text' , 'python' , 'non-executable' }
>> > identify . tags_from_path ( '/path/to/file-with-shebang' )
{ 'file' , 'text' , 'shell' , 'bash' , 'executable' }
>> > identify . tags_from_path ( '/bin/bash' )
{ 'file' , 'binary' , 'executable' }
>> > identify . tags_from_path ( '/path/to/directory' )
{ 'directory' }
>> > identify . tags_from_path ( '/path/to/symlink' )
{ 'symlink' }

เมื่อใช้ไฟล์บนดิสก์ การตรวจสอบจะดำเนินการดังนี้:

• ประเภทไฟล์ (ไฟล์, symlink, ไดเร็กทอรี, ซ็อกเก็ต)
• โหมด (ปฏิบัติการได้หรือไม่)
• ชื่อไฟล์ (ส่วนใหญ่ขึ้นอยู่กับนามสกุล)
• หากสามารถเรียกใช้งานได้ Shebang จะถูกอ่านและล่ามจะตีความ

หากคุณมีเพียงชื่อไฟล์

 >> > identify . tags_from_filename ( 'file.py' )
{ 'text' , 'python' }

หากคุณมีล่ามเท่านั้น

 >> > identify . tags_from_interpreter ( 'python3.5' )
{ 'python' , 'python3' }
>> > identify . tags_from_interpreter ( 'bash' )
{ 'shell' , 'bash' }
>> > identify . tags_from_interpreter ( 'some-unrecognized-thing' )
set ()

เป็นคลี

 $ identify-cli --help
usage: identify-cli [-h] [--filename-only] path

positional arguments:
  path

optional arguments:
  -h, --help       show this help message and exit
  --filename-only

$ identify-cli setup.py ; echo $?
["file", "non-executable", "python", "text"]
0
$ identify-cli setup.py --filename-only ; echo $?
["python", "text"]
0
$ identify-cli wat.wat ; echo $?
wat.wat does not exist.
1
$ identify-cli wat.wat --filename-only ; echo $?
1

การระบุไฟล์ LICENSE

identify ยังมี API สำหรับกำหนดประเภทของใบอนุญาตที่มีอยู่ในไฟล์ รูทีนนี้อิงตามแนวทางที่ผู้รับใบอนุญาตใช้โดยประมาณ (อัญมณีทับทิมที่ github ใช้เพื่อค้นหาใบอนุญาตสำหรับ repo)

แนวทางการ identify การใช้งานมีดังนี้:

1. เพิกถอนบรรทัดลิขสิทธิ์
2. ทำให้ช่องว่างทั้งหมดเป็นปกติ
3. ส่งคืนรายการที่ตรงกันทุกประการ
4. คืนค่าที่ใกล้ที่สุดด้วยระยะทางแก้ไข (โดยที่ระยะทางแก้ไข < 5%)

หากต้องการใช้ API ให้ติดตั้งผ่าน pip install identify[license]

>>> from identify import identify
>>> identify.license_id( ' LICENSE ' )
'MIT'

ค่าที่ส่งคืนของฟังก์ชัน license_id คือ SPDX id ปัจจุบันใบอนุญาตมีที่มาจาก choosealicense.com

มันทำงานอย่างไร

การเรียกไปที่ tags_from_path ทำสิ่งนี้:

1. ประเภทคืออะไร: ไฟล์, symlink, ไดเร็กทอรี? หากไม่ใช่ไฟล์ให้หยุดที่นี่
2. มันปฏิบัติการได้หรือไม่? เพิ่มแท็กที่เหมาะสม
3. เรารู้จักนามสกุลไฟล์หรือไม่? หากเป็นเช่นนั้น ให้เพิ่มแท็กที่เหมาะสม หยุดที่นี่ แท็กเหล่านี้จะรวมไบนารี/ข้อความ
4. ดูที่ X ไบต์แรกของไฟล์ ใช้สิ่งเหล่านี้เพื่อพิจารณาว่าเป็นไบนารี่หรือข้อความ เพิ่มแท็กที่เหมาะสม
5. หากระบุว่าเป็นข้อความด้านบน ให้พยายามอ่านและตีความ Shebang และเพิ่มแท็กที่เหมาะสม

จากการออกแบบ หมายความว่าเราไม่จำเป็นต้องอ่านไฟล์บางส่วนที่เรารู้จักนามสกุลไฟล์