tik_manager4.mixins.localize
============================

.. py:module:: tik_manager4.mixins.localize

.. autoapi-nested-parse::

   Mixin for localizing files and folders



Attributes
----------

.. autoapisummary::

   tik_manager4.mixins.localize.LOG


Classes
-------

.. autoapisummary::

   tik_manager4.mixins.localize.LocalizeMixin


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

.. py:class:: LocalizeMixin

   Bases: :py:obj:`tik_manager4.objects.entity.Entity`


   Localize mixin for Works and Publishes.


   .. py:method:: can_localize()

      Check if the entity can be localized.



   .. py:method:: get_localized_path(*args, return_str=True)

      Return the localized path for the entity.

      Args:
          args (str): The path arguments.
              Any values passed here will be appended to the path.
          return_str (bool): Return the string path instead of the Path object.



   .. py:method:: get_output_path(*args)

      Decide the output path for the entity.

      This depends on the localization settings.



   .. py:method:: get_resolved_path(*args)

      Return the path to the entity.

      If the entity is localized, return the localized path.



   .. py:method:: get_resolved_purgatory_path(*args)

      Return the path to the purgatory entity.

      If the entity is localized, return the localized purgatory path.



   .. py:method:: show_database_folder()

      Override the show_database_folder method to resolve the local or database path.



   .. py:method:: show_project_folder()

      Override the show_project_folder method to resolve the local or project path.



   .. py:method:: sync()

      Sync the entity to the origin.

      This will copy the entity to the origin path. Sync is single direction.



   .. py:method:: validate_paths(sources, targets)

      Validate that all source files exist and can be moved to target locations.



   .. py:property:: localized
      The localization status of the work version.



   .. py:property:: localized_path
      The localized path of the work version.



.. py:data:: LOG