Adding sort feature

Author: iago1460

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## [v2.2] - 2023-10-22
+* Adding sort feature
+
 ## [v2.1] - 2023-03-12
 
 ### Features

README.md

@@ -14,12 +14,12 @@ It also deals with duplicates, so you don't have to.
 
 ## Disclaimer
 
-Per design this command line interface tool deletes only duplicate files to potentially avoid any risk of losing data.
+Per design, this command line interface tool **only deletes duplicate files** to avoid any risk of losing data.
 
 
 ## Features
 
-* Move, Copy or delete duplicates operations
+* Move, copy, sort or delete duplicates operations
 * User-friendly console output
 * Obscure creation date detection
 * Custom folder structure definition
@@ -70,7 +70,7 @@ We are going to start creating a new directory `media`:
 
     mkdir media
 
-We are going to create a new catalogue named `local_photos` which is going to get store on the `media` directory.
+We are going to create a new catalogue named `local_media` which is going to get store on the newly created `media` directory.
 We specify our format pattern so photos are group by `year` and a subgroup of `month`:
 
     cataloguer create-catalogue local_media ./media --format-pattern %Y/%m/{file}
@@ -107,11 +107,11 @@ To get a summary of our catalogue we run:
   * `%B`: Month name
   * other format codes specified [here](https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes)
 * `/` Specifies a new folder
-* `{media_type}`: File type (`image`, `video`)
-* `{media_format}`: File format (`jpeg`, `tiff`, `png`, `gif`, `mp4` ...)
+* `{media_type}`: Detected file type (`image`, `video`)
+* `{media_format}`: Detected file format (`jpeg`, `tiff`, `png`, `gif`, `mp4` ...)
 * `{file}` Original filename (`photo.jpg`)
-* `{file_extension}` filename extension (`photo`)
-* `{file_name}` filename without the extension (`jpg`)
+* `{file_name}` Filename without the extension (`photo`)
+* `{file_extension}` Filename extension (`jpg`)
 * `{relative_path}` Relative path to the source directory
 
 
@@ -124,14 +124,14 @@ Variables can also be specified as environment variables, using a `CATALOGUER_`
 
     export CATALOGUER_FORMAT_PATTERN=%Y/%m/{file}
 
-`CATALOGUER_STORAGE_LOCATION` Accepts any path. That location will store cataloguer metadata.
+`CATALOGUER_STORAGE_LOCATION` Accepts any path. That location will store metadata.
 By default, it will create a `.catalogues` in the user's home directory.
 
 #### Examples:
 
 Pattern to fix file extensions keeping the folder structure:
 
-     cataloguer --format-pattern {relative_path}/{basename}.{media_format} move ./input ./output
+     cataloguer --format-pattern {relative_path}/{file_name}.{media_format} sort ./target/
 
 
 ## TODO list

cataloguer/cli.py

@@ -32,6 +32,7 @@ class Context(BaseModel):
 
 class Operation(Enum):
     MOVE = "move"
+    SORT = "sort"
     COPY = "copy"
     DELETE = "delete"
 
@@ -231,6 +232,18 @@ def move(ctx: Context, src, dst, dry_run):
     return operate(ctx, src, dst, operation_mode, dry_run)
 
 
+@cli.command()
+@click.argument("src")
+@click.option("--dry-run", is_flag=True)
+@click.pass_obj
+def sort(ctx: Context, src, dry_run):
+    """
+    Move files. In case of duplicates will take the shortest name.
+    """
+    operation_mode = Operation.SORT
+    return operate(ctx, src, None, operation_mode, dry_run)
+
+
 @cli.command()
 @click.argument("src")
 @click.argument("dst", required=False)
@@ -346,7 +359,7 @@ def operate(ctx, src, dst, operation_mode, dry_run=False):
                 f'Error "{dst}" cannot be a subdirectory of {src}'
             )
 
-    if operation_mode in (Operation.MOVE, Operation.COPY):
+    if operation_mode in (Operation.MOVE, Operation.COPY, Operation.SORT):
         format_pattern = ctx.global_settings.format_pattern
         if dst_data and isinstance(dst_data, Catalogue):
             format_pattern = format_pattern or dst_data.format_pattern
@@ -368,7 +381,7 @@ def operate(ctx, src, dst, operation_mode, dry_run=False):
             duplicated_discarded_files,
             files_to_operate,
         ) = extract_files(src_data)
-
+        
     if operation_mode == Operation.DELETE:
         if dst_data:
             duplicate_files_across_directories = [
@@ -400,6 +413,9 @@ def operate(ctx, src, dst, operation_mode, dry_run=False):
                     duplicated_files=duplicated_list_of_different_filenames
                 )
 
+    elif operation_mode == Operation.SORT:
+        files_to_process = files_to_operate
+        dst_data = src_data
     else:  # dst_data can only be Directory or Catalogue
         duplicate_files_across_directories = [
             file
@@ -477,6 +493,10 @@ def process_files(
     if isinstance(dst_data, Catalogue):
         path_format = path_format or dst_data.format_pattern
         unknown_format_pattern = unknown_format_pattern or dst_data.unknown_format_pattern
+    if operation_mode.SORT and isinstance(src_data, Catalogue):
+        path_format = path_format or src_data.format_pattern
+        unknown_format_pattern = unknown_format_pattern or src_data.unknown_format_pattern
+        
 
     tree = DirectoryTree()
     skipped_tree = DirectoryTree()
@@ -527,6 +547,9 @@ def process_file(file, dst_file_path, operation, dst_directory, dry_run):
 
     path_available = dst_directory.is_path_available(dst_file_path)
     if not path_available:
+        if operation.SORT:
+            # TODO: check if it is same file, for now just avoid moving it
+            return file
         logging.debug(f"Path {dst_file_path} not available, renaming file")
         dst_file_path = dst_directory.find_new_path(dst_file_path)
 
@@ -543,6 +566,10 @@ def process_file(file, dst_file_path, operation, dst_directory, dry_run):
         dst_directory.add_file(file)
         return file
 
+    if operation == Operation.SORT:
+        file.move_file(dst_file_path)
+        return file
+
     if operation == Operation.COPY:
         new_file = file.clone_file(dst_file_path)
         dst_directory.add_file(new_file)