pure-magic-rs 0.2.5__cp313-cp313t-musllinux_1_2_i686.whl

pure_magic_rs/__init__.py

@@ -0,0 +1,5 @@
+from .pure_magic_rs import *
+
+__doc__ = pure_magic_rs.__doc__
+if hasattr(pure_magic_rs, "__all__"):
+    __all__ = pure_magic_rs.__all__

pure_magic_rs/__init__.pyi

@@ -0,0 +1,163 @@
+from typing import List, Optional, Dict, Any
+
+class Magic:
+    """Represents a detected file type's "magic" information.
+
+    Attributes:
+        source (Optional[str]): The source of the magic detection.
+        message (str): A human-readable description of the detected type.
+        mime_type (str): The MIME type of the detected file.
+        creator_code (Optional[str]): The creator code, if available.
+        strength (int): The strength of the detection.
+        extensions (List[str]): Possible file extensions for the detected type.
+    """
+
+    @property
+    def source(self) -> Optional[str]: ...
+    @property
+    def message(self) -> str: ...
+    @property
+    def mime_type(self) -> str: ...
+    @property
+    def creator_code(self) -> Optional[str]: ...
+    @property
+    def strength(self) -> int: ...
+    @property
+    def extensions(self) -> List[str]: ...
+    def to_dict(self) -> Dict[str, Any]:
+        """Convert this `Magic` instance into a Python dictionary.
+
+        Returns:
+            dict: A dictionary with keys `source`, `message`, `mime_type`,
+                  `creator_code`, `strength`, and `extensions`.
+
+        Example:
+            >>> magic_dict = magic_instance.to_dict()
+            >>> print(magic_dict["mime_type"])
+        """
+        ...
+
+class MagicDb:
+    """A file type detection database using magic numbers.
+
+    This class provides methods to detect file types for both in-memory buffers
+    and files on disk.
+
+    Example:
+        >>> db = MagicDb()
+        >>> result = db.first_magic_file("example.txt")
+        >>> print(result.mime_type)
+    """
+
+    def __init__(self) -> None: ...
+    def first_magic_buffer(self, input: bytes, extension: Optional[str] = ...) -> Magic:
+        """Detect the first magic match for an in-memory buffer.
+
+        Args:
+            input (bytes): The buffer to analyze.
+            extension (Optional[str]): Optional file extension hint.
+
+        Returns:
+            Magic: The first detected magic result.
+
+        Raises:
+            ValueError: If magic identification failed
+
+        Example:
+            >>> with open("example.txt", "rb") as f:
+            ...     buffer = f.read()
+            >>> result = db.first_magic_buffer(buffer, "txt")
+        """
+        ...
+
+    def first_magic_file(self, path: str) -> Magic:
+        """Detect the first magic match for a file.
+
+        Args:
+            path (str): Path to the file to analyze.
+
+        Returns:
+            Magic: The first detected magic result.
+
+        Raises:
+            IOError: If the file cannot be opened.
+            ValueError: If magic identification failed
+
+        Example:
+            >>> result = db.first_magic_file("example.txt")
+        """
+        ...
+
+    def best_magic_buffer(self, input: bytes) -> Magic:
+        """Detect the best magic match for an in-memory buffer.
+
+        Args:
+            input (bytes): The buffer to analyze.
+
+        Returns:
+            Magic: The best detected magic result.
+
+        Raises:
+            ValueError: If magic identification failed
+
+        Example:
+            >>> with open("example.txt", "rb") as f:
+            ...     buffer = f.read()
+            >>> result = db.best_magic_buffer(buffer)
+        """
+        ...
+
+    def best_magic_file(self, path: str) -> Magic:
+        """Detect the best magic match for a file.
+
+        Args:
+            path (str): Path to the file to analyze.
+
+        Returns:
+            Magic: The best detected magic result.
+
+        Raises:
+            IOError: If the file cannot be opened.
+            ValueError: If magic identification failed
+
+        Example:
+            >>> result = db.best_magic_file("example.txt")
+        """
+        ...
+
+    def all_magics_buffer(self, input: bytes) -> List[Magic]:
+        """Detect all magic matches for an in-memory buffer.
+
+        Args:
+            input (bytes): The buffer to analyze.
+
+        Returns:
+            List[Magic]: All detected magic results.
+
+        Raises:
+            ValueError: If magic identification failed
+
+        Example:
+            >>> with open("example.txt", "rb") as f:
+            ...     buffer = f.read()
+            >>> results = db.all_magics_buffer(buffer)
+        """
+        ...
+
+    def all_magics_file(self, path: str) -> List[Magic]:
+        """Detect all magic matches for a file.
+
+        Args:
+            path (str): Path to the file to analyze.
+
+        Returns:
+            List[Magic]: All detected magic results.
+
+        Raises:
+            IOError: If the file cannot be opened.
+            ValueError: If magic identification failed
+
+        Example:
+            >>> results = db.all_magics_file("example.txt")
+        """
+        ...

pure_magic_rs-0.2.5.dist-info/METADATA

@@ -0,0 +1,111 @@
+Metadata-Version: 2.4
+Name: pure-magic-rs
+Version: 0.2.5
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Summary: Python bindings for pure-magic crate, a pure Rust re-implementation of libmagic
+Keywords: magic,file,mime,identification,libmagic
+Author-email: Quentin JEROME <quentin.jerome@circl.lu>
+Maintainer-email: Quentin JEROME <quentin.jerome@circl.lu>
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Issues, https://github.com/qjerome/magic-rs/issues
+Project-URL: Repository, https://github.com/qjerome/magic-rs
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pure-magic-rs?style=for-the-badge)](https://pypi.org/project/pure-magic-rs/)
+[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/qjerome/magic-rs/maturin.yml?style=for-the-badge)](https://github.com/qjerome/magic-rs/actions/workflows/maturin.yml)
+![GitHub License](https://img.shields.io/github/license/qjerome/magic-rs?style=for-the-badge&color=blue)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/pure-magic-rs?style=for-the-badge)
+
+
+<!-- cargo-rdme start -->
+
+# Pure Rust Python Bindings for File Type Detection
+
+`pure-magic-rs` is a Python module that provides bindings to the [`pure-magic`](https://crates.io/crates/pure-magic) crate, allowing you to detect file types, MIME types, and other metadata using a pure Rust alternative to the C `libmagic` library. This module uses an **embedded magic database**, so everything works out-of-the-box with **no need** of a compiled database or magic rule files.
+
+## Features
+- **Pure Rust implementation**: No C dependencies, easily cross-compilable for great compatibility
+- **Embedded magic database**: No database file or magic rules needed
+- Detect file types from buffers or files
+- Retrieve MIME types, creator codes, and file extensions
+- Convert results to Python dictionaries for easy integration
+- Supports both "first match", "best match" and "all matches" detection strategies
+
+## Installation
+```bash
+pip install pure-magic-rs
+```
+
+## Usage
+
+### Initializing the Database
+```python
+from pure_magic_rs import MagicDb
+# Initialize the Magic database (uses embedded database)
+db = MagicDb()
+```
+
+### Detecting File Types from Buffers
+```python
+# Detect the first match for a buffer (e.g., PNG data)
+png_data = b'\x89PNG\r\n\x1a\n\x00\x00\x00\rIHDR\x00\x00\x00\x01\x00\x00\x00\x01\x08\x02\x00\x00\x00\x90wS\xde\x00'
+result = db.first_magic_buffer(png_data, None)
+print(f"Detected: {result.message} (MIME: {result.mime_type})")
+```
+
+```python
+# Detect the best match for a buffer
+result = db.best_magic_buffer(png_data)
+print(f"Best match: {result.message}")
+```
+
+```python
+# Get all possible matches for a buffer
+results = db.all_magics_buffer(png_data)
+for r in results:
+    print(f"Match: {r.message}, MIME: {r.mime_type}, Strength: {r.strength}")
+```
+
+### Detecting File Types from Files
+```python
+# Detect the first match for a file
+result = db.first_magic_file("example.png")
+print(f"File type: {result.message}, Extensions: {result.extensions}")
+```
+
+```python
+# Detect the best match for a file
+result = db.best_magic_file("example.png")
+print(f"Best match: {result.message}")
+```
+
+```python
+# Get all possible matches for a file
+results = db.all_magics_file("example.png")
+for r in results:
+    print(f"Match: {r.message}, MIME: {r.mime_type}")
+```
+
+### Converting Results to Dictionaries
+```python
+result = db.first_magic_buffer(png_data, None)
+result_dict = result.to_dict()
+print(result_dict)
+# Output: {'source': None, 'message': 'PNG image data', 'mime_type': 'image/png', ...}
+```
+
+### Handling Errors
+```python
+try:
+    result = db.first_magic_file("nonexistent_file.txt")
+except IOError as e:
+    print(f"Error opening file: {e}")
+```
+
+## License
+This project is licensed under the **GPL-3 License**.
+
+<!-- cargo-rdme end -->
+

pure_magic_rs-0.2.5.dist-info/RECORD

@@ -0,0 +1,8 @@
+pure_magic_rs/__init__.py,sha256=578pugmlUioUEL9jNYxI2DSArh7RaFYFTH4gqrpMWhs,135
+pure_magic_rs/__init__.pyi,sha256=Ylh2DH-MGaKBphMHsARdpQZxVP5eXFTFuBGJzXpejx4,4704
+pure_magic_rs/pure_magic_rs.cpython-313t-i386-linux-musl.so,sha256=Fmb7DCa98SY7YDxo8-TeS2bAXRejNpqe6dSmBc1fO4Q,3811817
+pure_magic_rs/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pure_magic_rs-0.2.5.dist-info/METADATA,sha256=YAx8NdH5g4Qo3I-pdI5lpLxwxRN-cH6pjPC3Y_nuZkU,3999
+pure_magic_rs-0.2.5.dist-info/WHEEL,sha256=6ADlOhKFXhEu-Gk8dFo0B1i68er1Rbvld5DrNBBvRuo,107
+pure_magic_rs.libs/libgcc_s-f5fcfe20.so.1,sha256=AgqyMrWe8E5-efp_cXekgnQn-q6zJOV7u8ZBzQVlfJc,552385
+pure_magic_rs-0.2.5.dist-info/RECORD,,

pure_magic_rs-0.2.5.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.11.5)
+Root-Is-Purelib: false
+Tag: cp313-cp313t-musllinux_1_2_i686