Merge pull request #5 from Supporterino/feat/exclude

feat: ✨ add a regex exclude option

Author: Supporterino

CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.2.0] - 2024-XX-XX
+
+### Added
+
+- New `--exclude` option to allow filtering out files based on a regex pattern.
+  - Example: `photo-organizer /path/to/source /path/to/target --exclude "^ignore|\.tmp$"`
+  - This helps exclude unwanted files like temporary files or specific naming patterns.
+- Updated documentation to reflect the new feature.
+- Added unit tests for the `--exclude` functionality.
+
 ## [1.1.1] - 2024-06-25
 
 ### Changed

README.md

@@ -1,14 +1,15 @@
 # Photo Organizer
 [![Tests](https://github.com/Supporterino/photo-organizer/actions/workflows/python-package.yml/badge.svg)](https://github.com/Supporterino/photo-organizer/actions/workflows/python-package.yml)[![Upload Release](https://github.com/Supporterino/photo-organizer/actions/workflows/python-publish.yml/badge.svg)](https://github.com/Supporterino/photo-organizer/actions/workflows/python-publish.yml)[![PyPI version](https://badge.fury.io/py/photo-organizer.svg)](https://badge.fury.io/py/photo-organizer)
 
-Photo Organizer is a Python script that sorts photos from a source directory into a target directory based on their creation date. The script can organize photos into year, month, and optionally day subfolders. It also supports copying or moving files, recursive directory traversal, and filtering by file extensions.
+Photo Organizer is a Python script that sorts photos from a source directory into a target directory based on their creation date. The script can organize photos into year, month, and optionally day subfolders. It also supports copying or moving files, recursive directory traversal, filtering by file extensions, and excluding files using regex patterns.
 
 ## Features
 
 * Organize photos into year/month/day folders based on creation date
 * Move or copy files from the source to the target directory
 * Recursively traverse directories
 * Filter files by specified extensions
+* Exclude files from processing using regex patterns
 * Verbose logging for detailed information
 * Flexible folder structure with optional top-level year-month folders.
 
@@ -29,7 +30,7 @@ pip install photo-organizer
 ### Running the Script
 
 ```bash
-photo-organizer [-h] [-r] [-d] [-e [ENDINGS [ENDINGS ...]]] [-v] [-c] [--no-year] source target
+photo-organizer [-h] [-r] [-d] [-e [ENDINGS [ENDINGS ...]]] [-v] [-c] [--no-year] [--exclude EXCLUDE_PATTERN] source target
 ```
 
 ### Arguments
@@ -42,6 +43,7 @@ Options
 * `-r`, `--recursive`: Sort photos recursively from the source directory
 * `-d`, `--daily`: Organize photos into daily folders (year/month/day)
 * `-e`, `--endings`: Specify file endings/extensions to copy (e.g., .jpg .png). If not specified, all files are included
+* `--exclude`: Provide a regex pattern to exclude matching files from being processed
 * `-v`, `--verbose`: Enable verbose logging
 * `-c`, `--copy`: Copy files instead of moving them
 * `--no-year`: Do not place month folders inside a year folder; place them top-level with the name format YEAR-MONTH
@@ -63,6 +65,11 @@ Copy only .jpg and .png files:
 photo_organizer /path/to/source /path/to/target -e .jpg .png -c
 ```
 
+Exclude files matching a specific regex pattern:
+```bash
+photo-organizer /path/to/source /path/to/target --exclude "^ignore|\.tmp$"
+```
+
 Enable verbose logging:
 ```bash
 photo_organizer /path/to/source /path/to/target -v
@@ -78,7 +85,7 @@ Combine options to copy .jpg and .png files recursively into daily folders with
 photo-organizer -r -d -e .jpg .png -v -c /path/to/source /path/to/target
 ```
 
-## Dwevelopment
+## Development
 
 To contribute to this project, follow these steps:
 

photo_organizer/main.py

@@ -2,38 +2,41 @@
 
 import argparse
 import os
+import re
 import shutil
 import datetime
 import logging
 import filecmp
 
 
-def list_files(source, recursive=False, file_endings=None):
+def list_files(source, recursive=False, file_endings=None, exclude_pattern=None):
     """
-    List all files in the source directory.
+    List all files in the source directory, optionally filtering by file extension and excluding files by regex.
 
     Parameters:
     source (str): The source directory path.
     recursive (bool): If True, list files recursively. Default is False.
-    file_endings (list): List of file endings/extensions to include. Default is None.
+    file_endings (list): List of file extensions to include (e.g., ['.jpg', '.png']). Default is None.
+    exclude_pattern (str): A regex pattern to exclude matching files. Default is None.
 
     Returns:
-    list: A list of file paths.
+    list: A list of file paths that meet the criteria.
     """
     file_list = []
+    pattern = re.compile(exclude_pattern) if exclude_pattern else None
+    
     if recursive:
         for root, dirs, files in os.walk(source):
             for file in files:
-                if not file_endings or file.lower().endswith(tuple(file_endings)):
+                if (not file_endings or file.lower().endswith(tuple(file_endings))) and (not pattern or not pattern.search(file)):
                     file_list.append(os.path.join(root, file))
     else:
         with os.scandir(source) as entries:
             for entry in entries:
-                if entry.is_file() and (
-                    not file_endings or entry.name.lower().endswith(tuple(file_endings))
-                ):
+                if entry.is_file() and (not file_endings or entry.name.lower().endswith(tuple(file_endings))) and (not pattern or not pattern.search(entry.name)):
                     file_list.append(entry.path)
-    logging.debug(f"Listed {len(file_list)} files from {source}")
+    
+    logging.debug(f"Listed {len(file_list)} files from {source}, excluding pattern: {exclude_pattern}")
     return file_list
 
 
@@ -95,45 +98,24 @@ def configure_logging(verbose):
 
 def parse_arguments():
     """
-    Parse command line arguments.
+    Parse command-line arguments for the photo organizer.
 
     Returns:
-    Namespace: Parsed command line arguments.
+    argparse.Namespace: Parsed command-line arguments.
     """
     parser = argparse.ArgumentParser(
         description="Sort photos from source to target directory."
     )
     parser.add_argument("source", type=str, help="The source directory")
     parser.add_argument("target", type=str, help="The target directory")
-    parser.add_argument(
-        "-r", "--recursive", action="store_true", help="Sort photos recursively"
-    )
-    parser.add_argument(
-        "-d",
-        "--daily",
-        action="store_true",
-        default=False,
-        help="Folder structure with daily folders",
-    )
-    parser.add_argument(
-        "-e",
-        "--endings",
-        type=str,
-        nargs="*",
-        help="File endings/extensions to copy (e.g., .jpg .png)",
-    )
-    parser.add_argument(
-        "-v", "--verbose", action="store_true", help="Enable verbose logging"
-    )
-    parser.add_argument(
-        "-c", "--copy", action="store_true", help="Copy files instead of moving them"
-    )
-    parser.add_argument(
-        "--no-year",
-        action="store_true",
-        help="Do not place month folders inside a year folder",
-    )
-
+    parser.add_argument("-r", "--recursive", action="store_true", help="Sort photos recursively")
+    parser.add_argument("-d", "--daily", action="store_true", default=False, help="Folder structure with daily folders")
+    parser.add_argument("-e", "--endings", type=str, nargs="*", help="File endings/extensions to copy (e.g., .jpg .png)")
+    parser.add_argument("-v", "--verbose", action="store_true", help="Enable verbose logging")
+    parser.add_argument("-c", "--copy", action="store_true", help="Copy files instead of moving them")
+    parser.add_argument("--no-year", action="store_true", help="Do not place month folders inside a year folder")
+    parser.add_argument("--exclude", type=str, help="Regex pattern to exclude files from processing")
+    
     return parser.parse_args()
 
 
@@ -192,24 +174,27 @@ def organize_files(args, files):
 
 
 def main():
+    """
+    Main entry point for the photo organizer script. Parses arguments, configures logging, and processes files.
+    """
     # Parse the arguments
     args = parse_arguments()
-
+    
     # Configure logging
     configure_logging(args.verbose)
-
+    
     logging.info("Starting file sorting process")
-
+    
     # Ensure the source directory exists
     if not os.path.exists(args.source):
         logging.error(f"Source directory '{args.source}' does not exist.")
         return
-
+    
     # Ensure the target directory exists
     ensure_directory_exists(args.target)
-
-    # List all files in the source directory
-    files = list_files(args.source, args.recursive, args.endings)
-
+    
+    # List all files in the source directory, applying the exclusion filter
+    files = list_files(args.source, args.recursive, args.endings, args.exclude)
+    
     # Organize files by moving or copying them to the target directory
     organize_files(args, files)

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "photo_organizer"
-version = "1.1.1"
+version = "1.2.0"
 description = "A script to organize photos by creation date into year/month/day folders."
 readme = "README.md"
 authors = [

setup.py

@@ -4,7 +4,7 @@
 
 setup(
     name='photo_organizer',
-    version='1.1.1',
+    version='1.2.0',
     packages=find_packages(),
     entry_points={
         'console_scripts': [

tests/test_main.py

@@ -32,6 +32,49 @@ def setup_target_directory():
     with tempfile.TemporaryDirectory() as target_dir:
         yield target_dir
 
+def create_test_files(base_dir, filenames):
+    """Helper function to create test files in a temporary directory."""
+    for filename in filenames:
+        file_path = os.path.join(base_dir, filename)
+        with open(file_path, "w") as f:
+            f.write("test")
+
+def test_list_files_exclude_regex():
+    """Test that list_files correctly excludes files matching the regex pattern."""
+    with tempfile.TemporaryDirectory() as temp_dir:
+        filenames = ["photo1.jpg", "photo2.png", "ignore_me.txt", "exclude_me.doc"]
+        create_test_files(temp_dir, filenames)
+        
+        # Test exclusion of files ending with .txt or containing "exclude"
+        excluded_pattern = r".*\.txt|exclude.*"
+        files = list_files(temp_dir, recursive=False, file_endings=None, exclude_pattern=excluded_pattern)
+        
+        # Expected files: "photo1.jpg", "photo2.png" (since others match the exclude pattern)
+        expected_files = {os.path.join(temp_dir, "photo1.jpg"), os.path.join(temp_dir, "photo2.png")}
+        assert set(files) == expected_files
+
+def test_list_files_no_exclusion():
+    """Test that list_files returns all files when no exclusion pattern is given."""
+    with tempfile.TemporaryDirectory() as temp_dir:
+        filenames = ["photo1.jpg", "photo2.png", "document.txt"]
+        create_test_files(temp_dir, filenames)
+        
+        files = list_files(temp_dir, recursive=False, file_endings=None, exclude_pattern=None)
+        
+        expected_files = {os.path.join(temp_dir, f) for f in filenames}
+        assert set(files) == expected_files
+
+def test_list_files_exclude_with_endings():
+    """Test that list_files applies both file endings and exclude regex correctly."""
+    with tempfile.TemporaryDirectory() as temp_dir:
+        filenames = ["photo1.jpg", "photo2.png", "ignore.txt", "photo3.jpg"]
+        create_test_files(temp_dir, filenames)
+        
+        # Filter for .jpg files but exclude ones containing 'photo3'
+        files = list_files(temp_dir, recursive=False, file_endings=[".jpg"], exclude_pattern=r".*photo3.*")
+        
+        expected_files = {os.path.join(temp_dir, "photo1.jpg")}
+        assert set(files) == expected_files
 
 def test_list_files_non_recursive(setup_source_directory):
     source_dir, file_paths = setup_source_directory