aoptk.literature.id
===================

.. py:module:: aoptk.literature.id


Classes
-------

.. autoapisummary::

   aoptk.literature.id.ID
   aoptk.literature.id.PMCID
   aoptk.literature.id.PMID
   aoptk.literature.id.DOI


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

.. py:class:: ID(id_str: str)

   Base class for different types of publication IDs.


   .. py:attribute:: id_str


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


   .. py:method:: __eq__(other: object) -> bool

      Compare IDs by their string value.



   .. py:method:: __hash__() -> int

      Hash based on string value for use in sets/dicts.



.. py:class:: PMCID(id_str: str)

   Bases: :py:obj:`ID`


   PubMed Central ID.


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


.. py:class:: PMID(id_str: str)

   Bases: :py:obj:`ID`


   PubMed ID.


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


.. py:class:: DOI(id_str: str)

   Bases: :py:obj:`ID`


   Digital Object Identifier.


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