Skip to main content

File identification library for Python

Project description

identify

Build Status Coverage Status PyPI version

File identification library for Python.

Given a file (or some information about a file), return a set of standardized tags identifying what the file is.

Usage

With a file on disk

If you have an actual file on disk, you can get the most information possible (a superset of all other methods):

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

When using a file on disk, the checks performed are:

  • File type (file, symlink, directory)
  • Mode (is it executable?)
  • File name (mostly based on extension)
  • If executable, the shebang is read and the interpreter interpreted

If you only have the filename

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

If you only have the interpreter

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

As a 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 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

Identifying LICENSE files

identify also has an api for determining what type of license is contained in a file. This routine is roughly based on the approaches used by licensee (the ruby gem that github uses to figure out the license for a repo).

The approach that identify uses is as follows:

  1. Strip the copyright line
  2. Normalize all whitespace
  3. Return any exact matches
  4. Return the closest by edit distance (where edit distance < 5%)

To use the api, install via pip install identify[license]

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

The return value of the license_id function is an SPDX id. Currently licenses are sourced from choosealicense.com.

How it works

A call to tags_from_path does this:

  1. What is the type: file, symlink, directory? If it's not file, stop here.
  2. Is it executable? Add the appropriate tag.
  3. Do we recognize the file extension? If so, add the appropriate tags, stop here. These tags would include binary/text.
  4. Peek at the first X bytes of the file. Use these to determine whether it is binary or text, add the appropriate tag.
  5. If identified as text above, try to read and interpret the shebang, and add appropriate tags.

By design, this means we don't need to partially read files where we recognize the file extension.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

identify-1.4.10.tar.gz (95.3 kB view details)

Uploaded Source

Built Distribution

identify-1.4.10-py2.py3-none-any.whl (97.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file identify-1.4.10.tar.gz.

File metadata

  • Download URL: identify-1.4.10.tar.gz
  • Upload date:
  • Size: 95.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.39.0 CPython/3.6.8

File hashes

Hashes for identify-1.4.10.tar.gz
Algorithm Hash digest
SHA256 8ad99ed1f3a965612dcb881435bf58abcfbeb05e230bb8c352b51e8eac103360
MD5 947fd83dcffcebd65e5a7205e9b9eab8
BLAKE2b-256 e3b434bca440f89068052576d04a3cb4d2520525fa002b81cbd9d228e762c331

See more details on using hashes here.

Provenance

File details

Details for the file identify-1.4.10-py2.py3-none-any.whl.

File metadata

  • Download URL: identify-1.4.10-py2.py3-none-any.whl
  • Upload date:
  • Size: 97.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.39.0 CPython/3.6.8

File hashes

Hashes for identify-1.4.10-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 418f3b2313ac0b531139311a6b426854e9cbdfcfb6175447a5039aa6291d8b30
MD5 4c7eae27db0034e39f4d67a232cf4ea4
BLAKE2b-256 d2541b60dc59d42155392d89d91ea11eded49ac45b946d8799617e14d555dcca

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page