# python-magic
[](https://badge.fury.io/py/python-magic)
[](https://travis-ci.org/ahupp/python-magic) [](https://gitter.im/ahupp/python-magic?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
python-magic is a Python interface to the libmagic file type
identification library. libmagic identifies file types by checking
their headers according to a predefined list of file types. This
functionality is exposed to the command line by the Unix command
`file`.
## Usage
```python
>>> import magic
>>> magic.from_file("testdata/test.pdf")
'PDF document, version 1.2'
# recommend using at least the first 2048 bytes, as less can produce incorrect identification
>>> magic.from_buffer(open("testdata/test.pdf", "rb").read(2048))
'PDF document, version 1.2'
>>> magic.from_file("testdata/test.pdf", mime=True)
'application/pdf'
```
There is also a `Magic` class that provides more direct control,
including overriding the magic database file and turning on character
encoding detection. This is not recommended for general use. In
particular, it's not safe for sharing across multiple threads and
will fail throw if this is attempted.
```python
>>> f = magic.Magic(uncompress=True)
>>> f.from_file('testdata/test.gz')
'ASCII text (gzip compressed data, was "test", last modified: Sat Jun 28
21:32:52 2008, from Unix)'
```
You can also combine the flag options:
```python
>>> f = magic.Magic(mime=True, uncompress=True)
>>> f.from_file('testdata/test.gz')
'text/plain'
```
## Installation
The current stable version of python-magic is available on PyPI and
can be installed by running `pip install python-magic`.
Other sources:
- PyPI: http://pypi.python.org/pypi/python-magic/
- GitHub: https://github.com/ahupp/python-magic
This module is a simple wrapper around the libmagic C library, and
that must be installed as well:
### Debian/Ubuntu
```
sudo apt-get install libmagic1
```
### Windows
You'll need DLLs for libmagic. @julian-r maintains a pypi package with the DLLs, you can fetch it with:
```
pip install python-magic-bin
```
### OSX
- When using Homebrew: `brew install libmagic`
- When using macports: `port install file`
### Troubleshooting
- 'MagicException: could not find any magic files!': some
installations of libmagic do not correctly point to their magic
database file. Try specifying the path to the file explicitly in the
constructor: `magic.Magic(magic_file="path_to_magic_file")`.
- 'WindowsError: [Error 193] %1 is not a valid Win32 application':
Attempting to run the 32-bit libmagic DLL in a 64-bit build of
python will fail with this error. Here are 64-bit builds of libmagic for windows: https://github.com/pidydx/libmagicwin64.
Newer version can be found here: https://github.com/nscaife/file-windows.
- 'WindowsError: exception: access violation writing 0x00000000 ' This may indicate you are mixing
Windows Python and Cygwin Python. Make sure your libmagic and python builds are consistent.
## Bug Reports
python-magic is a thin layer over the libmagic C library.
Historically, most bugs that have been reported against python-magic
are actually bugs in libmagic; libmagic bugs can be reported on their
tracker here: https://bugs.astron.com/my_view_page.php. If you're not
sure where the bug lies feel free to file an issue on GitHub and I can
triage it.
## Running the tests
To run the tests across a variety of linux distributions (depends on Docker):
```
./test_docker.sh
```
To run tests locally across all available python versions:
```
./test/run.py
```
To run against a specific python version:
```
LC_ALL=en_US.UTF-8 python3 test/test.py
```
## libmagic python API compatibility
The python bindings shipped with libmagic use a module name that conflicts with this package. To work around this, python-magic includes a compatibility layer for the libmagic API. See [COMPAT.md](COMPAT.md) for a guide to libmagic / python-magic compatibility.
## Versioning
Minor version bumps should be backwards compatible. Major bumps are not.
## Author
Written by Adam Hupp in 2001 for a project that never got off the
ground. It originally used SWIG for the C library bindings, but
switched to ctypes once that was part of the python standard library.
You can contact me via my [website](http://hupp.org/adam) or
[GitHub](http://github.com/ahupp).
## License
python-magic is distributed under the MIT license. See the included
LICENSE file for details.
I am providing code in the repository to you under an open source license. Because this is my personal repository, the license you receive to my code is from me and not my employer (Facebook).
Raw data
{
"_id": null,
"home_page": "http://github.com/ahupp/python-magic",
"name": "python-magic",
"maintainer": "",
"docs_url": null,
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
"maintainer_email": "",
"keywords": "mime magic file",
"author": "Adam Hupp",
"author_email": "adam@hupp.org",
"download_url": "https://files.pythonhosted.org/packages/da/db/0b3e28ac047452d079d375ec6798bf76a036a08182dbb39ed38116a49130/python-magic-0.4.27.tar.gz",
"platform": null,
"description": "# python-magic\n[](https://badge.fury.io/py/python-magic)\n[](https://travis-ci.org/ahupp/python-magic) [](https://gitter.im/ahupp/python-magic?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\n\npython-magic is a Python interface to the libmagic file type\nidentification library. libmagic identifies file types by checking\ntheir headers according to a predefined list of file types. This\nfunctionality is exposed to the command line by the Unix command\n`file`.\n\n## Usage\n\n```python\n>>> import magic\n>>> magic.from_file(\"testdata/test.pdf\")\n'PDF document, version 1.2'\n# recommend using at least the first 2048 bytes, as less can produce incorrect identification\n>>> magic.from_buffer(open(\"testdata/test.pdf\", \"rb\").read(2048))\n'PDF document, version 1.2'\n>>> magic.from_file(\"testdata/test.pdf\", mime=True)\n'application/pdf'\n```\n\nThere is also a `Magic` class that provides more direct control,\nincluding overriding the magic database file and turning on character\nencoding detection. This is not recommended for general use. In\nparticular, it's not safe for sharing across multiple threads and\nwill fail throw if this is attempted.\n\n```python\n>>> f = magic.Magic(uncompress=True)\n>>> f.from_file('testdata/test.gz')\n'ASCII text (gzip compressed data, was \"test\", last modified: Sat Jun 28\n21:32:52 2008, from Unix)'\n```\n\nYou can also combine the flag options:\n\n```python\n>>> f = magic.Magic(mime=True, uncompress=True)\n>>> f.from_file('testdata/test.gz')\n'text/plain'\n```\n\n## Installation\n\nThe current stable version of python-magic is available on PyPI and\ncan be installed by running `pip install python-magic`.\n\nOther sources:\n\n- PyPI: http://pypi.python.org/pypi/python-magic/\n- GitHub: https://github.com/ahupp/python-magic\n\nThis module is a simple wrapper around the libmagic C library, and\nthat must be installed as well:\n\n### Debian/Ubuntu\n\n```\nsudo apt-get install libmagic1\n```\n\n### Windows\n\nYou'll need DLLs for libmagic. @julian-r maintains a pypi package with the DLLs, you can fetch it with:\n\n```\npip install python-magic-bin\n```\n\n### OSX\n\n- When using Homebrew: `brew install libmagic`\n- When using macports: `port install file`\n\n### Troubleshooting\n\n- 'MagicException: could not find any magic files!': some\n installations of libmagic do not correctly point to their magic\n database file. Try specifying the path to the file explicitly in the\n constructor: `magic.Magic(magic_file=\"path_to_magic_file\")`.\n\n- 'WindowsError: [Error 193] %1 is not a valid Win32 application':\n Attempting to run the 32-bit libmagic DLL in a 64-bit build of\n python will fail with this error. Here are 64-bit builds of libmagic for windows: https://github.com/pidydx/libmagicwin64.\n Newer version can be found here: https://github.com/nscaife/file-windows.\n\n- 'WindowsError: exception: access violation writing 0x00000000 ' This may indicate you are mixing\n Windows Python and Cygwin Python. Make sure your libmagic and python builds are consistent.\n\n\n## Bug Reports\n\npython-magic is a thin layer over the libmagic C library.\nHistorically, most bugs that have been reported against python-magic\nare actually bugs in libmagic; libmagic bugs can be reported on their\ntracker here: https://bugs.astron.com/my_view_page.php. If you're not\nsure where the bug lies feel free to file an issue on GitHub and I can\ntriage it.\n\n## Running the tests\n\nTo run the tests across a variety of linux distributions (depends on Docker):\n\n```\n./test_docker.sh\n```\n\nTo run tests locally across all available python versions:\n\n```\n./test/run.py\n```\n\nTo run against a specific python version:\n\n```\nLC_ALL=en_US.UTF-8 python3 test/test.py\n```\n\n## libmagic python API compatibility\n\nThe python bindings shipped with libmagic use a module name that conflicts with this package. To work around this, python-magic includes a compatibility layer for the libmagic API. See [COMPAT.md](COMPAT.md) for a guide to libmagic / python-magic compatibility.\n\n## Versioning\n\nMinor version bumps should be backwards compatible. Major bumps are not.\n\n## Author\n\nWritten by Adam Hupp in 2001 for a project that never got off the\nground. It originally used SWIG for the C library bindings, but\nswitched to ctypes once that was part of the python standard library.\n\nYou can contact me via my [website](http://hupp.org/adam) or\n[GitHub](http://github.com/ahupp).\n\n## License\n\npython-magic is distributed under the MIT license. See the included\nLICENSE file for details.\n\nI am providing code in the repository to you under an open source license. Because this is my personal repository, the license you receive to my code is from me and not my employer (Facebook).\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "File type identification using libmagic",
"version": "0.4.27",
"project_urls": {
"Homepage": "http://github.com/ahupp/python-magic"
},
"split_keywords": [
"mime",
"magic",
"file"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6c739f872cb81fc5c3bb48f7227872c28975f998f3e7c2b1c16e95e6432bbb90",
"md5": "72e34d86a65f5656be0907d5cef4ecd3",
"sha256": "c212960ad306f700aa0d01e5d7a325d20548ff97eb9920dcd29513174f0294d3"
},
"downloads": -1,
"filename": "python_magic-0.4.27-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "72e34d86a65f5656be0907d5cef4ecd3",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
"size": 13840,
"upload_time": "2022-06-07T20:16:57",
"upload_time_iso_8601": "2022-06-07T20:16:57.763303Z",
"url": "https://files.pythonhosted.org/packages/6c/73/9f872cb81fc5c3bb48f7227872c28975f998f3e7c2b1c16e95e6432bbb90/python_magic-0.4.27-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dadb0b3e28ac047452d079d375ec6798bf76a036a08182dbb39ed38116a49130",
"md5": "5ec09788e8dce05dfd4fd5345153f8a9",
"sha256": "c1ba14b08e4a5f5c31a302b7721239695b2f0f058d125bd5ce1ee36b9d9d3c3b"
},
"downloads": -1,
"filename": "python-magic-0.4.27.tar.gz",
"has_sig": false,
"md5_digest": "5ec09788e8dce05dfd4fd5345153f8a9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
"size": 14677,
"upload_time": "2022-06-07T20:16:59",
"upload_time_iso_8601": "2022-06-07T20:16:59.508508Z",
"url": "https://files.pythonhosted.org/packages/da/db/0b3e28ac047452d079d375ec6798bf76a036a08182dbb39ed38116a49130/python-magic-0.4.27.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-06-07 20:16:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ahupp",
"github_project": "python-magic",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "python-magic"
}
JSON
