strings.barcode_validator
=========================

.. py:module:: strings.barcode_validator

.. autoapi-nested-parse::

   https://en.wikipedia.org/wiki/Check_digit#Algorithms



Attributes
----------

.. autoapisummary::

   strings.barcode_validator.barcode


Functions
---------

.. autoapisummary::

   strings.barcode_validator.get_barcode
   strings.barcode_validator.get_check_digit
   strings.barcode_validator.is_valid


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

.. py:function:: get_barcode(barcode: str) -> int

   Returns the barcode as an integer

   >>> get_barcode("8718452538119")
   8718452538119
   >>> get_barcode("dwefgiweuf")
   Traceback (most recent call last):
       ...
   ValueError: Barcode 'dwefgiweuf' has alphabetic characters.


.. py:function:: get_check_digit(barcode: int) -> int

   Returns the last digit of barcode by excluding the last digit first
   and then computing to reach the actual last digit from the remaining
   12 digits.

   >>> get_check_digit(8718452538119)
   9
   >>> get_check_digit(87184523)
   5
   >>> get_check_digit(87193425381086)
   9
   >>> [get_check_digit(x) for x in range(0, 100, 10)]
   [0, 7, 4, 1, 8, 5, 2, 9, 6, 3]


.. py:function:: is_valid(barcode: int) -> bool

   Checks for length of barcode and last-digit
   Returns boolean value of validity of barcode

   >>> is_valid(8718452538119)
   True
   >>> is_valid(87184525)
   False
   >>> is_valid(87193425381089)
   False
   >>> is_valid(0)
   False
   >>> is_valid(dwefgiweuf)
   Traceback (most recent call last):
       ...
   NameError: name 'dwefgiweuf' is not defined


.. py:data:: barcode