Skip to main content

File identification library for Python

Project description

build status pre-commit.ci status

identify

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.

Installation

pip install identify

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):

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

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

  • File type (file, symlink, directory, socket)
  • 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-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

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-2.6.6.tar.gz (99.2 kB view details)

Uploaded Source

Built Distribution

identify-2.6.6-py2.py3-none-any.whl (99.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: identify-2.6.6.tar.gz
  • Upload date:
  • Size: 99.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for identify-2.6.6.tar.gz
Algorithm Hash digest
SHA256 7bec12768ed44ea4761efb47806f0a41f86e7c0a5fdf5950d4648c90eca7e251
MD5 483f3f5f444cf6bb208c21cbb635cc9c
BLAKE2b-256 82bfc68c46601bacd4c6fb4dd751a42b6e7087240eaabc6487f2ef7a48e0e8fc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: identify-2.6.6-py2.py3-none-any.whl
  • Upload date:
  • Size: 99.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for identify-2.6.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cbd1810bce79f8b671ecb20f53ee0ae8e86ae84b557de31d89709dc2a48ba881
MD5 03904453581e4448b63278caccf4eff9
BLAKE2b-256 74a168a395c17eeefb04917034bd0a1bfa765e7654fa150cca473d669aa3afb5

See more details on using hashes here.

Supported by

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