strings.is_spain_national_id
============================

.. py:module:: strings.is_spain_national_id


Attributes
----------

.. autoapisummary::

   strings.is_spain_national_id.LOOKUP_LETTERS
   strings.is_spain_national_id.NUMBERS_PLUS_LETTER


Functions
---------

.. autoapisummary::

   strings.is_spain_national_id.is_spain_national_id


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

.. py:function:: is_spain_national_id(spanish_id: str) -> bool

   Spain National Id is a string composed by 8 numbers plus a letter
   The letter in fact is not part of the ID, it acts as a validator,
   checking you didn't do a mistake when entering it on a system or
   are giving a fake one.

   https://en.wikipedia.org/wiki/Documento_Nacional_de_Identidad_(Spain)#Number

   >>> is_spain_national_id("12345678Z")
   True
   >>> is_spain_national_id("12345678z")  # It is case-insensitive
   True
   >>> is_spain_national_id("12345678x")
   False
   >>> is_spain_national_id("12345678I")
   False
   >>> is_spain_national_id("12345678-Z")  # Some systems add a dash
   True
   >>> is_spain_national_id("12345678")
   Traceback (most recent call last):
       ...
   ValueError: Input must be a string of 8 numbers plus letter
   >>> is_spain_national_id("123456709")
   Traceback (most recent call last):
       ...
   ValueError: Input must be a string of 8 numbers plus letter
   >>> is_spain_national_id("1234567--Z")
   Traceback (most recent call last):
       ...
   ValueError: Input must be a string of 8 numbers plus letter
   >>> is_spain_national_id("1234Z")
   Traceback (most recent call last):
       ...
   ValueError: Input must be a string of 8 numbers plus letter
   >>> is_spain_national_id("1234ZzZZ")
   Traceback (most recent call last):
       ...
   ValueError: Input must be a string of 8 numbers plus letter
   >>> is_spain_national_id(12345678)
   Traceback (most recent call last):
       ...
   TypeError: Expected string as input, found int


.. py:data:: LOOKUP_LETTERS
   :value: 'TRWAGMYFPDXBNJZSQVHLCKE'


.. py:data:: NUMBERS_PLUS_LETTER
   :value: 'Input must be a string of 8 numbers plus letter'