:py:mod:`dissect.target.plugins.os.unix.locale`
===============================================

.. py:module:: dissect.target.plugins.os.unix.locale




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

Classes
~~~~~~~

.. autoapisummary::

   dissect.target.plugins.os.unix.locale.UnixLocalePlugin



Functions
~~~~~~~~~

.. autoapisummary::
   :nosignatures:

   dissect.target.plugins.os.unix.locale.timezone_from_path



Attributes
~~~~~~~~~~

.. autoapisummary::

   dissect.target.plugins.os.unix.locale.UnixKeyboardRecord


.. py:data:: UnixKeyboardRecord

.. py:function:: timezone_from_path(path: pathlib.Path | str) -> str

   Return timezone name for the given zoneinfo path.

   .. code-block::

       /usr/share/zoneinfo/Europe/Amsterdam -> Europe/Amsterdam
       /usr/share/zoneinfo/UTC              -> UTC
       Etc/UTC                              -> UTC


.. py:class:: UnixLocalePlugin(target: dissect.target.target.Target)

   Bases: :py:obj:`dissect.target.plugins.os.default.locale.LocalePlugin`


   Unix locale plugin.


   .. py:method:: check_compatible() -> None

      Perform a compatibility check with the target.

      This function should return ``None`` if the plugin is compatible with the current target (``self.target``).
      For example, check if a certain file exists. Otherwise it should raise an
      :class:`UnsupportedPluginError`.

      :raises UnsupportedPluginError: If the plugin could not be loaded.



   .. py:method:: timezone() -> str | None

      Get the timezone of the system.



   .. py:method:: language() -> list[str]

      Get the configured locale(s) of the system.



   .. py:method:: keyboard() -> collections.abc.Iterator[UnixKeyboardRecord]

      Get the keyboard layout(s) of the system.