Enhancement: collapsible sidebar menus

Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>

docker/rootfs/etc/s6-overlay/s6-rc.d/init-start/run

@@ -13,8 +13,8 @@ echo $(date +%s) > /var/run/s6/container_environment/PAPERLESS_START_TIME_S
 # Check if we're starting as a non-root user
 if [ "$(id --user)" != "0" ]; then
 	printf "true" > /var/run/s6/container_environment/USER_IS_NON_ROOT
-	echo "${log_prefix}  paperless-ngx docker container running under a user ($(id --user):$(id --group))"
+	echo "${log_prefix} paperless-ngx docker container running under a user ($(id --user):$(id --group))"
 else
 	printf "/usr/src/paperless" > /var/run/s6/container_environment/HOME
-	echo "${log_prefix}  paperless-ngx docker container starting init as root"
+	echo "${log_prefix} paperless-ngx docker container starting init as root"
 fi

pyproject.toml

@@ -221,22 +221,12 @@ lint.per-file-ignores."src/documents/parsers.py" = [
 lint.per-file-ignores."src/documents/signals/handlers.py" = [
   "PTH",
 ] # TODO Enable & remove
-lint.per-file-ignores."src/documents/views.py" = [
-  "PTH",
-] # TODO Enable & remove
-lint.per-file-ignores."src/paperless/checks.py" = [
-  "PTH",
-] # TODO Enable & remove
 lint.per-file-ignores."src/paperless/settings.py" = [
   "PTH",
 ] # TODO Enable & remove
-lint.per-file-ignores."src/paperless_mail/mail.py" = [
-  "PTH",
-] # TODO Enable & remove
 lint.per-file-ignores."src/paperless_tesseract/tests/test_parser.py" = [
-  "PTH",
   "RUF001",
-] # TODO PTH Enable & remove
+]
 lint.isort.force-single-line = true
 
 [tool.pytest.ini_options]

src-ui/src/app/components/app-frame/app-frame.component.html

@@ -158,10 +158,13 @@
         </div>
 
         <div class="nav-group mt-3 mb-1">
-          <h6 class="sidebar-heading px-3 text-muted">
+          <h6 class="sidebar-heading px-3 text-muted d-flex align-items-center">
             <span i18n>Manage</span>
+            <button class="btn btn-link p-2 py-0" (click)="manageCollapse.toggle()">
+              <i-bs width="0.9em" height="0.9em" [name]="isManageMenuCollapsed ? 'chevron-down' : 'chevron-up'"></i-bs>
+            </button>
           </h6>
-          <ul class="nav flex-column mb-2">
+          <ul class="nav flex-column mb-2" #manageCollapse="ngbCollapse" [(ngbCollapse)]="isManageMenuCollapsed">
             <li class="nav-item app-link"
               *pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.Correspondent }">
               <a class="nav-link" routerLink="correspondents" routerLinkActive="active" (click)="closeMenu()"
@@ -235,117 +238,124 @@
         </div>
 
         <div class="nav-group mt-auto mb-1">
-          <h6 class="sidebar-heading px-3 pt-4 text-muted">
+          <h6 class="sidebar-heading px-3 pt-4 text-muted d-flex align-items-center">
             <span i18n>Administration</span>
+            <button class="btn btn-link p-2 py-0" (click)="adminCollapse.toggle()">
+              <i-bs width="0.9em" height="0.9em" [name]="isAdminMenuCollapsed ? 'chevron-down' : 'chevron-up'"></i-bs>
+            </button>
           </h6>
-          <ul class="nav flex-column mb-2">
+          <div class="mb-2">
-            <li class="nav-item app-link" *pngxIfPermissions="{ action: PermissionAction.Change, type: PermissionType.UISettings }"
+            <ul class="nav flex-column" #adminCollapse="ngbCollapse" [(ngbCollapse)]="isAdminMenuCollapsed">
-              tourAnchor="tour.settings">
+              <li class="nav-item app-link" *pngxIfPermissions="{ action: PermissionAction.Change, type: PermissionType.UISettings }"
-              <a class="nav-link" routerLink="settings" routerLinkActive="active" (click)="closeMenu()"
+                tourAnchor="tour.settings">
-                ngbPopover="Settings" i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end"
+                <a class="nav-link" routerLink="settings" routerLinkActive="active" (click)="closeMenu()"
-                container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
+                  ngbPopover="Settings" i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end"
-                <i-bs class="me-1" name="gear"></i-bs><span>&nbsp;<ng-container i18n>Settings</ng-container></span>
+                  container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
-              </a>
+                  <i-bs class="me-1" name="gear"></i-bs><span>&nbsp;<ng-container i18n>Settings</ng-container></span>
-            </li>
-            <li class="nav-item app-link" *pngxIfPermissions="{ action: PermissionAction.Change, type: PermissionType.AppConfig }">
-              <a class="nav-link" routerLink="config" routerLinkActive="active" (click)="closeMenu()"
-                ngbPopover="Configuration" i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end"
-                container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
-                <i-bs class="me-1" name="sliders2-vertical"></i-bs><span>&nbsp;<ng-container i18n>Configuration</ng-container></span>
-              </a>
-            </li>
-            <li class="nav-item app-link" *pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.User }">
-              <a class="nav-link" routerLink="usersgroups" routerLinkActive="active" (click)="closeMenu()"
-                ngbPopover="Users & Groups" i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end"
-                container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
-                <i-bs class="me-1" name="people"></i-bs><span>&nbsp;<ng-container i18n>Users & Groups</ng-container></span>
-              </a>
-            </li>
-            <li class="nav-item app-link"
-              *pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.PaperlessTask }"
-              tourAnchor="tour.file-tasks">
-              <a class="nav-link" routerLink="tasks" routerLinkActive="active" (click)="closeMenu()"
-                ngbPopover="File Tasks" i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end"
-                container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
-                <i-bs class="me-1" name="list-task"></i-bs><span>&nbsp;<ng-container i18n>File Tasks</ng-container>@if (tasksService.failedFileTasks.length > 0) {
-                  <span><span class="badge bg-danger ms-2 d-inline">{{tasksService.failedFileTasks.length}}</span></span>
-                }</span>
-                @if (tasksService.failedFileTasks.length > 0 && slimSidebarEnabled) {
-                  <span class="badge bg-danger position-absolute top-0 end-0 d-none d-md-block">{{tasksService.failedFileTasks.length}}</span>
-                }
-              </a>
-            </li>
-            @if (permissionsService.isAdmin()) {
-              <li class="nav-item app-link">
-                <a class="nav-link" routerLink="logs" routerLinkActive="active" (click)="closeMenu()" ngbPopover="Logs"
-                  i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end" container="body"
-                  triggers="mouseenter:mouseleave" popoverClass="popover-slim">
-                  <i-bs class="me-1" name="text-left"></i-bs><span>&nbsp;<ng-container i18n>Logs</ng-container></span>
                 </a>
               </li>
-            }
+              <li class="nav-item app-link" *pngxIfPermissions="{ action: PermissionAction.Change, type: PermissionType.AppConfig }">
-            <li class="nav-item mt-2" tourAnchor="tour.outro">
+                <a class="nav-link" routerLink="config" routerLinkActive="active" (click)="closeMenu()"
-              <a class="px-3 py-2 text-muted small d-flex align-items-center flex-wrap text-decoration-none"
+                  ngbPopover="Configuration" i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end"
-                target="_blank" rel="noopener noreferrer" href="https://docs.paperless-ngx.com" ngbPopover="Documentation"
+                  container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
-                i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end" container="body"
+                  <i-bs class="me-1" name="sliders2-vertical"></i-bs><span>&nbsp;<ng-container i18n>Configuration</ng-container></span>
-                triggers="mouseenter:mouseleave" popoverClass="popover-slim">
+                </a>
-                <i-bs class="d-flex" name="question-circle"></i-bs><span class="ms-1">&nbsp;<ng-container i18n>Documentation</ng-container></span>
+              </li>
-              </a>
+              <li class="nav-item app-link" *pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.User }">
-            </li>
+                <a class="nav-link" routerLink="usersgroups" routerLinkActive="active" (click)="closeMenu()"
-            <li class="nav-item" [class.visually-hidden]="slimSidebarEnabled">
+                  ngbPopover="Users & Groups" i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end"
-              <div class="px-3 py-0 text-muted small d-flex align-items-center flex-wrap">
+                  container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
-                <div class="me-3">
+                  <i-bs class="me-1" name="people"></i-bs><span>&nbsp;<ng-container i18n>Users & Groups</ng-container></span>
-                  <a class="text-muted text-decoration-none" target="_blank" rel="noopener noreferrer"
+                </a>
-                    href="https://github.com/paperless-ngx/paperless-ngx" ngbPopover="GitHub" i18n-ngbPopover
+              </li>
-                    [disablePopover]="!slimSidebarEnabled" placement="end" container="body"
+              <li class="nav-item app-link"
+                *pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.PaperlessTask }"
+                tourAnchor="tour.file-tasks">
+                <a class="nav-link" routerLink="tasks" routerLinkActive="active" (click)="closeMenu()"
+                  ngbPopover="File Tasks" i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end"
+                  container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
+                  <i-bs class="me-1" name="list-task"></i-bs><span>&nbsp;<ng-container i18n>File Tasks</ng-container>@if (tasksService.failedFileTasks.length > 0) {
+                    <span><span class="badge bg-danger ms-2 d-inline">{{tasksService.failedFileTasks.length}}</span></span>
+                  }</span>
+                  @if (tasksService.failedFileTasks.length > 0 && slimSidebarEnabled) {
+                    <span class="badge bg-danger position-absolute top-0 end-0 d-none d-md-block">{{tasksService.failedFileTasks.length}}</span>
+                  }
+                </a>
+              </li>
+              @if (permissionsService.isAdmin()) {
+                <li class="nav-item app-link">
+                  <a class="nav-link" routerLink="logs" routerLinkActive="active" (click)="closeMenu()" ngbPopover="Logs"
+                    i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end" container="body"
                     triggers="mouseenter:mouseleave" popoverClass="popover-slim">
-                    {{ versionString }}
+                    <i-bs class="me-1" name="text-left"></i-bs><span>&nbsp;<ng-container i18n>Logs</ng-container></span>
                   </a>
-                </div>
+                </li>
-                @if (!settingsService.updateCheckingIsSet || appRemoteVersion) {
+              }
-                  <div class="version-check">
+            </ul>
-                    <ng-template #updateAvailablePopContent>
+            <ul class="nav flex-column">
-                      <span class="small">Paperless-ngx {{ appRemoteVersion.version }} <ng-container i18n>is
+              <li class="nav-item mt-2" tourAnchor="tour.outro">
-                          available.</ng-container><br /><ng-container i18n>Click to view.</ng-container></span>
+                <a class="px-3 py-2 text-muted small d-flex align-items-center flex-wrap text-decoration-none"
-                    </ng-template>
+                  target="_blank" rel="noopener noreferrer" href="https://docs.paperless-ngx.com" ngbPopover="Documentation"
-                    <ng-template #updateCheckingNotEnabledPopContent>
+                  i18n-ngbPopover [disablePopover]="!slimSidebarEnabled" placement="end" container="body"
-                      <p class="small mb-2">
+                  triggers="mouseenter:mouseleave" popoverClass="popover-slim">
-                        <ng-container i18n>Paperless-ngx can automatically check for updates</ng-container>
+                  <i-bs class="d-flex" name="question-circle"></i-bs><span class="ms-1">&nbsp;<ng-container i18n>Documentation</ng-container></span>
-                      </p>
+                </a>
-                      <div class="btn-group btn-group-xs flex-fill w-100">
+              </li>
-                        <button class="btn btn-outline-primary" (click)="setUpdateChecking(true)">Enable</button>
+              <li class="nav-item" [class.visually-hidden]="slimSidebarEnabled">
-                        <button class="btn btn-outline-secondary" (click)="setUpdateChecking(false)">Disable</button>
+                <div class="px-3 py-0 text-muted small d-flex align-items-center flex-wrap">
-                      </div>
+                  <div class="me-3">
-                      <p class="small mb-0 mt-2">
+                    <a class="text-muted text-decoration-none" target="_blank" rel="noopener noreferrer"
-                        <a class="small text-decoration-none fst-italic" routerLink="/settings" fragment="update-checking" i18n>
+                      href="https://github.com/paperless-ngx/paperless-ngx" ngbPopover="GitHub" i18n-ngbPopover
-                          How does this work?
+                      [disablePopover]="!slimSidebarEnabled" placement="end" container="body"
-                        </a>
+                      triggers="mouseenter:mouseleave" popoverClass="popover-slim">
-                      </p>
+                      {{ versionString }}
-                    </ng-template>
+                    </a>
-                    @if (settingsService.updateCheckingIsSet) {
+                  </div>
-                      @if (appRemoteVersion.update_available) {
+                  @if (!settingsService.updateCheckingIsSet || appRemoteVersion) {
-                        <a class="small text-decoration-none" target="_blank" rel="noopener noreferrer"
+                    <div class="version-check">
-                          href="https://github.com/paperless-ngx/paperless-ngx/releases"
+                      <ng-template #updateAvailablePopContent>
-                          [ngbPopover]="updateAvailablePopContent" popoverClass="shadow" triggers="mouseenter:mouseleave"
+                        <span class="small">Paperless-ngx {{ appRemoteVersion.version }} <ng-container i18n>is
+                            available.</ng-container><br /><ng-container i18n>Click to view.</ng-container></span>
+                      </ng-template>
+                      <ng-template #updateCheckingNotEnabledPopContent>
+                        <p class="small mb-2">
+                          <ng-container i18n>Paperless-ngx can automatically check for updates</ng-container>
+                        </p>
+                        <div class="btn-group btn-group-xs flex-fill w-100">
+                          <button class="btn btn-outline-primary" (click)="setUpdateChecking(true)">Enable</button>
+                          <button class="btn btn-outline-secondary" (click)="setUpdateChecking(false)">Disable</button>
+                        </div>
+                        <p class="small mb-0 mt-2">
+                          <a class="small text-decoration-none fst-italic" routerLink="/settings" fragment="update-checking" i18n>
+                            How does this work?
+                          </a>
+                        </p>
+                      </ng-template>
+                      @if (settingsService.updateCheckingIsSet) {
+                        @if (appRemoteVersion.update_available) {
+                          <a class="small text-decoration-none" target="_blank" rel="noopener noreferrer"
+                            href="https://github.com/paperless-ngx/paperless-ngx/releases"
+                            [ngbPopover]="updateAvailablePopContent" popoverClass="shadow" triggers="mouseenter:mouseleave"
+                            container="body">
+                            <i-bs width="1.2em" height="1.2em" name="info-circle"></i-bs>
+                            @if (appRemoteVersion?.update_available) {
+                              &nbsp;<ng-container i18n>Update available</ng-container>
+                            }
+                          </a>
+                        }
+                      } @else {
+                        <a  *pngxIfPermissions="{ action: PermissionAction.Change, type: PermissionType.UISettings }" class="small text-decoration-none" routerLink="/settings" fragment="update-checking"
+                          [ngbPopover]="updateCheckingNotEnabledPopContent" popoverClass="shadow" triggers="mouseenter"
                           container="body">
                           <i-bs width="1.2em" height="1.2em" name="info-circle"></i-bs>
-                          @if (appRemoteVersion?.update_available) {
-                            &nbsp;<ng-container i18n>Update available</ng-container>
-                          }
                         </a>
                       }
-                    } @else {
+                    </div>
-                      <a  *pngxIfPermissions="{ action: PermissionAction.Change, type: PermissionType.UISettings }" class="small text-decoration-none" routerLink="/settings" fragment="update-checking"
+                  }
-                        [ngbPopover]="updateCheckingNotEnabledPopContent" popoverClass="shadow" triggers="mouseenter"
+                </div>
-                        container="body">
+              </li>
-                        <i-bs width="1.2em" height="1.2em" name="info-circle"></i-bs>
+            </ul>
-                      </a>
+          </div>
-                    }
-                  </div>
-                }
-              </div>
-            </li>
-          </ul>
         </div>
       </div>
     </nav>

src-ui/src/app/components/app-frame/app-frame.component.ts

@@ -78,6 +78,8 @@ export class AppFrameComponent
   appRemoteVersion: AppRemoteVersion
 
   isMenuCollapsed: boolean = true
+  isManageMenuCollapsed: boolean = false
+  isAdminMenuCollapsed: boolean = false
 
   slimSidebarAnimating: boolean = false
 

src-ui/src/main.ts

@@ -55,6 +55,8 @@ import {
   checkLg,
   chevronDoubleLeft,
   chevronDoubleRight,
+  chevronDown,
+  chevronUp,
   clipboard,
   clipboardCheck,
   clipboardCheckFill,
@@ -260,6 +262,8 @@ const icons = {
   checkAll,
   checkCircleFill,
   checkLg,
+  chevronDown,
+  chevronUp,
   chevronDoubleLeft,
   chevronDoubleRight,
   clipboard,

src/documents/views.py

@@ -650,7 +650,7 @@ class DocumentViewSet(
         )
 
     def get_metadata(self, file, mime_type):
-        if not os.path.isfile(file):
+        if not Path(file).is_file():
             return None
 
         parser_class = get_parser_class_for_mime_type(mime_type)
@@ -668,8 +668,8 @@ class DocumentViewSet(
             return []
 
     def get_filesize(self, filename):
-        if os.path.isfile(filename):
+        if Path(filename).is_file():
-            return os.stat(filename).st_size
+            return Path(filename).stat().st_size
         else:
             return None
 
@@ -1215,31 +1215,37 @@ class UnifiedSearchViewSet(DocumentViewSet):
 class LogViewSet(ViewSet):
     permission_classes = (IsAuthenticated, PaperlessAdminPermissions)
 
-    log_files = ["paperless", "mail", "celery"]
+    ALLOWED_LOG_FILES = {
+        "paperless": "paperless.log",
+        "mail": "mail.log",
+        "celery": "celery.log",
+    }
 
-    def get_log_filename(self, log):
+    def get_log_file(self, log_key: str) -> Path:
-        return os.path.join(settings.LOGGING_DIR, f"{log}.log")
+        return Path(settings.LOGGING_DIR) / self.ALLOWED_LOG_FILES[log_key]
 
     def retrieve(self, request, *args, **kwargs):
-        log_file = kwargs.get("pk")
+        log_key = kwargs.get("pk")
-        if log_file not in self.log_files:
+        if log_key not in self.ALLOWED_LOG_FILES:
             raise Http404
 
-        filename = self.get_log_filename(log_file)
+        log_file = self.get_log_file(log_key)
 
-        if not os.path.isfile(filename):
+        if not log_file.is_file():
             raise Http404
 
-        with open(filename) as f:
+        with log_file.open() as f:
             lines = [line.rstrip() for line in f.readlines()]
 
         return Response(lines)
 
     def list(self, request, *args, **kwargs):
-        exist = [
+        existing_logs = [
-            log for log in self.log_files if os.path.isfile(self.get_log_filename(log))
+            log_key
+            for log_key in self.ALLOWED_LOG_FILES
+            if self.get_log_file(log_key).is_file()
         ]
-        return Response(exist)
+        return Response(existing_logs)
 
 
 class SavedViewViewSet(ModelViewSet, PassUserMixin):
@@ -2073,7 +2079,7 @@ class BulkDownloadView(GenericAPIView):
                 strategy.add_document(document)
 
         # TODO(stumpylog): Investigate using FileResponse here
-        with open(temp.name, "rb") as f:
+        with Path(temp.name).open("rb") as f:
             response = HttpResponse(f, content_type="application/zip")
             response["Content-Disposition"] = '{}; filename="{}"'.format(
                 "attachment",

src/paperless/checks.py

@@ -3,6 +3,7 @@ import os
 import pwd
 import shutil
 import stat
+from pathlib import Path
 
 from django.conf import settings
 from django.core.checks import Error
@@ -19,26 +20,23 @@ writeable_hint = (
 )
 
 
-def path_check(var, directory):
+def path_check(var, directory: Path) -> list[Error]:
-    messages = []
+    messages: list[Error] = []
     if directory:
-        if not os.path.isdir(directory):
+        if not directory.is_dir():
             messages.append(
                 Error(exists_message.format(var), exists_hint.format(directory)),
             )
         else:
-            test_file = os.path.join(
+            test_file: Path = directory / f"__paperless_write_test_{os.getpid()}__"
-                directory,
-                f"__paperless_write_test_{os.getpid()}__",
-            )
             try:
-                with open(test_file, "w"):
+                with test_file.open("w"):
                     pass
             except PermissionError:
-                dir_stat = os.stat(directory)
+                dir_stat: os.stat_result = Path(directory).stat()
-                dir_mode = stat.filemode(dir_stat.st_mode)
+                dir_mode: str = stat.filemode(dir_stat.st_mode)
-                dir_owner = pwd.getpwuid(dir_stat.st_uid).pw_name
+                dir_owner: str = pwd.getpwuid(dir_stat.st_uid).pw_name
-                dir_group = grp.getgrgid(dir_stat.st_gid).gr_name
+                dir_group: str = grp.getgrgid(dir_stat.st_gid).gr_name
                 messages.append(
                     Error(
                         writeable_message.format(var),
@@ -48,14 +46,18 @@ def path_check(var, directory):
                     ),
                 )
             finally:
-                if os.path.isfile(test_file):
+                try:
-                    os.remove(test_file)
+                    if test_file.is_file():
+                        test_file.unlink()
+                except (PermissionError, OSError):
+                    # Skip cleanup if we can't access the file — expected in permission tests
+                    pass
 
     return messages
 
 
 @register()
-def paths_check(app_configs, **kwargs):
+def paths_check(app_configs, **kwargs) -> list[Error]:
     """
     Check the various paths for existence, readability and writeability
     """

src/paperless/tests/test_checks.py

@@ -27,9 +27,9 @@ class TestChecks(DirectoriesMixin, TestCase):
         self.assertEqual(paths_check(None), [])
 
     @override_settings(
-        MEDIA_ROOT="uuh",
+        MEDIA_ROOT=Path("uuh"),
-        DATA_DIR="whatever",
+        DATA_DIR=Path("whatever"),
-        CONSUMPTION_DIR="idontcare",
+        CONSUMPTION_DIR=Path("idontcare"),
     )
     def test_paths_check_dont_exist(self):
         msgs = paths_check(None)

src/paperless_mail/mail.py

@@ -1,7 +1,6 @@
 import datetime
 import itertools
 import logging
-import os
 import ssl
 import tempfile
 import traceback
@@ -484,7 +483,7 @@ class MailAccountHandler(LoggingMixin):
             return message.subject
 
         elif rule.assign_title_from == MailRule.TitleSource.FROM_FILENAME:
-            return os.path.splitext(os.path.basename(att.filename))[0]
+            return Path(att.filename).stem
 
         elif rule.assign_title_from == MailRule.TitleSource.NONE:
             return None
@@ -908,7 +907,7 @@ class MailAccountHandler(LoggingMixin):
             dir=settings.SCRATCH_DIR,
             suffix=".eml",
         )
-        with open(temp_filename, "wb") as f:
+        with Path(temp_filename).open("wb") as f:
             # Move "From"-header to beginning of file
             # TODO: This ugly workaround is needed because the parser is
             #   chosen only by the mime_type detected via magic

src/paperless_tesseract/tests/test_parser.py

@@ -1,4 +1,3 @@
-import os
 import shutil
 import tempfile
 import uuid
@@ -70,13 +69,13 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         """
         parser = RasterisedDocumentParser(uuid.uuid4())
         page_count = parser.get_page_count(
-            os.path.join(self.SAMPLE_FILES, "simple-digital.pdf"),
+            (self.SAMPLE_FILES / "simple-digital.pdf").as_posix(),
             "application/pdf",
         )
         self.assertEqual(page_count, 1)
 
         page_count = parser.get_page_count(
-            os.path.join(self.SAMPLE_FILES, "multi-page-mixed.pdf"),
+            (self.SAMPLE_FILES / "multi-page-mixed.pdf").as_posix(),
             "application/pdf",
         )
         self.assertEqual(page_count, 6)
@@ -93,7 +92,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         parser = RasterisedDocumentParser(uuid.uuid4())
         with self.assertLogs("paperless.parsing.tesseract", level="WARNING") as cm:
             page_count = parser.get_page_count(
-                os.path.join(self.SAMPLE_FILES, "password-protected.pdf"),
+                (self.SAMPLE_FILES / "password-protected.pdf").as_posix(),
                 "application/pdf",
             )
             self.assertEqual(page_count, None)
@@ -102,7 +101,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
     def test_thumbnail(self):
         parser = RasterisedDocumentParser(uuid.uuid4())
         thumb = parser.get_thumbnail(
-            os.path.join(self.SAMPLE_FILES, "simple-digital.pdf"),
+            (self.SAMPLE_FILES / "simple-digital.pdf").as_posix(),
             "application/pdf",
         )
         self.assertIsFile(thumb)
@@ -119,7 +118,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
 
         parser = RasterisedDocumentParser(uuid.uuid4())
         thumb = parser.get_thumbnail(
-            os.path.join(self.SAMPLE_FILES, "simple-digital.pdf"),
+            (self.SAMPLE_FILES / "simple-digital.pdf").as_posix(),
             "application/pdf",
         )
         self.assertIsFile(thumb)
@@ -127,7 +126,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
     def test_thumbnail_encrypted(self):
         parser = RasterisedDocumentParser(uuid.uuid4())
         thumb = parser.get_thumbnail(
-            os.path.join(self.SAMPLE_FILES, "encrypted.pdf"),
+            (self.SAMPLE_FILES / "encrypted.pdf").as_posix(),
             "application/pdf",
         )
         self.assertIsFile(thumb)
@@ -135,17 +134,17 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
     def test_get_dpi(self):
         parser = RasterisedDocumentParser(None)
 
-        dpi = parser.get_dpi(os.path.join(self.SAMPLE_FILES, "simple-no-dpi.png"))
+        dpi = parser.get_dpi((self.SAMPLE_FILES / "simple-no-dpi.png").as_posix())
         self.assertEqual(dpi, None)
 
-        dpi = parser.get_dpi(os.path.join(self.SAMPLE_FILES, "simple.png"))
+        dpi = parser.get_dpi((self.SAMPLE_FILES / "simple.png").as_posix())
         self.assertEqual(dpi, 72)
 
     def test_simple_digital(self):
         parser = RasterisedDocumentParser(None)
 
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "simple-digital.pdf"),
+            (self.SAMPLE_FILES / "simple-digital.pdf").as_posix(),
             "application/pdf",
         )
 
@@ -157,7 +156,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         parser = RasterisedDocumentParser(None)
 
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "with-form.pdf"),
+            (self.SAMPLE_FILES / "with-form.pdf").as_posix(),
             "application/pdf",
         )
 
@@ -173,7 +172,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         parser = RasterisedDocumentParser(None)
 
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "with-form.pdf"),
+            (self.SAMPLE_FILES / "with-form.pdf").as_posix(),
             "application/pdf",
         )
 
@@ -187,7 +186,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
     def test_signed(self):
         parser = RasterisedDocumentParser(None)
 
-        parser.parse(os.path.join(self.SAMPLE_FILES, "signed.pdf"), "application/pdf")
+        parser.parse((self.SAMPLE_FILES / "signed.pdf").as_posix(), "application/pdf")
 
         self.assertIsNone(parser.archive_path)
         self.assertContainsStrings(
@@ -203,7 +202,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         parser = RasterisedDocumentParser(None)
 
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "encrypted.pdf"),
+            (self.SAMPLE_FILES / "encrypted.pdf").as_posix(),
             "application/pdf",
         )
 
@@ -214,7 +213,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
     def test_with_form_error_notext(self):
         parser = RasterisedDocumentParser(None)
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "with-form.pdf"),
+            (self.SAMPLE_FILES / "with-form.pdf").as_posix(),
             "application/pdf",
         )
 
@@ -228,7 +227,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         parser = RasterisedDocumentParser(None)
 
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "with-form.pdf"),
+            (self.SAMPLE_FILES / "with-form.pdf").as_posix(),
             "application/pdf",
         )
 
@@ -240,7 +239,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
     def test_image_simple(self):
         parser = RasterisedDocumentParser(None)
 
-        parser.parse(os.path.join(self.SAMPLE_FILES, "simple.png"), "image/png")
+        parser.parse((self.SAMPLE_FILES / "simple.png").as_posix(), "image/png")
 
         self.assertIsFile(parser.archive_path)
 
@@ -252,11 +251,11 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         with tempfile.TemporaryDirectory() as tempdir:
             # Copy sample file to temp directory, as the parsing changes the file
             # and this makes it modified to Git
-            sample_file = os.path.join(self.SAMPLE_FILES, "simple-alpha.png")
+            sample_file = self.SAMPLE_FILES / "simple-alpha.png"
-            dest_file = os.path.join(tempdir, "simple-alpha.png")
+            dest_file = Path(tempdir) / "simple-alpha.png"
             shutil.copy(sample_file, dest_file)
 
-            parser.parse(dest_file, "image/png")
+            parser.parse(dest_file.as_posix(), "image/png")
 
             self.assertIsFile(parser.archive_path)
 
@@ -266,7 +265,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         parser = RasterisedDocumentParser(None)
 
         dpi = parser.calculate_a4_dpi(
-            os.path.join(self.SAMPLE_FILES, "simple-no-dpi.png"),
+            (self.SAMPLE_FILES / "simple-no-dpi.png").as_posix(),
         )
 
         self.assertEqual(dpi, 62)
@@ -278,7 +277,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
 
         def f():
             parser.parse(
-                os.path.join(self.SAMPLE_FILES, "simple-no-dpi.png"),
+                (self.SAMPLE_FILES / "simple-no-dpi.png").as_posix(),
                 "image/png",
             )
 
@@ -288,7 +287,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
     def test_image_no_dpi_default(self):
         parser = RasterisedDocumentParser(None)
 
-        parser.parse(os.path.join(self.SAMPLE_FILES, "simple-no-dpi.png"), "image/png")
+        parser.parse((self.SAMPLE_FILES / "simple-no-dpi.png").as_posix(), "image/png")
 
         self.assertIsFile(parser.archive_path)
 
@@ -300,7 +299,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
     def test_multi_page(self):
         parser = RasterisedDocumentParser(None)
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "multi-page-digital.pdf"),
+            (self.SAMPLE_FILES / "multi-page-digital.pdf").as_posix(),
             "application/pdf",
         )
         self.assertIsFile(parser.archive_path)
@@ -313,7 +312,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
     def test_multi_page_pages_skip(self):
         parser = RasterisedDocumentParser(None)
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "multi-page-digital.pdf"),
+            (self.SAMPLE_FILES / "multi-page-digital.pdf").as_posix(),
             "application/pdf",
         )
         self.assertIsFile(parser.archive_path)
@@ -326,7 +325,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
     def test_multi_page_pages_redo(self):
         parser = RasterisedDocumentParser(None)
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "multi-page-digital.pdf"),
+            (self.SAMPLE_FILES / "multi-page-digital.pdf").as_posix(),
             "application/pdf",
         )
         self.assertIsFile(parser.archive_path)
@@ -339,7 +338,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
     def test_multi_page_pages_force(self):
         parser = RasterisedDocumentParser(None)
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "multi-page-digital.pdf"),
+            (self.SAMPLE_FILES / "multi-page-digital.pdf").as_posix(),
             "application/pdf",
         )
         self.assertIsFile(parser.archive_path)
@@ -352,7 +351,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
     def test_multi_page_analog_pages_skip(self):
         parser = RasterisedDocumentParser(None)
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "multi-page-images.pdf"),
+            (self.SAMPLE_FILES / "multi-page-images.pdf").as_posix(),
             "application/pdf",
         )
         self.assertIsFile(parser.archive_path)
@@ -376,7 +375,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         """
         parser = RasterisedDocumentParser(None)
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "multi-page-images.pdf"),
+            (self.SAMPLE_FILES / "multi-page-images.pdf").as_posix(),
             "application/pdf",
         )
         self.assertIsFile(parser.archive_path)
@@ -398,7 +397,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         """
         parser = RasterisedDocumentParser(None)
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "multi-page-images.pdf"),
+            (self.SAMPLE_FILES / "multi-page-images.pdf").as_posix(),
             "application/pdf",
         )
         self.assertIsFile(parser.archive_path)
@@ -420,7 +419,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         """
         parser = RasterisedDocumentParser(None)
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "multi-page-digital.pdf"),
+            (self.SAMPLE_FILES / "multi-page-digital.pdf").as_posix(),
             "application/pdf",
         )
         self.assertIsNone(parser.archive_path)
@@ -443,7 +442,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         """
         parser = RasterisedDocumentParser(None)
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "multi-page-images.pdf"),
+            (self.SAMPLE_FILES / "multi-page-images.pdf").as_posix(),
             "application/pdf",
         )
 
@@ -468,7 +467,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         """
         parser = RasterisedDocumentParser(None)
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "multi-page-digital.pdf"),
+            (self.SAMPLE_FILES / "multi-page-digital.pdf").as_posix(),
             "application/pdf",
         )
         self.assertIsNotNone(parser.archive_path)
@@ -491,7 +490,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         """
         parser = RasterisedDocumentParser(None)
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "multi-page-images.pdf"),
+            (self.SAMPLE_FILES / "multi-page-images.pdf").as_posix(),
             "application/pdf",
         )
         self.assertIsNotNone(parser.archive_path)
@@ -514,7 +513,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         """
         parser = RasterisedDocumentParser(None)
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "multi-page-digital.pdf"),
+            (self.SAMPLE_FILES / "multi-page-digital.pdf").as_posix(),
             "application/pdf",
         )
         self.assertIsNone(parser.archive_path)
@@ -537,7 +536,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         """
         parser = RasterisedDocumentParser(None)
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "multi-page-images.pdf"),
+            (self.SAMPLE_FILES / "multi-page-images.pdf").as_posix(),
             "application/pdf",
         )
         self.assertIsNotNone(parser.archive_path)
@@ -560,7 +559,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         """
         parser = RasterisedDocumentParser(None)
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "multi-page-digital.pdf"),
+            (self.SAMPLE_FILES / "multi-page-digital.pdf").as_posix(),
             "application/pdf",
         )
         self.assertIsNone(parser.archive_path)
@@ -583,7 +582,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         """
         parser = RasterisedDocumentParser(None)
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "multi-page-images.pdf"),
+            (self.SAMPLE_FILES / "multi-page-images.pdf").as_posix(),
             "application/pdf",
         )
         self.assertIsNone(parser.archive_path)
@@ -606,7 +605,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         """
         parser = RasterisedDocumentParser(None)
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "multi-page-mixed.pdf"),
+            (self.SAMPLE_FILES / "multi-page-mixed.pdf").as_posix(),
             "application/pdf",
         )
         self.assertIsNotNone(parser.archive_path)
@@ -616,7 +615,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
             ["page 1", "page 2", "page 3", "page 4", "page 5", "page 6"],
         )
 
-        with open(os.path.join(parser.tempdir, "sidecar.txt")) as f:
+        with (parser.tempdir / "sidecar.txt").open() as f:
             sidecar = f.read()
 
         self.assertIn("[OCR skipped on page(s) 4-6]", sidecar)
@@ -637,7 +636,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         """
         parser = RasterisedDocumentParser(None)
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "single-page-mixed.pdf"),
+            (self.SAMPLE_FILES / "single-page-mixed.pdf").as_posix(),
             "application/pdf",
         )
         self.assertIsNotNone(parser.archive_path)
@@ -651,7 +650,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
             ],
         )
 
-        with open(os.path.join(parser.tempdir, "sidecar.txt")) as f:
+        with (parser.tempdir / "sidecar.txt").open() as f:
             sidecar = f.read().lower()
 
         self.assertIn("this is some text, but in an image, also on page 1.", sidecar)
@@ -674,7 +673,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         """
         parser = RasterisedDocumentParser(None)
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "multi-page-mixed.pdf"),
+            (self.SAMPLE_FILES / "multi-page-mixed.pdf").as_posix(),
             "application/pdf",
         )
         self.assertIsNone(parser.archive_path)
@@ -686,7 +685,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
     @override_settings(OCR_MODE="skip", OCR_ROTATE_PAGES=True)
     def test_rotate(self):
         parser = RasterisedDocumentParser(None)
-        parser.parse(os.path.join(self.SAMPLE_FILES, "rotated.pdf"), "application/pdf")
+        parser.parse((self.SAMPLE_FILES / "rotated.pdf").as_posix(), "application/pdf")
         self.assertContainsStrings(
             parser.get_text(),
             [
@@ -708,7 +707,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         """
         parser = RasterisedDocumentParser(None)
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "multi-page-images.tiff"),
+            (self.SAMPLE_FILES / "multi-page-images.tiff").as_posix(),
             "image/tiff",
         )
         self.assertIsFile(parser.archive_path)
@@ -728,7 +727,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
             - Text from all pages extracted
         """
         parser = RasterisedDocumentParser(None)
-        sample_file = os.path.join(self.SAMPLE_FILES, "multi-page-images-alpha.tiff")
+        sample_file = self.SAMPLE_FILES / "multi-page-images-alpha.tiff"
         with tempfile.NamedTemporaryFile() as tmp_file:
             shutil.copy(sample_file, tmp_file.name)
             parser.parse(
@@ -753,10 +752,9 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
             - Text from all pages extracted
         """
         parser = RasterisedDocumentParser(None)
-        sample_file = os.path.join(
+        sample_file = (
-            self.SAMPLE_FILES,
+            self.SAMPLE_FILES / "multi-page-images-alpha-rgb.tiff"
-            "multi-page-images-alpha-rgb.tiff",
+        ).as_posix()
-        )
         with tempfile.NamedTemporaryFile() as tmp_file:
             shutil.copy(sample_file, tmp_file.name)
             parser.parse(
@@ -845,7 +843,7 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         parser = RasterisedDocumentParser(None)
 
         parser.parse(
-            os.path.join(self.SAMPLE_FILES, "rtl-test.pdf"),
+            (self.SAMPLE_FILES / "rtl-test.pdf").as_posix(),
             "application/pdf",
         )
 
@@ -860,49 +858,52 @@ class TestParser(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
         self.assertRaises(
             ParseError,
             parser.parse,
-            os.path.join(self.SAMPLE_FILES, "simple-digital.pdf"),
+            (self.SAMPLE_FILES / "simple-digital.pdf").as_posix(),
             "application/pdf",
         )
 
 
 class TestParserFileTypes(DirectoriesMixin, FileSystemAssertsMixin, TestCase):
-    SAMPLE_FILES = os.path.join(os.path.dirname(__file__), "samples")
+    SAMPLE_FILES = Path(__file__).parent / "samples"
 
     def test_bmp(self):
         parser = RasterisedDocumentParser(None)
-        parser.parse(os.path.join(self.SAMPLE_FILES, "simple.bmp"), "image/bmp")
+        parser.parse((self.SAMPLE_FILES / "simple.bmp").as_posix(), "image/bmp")
         self.assertIsFile(parser.archive_path)
         self.assertIn("this is a test document", parser.get_text().lower())
 
     def test_jpg(self):
         parser = RasterisedDocumentParser(None)
-        parser.parse(os.path.join(self.SAMPLE_FILES, "simple.jpg"), "image/jpeg")
+        parser.parse((self.SAMPLE_FILES / "simple.jpg").as_posix(), "image/jpeg")
         self.assertIsFile(parser.archive_path)
         self.assertIn("this is a test document", parser.get_text().lower())
 
     def test_heic(self):
         parser = RasterisedDocumentParser(None)
-        parser.parse(os.path.join(self.SAMPLE_FILES, "simple.heic"), "image/heic")
+        parser.parse((self.SAMPLE_FILES / "simple.heic").as_posix(), "image/heic")
         self.assertIsFile(parser.archive_path)
         self.assertIn("pizza", parser.get_text().lower())
 
     @override_settings(OCR_IMAGE_DPI=200)
     def test_gif(self):
         parser = RasterisedDocumentParser(None)
-        parser.parse(os.path.join(self.SAMPLE_FILES, "simple.gif"), "image/gif")
+        parser.parse((self.SAMPLE_FILES / "simple.gif").as_posix(), "image/gif")
         self.assertIsFile(parser.archive_path)
         self.assertIn("this is a test document", parser.get_text().lower())
 
     def test_tiff(self):
         parser = RasterisedDocumentParser(None)
-        parser.parse(os.path.join(self.SAMPLE_FILES, "simple.tif"), "image/tiff")
+        parser.parse((self.SAMPLE_FILES / "simple.tif").as_posix(), "image/tiff")
         self.assertIsFile(parser.archive_path)
         self.assertIn("this is a test document", parser.get_text().lower())
 
     @override_settings(OCR_IMAGE_DPI=72)
     def test_webp(self):
         parser = RasterisedDocumentParser(None)
-        parser.parse(os.path.join(self.SAMPLE_FILES, "document.webp"), "image/webp")
+        parser.parse(
+            (self.SAMPLE_FILES / "document.webp").as_posix(),
+            "image/webp",
+        )
         self.assertIsFile(parser.archive_path)
         # Older tesseracts consistently mangle the space between "a webp",
         # tesseract 5.3.0 seems to do a better job, so we're accepting both