geoseeq 0.7.4__py3-none-any.whl → 0.7.5__py3-none-any.whl

geoseeq/cli/download.py

@@ -3,6 +3,7 @@ import logging
 from os import makedirs
 from os.path import dirname, join
 
+import gzip
 import click
 import pandas as pd
 from multiprocessing import Pool
@@ -32,6 +33,7 @@ from .utils import convert_size
 from geoseeq.constants import FASTQ_MODULE_NAMES
 from geoseeq.result import ResultFile
 from geoseeq.upload_download_manager import GeoSeeqDownloadManager
+import os
 
 logger = logging.getLogger('geoseeq_api')
 
@@ -378,7 +380,27 @@ def cli_download_ids(state, cores, target_dir, file_name, yes, download, head, i
         download_manager.download_files()
 
 
-def _get_sample_result_files_with_names(sample, module_name=None, first=False):
+def _get_local_filename_for_fastq(sample, result_file, read_type, read_num, lane_num, file_name_mode):
+    """Return a local filename for a fastq file based on the specified naming mode."""
+    if file_name_mode == "original":
+        return result_file.get_stored_data_filename()
+    elif file_name_mode == "geoseeq":
+        sname = sample.name.replace(".", "-").replace(" ", "_").lower()
+        rtype = read_type.replace("::", "__").replace(".", "-").replace(" ", "_").lower()
+        filename = f"{sname}.{rtype}.R{read_num}.L{lane_num}.fastq.gz"
+        return filename
+    elif file_name_mode == "sample-uuid":
+        filename = f"{sample.uuid}.R{read_num}.L{lane_num}.fastq.gz"
+        return filename
+    elif file_name_mode == "file-uuid":
+        filename = f"{result_file.uuid}.fastq.gz"
+        return filename
+    else:
+        raise ValueError(f"Unknown file name mode: {file_name_mode}")
+
+
+def _get_sample_result_files_with_names(sample, module_name=None, which_fastqs_mode='all', file_name_mode='original'):
+    """Return list of (result_file, filename, key) tuples for all fastq files in a sample."""
     result_files_with_names = []
     for read_type, folder in sample.get_all_fastqs().items():
         if module_name and module_name != read_type:
@@ -388,19 +410,18 @@ def _get_sample_result_files_with_names(sample, module_name=None, first=False):
                 lane_num = lane_num + 1  # 1 indexed
                 if read_type in ["short_read::paired_end"]:
                     key = (sample, read_type, 1, lane_num)  # sample name, read type, read number, lane number
-                    result_files_with_names.append(
-                        (result_file[0], result_file[0].get_referenced_filename(), key)
-                    )
+                    fname = _get_local_filename_for_fastq(sample, result_file[0], read_type, 1, lane_num, file_name_mode)
+                    result_files_with_names.append((result_file[0], fname, key))
+                    if which_fastqs_mode == "first-r1":
+                        break
                     key = (sample, read_type, 2, lane_num)
-                    result_files_with_names.append(
-                        (result_file[1], result_file[1].get_referenced_filename(), key)
-                    )
+                    fname = _get_local_filename_for_fastq(sample, result_file[1], read_type, 2, lane_num, file_name_mode)
+                    result_files_with_names.append((result_file[1], fname, key))
                 else:
                     key = (sample, read_type, 1, lane_num)
-                    result_files_with_names.append(
-                        (result_file, result_file.get_referenced_filename(), key)
-                    )
-            if first:
+                    fname = _get_local_filename_for_fastq(sample, result_file, read_type, 1, lane_num, file_name_mode)
+                    result_files_with_names.append((result_file, fname, key))
+            if which_fastqs_mode in ["first-all", "first-r1"]:
                 break
 
     return result_files_with_names
@@ -442,14 +463,52 @@ def _make_read_configs(download_results, config_dir="."):
         with open(config_path, "w") as f:
             json.dump(config_blob, f, indent=4)
 
+def _open_maybe_gzip(local_path):
+    """Open a file that may be gzipped. Do not rely on file extension."""
+    with open(local_path, "rb") as f:
+        magic_number = f.read(2)
+    if magic_number == b'\x1f\x8b':
+        return gzip.open(local_path, "rt")
+    else:
+        return open(local_path, "r")
+
+
+def _trim_fastq_to_complete_reads(key, local_path):
+    """Trim a fastq file to the nearest complete read boundary under head_bytes.
+    
+    Write the output as a gzipped file regardless of input compression.
+    """
+    temp_path = local_path + ".tmp"
+    with _open_maybe_gzip(local_path) as infile, gzip.open(temp_path, "wt") as outfile:
+        lines_written = 0
+        while True:
+            read_lines = []
+            for _ in range(4):
+                line = infile.readline()
+                if not line:
+                    break
+                read_lines.append(line)
+            if len(read_lines) < 4:
+                break  # end of file
+            if infile.tell() > key[4]:  # key[4] is head_bytes
+                break  # reached head limit
+            for line in read_lines:
+                outfile.write(line)
+            lines_written += 4
+    # Replace original file with trimmed file
+    
+    os.replace(temp_path, local_path)
+
 
 @cli_download.command("fastqs")
 @use_common_state
 @cores_option
 @click.option("--target-dir", default=".")
 @yes_option
-@click.option("--first/--all", default=False, help="Download only the first folder of fastq files for each sample.")
+@click.option('--file-name-mode', type=click.Choice(['original', 'geoseeq', 'sample-uuid', 'file-uuid']), help="Choose how the downloaded fastq files are named.", default='original')
+@click.option("--which-fastqs-mode", type=click.Choice(["first-all", "first-r1", "all"]), default="all", help="Choose which fastq files to download per sample. ")
 @click.option("--download/--urls-only", default=True, help="Download files or just print urls")
+@head_option
 @click.option("--config-dir", default=None, help="Directory to write read config files. If unset do not write config files.")
 @module_option(FASTQ_MODULE_NAMES, use_default=False)
 @ignore_errors_option
@@ -460,8 +519,10 @@ def cli_download_fastqs(state,
                         cores,
                         target_dir,
                         yes,
-                        first,
+                        file_name_mode,
+                        which_fastqs_mode,
                         download,
+                        head,
                         config_dir,
                         module_name,
                         ignore_errors,
@@ -474,6 +535,20 @@ def cli_download_fastqs(state,
     This command will download fastq files from a GeoSeeq project. You can filter
     files by sample name and by specific fastq read types.
 
+    The filenames of the downloaded fastq files can be controlled using the --file-name-mode option:
+    - original: Use the original filename as uploaded to GeoSeeq (default)
+    - geoseeq: Use a normalized GeoSeeq generated filename that includes the sample name, read type, read number, and lane number.
+    - sample-uuid: Use the GeoSeeq UUID of the sample along with lane number and read number.
+    - file-uuid: Use the GeoSeeq UUID of the result file only.
+
+    If the --head option is used to only download the first N bytes of each fastq file, this command
+    will automatically clip the fastq files at the nearest complete read boundary to avoid incomplete reads.
+
+    The --which-fastqs-mode option controls which fastq files are downloaded per sample:
+    - first-all: Download all fastq files but from the first fastq folder only.
+    - first-r1: Download only the first read (R1) fastq file from the first fastq folder.
+    - all: Download all fastq files from all folders.
+
     ---
 
     Example Usage:
@@ -523,7 +598,7 @@ def cli_download_fastqs(state,
     result_files_with_names = []
     for sample in samples:
         try:
-            result_files_with_names += _get_sample_result_files_with_names(sample, module_name, first)
+            result_files_with_names += _get_sample_result_files_with_names(sample, module_name, which_fastqs_mode, file_name_mode)
         except Exception as e:
             logger.error(f"Error fetching fastq files for sample {sample.name}: {e}")
             if not ignore_errors:
@@ -538,9 +613,14 @@ def cli_download_fastqs(state,
         ignore_errors=ignore_errors,
         log_level=state.log_level,
         progress_tracker_factory=PBarManager().get_new_bar,
+        head=head,
     )
     for result_file, filename, key in result_files_with_names:
-        download_manager.add_download(result_file, join(target_dir, filename), key=key)
+        callback = None
+        if head:
+            callback = _trim_fastq_to_complete_reads
+            key = key + (head,)  # append head bytes to key
+        download_manager.add_download(result_file, join(target_dir, filename), key=key, callback=callback)
     if not download:
         print(download_manager.get_url_string(), file=state.outfile)
     else:

geoseeq/cli/main.py

@@ -55,7 +55,7 @@ def version():
     Use of this tool implies acceptance of the GeoSeeq End User License Agreement.
     Run `geoseeq eula show` to view the EULA.
     """
-    click.echo("0.7.4")  # remember to update pyproject.toml
+    click.echo("0.7.5")  # remember to update pyproject.toml
 
 
 @main.group("advanced")

geoseeq/result/result_file.py

@@ -103,6 +103,18 @@ class ResultFile(RemoteObject, ResultFileUpload, ResultFileDownload, ResultFileS
         # except TypeError:
         #     return basename(self.get_blob_filename())
 
+    def get_stored_data_filename(self):
+        """Return the filename that is stored in the stored_data field.
+        
+        This is typically the filename that was originally uploaded to create this result file.
+        """
+        try:
+            key = [k for k in ["filename", "uri", "url"] if k in self.stored_data][0]
+        except IndexError:
+            raise TypeError("Cannot make a reference filename for a BLOB type result field.")
+        filepath = self.stored_data[key]
+        return basename(filepath)
+
     def _save(self):
         data = {field: getattr(self, field) for field in self.remote_fields if hasattr(self, field)}
         data["analysis_result"] = self.parent.uuid

{geoseeq-0.7.4.dist-info → geoseeq-0.7.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geoseeq
-Version: 0.7.4
+Version: 0.7.5
 Summary: GeoSeeq command line tools and python API
 Project-URL: Homepage, https://github.com/biotia/geoseeq_api_client
 Project-URL: Issues, https://github.com/biotia/geoseeq_api_client/issues

{geoseeq-0.7.4.dist-info → geoseeq-0.7.5.dist-info}/RECORD

@@ -21,11 +21,11 @@ geoseeq/cli/__init__.py,sha256=4WnK87K5seRK3SGJAxNWnQTqyg5uBhdhrOrzB1D4b3M,24
 geoseeq/cli/constants.py,sha256=NtRSNBuna42605LE0sVywTPfmzYQnG-3yrT_M7Ml5B0,213
 geoseeq/cli/copy.py,sha256=02U9kdrAIbbM8MlRMLL6p-LMYFSuRObE3h5jyvcL__M,2275
 geoseeq/cli/detail.py,sha256=q8Suu-j2k18knfSVFG-SWWGNsKM-n8y9RMA3LcIIi9Y,4132
-geoseeq/cli/download.py,sha256=Znjuc9IFOcIa5_Od9mFXHJdYAJtgw9Bc_wPPcOVXn7s,21298
+geoseeq/cli/download.py,sha256=U4x-Y5DMkRGcWctVdp6YIFviLZI6tpMMyXEeV2tbzaM,25407
 geoseeq/cli/fastq_utils.py,sha256=-bmeQLaiMBm57zWOF0R5OlWTU0_3sh1JBC1RYw2BOFM,3083
 geoseeq/cli/find_grn.py,sha256=oMDxkzGQBQb2_cCuvmwoeHOsFHqyO9RLeJzrB6bAe5M,439
 geoseeq/cli/get_eula.py,sha256=79mbUwyiF7O1r0g6UTxG9kJGQEqKuH805E6eLkPC6Y4,997
-geoseeq/cli/main.py,sha256=gHZzocvIrfigz9EP3V1BxPh5OFNsp6i6_jqbP6vb_a8,4133
+geoseeq/cli/main.py,sha256=Gvi5Bh5zbEmYPdShcrY0C3KAwQdRiNxsMUhATVtDWMc,4133
 geoseeq/cli/manage.py,sha256=wGXAcVaXqE5JQEU8Jh6OlHr02nB396bpS_SFcOZdrEo,5929
 geoseeq/cli/progress_bar.py,sha256=p1Xl01nkYxSBZCB30ue2verIIi22W93m3ZAMAxipD0g,738
 geoseeq/cli/project.py,sha256=V5SdXm2Hwo2lxrkpwRDedw-mAE4XnM2uwT-Gj1D90VQ,3030
@@ -76,7 +76,7 @@ geoseeq/result/bioinfo.py,sha256=QQtbyogrdro9avJSN0713sxLVnVeA24mFw3hWtKDKyw,178
 geoseeq/result/file_chunker.py,sha256=bXq1csuRtqMB5sbH-AfWo6gdPwrivv5DJPuHVj-h08w,1758
 geoseeq/result/file_download.py,sha256=5IXg_dIWlrRHBJQssO42da5_bIJOyH0_b8K2KWVAFBE,8210
 geoseeq/result/file_upload.py,sha256=xs1DrI-h4ZP7xN8HPBc3SFpcPAxR5HAolraP1Zu7tvE,10648
-geoseeq/result/result_file.py,sha256=mkFh2DpKO1-kEAARCMYjkc7TmkJh41azyauGIHl_VZo,9173
+geoseeq/result/result_file.py,sha256=Mu_8cJYN3tVlkLYnbd_pyGinBoePlmQxLFIbeF-PWyo,9698
 geoseeq/result/result_folder.py,sha256=iyO0hwZWokrH6oWhBgHlunWMpCMpejKb8v2sHFhecws,11283
 geoseeq/result/resumable_download_tracker.py,sha256=YEzqHBBnE7L3XokTvlTAhHZ8TcDTIE_pyTQ7YadOfbU,3667
 geoseeq/result/resumable_upload_tracker.py,sha256=2aI09gYz2yw63jEXqs8lmCRKQ79TIc3YuPETvP0Jeek,3811
@@ -92,8 +92,8 @@ geoseeq/vc/vc_cache.py,sha256=P4LXTbq2zOIv1OhP7Iw5MmypR2vXuy29Pq5K6gRvi-M,730
 geoseeq/vc/vc_dir.py,sha256=A9CLTh2wWCRzZjiLyqXD1vhtsWZGD3OjaMT5KqlfAXI,457
 geoseeq/vc/vc_sample.py,sha256=qZeioWydXvfu4rGMs20nICfNcp46y_XkND-bHdV6P5M,3850
 geoseeq/vc/vc_stub.py,sha256=IQr8dI0zsWKVAeY_5ybDD6n49_3othcgfHS3P0O9tuY,3110
-geoseeq-0.7.4.dist-info/METADATA,sha256=cJnudtWL38eoOqQF1IfjmYaslq5beDTFMNPYP7Y2vio,5652
-geoseeq-0.7.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-geoseeq-0.7.4.dist-info/entry_points.txt,sha256=yF-6KDM8zXib4Al0qn49TX-qM7PUkWUIcYtsgt36rjM,45
-geoseeq-0.7.4.dist-info/licenses/LICENSE,sha256=IuhIl1XCxXLPLJT_coN1CNqQU4Khlq7x4IdW7ioOJD8,1067
-geoseeq-0.7.4.dist-info/RECORD,,
+geoseeq-0.7.5.dist-info/METADATA,sha256=SzijU4fXQxHJBEgmy8c8Uv8Y2JmdNDOQYD92EwmPTBw,5652
+geoseeq-0.7.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+geoseeq-0.7.5.dist-info/entry_points.txt,sha256=yF-6KDM8zXib4Al0qn49TX-qM7PUkWUIcYtsgt36rjM,45
+geoseeq-0.7.5.dist-info/licenses/LICENSE,sha256=IuhIl1XCxXLPLJT_coN1CNqQU4Khlq7x4IdW7ioOJD8,1067
+geoseeq-0.7.5.dist-info/RECORD,,