anki._vendor.stringcase
=======================

.. py:module:: anki._vendor.stringcase

.. autoapi-nested-parse::

   String convert functions



Functions
---------

.. autoapisummary::

   anki._vendor.stringcase.camelcase
   anki._vendor.stringcase.capitalcase
   anki._vendor.stringcase.constcase
   anki._vendor.stringcase.lowercase
   anki._vendor.stringcase.pascalcase
   anki._vendor.stringcase.pathcase
   anki._vendor.stringcase.backslashcase
   anki._vendor.stringcase.sentencecase
   anki._vendor.stringcase.snakecase
   anki._vendor.stringcase.spinalcase
   anki._vendor.stringcase.dotcase
   anki._vendor.stringcase.titlecase
   anki._vendor.stringcase.trimcase
   anki._vendor.stringcase.uppercase
   anki._vendor.stringcase.alphanumcase


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

.. py:function:: camelcase(string)

   Convert string into camel case.

   Args:
       string: String to convert.

   Returns:
       string: Camel case string.



.. py:function:: capitalcase(string)

   Convert string into capital case.
   First letters will be uppercase.

   Args:
       string: String to convert.

   Returns:
       string: Capital case string.



.. py:function:: constcase(string)

   Convert string into upper snake case.
   Join punctuation with underscore and convert letters into uppercase.

   Args:
       string: String to convert.

   Returns:
       string: Const cased string.



.. py:function:: lowercase(string)

   Convert string into lower case.

   Args:
       string: String to convert.

   Returns:
       string: Lowercase case string.



.. py:function:: pascalcase(string)

   Convert string into pascal case.

   Args:
       string: String to convert.

   Returns:
       string: Pascal case string.



.. py:function:: pathcase(string)

   Convert string into path case.
   Join punctuation with slash.

   Args:
       string: String to convert.

   Returns:
       string: Path cased string.



.. py:function:: backslashcase(string)

   Convert string into spinal case.
   Join punctuation with backslash.

   Args:
       string: String to convert.

   Returns:
       string: Spinal cased string.



.. py:function:: sentencecase(string)

   Convert string into sentence case.
   First letter capped and each punctuations are joined with space.

   Args:
       string: String to convert.

   Returns:
       string: Sentence cased string.



.. py:function:: snakecase(string)

   Convert string into snake case.
   Join punctuation with underscore

   Args:
       string: String to convert.

   Returns:
       string: Snake cased string.



.. py:function:: spinalcase(string)

   Convert string into spinal case.
   Join punctuation with hyphen.

   Args:
       string: String to convert.

   Returns:
       string: Spinal cased string.



.. py:function:: dotcase(string)

   Convert string into dot case.
   Join punctuation with dot.

   Args:
       string: String to convert.

   Returns:
       string: Dot cased string.



.. py:function:: titlecase(string)

   Convert string into sentence case.
   First letter capped while each punctuations is capitalsed
   and joined with space.

   Args:
       string: String to convert.

   Returns:
       string: Title cased string.



.. py:function:: trimcase(string)

   Convert string into trimmed string.

   Args:
       string: String to convert.

   Returns:
       string: Trimmed case string


.. py:function:: uppercase(string)

   Convert string into upper case.

   Args:
       string: String to convert.

   Returns:
       string: Uppercase case string.



.. py:function:: alphanumcase(string)

   Cuts all non-alphanumeric symbols,
   i.e. cuts all expect except 0-9, a-z and A-Z.

   Args:
       string: String to convert.

   Returns:
       string: String with cut non-alphanumeric symbols.