dump-things-pyclient 0.2.3__py3-none-any.whl → 0.2.5__py3-none-any.whl

dump_things_pyclient/commands/dtc_plugins/auto_curate.py

@@ -2,8 +2,19 @@ import json
 import logging
 import re
 import sys
+from itertools import (
+    count,
+    chain,
+)
+from typing import (
+    cast,
+    Iterable,
+)
 
 import rich_click as click
+from rich import print as rprint
+from rich.console import Console
+from rich.progress import track
 
 from ...communicate import (
     HTTPError,
@@ -16,6 +27,7 @@ from ...communicate import (
 
 logger = logging.getLogger('auto-curate')
 
+console = Console(file=sys.stderr)
 stl_info = False
 
 
@@ -32,17 +44,17 @@ stl_info = False
 @click.option(
     '--destination-service-url',
     metavar='DEST_SERVICE_URL',
-    help='select a different dump-thing-service, i.e. not SERVICE_URL, as destination for auto-curated records',
+    help='select a different dump-thing-service, i.e. not SERVICE_URL, as destination for auto-curated records (the default is SERVICE_URL)',
 )
 @click.option(
     '--destination-collection',
     metavar='DEST_COLLECTION',
-    help='select a different collection, i.e. not the COLLECTION of SERVICE_URL, as destination for auto-curated records',
+    help='select a different collection, i.e. not COLLECTION, as destination for auto-curated records',
 )
 @click.option(
     '--destination-token',
     metavar='DEST_TOKEN',
-    help='if provided, this token will be used the authenticate again DEST_SERVICE_URL, otherwise the token for SERVICE_URL will be used',
+    help='if provided, this token will be used the authenticate against DEST_SERVICE_URL, which defaults to SERVICE_URL (the default is the token provided via --token)',
 )
 @click.option(
     '--pid', '-p',
@@ -114,7 +126,11 @@ def cli(
             dry_run,
         )
     except HTTPError as e:
-        print(f'ERROR: {e}: {e.response.text}', file=sys.stderr, flush=True)
+        rprint(
+            f'[red]Error[/red]: {e}: {e.response.text}',
+            file=sys.stderr,
+            flush=True,
+        )
     return 1
 
 
@@ -135,14 +151,14 @@ def auto_curate(
     curator_token = obj
 
     if curator_token is None:
-        print(
-            f'ERROR: no token was provided (use --token or DTC_TOKEN environment variable)',
-            file=sys.stderr,
-            flush=True,
-        )
+        console.print(f'[red]Error[/red]: no token was provided (use --token or DTC_TOKEN environment variable)')
         return 1
 
-    click.echo(f'auto curate: {obj}')
+    if destination_service_url is None:
+        destination_service_url = service_url
+
+    if destination_token is None:
+        destination_token = curator_token
 
     output = None
 
@@ -157,12 +173,12 @@ def auto_curate(
     if list_labels:
         output = []
 
-    for label in incoming_read_labels(
-            service_url=service_url,
-            collection=collection,
-            token=obj,
-    ):
-
+    all_labels = incoming_read_labels(
+        service_url=service_url,
+        collection=collection,
+        token=obj,
+    )
+    for label in all_labels:
         if include and label not in include:
             logger.debug('ignoring non-included incoming label: %s', label)
             continue
@@ -178,13 +194,34 @@ def auto_curate(
         if list_records:
             output[label] = []
 
-        for record, _, _, _, _ in incoming_read_records(
-                service_url=service_url,
-                collection=collection,
-                label=label,
-                token=obj,
-        ):
+        # Get the total number of entries for the
+        record_source = incoming_read_records(
+            service_url=service_url,
+            collection=collection,
+            label=label,
+            token=obj,
+        )
 
+        # Get the first entry to find the total number of records
+        try:
+            first_record, _, _, _, total = next(record_source)
+        except StopIteration:
+            console.print(f'no records in incoming area [green]{label}[/green], skipping it')
+            continue
+
+        # Get the first entry an all other entries
+        for index, (record, _, _, _, total) in track(
+                zip(
+                    count(),
+                    chain(
+                        [(first_record, None, None, None, None)],
+                        cast(Iterable, record_source),
+                    ),
+                ),
+                description=f'processing [green]{label}[/green]',
+                total=total,
+                console=console,
+        ):
             if list_records:
                 output[label].append(record)
                 continue
@@ -204,43 +241,53 @@ def auto_curate(
                 class_name = re.search('([_A-Za-z0-9]*$)', record['schema_type']).group(0)
             except (IndexError, KeyError):
                 global stl_info
+                console.print(f'[yellow]Warning[/yellow]: ignoring record with pid {record["pid"]} because `schema_type` attribute is missing.')
                 if not stl_info:
-                    logger.warning(
-                        f"""Could not find `schema_type` attribute in record with
-                            pid {record['pid']}. Please ensure that `schema_type` is stored in
-                            the records or that the associated incoming area store has a backend
-                            with a "Schema Type Layer", i.e., "record_dir+stl" or
-                            "sqlite+stl".""",
+                    console.print(
+                        '         Please ensure that `schema_type` is stored in the records '
+                        'or that the associated incoming area store has a backend with a '
+                        '"Schema Type Layer", i.e., "record_dir+stl" or "sqlite+stl"."',
                     )
                     stl_info = True
-                else:
-                    logger.warning(f'ignoring record with pid {record["pid"]}, `schema_type` attribute is missing.')
                 continue
 
             if dry_run:
-                print(f'WRITE record "{record["pid"]}" of class "{class_name}" to "{destination_collection}@{destination_service_url}"')
-                print(f'DELETE record "{record["pid"]}" from inbox "{label}" of "{collection}@{service_url}"')
+                console.print(f'WRITE record [green]"{record["pid"]}"[/green] of class "{class_name}" to "{destination_collection}@{destination_service_url}"')
+                console.print(f'DELETE record [green]"{record["pid"]}"[/green] from inbox "{label}" of "{collection}@{service_url}"')
                 continue
 
             # Store record in destination collection
-            curated_write_record(
-                service_url=destination_service_url,
-                collection=destination_collection,
-                class_name=class_name,
-                record=record,
-                token=destination_token)
+            try:
+                curated_write_record(
+                    service_url=destination_service_url,
+                    collection=destination_collection,
+                    class_name=class_name,
+                    record=record,
+                    token=destination_token,
+                )
+            except HTTPError as e:
+                console.print(
+                    f'[red]Error[/red]: writing record with pid {record["pid"]} failed: {e}: {e.response.text}',
+                )
+                raise
 
             # Delete record from incoming area
-            incoming_delete_record(
-                service_url=service_url,
-                collection=collection,
-                label=label,
-                pid=record['pid'],
-                token=obj,
-            )
+            try:
+                incoming_delete_record(
+                    service_url=service_url,
+                    collection=collection,
+                    label=label,
+                    pid=record['pid'],
+                    token=curator_token,
+                )
+            except HTTPError as e:
+                console.print(
+                    f'[red]ERROR[/red]: deleting record with pid {record["pid"]} failed: {e}: {e.response.text}',
+                )
+                raise
 
     if output is not None:
-        print(json.dumps(output, ensure_ascii=False))
+        rprint(json.dumps(output, ensure_ascii=False))
 
     return 0
 

dump_things_pyclient/commands/dtc_plugins/maintenance.py

@@ -0,0 +1,73 @@
+import logging
+
+import rich_click as click
+
+from ...communicate import (
+    HTTPError,
+    maintenance as communicate_maintenance,
+)
+
+
+logger = logging.getLogger('maintenance')
+
+subcommand_name = 'maintenance'
+
+
+@click.command(short_help='Activate or deactivate maintenance mode on a collection')
+@click.pass_obj
+@click.argument(
+    'service_url',
+    metavar='SERVICE_URL',
+)
+@click.argument(
+    'collection',
+    metavar='COLLECTION',
+)
+@click.argument(
+    'active',
+    metavar='ACTIVE',
+    type=click.Choice(['On', 'Off'], case_sensitive=False),
+)
+def cli(
+        obj,
+        service_url: str,
+        collection: str,
+        active: bool,
+):
+    """Activate or deactivate maintenance mode on collection COLLECTION on the
+    service SERVICE_URL. The argument ACTIVE should be either `On` or `Off`
+    (case-insensitive).
+
+    A token with curator rights is required.
+
+    This command expects a server version >= 5.4.0"""
+    try:
+        return maintenance(
+            obj,
+            service_url,
+            collection,
+            active,
+        )
+    except HTTPError as e:
+        click.echo(f'ERROR: {e}: {e.response.text}', err=True)
+    return 1
+
+
+def maintenance(
+        obj: str,
+        service_url: str,
+        collection: str,
+        active: bool,
+):
+    token = obj
+    if token is None:
+        click.echo('ERROR: no token provided', err=True)
+        return 1
+
+    communicate_maintenance(
+        service_url=service_url,
+        collection=collection,
+        active=active,
+        token=token,
+    )
+    return 0

dump_things_pyclient/communicate.py

@@ -37,6 +37,8 @@ __all__ = [
     'incoming_read_records_of_class',
     'incoming_read_record_with_pid',
     'incoming_write_record',
+    'maintenance',
+    'server',
 ]
 
 
@@ -694,6 +696,33 @@ def server(
     return _do_request(requests.get, url=url, token=None, params=None)
 
 
+def maintenance(
+        service_url: str,
+        collection: str,
+        active: bool,
+        token: str,
+) -> None:
+    """Activate or deactivate maintenance mode of a collection
+
+    :param service_url: the base URL of the service, i.e., the URL up to
+           `/<collection>/...`, `/maintenance`, or `/server`
+    :param collection: the name of the collection
+    :param active: whether maintenance mode should be active (`True`) or
+           non-active (`False`).
+    :param token: a token to authenticate against the endpoint, the token
+           must have curator-rights for the collection
+    """
+    url = (
+            (f'{service_url[:-1]}' if service_url.endswith('/') else service_url)
+            + '/maintenance'
+    )
+    _post_to_url(
+        url=url,
+        token=token,
+        json={'collection': collection, 'active': active}
+    )
+
+
 def _get_from_url(url: str,
                   token: str | None,
                   params: dict[str, str] | None = None,

{dump_things_pyclient-0.2.3.dist-info → dump_things_pyclient-0.2.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dump-things-pyclient
-Version: 0.2.3
+Version: 0.2.5
 Summary: A client library and CLI commands for dump-things-services
 Author-email: Christian Mönch <christian.moench@web.de>
 Requires-Python: >=3.11

{dump_things_pyclient-0.2.3.dist-info → dump_things_pyclient-0.2.5.dist-info}/RECORD

@@ -1,20 +1,21 @@
 dump_things_pyclient/__init__.py,sha256=cn-U3TRIalN6aYHp1cMBRkQm1x98XBwquLFbgFEIf_Q,113
-dump_things_pyclient/communicate.py,sha256=R1lifyuP5Cm2oQdyaWxTsQAbiMBU9NxYA5-9yU4M3qA,31008
+dump_things_pyclient/communicate.py,sha256=OSSrPRmeURiW1tOuBXecBzUgC_Qeb8TBs05l6QyoNF8,31904
 dump_things_pyclient/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dump_things_pyclient/commands/dtc.py,sha256=dxW5RuogqwhzfVujZ_EEsQMk8BcVMbZyMdg5c8EvYIA,1726
 dump_things_pyclient/commands/json2ttl.py,sha256=8BkvdjLWZ_H0L6fTmuR2M2MglKiMUiuNUcuWr_w6_dQ,2133
 dump_things_pyclient/commands/redirect.py,sha256=kl8pGj8khjxk4lhk8AJLfgtCIm5PtjeMAl0J6K5FB7M,264
 dump_things_pyclient/commands/dtc_plugins/__init__.py,sha256=0YLByLiofhHkhJcDCkokldcCw3Jj0rsKJinRX4tt3Hc,514
-dump_things_pyclient/commands/dtc_plugins/auto_curate.py,sha256=3_SHXPQCXmY6GqTMTNVkKh5vvshfiZpMGFY0gvJxRbo,7411
+dump_things_pyclient/commands/dtc_plugins/auto_curate.py,sha256=mDYHkXVS_2Nrcqd90nC9LIBCQnzYfRdj66fmZweyX_M,9094
 dump_things_pyclient/commands/dtc_plugins/clean_incoming.py,sha256=slk3xn1-DgMl88WZqgyemyscwof97TMXt3rley4mU1w,2086
 dump_things_pyclient/commands/dtc_plugins/delete_record.py,sha256=TVXyGetob8d75zuSBGuRKjtQPAcRqqjw-CcwYYHSC28,3626
 dump_things_pyclient/commands/dtc_plugins/export.py,sha256=FF1DmSmIA3GIhosUrTrXy_qyypMSJUalxdLJ844XhIE,4850
 dump_things_pyclient/commands/dtc_plugins/get_records.py,sha256=00W-agALqO_qFhjq14MI9N6TnJCgscMioy-Ll1ClrB4,7451
 dump_things_pyclient/commands/dtc_plugins/list_incoming.py,sha256=tmM0Qs4MVwMMLyERsWCxWGTM90rSNOShLpHH32wObd8,1959
+dump_things_pyclient/commands/dtc_plugins/maintenance.py,sha256=WkVVxDVd04Mi-cRIdAGSwn-7aP2bDlLjaCzt-H4_sJU,1553
 dump_things_pyclient/commands/dtc_plugins/post_records.py,sha256=s3j9THe-RszKxyIISkQZRCTKplWWLlomHbS5dyRlep0,2908
 dump_things_pyclient/commands/dtc_plugins/read_pages.py,sha256=hpw7vtG7joIMrNqEqZFCwzbQFd3ATzv7iyySsX8nKWk,3385
-dump_things_pyclient-0.2.3.dist-info/METADATA,sha256=hgtqkFRDuld7OTe2Alt-U-2YDqZurOqYT7PHphJ-uGQ,999
-dump_things_pyclient-0.2.3.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-dump_things_pyclient-0.2.3.dist-info/entry_points.txt,sha256=U1QhQtk767G_OXdZwPdTXYbIPfcDU13Z2u1d6exX8uE,470
-dump_things_pyclient-0.2.3.dist-info/top_level.txt,sha256=Asvruw-SyLoYhWis1CFOx89RGxpjXoTZVGoq4JSGt88,21
-dump_things_pyclient-0.2.3.dist-info/RECORD,,
+dump_things_pyclient-0.2.5.dist-info/METADATA,sha256=Bnwt2hpG4eycg9gnso1oi_HWhNjLePPbgxpeZ6kTrNc,999
+dump_things_pyclient-0.2.5.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+dump_things_pyclient-0.2.5.dist-info/entry_points.txt,sha256=U1QhQtk767G_OXdZwPdTXYbIPfcDU13Z2u1d6exX8uE,470
+dump_things_pyclient-0.2.5.dist-info/top_level.txt,sha256=Asvruw-SyLoYhWis1CFOx89RGxpjXoTZVGoq4JSGt88,21
+dump_things_pyclient-0.2.5.dist-info/RECORD,,