Source code

Revision control

Copy as Markdown

Other Tools

Metadata-Version: 2.0
Name: binaryornot
Version: 0.4.4
Summary: Ultra-lightweight pure Python package to check if a file is binary or text.
Author: Audrey Roy Greenfeld
Author-email: aroy@alum.mit.edu
License: BSD
Keywords: binaryornot
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: chardet (>=3.0.2)
=============================
BinaryOrNot
=============================
:alt: Documentation Status
:alt: 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.
* Free software: BSD license
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
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):
Windows (Windows Server 2012 R2 (x64)):
Credits
-------
* Special thanks to Eli Bendersky (@eliben) for his writeup explaining the heuristic and his implementation, which this is largely based on.
* Source code from the portion of Perl's `pp_fttext` that checks for textiness: https://github.com/Perl/perl5/blob/v5.23.1/pp_sys.c#L3527-L3587
History
-------
0.4.4 (2017-04-13)
~~~~~~~~~~~~~~~~~~
* Notify users for file i/o issues. Thanks @lukehinds!
0.4.3 (2017-04-13)
~~~~~~~~~~~~~~~~~~
* Restricted chardet to anything 3.0.2 or higher due to https://github.com/chardet/chardet/issues/113. Thanks @dan-blanchard for the quick fix!
0.4.2 (2017-04-12)
~~~~~~~~~~~~~~~~~~
* Restricted chardet to anything under 3.0 due to https://github.com/chardet/chardet/issues/113
* Added pyup badge
* Added utilities for pushing new versions up
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`_.
.. _`@pombredanne`: https://github.com/pombredanne
.. _`@pydanny`: https://github.com/pydanny
.. _`@asmeurer`: https://github.com/asmeurer
.. _`@audreyr`: https://github.com/audreyr
.. _`@DRMacIver`: https://github.com/DRMacIver
.. _`@hackebrot`: https://github.com/hackebrot
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`_.
.. _`@vincentbernat`: https://github.com/vincentbernat
0.2.0 (2013-09-22)
~~~~~~~~~~~~~~~~~~
* Complete rewrite of everything. Thanks `@ncoghlan`_.
.. _`@ncoghlan`: https://github.com/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.