:tocdepth: 3

:py:mod:`gws.plugin.csv_helper`
===============================

.. py:module:: gws.plugin.csv_helper

.. autoapi-nested-parse::

   Common csv writer helper.



**Source code:** :source:`gws.plugin.csv_helper<gws/plugin/csv_helper/__init__.py>`



Package Contents
----------------



.. py:class:: Config(*args, **kwargs)


   Bases: :py:obj:`gws.Config`

   CSV helper.

   .. py:attribute:: format
      :type:  FormatConfig

      CSV format settings.


.. py:class:: Format(*args, **kwargs)


   Bases: :py:obj:`gws.Data`

   Basic data object.

   This object can be instantiated by passing one or or ``dict`` arguments
   and/or keyword args. All dicts keys and keywords become attributes of the object.

   Accessing an undefined attribute returns ``None`` and no error is raised,
   unless the attribute name starts with an underscore.

   .. py:attribute:: delimiter
      :type:  str

   .. py:attribute:: encoding
      :type:  str

   .. py:attribute:: formulaHack
      :type:  bool

   .. py:attribute:: quote
      :type:  str

   .. py:attribute:: quoteAll
      :type:  bool

   .. py:attribute:: rowDelimiter
      :type:  str


.. py:class:: FormatConfig(*args, **kwargs)


   Bases: :py:obj:`gws.Config`

   CSV format settings

   .. py:attribute:: delimiter
      :type:  str
      :value: ','


      Field delimiter.

   .. py:attribute:: encoding
      :type:  str
      :value: 'utf8'


      Text encoding.

   .. py:attribute:: formulaHack
      :type:  bool
      :value: True


      Prepend numeric strings with an equals sign.

   .. py:attribute:: quote
      :type:  str
      :value: '"'


      Quote character.

   .. py:attribute:: quoteAll
      :type:  bool
      :value: False


      Quote all fields.

   .. py:attribute:: rowDelimiter
      :type:  str
      :value: 'LF'


      Row delimiter.


.. py:class:: Object


   Bases: :py:obj:`gws.Node`

   Configurable GWS object.

   .. py:attribute:: format
      :type:  Format

   .. py:method:: configure()

      Configuration hook.


   .. py:method:: writer(locale: gws.Locale)

      Creates a new csv Writer.

      :param locale: Locale to use.