fileutils-dir 0.1.3__py3-none-any.whl → 0.3.0__py3-none-any.whl

fileutils/files.py

@@ -2,25 +2,46 @@ from collections.abc import Iterable
 from pathlib import Path
 
 FILE_TYPES = {
-              "image": [".jpg", ".jpeg", ".png", ".webp", ".bmp", ".gif", ".tiff"],
-              "text": [".txt", ".md", ".rst", ".log"], "pdf": [".pdf"], "doc": [".doc", ".docx", ".odt"],
-              "sheet": [".xls", ".xlsx", ".ods", ".csv"], "presentation": [".ppt", ".pptx", ".odp"],
-              "code": [".py", ".js", ".ts", ".java", ".c", ".cpp", ".h", ".go", ".rs", ".rb", ".php", ".sh"],
-              "data": [".json", ".yaml", ".yml", ".xml", ".toml"],
-              "audio": [".mp3", ".wav", ".flac", ".ogg", ".aac", ".m4a"],
-              "video": [".mp4", ".mkv", ".avi", ".mov", ".webm"],
-              "archive": [".zip", ".tar", ".gz", ".bz2", ".7z", ".rar"],
+    "image": [".jpg", ".jpeg", ".png", ".webp", ".bmp", ".gif", ".tiff"],
+    "text": [".txt", ".md", ".rst", ".log"],
+    "pdf": [".pdf"],
+    "doc": [".doc", ".docx", ".odt"],
+    "sheet": [".xls", ".xlsx", ".ods", ".csv"],
+    "presentation": [".ppt", ".pptx", ".odp"],
+    "code": [".py", ".js", ".ts", ".java", ".c", ".cpp", ".h", ".go", ".rs", ".rb", ".php", ".sh"],
+    "data": [".json", ".yaml", ".yml", ".xml", ".toml"],
+    "audio": [".mp3", ".wav", ".flac", ".ogg", ".aac", ".m4a"],
+    "video": [".mp4", ".mkv", ".avi", ".mov", ".webm"],
+    "archive": [".zip", ".tar", ".gz", ".bz2", ".7z", ".rar"],
 }
 
-
 def in_dir(
-        paths: Iterable[str] | None = None,
-        ext: Iterable[str] | None = None,
-        dtype: Iterable[str] | None = None,
+    path=".",
+    *args,
+    ext=None,
+    dtype=None,
 ) -> list[str]:
-    paths = paths or ["."]
+    """
+    "in_dir() accepts only one positional argument (path).
+            Use keyword arguments for filters or leave empty:
+            in_dir(path, ext='filetype')
+            in_dir(path, dtype='data_type')
+    dtype options: image, text, pdf, doc, sheet, presentation, code, data, audio, video, archive
+    """
+    if args:
+        raise TypeError(
+            "in_dir() accepts only one positional argument (path).\n"
+            "Use keyword arguments for filters or leave empty:\n"
+            "  in_dir(path, ext='filetype')\n"
+            "  in_dir(path, dtype='data_type')"
+        )
     ext = ext or []
     dtype = dtype or []
+    
+    if isinstance(ext, str):
+        ext = [ext]
+    if isinstance(dtype, str):
+        dtype = [dtype]
 
     normalized_extensions = {
         e.lower() if e.startswith(".") else f".{e.lower()}"
@@ -29,19 +50,20 @@ def in_dir(
 
     for file_type in dtype:
         key = file_type.strip().lower()
-        try:
-            normalized_extensions.update(FILE_TYPES[key])
-        except KeyError:
-            raise ValueError(f"Unknown file type: {file_type}")
+        if key not in FILE_TYPES:
+            raise ValueError(
+                f"Unknown file type: {file_type}. "
+                f"Valid types: {', '.join(FILE_TYPES)}"
+            )
+        normalized_extensions.update(FILE_TYPES[key])
 
-    files_to_return: list[str] = []
+    files: list[str] = []
 
-    for path in paths:
-        for item in Path(path).iterdir():
-            if not item.is_file():
-                continue
+    for item in Path(path).iterdir():
+        if item.is_file() and (
+            not normalized_extensions or item.suffix.lower() in normalized_extensions
+        ):
+            files.append(str(item))
 
-            if not normalized_extensions or item.suffix.lower() in normalized_extensions:
-                files_to_return.append(str(item))
+    return files
 
-    return files_to_return

fileutils_dir-0.3.0.dist-info/METADATA

@@ -0,0 +1,70 @@
+Metadata-Version: 2.4
+Name: fileutils-dir
+Version: 0.3.0
+Summary: Small utilities for listing files in directories
+Author: Jatavallabhula Sarat Anirudh
+License-Expression: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# fileutils
+
+A small Python library for filtering and listing files. 
+
+## Installation
+
+```bash
+pip install fileutils-dir
+```
+
+## Usage
+
+```python
+from fileutils import in_dir
+
+# List all files in the current directory
+files = in_dir()
+
+# Filter by extension
+python_files = in_dir(ext=[".py"])
+
+# Filter by predefined categories
+media_files = in_dir(dtype=["image", "video"])
+
+# Filter by both
+results = in_dir(path="src", ext=[".c"], dtype=["text"])
+```
+
+## API Reference
+
+### `in_dir(path=".", *, ext=None, dtype=None)`
+
+Returns a list of file paths as strings from the specified directory.
+
+- **path**: Directory to search. Accepts `str` or `pathlib.Path`. Defaults to `"."`.
+- **ext**: An iterable of file extensions to include. 
+- **dtype**: An iterable of predefined file type categories. 
+
+If neither `ext` nor `dtype` are provided, all files in the directory are returned. If both are provided, the result is the union of both filters. Subdirectories are ignored.
+
+## Supported Types
+
+The `dtype` parameter supports the following categories:
+
+| Category | Extensions |
+| :--- | :--- |
+| `image` | .jpg, .jpeg, .png, .webp, .bmp, .gif, .tiff |
+| `text` | .txt, .md, .rst, .log |
+| `pdf` | .pdf |
+| `doc` | .doc, .docx, .odt |
+| `sheet` | .xls, .xlsx, .ods, .csv |
+| `presentation` | .ppt, .pptx, .odp |
+| `code` | .py, .js, .ts, .java, .c, .cpp, .h, .go, .rs, .rb, .php, .sh |
+| `data` | .json, .yaml, .yml, .xml, .toml |
+| `audio` | .mp3, .wav, .flac, .ogg, .aac, .m4a |
+| `video` | .mp4, .mkv, .avi, .mov, .webm |
+| `archive` | .zip, .tar, .gz, .bz2, .7z, .rar |
+
+## License
+
+MIT

fileutils_dir-0.3.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+fileutils/__init__.py,sha256=3u-pHKVodcCPECMcj95lrkk8nr7tl6_HRqiQOw6YbBM,78
+fileutils/files.py,sha256=Aymj5dvKW8szLmSNUZvzAba6-_syJeTRPEPDkRHD6Jc,2274
+fileutils_dir-0.3.0.dist-info/METADATA,sha256=7Q6MibbNB_YSmDjnnHRZixGpzQ0mP4wAbxtLeFEJNX4,1899
+fileutils_dir-0.3.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+fileutils_dir-0.3.0.dist-info/top_level.txt,sha256=kZPCAZpYo7OkmwY_R2a4ifuMINdW5AZd2JaNHDSXQYQ,10
+fileutils_dir-0.3.0.dist-info/RECORD,,

fileutils_dir-0.1.3.dist-info/METADATA

@@ -1,59 +0,0 @@
-Metadata-Version: 2.4
-Name: fileutils-dir
-Version: 0.1.3
-Summary: Small utilities for listing files in directories
-Author: Jatavallabhula Sarat Anirudh
-License-Expression: MIT
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-
-# fileutils
-
-Small utilities for working with files and directories.
-
-Currently provides a helper to list files in one or more directories,
-optionally filtered by file extension or file type.
-
-Installation (local development)
-
-    pip install -e .
-
-Usage
-
-    from fileutils import in_dir
-
-    # All files in current directory
-    files = in_dir()
-
-    # All Python files
-    files = in_dir(extensions=[".py"])
-
-    # Files by type
-    files = in_dir(types=["code"])
-
-    # Multiple directories
-    files = in_dir(directories=["src", "tests"], types=["code"])
-
-Behavior
-
-- Defaults to the current directory (.)
-- If no extensions or types are provided, all files are returned
-- If both are provided, the result is the union of both filters
-- Only files are returned (directories are ignored)
-
-Supported types
-
-Common file groups such as:
-- code
-- text
-- image
-- pdf
-- audio
-- video
-- archive
-
-See source for the full mapping.
-
-License
-
-MIT

fileutils_dir-0.1.3.dist-info/RECORD

@@ -1,6 +0,0 @@
-fileutils/__init__.py,sha256=3u-pHKVodcCPECMcj95lrkk8nr7tl6_HRqiQOw6YbBM,78
-fileutils/files.py,sha256=pSHHNR8oZyCtSi7ZL73wIqywyntwe7mKVogaAdhLh_8,1718
-fileutils_dir-0.1.3.dist-info/METADATA,sha256=f4HpV1wJjFH_7pcDiCqP0Yd8Mo6ArSNKvXLWLJg4v8M,1239
-fileutils_dir-0.1.3.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-fileutils_dir-0.1.3.dist-info/top_level.txt,sha256=kZPCAZpYo7OkmwY_R2a4ifuMINdW5AZd2JaNHDSXQYQ,10
-fileutils_dir-0.1.3.dist-info/RECORD,,