:tocdepth: 3

:py:mod:`gws.plugin.model_value.current_user`
=============================================

.. py:module:: gws.plugin.model_value.current_user

.. autoapi-nested-parse::

   Current user.

   Formats properties of the current user and returns them as a string.

   If ``format`` is configured, it must be a Python format string with a reference
   to the ``user`` param, e.g. ``"{user.displayName}_{user.isGuest}"``.

   If no ``format`` is configured, user's ``loginName`` is returned.



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



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



.. py:class:: Config


   Bases: :py:obj:`gws.base.model.value.Config`

   Current user value configuration.

   .. py:attribute:: format
      :type:  str
      :value: ''


      Format string.


.. py:class:: Object


   Bases: :py:obj:`gws.base.model.value.Object`

   .. py:attribute:: format
      :type:  str

   .. py:method:: compute(field, feature, mc)

   .. py:method:: configure()