py_serializable.formatters
==========================

.. py:module:: py_serializable.formatters


Classes
-------

.. autoapisummary::

   py_serializable.formatters.BaseNameFormatter
   py_serializable.formatters.CamelCasePropertyNameFormatter
   py_serializable.formatters.KebabCasePropertyNameFormatter
   py_serializable.formatters.SnakeCasePropertyNameFormatter
   py_serializable.formatters.CurrentFormatter


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

.. py:class:: BaseNameFormatter

   Bases: :py:obj:`abc.ABC`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:method:: encode(property_name: str) -> str
      :classmethod:

      :abstractmethod:



   .. py:method:: decode(property_name: str) -> str
      :classmethod:

      :abstractmethod:



   .. py:method:: decode_as_class_name(name: str) -> str
      :classmethod:



   .. py:method:: decode_handle_python_builtins_and_keywords(name: str) -> str
      :classmethod:



   .. py:method:: encode_handle_python_builtins_and_keywords(name: str) -> str
      :classmethod:



.. py:class:: CamelCasePropertyNameFormatter

   Bases: :py:obj:`BaseNameFormatter`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:method:: encode(property_name: str) -> str
      :classmethod:



   .. py:method:: decode(property_name: str) -> str
      :classmethod:



   .. py:method:: decode_as_class_name(name: str) -> str
      :classmethod:



   .. py:method:: decode_handle_python_builtins_and_keywords(name: str) -> str
      :classmethod:



   .. py:method:: encode_handle_python_builtins_and_keywords(name: str) -> str
      :classmethod:



.. py:class:: KebabCasePropertyNameFormatter

   Bases: :py:obj:`BaseNameFormatter`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:method:: encode(property_name: str) -> str
      :classmethod:



   .. py:method:: decode(property_name: str) -> str
      :classmethod:



   .. py:method:: decode_as_class_name(name: str) -> str
      :classmethod:



   .. py:method:: decode_handle_python_builtins_and_keywords(name: str) -> str
      :classmethod:



   .. py:method:: encode_handle_python_builtins_and_keywords(name: str) -> str
      :classmethod:



.. py:class:: SnakeCasePropertyNameFormatter

   Bases: :py:obj:`BaseNameFormatter`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:method:: encode(property_name: str) -> str
      :classmethod:



   .. py:method:: decode(property_name: str) -> str
      :classmethod:



   .. py:method:: decode_as_class_name(name: str) -> str
      :classmethod:



   .. py:method:: decode_handle_python_builtins_and_keywords(name: str) -> str
      :classmethod:



   .. py:method:: encode_handle_python_builtins_and_keywords(name: str) -> str
      :classmethod:



.. py:class:: CurrentFormatter

   .. py:attribute:: formatter
      :type:  Type[BaseNameFormatter]