Skip to main content

Lightweight package for reading and writing FASTA files.

Project description

protfasta

Build Status

Release 0.1.18 (April 2026)

Overview

protfasta - a robust parser for protein-based FASTA files.

Documentation

For all documentation see https://protfasta.readthedocs.io/en/latest/.

For code see https://github.com/holehouse-lab/protfasta.

Installation

protfasta has been tested on Linux and macOS. It should also work on Windows but we haven't tested it there yet.

protfasta can be downloaded and installed directly from PyPI using pip:

pip install protfasta

If this has worked, the pfasta command-line tool should be available from the command-line

pfasta --help

And you're done. This also means you can now import and use protfasta in your Python workflow.

Simple example

import protfasta

# sequences is now a dictionary where keys are FASTA headers and values are sequences.
sequences = protfasta.read_fasta('inputfile.fasta')

Errors and help

For bug reports or errors please raise an issue on this github repository (see the Issues tab at the top).

Changelog

  • 0.1.18 (April 2026) - Performance overhaul for large FASTA files (hundreds of millions of sequences).

    • read_fasta now streams the input file instead of reading it entirely into memory with readlines() — peak memory is now O(single record) rather than O(file size).
    • New protfasta.iter_fasta(filename, header_parser=None) generator for memory-bounded streaming access to (header, sequence) pairs from files that don't fit in RAM.
    • Core parser rewritten to use list-of-parts + ''.join() instead of quadratic string concatenation, and to skip header-uniqueness tracking entirely when expect_unique_header=False.
    • convert_to_valid / invalid-residue handling now uses a pre-built str.translate table (single C-level pass) instead of a chained str.replace loop — typically 5–20× faster.
    • check_sequence_is_valid now uses frozenset membership instead of list-based in scans.
    • Duplicate-detection utilities (fail_on_duplicates, remove_duplicates, fail_on_duplicate_sequences, remove_duplicate_sequences) now store 16-byte blake2b digests instead of full sequences in their lookup structures, dramatically reducing peak memory for files with long sequences.
    • write_fasta replaced its per-residue fh.write() loop with chunked slice writes and opens the output with a 1 MiB buffer — roughly two orders of magnitude faster on large files.
    • All existing behavior and the full test suite (239 tests) are preserved.
  • 0.1.16 - 0.1.17 - skipped...

  • 0.1.14 and 0.1.15 (October 2024) - Re-wrote build chain and versioning to use pyproject.toml and versioningit. protfasta should now support Python beyond 3.12. About bloody time.

    • Added --version flag to pfasta
    • Messed around a bit with tags to ensure we had a tagged version compatible with them.
  • 0.1.13 (January 2023) - Added upper limit of Python 3.11 to accomodate clash between versioneer and Python 3.12. Ultimately we'll move to versioningit for release versioning (as we have done internally) but need to make sure we have a robust protocol for this switch and then do this for ALL tools....

  • 0.1.12 (March 2023) - integrated in check_header_parser flag via pull request from the amazing Friedlab !

  • Added in append_to_fasta flag so you can append to an existing FASTA file (thanks Ryan!)

  • 0.1.11 (Sept 17th 2022) - re-wrote code for checking duplicate sequence to make it O(1) instead of O(n) for number of sequences (:-/) and added convert-remove option for invalid_sequences

  • 0.1.9 (Sept 12th 2021) - added in robustness for whitespace in sequence files, which, bizarrely, was not present (i.e. added as an invalid residue type but can now be converted).

Copyright

Copyright (c) 2020-2026, Alex Holehouse - Holehouse lab. protfasta is released under the MIT license. The codebase is well structured and relatively simple, lending it to feature addition. We welcome pull-requests assuming contributed code maintains an appropriate level of clarity and robustness.

Acknowledgements

Many of the software-engineering tools and approaches used in the development of protfasta come from resources developed by the Molecular Sciences Software Institute.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

protfasta-0.1.18.tar.gz (123.7 kB view details)

Uploaded Source

File details

Details for the file protfasta-0.1.18.tar.gz.

File metadata

  • Download URL: protfasta-0.1.18.tar.gz
  • Upload date:
  • Size: 123.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.30 {"installer":{"name":"uv","version":"0.9.30","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for protfasta-0.1.18.tar.gz
Algorithm Hash digest
SHA256 32cf3002cff1e7c5d8d5bf29e28578375a8a716ee35dc24bd52bf4a06de23969
MD5 0842df9f7dc161acc11c075c81e5a642
BLAKE2b-256 621dc76ef9ea542b853888a3c5c84bec7e5b87ba3cf586299cdef4727bf02f0d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page