Replace python-qbittorrent with qbittorrent-api

requirements.txt

@@ -1,2 +1,2 @@
-python-qbittorrent==0.4.3
-sqlalchemy==2.0.27
+qbittorrent-api==2025.2.0
+SQLAlchemy==2.0.38

tarc/main.py

@@ -15,64 +15,79 @@ import uuid
 import argparse
 from datetime import datetime, timezone
 
-import qbittorrent
-from sqlalchemy import create_engine, event
-from sqlalchemy.orm import sessionmaker
+import qbittorrentapi
+from sqlalchemy import create_engine, inspect
+from sqlalchemy.orm import Session
+from sqlalchemy.exc import DatabaseError
 
-from .models import Base, Client
+from .models import Base, SchemaVersion, Client
 
 # SCHEMA format is YYYYMMDDX
-SCHEMA = 202410060
+SCHEMA = 202503100
+
 
 def init_db(engine):
     """
     Initialize database
     """
-    # Create all tables first
     Base.metadata.create_all(engine)
 
-    # Set the schema version using SQLAlchemy primitives
-    @event.listens_for(engine, 'connect')
-    def set_sqlite_pragma(dbapi_connection, connection_record):
-        cursor = dbapi_connection.cursor()
-        cursor.execute(f"PRAGMA user_version = {SCHEMA}")
-        cursor.close()
+    with Session(engine) as session:
+        if not session.query(SchemaVersion).first():
+            now = datetime.now(timezone.utc)
+            version = SchemaVersion(version=SCHEMA, applied_at=now)
+            session.add(version)
+            session.commit()
+
+
+def get_schema_version(engine):
+    """
+    Get current schema version from database
+    """
+    with Session(engine) as session:
+        version = session.query(SchemaVersion).order_by(SchemaVersion.id.desc()).first()
+        return version.version if version else None
 
 
 def list_tables(engine):
     """
     List all tables in database
     """
-    return Base.metadata.tables.keys()
+    inspector = inspect(engine)
+    return inspector.get_table_names()
 
 
-def add_client(session, name, endpoint, last_seen):
+def add_client(engine, name, endpoint, last_seen):
     """
     Add a new client endpoint to database
     """
-    new_client = Client(
-        uuid=str(uuid.uuid4()),
-        name=name,
-        endpoint=endpoint,
-        last_seen=last_seen
-    )
-    session.add(new_client)
-    session.commit()
+    with Session(engine) as session:
+        client = Client(
+            uuid=str(uuid.uuid4()), name=name, endpoint=endpoint, last_seen=last_seen
+        )
+        session.add(client)
+        session.commit()
 
 
-def find_client(session, endpoint):
+def find_client(engine, endpoint):
     """
     Find existing client
     """
-    clients = session.query(Client.id, Client.name, Client.uuid).filter(Client.endpoint == endpoint).all()
-    return clients
+    with Session(engine) as session:
+        clients = (
+            session.query(Client.id, Client.name, Client.uuid)
+            .filter_by(endpoint=endpoint)
+            .all()
+        )
+        return clients
 
 
-def list_clients(session):
+def list_clients(engine):
     """
     List all stored clients
     """
-    return session.query(Client).all()
+    with Session(engine) as session:
+        return session.query(Client).all()
 
 
 def main():
@@ -102,64 +117,52 @@ def main():
 
     if args.command == "scan":
         if args.storage is None:
-            STORAGE = os.path.expanduser("~/.tarch.db")
+            storage_path = os.path.expanduser("~/.tarc.db")
         else:
-            STORAGE = args.storage
+            storage_path = args.storage
+
         try:
-            engine = create_engine(f"sqlite:///{STORAGE}")
+            engine = create_engine(f"sqlite:///{storage_path}")
             tables = list_tables(engine)
-            Session = sessionmaker(bind=engine)
-            session = Session()
-        except Exception as e:
-            print(f'[ERROR]: Database Error "{STORAGE}" ({str(e)})')
+        except DatabaseError as e:
+            print(f'[ERROR]: Database Error "{storage_path}" ({str(e)})')
             sys.exit(1)
-        if len(tables) == 0:
-            print(f"[INFO]: Initializing database at {STORAGE}")
+
+        if not tables:
+            print(f"[INFO]: Initializing database at {storage_path}")
             init_db(engine)
 
-        # Check schema version using SQLAlchemy primitives
-        schema_found = None
-        
-        @event.listens_for(engine, 'connect')
-        def get_sqlite_pragma(dbapi_connection, connection_record):
-            nonlocal schema_found
-            cursor = dbapi_connection.cursor()
-            cursor.execute("PRAGMA user_version")
-            schema_found = cursor.fetchone()[0]
-            cursor.close()
-        
-        # Force a connection to trigger the event
-        with engine.connect() as conn:
-            pass
-        
+        schema_found = get_schema_version(engine)
+        if schema_found is None:
+            print("[ERROR]: Could not determine schema version")
+            sys.exit(1)
         if not SCHEMA == schema_found:
             print(f"[ERROR]: SCHEMA {schema_found}, expected {SCHEMA}")
             sys.exit(1)
-        if not args.directory is None:
+
+        if args.directory is not None:
             print("[INFO]: --directory is not implemented")
             sys.exit(0)
-        elif not args.endpoint is None:
-            qb = qbittorrent.Client(args.endpoint)
-            if args.username and args.password:
-                qb.login(args.username, args.password)
-            if qb.qbittorrent_version is None:
-                print(f'[ERROR]: Couldn\'t find client version at "{args.endpoint}"')
+        elif args.endpoint is not None:
+            qb = qbittorrentapi.Client(host=args.endpoint,
+                                       username=args.username, password=args.password)
+            try:
+                qb.auth_log_in()
+            except qbittorrentapi.LoginFailed as e:
+                print(f'[ERROR]: Login failed for endpoint "{args.endpoint}": {e}')
                 sys.exit(1)
-            elif not re.match(r"^v?\d+(\.\d+)*$", qb.qbittorrent_version):
-                print(f'[ERROR]: Invalid version found at "{args.endpoint}"')
-                if args.debug:
-                    print(f"[DEBUG]: {qb.qbittorrent_version}")
+            if not re.match(r"^v?\d+(\.\d+)*$", qb.app.version):
+                print(f'[ERROR]: Invalid version "{qb.app.version}" found at "{args.endpoint}"')
                 sys.exit(1)
             else:
-                print(
-                    f'[INFO]: Found qbittorrent {qb.qbittorrent_version} at "{args.endpoint}"'
-                )
-            clients = find_client(session, args.endpoint)
+                print(f'[INFO]: Found qBittorrent {qb.app.version} at "{args.endpoint}"')
+
+            clients = find_client(engine, args.endpoint)
             if args.confirm_add:
                 if len(clients) == 0:
-                    if not args.name is None:
+                    if args.name is not None:
                         now = datetime.now(timezone.utc)
-                        add_client(session, args.name, args.endpoint, now)
+                        add_client(engine, args.name, args.endpoint, now)
                         print(f"[INFO]: Added client {args.name} ({args.endpoint})")
                     else:
                         print("[ERROR]: Must specify --name for a new client")
@@ -177,17 +180,16 @@ def main():
                 print("[ERROR]: Use --confirm-add to add a new endpoint")
                 sys.exit(1)
             elif len(clients) == 1:
-                torrents = qb.torrents()
+                torrents = qb.torrents_info()
                 print(f"[INFO]: There are {len(torrents)} torrents\n")
-                
                 for torrent in torrents[:2]:
-                    files = qb.get_torrent_files(torrent["hash"])
-                    trackers = qb.get_torrent_trackers(torrent["hash"])
-                    print(f"[name]: {torrent['name']}")
-                    print(f"[infohash_v1]: {torrent['infohash_v1']}")
-                    print(f"[content_path]: {torrent['content_path']}")
-                    print(f"[magent_uri]: {torrent['magnet_uri'][0:80]}")
-                    print(f"[completed_on]: {torrent['completed']}")
+                    files = qb.torrents_files(torrent.hash)
+                    trackers = qb.torrents_trackers(torrent.hash)
+                    print(f"[name]: {torrent.name}")
+                    print(f"[infohash_v1]: {torrent.hash}")
+                    print(f"[content_path]: {torrent.content_path}")
+                    print(f"[magnet_uri]: {torrent.magnet_uri[:80]}")
+                    print(f"[completed_on]: {torrent.completed}\n")
                     print(f"[trackers]: {len(trackers)}")
                     print(f"[file_count]: {len(files)}\n")
                     if args.debug:

tarc/models.py

@@ -1,109 +1,106 @@
-#!/usr/bin/env python3
-"""
-Database models for Torrent Archiver
-"""
+"""SQLAlchemy models for the tarc database."""
 
-from sqlalchemy import Column, Integer, String, Boolean, DateTime, ForeignKey, UniqueConstraint
-from sqlalchemy.ext.declarative import declarative_base
-from sqlalchemy.orm import relationship
+from sqlalchemy import (
+    Column,
+    Integer,
+    String,
+    DateTime,
+    Boolean,
+    ForeignKey,
+    UniqueConstraint,
+)
+from sqlalchemy.orm import declarative_base
 
 Base = declarative_base()
 
-class Client(Base):
-    __tablename__ = 'clients'
 
-    id = Column(Integer, primary_key=True, autoincrement=True)
+class SchemaVersion(Base):  # pylint: disable=too-few-public-methods
+    """Database schema version tracking."""
+
+    __tablename__ = "schema_version"
+    id = Column(Integer, primary_key=True)
+    version = Column(Integer, nullable=False)
+    applied_at = Column(DateTime, nullable=False)
+
+
+class Client(Base):  # pylint: disable=too-few-public-methods
+    """BitTorrent client instance."""
+
+    __tablename__ = "clients"
+    id = Column(Integer, primary_key=True)
     name = Column(String, nullable=False, unique=True)
     uuid = Column(String, nullable=False, unique=True)
     endpoint = Column(String, nullable=False)
     last_seen = Column(DateTime, nullable=False)
 
-    torrent_clients = relationship("TorrentClient", back_populates="client")
-    torrent_trackers = relationship("TorrentTracker", back_populates="client")
-    torrent_files = relationship("TorrentFile", back_populates="client")
 
+class Torrent(Base):  # pylint: disable=too-few-public-methods
+    """BitTorrent metadata."""
 
-class Torrent(Base):
-    __tablename__ = 'torrents'
-    
-    id = Column(Integer, primary_key=True, autoincrement=True)
+    __tablename__ = "torrents"
+    id = Column(Integer, primary_key=True)
     info_hash_v1 = Column(String, nullable=False, unique=True)
     info_hash_v2 = Column(String, unique=True)
     file_count = Column(Integer, nullable=False)
     completed_on = Column(DateTime, nullable=False)
 
-    torrent_clients = relationship("TorrentClient", back_populates="torrent")
-    torrent_trackers = relationship("TorrentTracker", back_populates="torrent")
-    torrent_files = relationship("TorrentFile", back_populates="torrent")
 
+class TorrentClient(Base):  # pylint: disable=too-few-public-methods
+    """Association between torrents and clients."""
 
-class TorrentClient(Base):
-    __tablename__ = 'torrent_clients'
-    
-    id = Column(Integer, primary_key=True, autoincrement=True)
-    torrent_id = Column(Integer, ForeignKey('torrents.id'), nullable=False)
-    client_id = Column(Integer, ForeignKey('clients.id'), nullable=False)
+    __tablename__ = "torrent_clients"
+    id = Column(Integer, primary_key=True)
+    torrent_id = Column(Integer, ForeignKey("torrents.id"), nullable=False)
+    client_id = Column(Integer, ForeignKey("clients.id"), nullable=False)
     name = Column(String, nullable=False)
     content_path = Column(String, nullable=False)
     last_seen = Column(DateTime, nullable=False)
-    
-    torrent = relationship("Torrent", back_populates="torrent_clients")
-    client = relationship("Client", back_populates="torrent_clients")
-    
-    __table_args__ = (UniqueConstraint('torrent_id', 'client_id'),)
+    __table_args__ = (UniqueConstraint("torrent_id", "client_id"),)
 
 
-class Tracker(Base):
-    __tablename__ = 'trackers'
+class Tracker(Base):  # pylint: disable=too-few-public-methods
+    """BitTorrent tracker information."""
 
-    id = Column(Integer, primary_key=True, autoincrement=True)
+    __tablename__ = "trackers"
+    id = Column(Integer, primary_key=True)
     url = Column(String, nullable=False, unique=True)
     last_seen = Column(DateTime, nullable=False)
 
-    torrent_trackers = relationship("TorrentTracker", back_populates="tracker")
 
+class TorrentTracker(Base):  # pylint: disable=too-few-public-methods
+    """Association between torrents and trackers."""
 
-class TorrentTracker(Base):
-    __tablename__ = 'torrent_trackers'
-    
-    id = Column(Integer, primary_key=True, autoincrement=True)
-    client_id = Column(Integer, ForeignKey('clients.id'), nullable=False)
-    torrent_id = Column(Integer, ForeignKey('torrents.id'), nullable=False)
-    tracker_id = Column(Integer, ForeignKey('trackers.id'), nullable=False)
+    __tablename__ = "torrent_trackers"
+    id = Column(Integer, primary_key=True)
+    client_id = Column(Integer, ForeignKey("clients.id"), nullable=False)
+    torrent_id = Column(Integer, ForeignKey("torrents.id"), nullable=False)
+    tracker_id = Column(Integer, ForeignKey("trackers.id"), nullable=False)
     last_seen = Column(DateTime, nullable=False)
-    
-    client = relationship("Client", back_populates="torrent_trackers")
-    torrent = relationship("Torrent", back_populates="torrent_trackers")
-    tracker = relationship("Tracker", back_populates="torrent_trackers")
-    
-    __table_args__ = (UniqueConstraint('client_id', 'torrent_id', 'tracker_id'),)
+    __table_args__ = (UniqueConstraint("client_id", "torrent_id", "tracker_id"),)
 
 
-class File(Base):
-    __tablename__ = 'files'
+class File(Base):  # pylint: disable=too-few-public-methods
+    """File metadata and hashes."""
 
-    id = Column(Integer, primary_key=True, autoincrement=True)
+    __tablename__ = "files"
+    id = Column(Integer, primary_key=True)
     size = Column(Integer, nullable=False)
     oshash = Column(String, nullable=False, unique=True)
     hash = Column(String, unique=True)
 
-    torrent_files = relationship("TorrentFile", back_populates="file")
 
+class TorrentFile(Base):  # pylint: disable=too-few-public-methods
+    """Association between torrents and files."""
 
-class TorrentFile(Base):
-    __tablename__ = 'torrent_files'
-    
-    id = Column(Integer, primary_key=True, autoincrement=True)
-    file_id = Column(Integer, ForeignKey('files.id'), nullable=False)
-    torrent_id = Column(Integer, ForeignKey('torrents.id'), nullable=False)
-    client_id = Column(Integer, ForeignKey('clients.id'), nullable=False)
+    __tablename__ = "torrent_files"
+    id = Column(Integer, primary_key=True)
+    file_id = Column(Integer, ForeignKey("files.id"), nullable=False)
+    torrent_id = Column(Integer, ForeignKey("torrents.id"), nullable=False)
+    client_id = Column(Integer, ForeignKey("clients.id"), nullable=False)
     file_index = Column(Integer, nullable=False)
     file_path = Column(String, nullable=False)
     is_downloaded = Column(Boolean, nullable=False)
     last_checked = Column(DateTime, nullable=False)
-    
-    file = relationship("File", back_populates="torrent_files")
-    torrent = relationship("Torrent", back_populates="torrent_files")
-    client = relationship("Client", back_populates="torrent_files")
-    
-    __table_args__ = (UniqueConstraint('file_id', 'torrent_id', 'client_id', 'file_index'),) 
+    __table_args__ = (
+        UniqueConstraint("file_id", "torrent_id", "client_id", "file_index"),
+    )