init commit

Author: fpgmaas

.github/workflows/on-release-main.yml

@@ -64,4 +64,3 @@ jobs:
 
       - name: Deploy documentation
         run: uv run mkdocs gh-deploy --force
-

README.md

@@ -45,7 +45,7 @@ def set_content_type(mime: MimeType) -> str:
     return f"Content-Type: {mime}"
 ```
 
-### Flexible String Parsing  
+### Flexible String Parsing
 
 Parse real-world MIME type strings with automatic parameter stripping and alias normalization:
 
@@ -69,7 +69,7 @@ print(unknown)  # None
 
 Detect MIME types from file extensions and paths:
 
-```python  
+```python
 from mime_enum import from_extension, from_path
 
 # Look up by extension (with or without dot, case-insensitive)

docs/api.md

@@ -11,4 +11,4 @@ This page contains the complete API documentation for the `mime-enum` package, a
 
 ## MimeType Enum
 
-::: mime_enum.mimetype.MimeType
+::: mime_enum.mimetype.MimeType

docs/index.md

@@ -45,7 +45,7 @@ def set_content_type(mime: MimeType) -> str:
     return f"Content-Type: {mime}"
 ```
 
-### Flexible String Parsing  
+### Flexible String Parsing
 
 Parse real-world MIME type strings with automatic parameter stripping and alias normalization:
 
@@ -69,7 +69,7 @@ print(unknown)  # None
 
 Detect MIME types from file extensions and paths:
 
-```python  
+```python
 from mime_enum import from_extension, from_path
 
 # Look up by extension (with or without dot, case-insensitive)
@@ -84,4 +84,4 @@ mime_type = from_path("/path/to/document.pdf")  # MimeType.APPLICATION_PDF
 
 For detailed usage examples, see the [Usage Guide](usage.md).
 
-For complete API documentation, see the [API Reference](api.md).
+For complete API documentation, see the [API Reference](api.md).

mimeData.json

@@ -109,7 +109,8 @@
       "communityContributed": false,
       "popularUsage": null
     }
-  },{
+  },
+  {
     "name": "image/avif-sequence",
     "description": "AVIF (AV1 Image File Format) is an image and animation file format, an extension of <a href=\"/image/heif\">HEIF</a> allowing images encoded with AV1. Most files will only have AV1-encoded images, but a mixture of different encodings is allowed. Early draft versions were named AV1 Still Image File Format.",
     "furtherReading": [
@@ -356,7 +357,7 @@
   },
   {
     "name": "image/x-icns",
-    "description": "ICNS (often written in lowercase as icns) is the native icon format of Mac OS and OS X.<br /><br />It goes by many other names, including Apple Icon, Macintosh Icon, Mac OS Icon, Macintosh OS X Icon, Mac OS X Icon Resource, Mac OS icns Resource, and IconFamily Resource.<br /><br />There are usually multiple images in a file. Supported image sizes are 16×12, and 16, 32, 48, 128, 256, 512, and 1024 pixels square.",
+    "description": "ICNS (often written in lowercase as icns) is the native icon format of Mac OS and OS X.<br /><br />It goes by many other names, including Apple Icon, Macintosh Icon, Mac OS Icon, Macintosh OS X Icon, Mac OS X Icon Resource, Mac OS icns Resource, and IconFamily Resource.<br /><br />There are usually multiple images in a file. Supported image sizes are 16\u00d712, and 16, 32, 48, 128, 256, 512, and 1024 pixels square.",
     "furtherReading": [
       {
         "title": "Let's Solve the File Format Problem!",
@@ -5406,8 +5407,7 @@
       }
     ],
     "links": {
-      "deprecates": [
-      ],
+      "deprecates": [],
       "relatedTo": [],
       "parentOf": [
         "audio/x-aiff"
@@ -6619,7 +6619,7 @@
   },
   {
     "name": "application/yaml",
-    "description": "YAML (YAML Ain’t Markup Language) is a serialization format. It is a strict superset of JSON, with the addition of syntactically significant newlines and indentation, like Python. Unlike Python, however, YAML doesn’t allow literal tab characters for indentation. It is designed to be human-friendly and work well with modern programming languages for common everyday tasks. It is broadly useful for programming needs ranging from configuration files to Internet messaging to object persistence to data auditing. Together with the Unicode standard for characters, it is also well-suited for internationalization.",
+    "description": "YAML (YAML Ain\u2019t Markup Language) is a serialization format. It is a strict superset of JSON, with the addition of syntactically significant newlines and indentation, like Python. Unlike Python, however, YAML doesn\u2019t allow literal tab characters for indentation. It is designed to be human-friendly and work well with modern programming languages for common everyday tasks. It is broadly useful for programming needs ranging from configuration files to Internet messaging to object persistence to data auditing. Together with the Unicode standard for characters, it is also well-suited for internationalization.",
     "furtherReading": [
       {
         "title": "Internet Assigned Numbers Authority (IANA)",
@@ -7570,7 +7570,7 @@
   },
   {
     "name": "video/x-matroska",
-    "description": "Matroska (sometimes spelled Matroška) is an open standard multimedia container format. It is based on the EBML metaformat and can be used with a variety of compressed video formats.",
+    "description": "Matroska (sometimes spelled Matro\u0161ka) is an open standard multimedia container format. It is based on the EBML metaformat and can be used with a variety of compressed video formats.",
     "furtherReading": [
       {
         "title": "Let's Solve the File Format Problem!",
@@ -8127,7 +8127,7 @@
   },
   {
     "name": "text/x-pascal",
-    "description": "Pascal is an influential imperative and procedural programming language, designed in 1968–1969 and published in 1970. Borland's Turbo Pascal, and the later Borland Pascal, were popular in the 1980s and early 1990s on the PC/MS-DOS platform (CP/M versions were also released).",
+    "description": "Pascal is an influential imperative and procedural programming language, designed in 1968\u20131969 and published in 1970. Borland's Turbo Pascal, and the later Borland Pascal, were popular in the 1980s and early 1990s on the PC/MS-DOS platform (CP/M versions were also released).",
     "furtherReading": [
       {
         "title": "Let's Solve the File Format Problem!",
@@ -8985,7 +8985,7 @@
   },
   {
     "name": "application/prql",
-    "description": "PRQL is a modern language for transforming data — a simple, powerful, pipelined SQL replacement.",
+    "description": "PRQL is a modern language for transforming data \u2014 a simple, powerful, pipelined SQL replacement.",
     "furtherReading": [
       {
         "title": "Let's Solve the File Format Problem!",
@@ -9147,16 +9147,25 @@
       "deprecates": [],
       "relatedTo": [],
       "parentOf": [],
-      "alternativeTo": ["text/x-python-code", "text/x-python-script", "application/x-python-code", "application/x-python-script"]
+      "alternativeTo": [
+        "text/x-python-code",
+        "text/x-python-script",
+        "application/x-python-code",
+        "application/x-python-script"
+      ]
     },
     "fileTypes": [
-      ".py", ".pyc", ".pyo", ".pyd", ".whl"
+      ".py",
+      ".pyc",
+      ".pyo",
+      ".pyd",
+      ".whl"
     ],
     "furtherReading": [
-        {
-            "title": "Let's Solve the File Format Problem!",
-            "url": "http://fileformats.archiveteam.org/wiki/Python"
-        }
+      {
+        "title": "Let's Solve the File Format Problem!",
+        "url": "http://fileformats.archiveteam.org/wiki/Python"
+      }
     ],
     "notices": {
       "hasNoOfficial": true,

pyproject.toml

@@ -109,4 +109,3 @@ skip_empty = true
 [tool.coverage.run]
 branch = true
 source = ["src"]
-

src/mime_enum/__init__.py

@@ -1,6 +1,4 @@
-from mime_enum.core import parse, try_parse, from_extension, from_path
+from mime_enum.core import from_extension, from_path, parse, try_parse
 from mime_enum.mimetype import MimeType
 
-__all__ = (
-    "MimeType", "parse", "try_parse", "from_extension", "from_path"
-)
+__all__ = ("MimeType", "from_extension", "from_path", "parse", "try_parse")

src/mime_enum/core.py

@@ -5,7 +5,7 @@
 from pathlib import Path
 
 # Import the generated enum + maps
-from .mimetype import MimeType, _ALIASES, _EXT_TO_MIME
+from .mimetype import _ALIASES, _EXT_TO_MIME, MimeType
 
 _PARAM_RE = re.compile(r"\s*;.*$")
 
@@ -16,23 +16,23 @@ def _strip_params(value: str) -> str:
 
 def parse(value: str) -> MimeType:
     """Parse a MIME type string to a MimeType enum.
-    
+
     Performs strict parsing with the following behavior:
-    
+
     - Strips parameters (e.g., 'application/json; charset=utf-8' becomes 'application/json')
     - Normalizes known aliases to their canonical form
     - Case-insensitive matching
     - Raises ValueError for unknown MIME types
-    
+
     Args:
         value: The MIME type string to parse (e.g., 'application/json')
-        
+
     Returns:
         The corresponding MimeType enum value
-        
+
     Raises:
         ValueError: If the MIME type is empty, malformed, or unknown
-        
+
     Examples:
         >>> parse('application/json')
         MimeType.APPLICATION_JSON
@@ -42,28 +42,28 @@ def parse(value: str) -> MimeType:
         MimeType.APPLICATION_JSON
     """
     if not value:
-        raise ValueError("Empty MIME string")
+        raise ValueError("Empty MIME string")  # noqa: TRY003
     core = _strip_params(value)
     if core in _ALIASES:
         return _ALIASES[core]
     try:
         return MimeType(core)
     except ValueError as exc:
-        raise ValueError(f"Unknown MIME type: {value!r}") from exc
+        raise ValueError(f"Unknown MIME type: {value!r}") from exc  # noqa: TRY003
 
 
 def try_parse(value: str) -> MimeType | None:
     """Parse a MIME type string, returning None for unknown types.
-    
+
     Similar to parse() but returns None instead of raising ValueError
     for unknown or empty MIME type strings.
-    
+
     Args:
         value: The MIME type string to parse (e.g., 'application/json')
-        
+
     Returns:
         The corresponding MimeType enum value, or None if unknown/empty
-        
+
     Examples:
         >>> try_parse('application/json')
         MimeType.APPLICATION_JSON
@@ -85,26 +85,26 @@ def try_parse(value: str) -> MimeType | None:
 
 def from_extension(ext: str) -> MimeType | None:
     """Get MIME type from a file extension.
-    
+
     Performs case-insensitive lookup of MIME types by file extension.
     Handles extensions with or without leading dot.
-    
+
     Args:
         ext: File extension (e.g., 'json', '.json', 'PDF', '.PDF')
-        
+
     Returns:
         The corresponding MimeType enum value, or None if extension is unknown
-        
+
     Note:
         This function only looks at the file extension and does NOT examine
         actual file content. Files can have incorrect or missing extensions,
         making this method unreliable for security-critical applications.
-        
+
         For content-based MIME type detection, consider using packages like:
-        
+
         - `python-magic` (libmagic wrapper)
         - `filetype` (pure Python file type detection)
-        
+
     Examples:
         >>> from_extension('json')
         MimeType.APPLICATION_JSON
@@ -122,30 +122,30 @@ def from_extension(ext: str) -> MimeType | None:
 
 def from_path(path: str | Path) -> MimeType | None:
     """Get MIME type from a file path or filename.
-    
+
     Extracts the file extension from the path and looks up the
     corresponding MIME type. Uses the last extension for compound
     extensions (e.g., 'file.tar.gz' uses '.gz').
-    
+
     Args:
         path: File path or filename (str or Path object)
-        
+
     Returns:
         The corresponding MimeType enum value, or None if no extension
         or unknown extension
-        
+
     Warning:
         This function is purely extension-based and does NOT read or examine
         the actual file content. This can be unreliable because:
-        
+
         - Files may have incorrect extensions (e.g., .txt file containing JSON)
         - Files may be renamed with wrong extensions
         - Files without extensions will return None
         - Malicious files can masquerade with fake extensions
-        
+
         For accurate MIME type detection based on file signatures/magic bytes,
         use content-based detection libraries like `python-magic` or `filetype`.
-        
+
     Examples:
         >>> from_path('/tmp/document.pdf')
         MimeType.APPLICATION_PDF