freqsap.accession
=================

.. py:module:: freqsap.accession

.. autoapi-nested-parse::

   Module for handling protein accession identifiers.



Classes
-------

.. autoapisummary::

   freqsap.accession.Accession


Module Contents
---------------

.. py:class:: Accession(accession: str)

   Protein accession identifier.

   Validates and stores UniProt accession identifiers according to the
   UniProt accession number format.


   .. py:attribute:: _id


   .. py:attribute:: _pattern
      :value: '[OPQ][0-9][A-Z0-9]{3}[0-9]|[A-NR-Z][0-9]([A-Z][A-Z0-9]{2}[0-9]){1,2}'



   .. py:method:: valid() -> bool

      Validate the accession using the built in regex pattern.

      :returns: True if valid, otherwise False.
      :rtype: bool



   .. py:method:: __str__() -> str

      Return the string representation of the accession.

      :returns: The accession identifier string.
      :rtype: str