papers-cli 2.13__tar.gz → 2.14b0__tar.gz

{papers_cli-2.13 → papers_cli-2.14b0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: papers-cli
-Version: 2.13
+Version: 2.14b0
 Summary: utilities to keep your PDF library organized
 Author-email: Mahé Perrette <mahe.perrette@gmail.com>
 License: MIT

{papers_cli-2.13 → papers_cli-2.14b0}/papers/__main__.py

@@ -9,8 +9,6 @@ import subprocess as sp
 import shutil
 import itertools
 import fnmatch   # unix-like match
-import hashlib
-import time
 
 import papers
 from papers import logger
@@ -19,7 +17,8 @@ from papers.extract import fetch_bibtex_by_doi, fetch_bibtex_by_fulltext_crossre
 from papers.encoding import parse_file, format_file, family_names, format_entries, standard_name, format_entry, parse_keywords, format_key
 from papers.config import bcolors, Config, search_config, CONFIG_FILE, CONFIG_FILE_LOCAL, DATA_DIR, CONFIG_FILE_LEGACY, BACKUP_DIR
 from papers.duplicate import list_duplicates, list_uniques, edit_entries
-from papers.bib import Biblio, FUZZY_RATIO, DEFAULT_SIMILARITY, entry_filecheck, backupfile as backupfile_func, isvalidkey, DuplicateKeyError
+from papers.bib import (Biblio, FUZZY_RATIO, DEFAULT_SIMILARITY, entry_filecheck,
+                        backupfile as backupfile_func, isvalidkey, DuplicateKeyError, clean_filesdir)
 from papers.utils import move, checksum, view_pdf, open_folder
 from papers import __version__
 
@@ -89,6 +88,9 @@ def _backup_bib(biblio, config, message=None):
         biblio.rename_entries_files(copy=True, relative_to=backupdir, hardlink=True)
         biblio.save(config.backupfile_clean)
         config.gitcmd(f"add {config.backupfile_clean.name}")
+
+        # Remove unlink files
+        clean_filesdir(biblio, interactive=False, ignore_files=[config.backupfile, config.backupfile_clean])
         config.gitcmd(f"add files")
 
     else:
@@ -673,6 +675,10 @@ def filecheckcmd(parser, o, config):
     if o.rename:
         biblio.rename_entries_files(o.copy)
 
+    if o.clean_filesdir:
+        print("Check files directory for unlinked files")
+        clean_filesdir(biblio, interactive=not o.force, ignore_files=[config.bibtex])
+
     savebib(biblio, config)
 
 def redocmd(parser, o, config):
@@ -1116,6 +1122,9 @@ def get_parser(config=None):
     filecheckp.add_argument('-d', '--delete-broken', action='store_true',
         help='remove file entry if the file link is broken')
 
+    filecheckp.add_argument('--clean-filesdir', action='store_true',
+        help='remove files in filesdir if not referred to in any entry')
+
     filecheckp.add_argument('--fix-mendeley', action='store_true',
         help='fix a Mendeley bug where the leading "/" is omitted.')
 

{papers_cli-2.13 → papers_cli-2.14b0}/papers/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.13'
-__version_tuple__ = version_tuple = (2, 13)
+__version__ = version = '2.14b0'
+__version_tuple__ = version_tuple = (2, 14)

{papers_cli-2.13 → papers_cli-2.14b0}/papers/bib.py

@@ -1,13 +1,8 @@
 import os
 from pathlib import Path
-import logging
-# logger.basicConfig(level=logger.INFO)
-import argparse
-import subprocess as sp
 import shutil
 import bisect
-import itertools
-import fnmatch   # unix-like match
+from unidecode import unidecode as unicode_to_ascii
 import bibtexparser
 from bibtexparser.customization import convert_to_unicode
 
@@ -18,8 +13,8 @@ from papers.extract import extract_pdf_doi, isvaliddoi, parse_doi
 from papers.extract import extract_pdf_metadata
 from papers.extract import fetch_bibtex_by_fulltext_crossref, fetch_bibtex_by_doi
 
-from papers.encoding import unicode_to_latex, unicode_to_ascii
 from papers.encoding import parse_file, format_file, standard_name, family_names, format_entries, update_file_path, format_entry
+from papers.latexenc import unicode_to_latex, latex_to_unicode
 
 from papers.filename import NAMEFORMAT, KEYFORMAT
 from papers.utils import bcolors, checksum, move as _move
@@ -309,7 +304,7 @@ class Biblio:
             else:
                 print(format_entry(self, entry, prefix="New entry"))
                 print(format_entry(self, self.entries[i], prefix="Conflicts with"))
-                raise DuplicateKeyError('Key conflict. Try update_key is True?')
+                raise DuplicateKeyError('Key conflict. Try update_key is True or specify --key KEY explicitly')
 
         else:
             logger.info('new entry: '+self.key(entry))
@@ -821,3 +816,71 @@ def entry_filecheck(e, delete_broken=False, fix_mendeley=False,
         newfiles.append(file)
 
     e['file'] = format_file(newfiles, relative_to=relative_to)
+
+
+def clean_filesdir(biblio, interactive=True, ignore_files=None, ignore_folders=None):
+    if biblio.filesdir is None:
+        raise ValueError('filesdir is not defined, cannot clean')
+    removed_files = []
+
+    allfiles = set(os.path.abspath(file) for e in biblio.entries for file in biblio.get_files(e))
+    if ignore_files:
+        for f in ignore_files:
+            allfiles.add(os.path.abspath(f))
+    allfolders = set(os.path.abspath(folder) for e in biblio.entries for folder in {os.path.dirname(file) for file in biblio.get_files(e)})
+
+    if ignore_folders is None:
+        ignore_folders = []
+
+    for root, direcs, files in os.walk(biblio.filesdir):
+
+        ANS = None  # Y(es) or N(o) for all files in this folder (reset at each pass)
+        if root in ignore_folders:
+            continue
+        if '.git' in root.split(os.path.sep):
+            continue
+        for file in files:
+            path = os.path.abspath(os.path.join(root, file))
+            if file.startswith('.') or file.endswith('.bib'):
+                continue
+            if path not in allfiles:
+                if interactive:
+                    if ANS is None:
+                        ans = input(f"File: {os.path.relpath(path, biblio.filesdir)} not in library. Remove ? [Y/n/Y/N] ")
+                    else:
+                        ans = ANS
+                    if ans in ['Y', 'N']:
+                        ans = ANS = ans.lower()  # same reply for all files in this folder
+                    if ans.lower() == 'y':
+                        os.remove(path)
+                        removed_files.append(path)
+                else:
+                    logger.info(f"Remove unlinked file {os.path.relpath(path, biblio.filesdir)}.")
+                    os.remove(path)
+                    removed_files.append(path)
+
+        for direc in direcs:
+            if direc.startswith('.'):
+                continue
+            if direc in ignore_folders:
+                continue
+
+            # Check multifile entries
+            bibtex = os.path.join(root, direc, '.'+direc+'.bib')
+            if not os.path.exists(bibtex):
+                continue
+
+            direcpath = os.path.abspath(os.path.join(root, direc))
+
+            if direcpath not in allfolders:
+                if interactive:
+                    ans = input(f"Folder: {os.path.relpath(direcpath, root)} not in library. Remove ? [Y/n] ")
+                    if ans.lower() == 'y':
+                        shutil.rmtree(os.path.join(root, direcpath))
+                else:
+                    logger.info(f"Remove folder {direc}.")
+                    shutil.rmtree(os.path.join(root, direcpath))
+
+        break
+
+    return removed_files

{papers_cli-2.13 → papers_cli-2.14b0}/papers/config.py

@@ -85,7 +85,7 @@ class Config:
             return Path(os.path.sep)
 
     def gitcmd(self, cmd, check=True, **kw):
-        logger.debug(f"git add {self.backupfile.name}")
+        logger.debug(f"git {cmd} -C {self.gitdir}")
         try:
             sp.run(
                 f"git {cmd}",

{papers_cli-2.13 → papers_cli-2.14b0}/papers/encoding.py

@@ -2,7 +2,6 @@ import os
 import bibtexparser
 from pathlib import Path
 from unidecode import unidecode as unicode_to_ascii
-from papers.latexenc import unicode_to_latex
 from papers.utils import ansi_link as link, bcolors
 from papers import logger
 

{papers_cli-2.13 → papers_cli-2.14b0}/papers_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: papers-cli
-Version: 2.13
+Version: 2.14b0
 Summary: utilities to keep your PDF library organized
 Author-email: Mahé Perrette <mahe.perrette@gmail.com>
 License: MIT