jamorasep.kana_util
===================

.. py:module:: jamorasep.kana_util


Functions
---------

.. autoapisummary::

   jamorasep.kana_util.h2k
   jamorasep.kana_util.k2h
   jamorasep.kana_util.is_hiragana
   jamorasep.kana_util.is_katakana
   jamorasep.kana_util.is_kana


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

.. py:function:: h2k(text: str = '') -> str

   Convert hiragana to katakana.
   Characters other than hiragana are not converted.
   Only Unicode is supported, which is the default code in Python3.

   :param text: hiragana string
   :type text: str

   :returns: katakana string
   :rtype: str


.. py:function:: k2h(text: str = '') -> str

   Convert katakana to hiragana.
   Characters other than katakana are not converted.
   Only Unicode is supported, which is the default code in Python3.
   Hankaku katakana will not be converted.
   Some special katakana such as ヸ will not be converted, too.

   :param text: katakana string
   :type text: str

   :returns: hiragana string
   :rtype: str


.. py:function:: is_hiragana(text: Union[str, List[str]] = '') -> bool

   Check if the input is hiragana.
   Only Unicode is supported, which is the default code in Python3.

   :param text: string
   :type text: str

   :returns: True if the input is hiragana.
   :rtype: bool


.. py:function:: is_katakana(text: Union[str, List[str]] = '') -> bool

   Check if the input is katakana.
   Only Unicode is supported, which is the default code in Python3.

   :param text: string
   :type text: str

   :returns: True if the input is katakana.
   :rtype: bool


.. py:function:: is_kana(text: Union[str, List[str]] = '') -> bool

   Check if the input is hiragana or katakana.
   Only Unicode is supported, which is the default code in Python3.

   :param text: string
   :type text: str

   :returns: True if the input is hiragana or katakana.
   :rtype: bool