1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
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.
Home-page: https://github.com/audreyr/binaryornot
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
=============================
.. image:: https://img.shields.io/pypi/v/binaryornot.svg?style=flat
:target: https://pypi.python.org/pypi/binaryornot
.. image:: https://readthedocs.org/projects/binaryornot/badge/?version=latest
:target: http://binaryornot.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://pyup.io/repos/github/audreyr/binaryornot/shield.svg
:target: https://pyup.io/repos/github/audreyr/binaryornot/
: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
* Documentation: https://binaryornot.readthedocs.io
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:
* http://stackoverflow.com/questions/898669/how-can-i-detect-if-a-file-is-binary-non-text-in-python
* http://stackoverflow.com/questions/1446549/how-to-identify-binary-and-text-files-using-python
* http://code.activestate.com/recipes/173220/
* http://eli.thegreenplace.net/2011/10/19/perls-guess-if-file-is-text-or-binary-implemented-in-python/
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):
.. image:: https://img.shields.io/travis/audreyr/binaryornot/master.svg
:target: https://travis-ci.org/audreyr/binaryornot
Windows (Windows Server 2012 R2 (x64)):
.. image:: https://img.shields.io/appveyor/ci/audreyr/binaryornot/master.svg
:target: https://ci.appveyor.com/project/audreyr/binaryornot
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
.. _`@scop`: https://github.com/scop
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.
|
