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，并添加适当的标签。

根据设计，这意味着我们不需要部分读取我们识别文件扩展名的文件。