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' }

當使用磁碟上的檔案時，執行的檢查是：

• 檔案類型（檔案、符號連結、目錄、套接字）
• 模式（可執行嗎？）
• 檔案名稱（主要基於副檔名）
• 如果可執行，則讀取 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 ()

作為一個cli

 $ 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 用於確定儲存庫許可證的 ruby​​ gem）。

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. 什麼是類型：檔案、符號連結、目錄？如果不是文件，則到此為止。
2. 它可以執行嗎？添加適當的標籤。
3. 我們能辨識檔案副檔名嗎？如果是這樣，請添加適當的標籤，到此為止。這些標籤將包括二進位/文字。
4. 查看文件的前 X 個位元組。使用這些來確定它是二進制還是文本，並添加適當的標籤。
5. 如果識別為上面的文本，請嘗試閱讀和解釋 shebang，並添加適當的標籤。

根據設計，這意味著我們不需要部分讀取我們識別檔案副檔名的檔案。