Skip to main content

Ultra-lightweight pure Python package to check if a file is binary or text.

Project description

https://img.shields.io/pypi/v/binaryornot.svg?style=flat Documentation Status Updates

Ultra-lightweight pure Python package to guess whether a file is binary or text, using a heuristic similar to Perl’s pp_fttext and its analysis by @eliben.

Status

It works, and people are using this package in various places. But it doesn’t cover all edge cases yet.

The code could be improved. Pull requests welcome! As of now, it is based on these snippets, but that may change:

Features

Has tests for these file types:

  • Text: .txt, .css, .json, .svg, .js, .lua, .pl, .rst

  • Binary: .png, .gif, .jpg, .tiff, .bmp, .DS_Store, .eot, .otf, .ttf, .woff, .rgb

Has tests for numerous encodings.

Why?

You may be thinking, “I can write this in 2 lines of code?!”

It’s actually not that easy. Here’s a great article about how Perl’s heuristic to guess file types works: http://eli.thegreenplace.net/2011/10/19/perls-guess-if-file-is-text-or-binary-implemented-in-python/

And that’s just where we started. Over time, we’ve found more edge cases and our heuristic has gotten more complex.

Also, this package saves you from having to write and thoroughly test your code with all sorts of weird file types and encodings, cross-platform.

Builds

Linux (Ubuntu 12.04 LTS Server Edition 64 bit):

https://img.shields.io/travis/audreyr/binaryornot/master.svg

Windows (Windows Server 2012 R2 (x64)):

https://img.shields.io/appveyor/ci/audreyr/binaryornot/master.svg

Credits

History

0.4.2 (2017-04-12)

0.4.0 (2015-08-21)

  • Enhanced detection for some binary streams and UTF texts. (#10, 11) Thanks @pombredanne.

  • Set up Appveyor for continuous testing on Windows. Thanks @pydanny.

  • Update link to Perl source implementation. (#9) Thanks @asmeurer @pombredanne @audreyr.

  • Handle UnicodeDecodeError in check. (#12) Thanks @DRMacIver.

  • Add very simple Hypothesis based tests. (#13) Thanks @DRMacIver.

  • Use setup to determine requirements and remove redundant requirements.txt. (#14) Thanks @hackebrot.

  • Add documentation status badge to README.rst. (#15) Thanks @hackebrot.

  • Run tox in travis.yml. Add pypy and Python 3.4 to tox environments. (#16) Thanks @hackebrot @pydanny.

  • Handle LookupError when detecting encoding. (#17) Thanks @DRMacIver.

0.3.0 (2014-05-05)

  • Include tests, docs in source package. (#6) Thanks @vincentbernat.

  • Drop unnecessary shebangs and executable bits. (#8) Thanks @scop.

  • Generate string of printable extended ASCII bytes only once. (#7) Thanks @scop.

  • Make number of bytes to read parametrizable. (#7) Thanks @scop.

0.2.0 (2013-09-22)

  • Complete rewrite of everything. Thanks @ncoghlan.

0.1.1 (2013-08-17)

  • Tests pass under Python 2.6, 2.7, 3.3, PyPy.

0.1.0 (2013-08-17)

  • First release on PyPI.

Project details


Download files

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

Source Distribution

binaryornot-0.4.2.tar.gz (370.8 kB view details)

Uploaded Source

Built Distribution

binaryornot-0.4.2-py2.py3-none-any.whl (8.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file binaryornot-0.4.2.tar.gz.

File metadata

  • Download URL: binaryornot-0.4.2.tar.gz
  • Upload date:
  • Size: 370.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for binaryornot-0.4.2.tar.gz
Algorithm Hash digest
SHA256 055c7515ec18e55491c74cdf99b67945d235ca91afb65614128e6d37fee66d1d
MD5 98fd6f68433a453d8513c5230c4fa17f
BLAKE2b-256 a3fc79c9a88d1a56d93fbf4851c933ed9ab5c96a00f3ad8e5e3f12aa99d5df82

See more details on using hashes here.

File details

Details for the file binaryornot-0.4.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for binaryornot-0.4.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b2ec5159b049f7cc99fd212a2bb1c6b52df3faf9379d8f2048aea0bf22cecb9f
MD5 c7088557fd0af3683aa9cf7443e22c93
BLAKE2b-256 85737fd9218da66e41bf62444dfaffd9aac7a4eaa2cf805a0170cd5e3a228382

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 Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page